include/llvm/Analysis/Dominators.h

   1 //===- llvm/Analysis/Dominators.h - Dominator Info Calculation --*- C++ -*-===//
   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 defines the DominatorTree class, which provides fast and efficient
  11 // dominance queries.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_ANALYSIS_DOMINATORS_H
  16 #define LLVM_ANALYSIS_DOMINATORS_H
  17
  18 #include "llvm/Pass.h"
  19 #include "llvm/Function.h"
  20 #include "llvm/ADT/DenseMap.h"
  21 #include "llvm/ADT/DepthFirstIterator.h"
  22 #include "llvm/ADT/GraphTraits.h"
  23 #include "llvm/ADT/SmallPtrSet.h"
  24 #include "llvm/ADT/SmallVector.h"
  25 #include "llvm/Support/CFG.h"
  26 #include "llvm/Support/Compiler.h"
  27 #include "llvm/Support/raw_ostream.h"
  28 #include <algorithm>
  29
  30 namespace llvm {
  31
  32 //===----------------------------------------------------------------------===//
  33 /// DominatorBase - Base class that other, more interesting dominator analyses
  34 /// inherit from.
  35 ///
  36 template <class NodeT>
  37 class DominatorBase {
  38 protected:
  39   std::vector<NodeT*> Roots;
  40   const bool IsPostDominators;
  41   inline explicit DominatorBase(bool isPostDom) :
  42     Roots(), IsPostDominators(isPostDom) {}
  43 public:
  44
  45   /// getRoots - Return the root blocks of the current CFG.  This may include
  46   /// multiple blocks if we are computing post dominators.  For forward
  47   /// dominators, this will always be a single block (the entry node).
  48   ///
  49   inline const std::vector<NodeT*> &getRoots() const { return Roots; }
  50
  51   /// isPostDominator - Returns true if analysis based of postdoms
  52   ///
  53   bool isPostDominator() const { return IsPostDominators; }
  54 };
  55
  56
  57 //===----------------------------------------------------------------------===//
  58 // DomTreeNode - Dominator Tree Node
  59 template<class NodeT> class DominatorTreeBase;
  60 struct PostDominatorTree;
  61 class MachineBasicBlock;
  62
  63 template <class NodeT>
  64 class DomTreeNodeBase {
  65   NodeT *TheBB;
  66   DomTreeNodeBase<NodeT> *IDom;
  67   std::vector<DomTreeNodeBase<NodeT> *> Children;
  68   int DFSNumIn, DFSNumOut;
  69
  70   template<class N> friend class DominatorTreeBase;
  71   friend struct PostDominatorTree;
  72 public:
  73   typedef typename std::vector<DomTreeNodeBase<NodeT> *>::iterator iterator;
  74   typedef typename std::vector<DomTreeNodeBase<NodeT> *>::const_iterator
  75                    const_iterator;
  76
  77   iterator begin()             { return Children.begin(); }
  78   iterator end()               { return Children.end(); }
  79   const_iterator begin() const { return Children.begin(); }
  80   const_iterator end()   const { return Children.end(); }
  81
  82   NodeT *getBlock() const { return TheBB; }
  83   DomTreeNodeBase<NodeT> *getIDom() const { return IDom; }
  84   const std::vector<DomTreeNodeBase<NodeT>*> &getChildren() const {
  85     return Children;
  86   }
  87
  88   DomTreeNodeBase(NodeT *BB, DomTreeNodeBase<NodeT> *iDom)
  89     : TheBB(BB), IDom(iDom), DFSNumIn(-1), DFSNumOut(-1) { }
  90
  91   DomTreeNodeBase<NodeT> *addChild(DomTreeNodeBase<NodeT> *C) {
  92     Children.push_back(C);
  93     return C;
  94   }
  95
  96   size_t getNumChildren() const {
  97     return Children.size();
  98   }
  99
 100   void clearAllChildren() {
 101     Children.clear();
 102   }
 103
 104   bool compare(DomTreeNodeBase<NodeT> *Other) {
 105     if (getNumChildren() != Other->getNumChildren())
 106       return true;
 107
 108     SmallPtrSet<NodeT *, 4> OtherChildren;
 109     for (iterator I = Other->begin(), E = Other->end(); I != E; ++I) {
 110       NodeT *Nd = (*I)->getBlock();
 111       OtherChildren.insert(Nd);
 112     }
 113
 114     for (iterator I = begin(), E = end(); I != E; ++I) {
 115       NodeT *N = (*I)->getBlock();
 116       if (OtherChildren.count(N) == 0)
 117         return true;
 118     }
 119     return false;
 120   }
 121
 122   void setIDom(DomTreeNodeBase<NodeT> *NewIDom) {
 123     assert(IDom && "No immediate dominator?");
 124     if (IDom != NewIDom) {
 125       typename std::vector<DomTreeNodeBase<NodeT>*>::iterator I =
 126                   std::find(IDom->Children.begin(), IDom->Children.end(), this);
 127       assert(I != IDom->Children.end() &&
 128              "Not in immediate dominator children set!");
 129       // I am no longer your child...
 130       IDom->Children.erase(I);
 131
 132       // Switch to new dominator
 133       IDom = NewIDom;
 134       IDom->Children.push_back(this);
 135     }
 136   }
 137
 138   /// getDFSNumIn/getDFSNumOut - These are an internal implementation detail, do
 139   /// not call them.
 140   unsigned getDFSNumIn() const { return DFSNumIn; }
 141   unsigned getDFSNumOut() const { return DFSNumOut; }
 142 private:
 143   // Return true if this node is dominated by other. Use this only if DFS info
 144   // is valid.
 145   bool DominatedBy(const DomTreeNodeBase<NodeT> *other) const {
 146     return this->DFSNumIn >= other->DFSNumIn &&
 147       this->DFSNumOut <= other->DFSNumOut;
 148   }
 149 };
 150
 151 EXTERN_TEMPLATE_INSTANTIATION(class DomTreeNodeBase<BasicBlock>);
 152 EXTERN_TEMPLATE_INSTANTIATION(class DomTreeNodeBase<MachineBasicBlock>);
 153
 154 template<class NodeT>
 155 static raw_ostream &operator<<(raw_ostream &o,
 156                                const DomTreeNodeBase<NodeT> *Node) {
 157   if (Node->getBlock())
 158     WriteAsOperand(o, Node->getBlock(), false);
 159   else
 160     o << " <<exit node>>";
 161
 162   o << " {" << Node->getDFSNumIn() << "," << Node->getDFSNumOut() << "}";
 163
 164   return o << "\n";
 165 }
 166
 167 template<class NodeT>
 168 static void PrintDomTree(const DomTreeNodeBase<NodeT> *N, raw_ostream &o,
 169                          unsigned Lev) {
 170   o.indent(2*Lev) << "[" << Lev << "] " << N;
 171   for (typename DomTreeNodeBase<NodeT>::const_iterator I = N->begin(),
 172        E = N->end(); I != E; ++I)
 173     PrintDomTree<NodeT>(*I, o, Lev+1);
 174 }
 175
 176 typedef DomTreeNodeBase<BasicBlock> DomTreeNode;
 177
 178 //===----------------------------------------------------------------------===//
 179 /// DominatorTree - Calculate the immediate dominator tree for a function.
 180 ///
 181
 182 template<class FuncT, class N>
 183 void Calculate(DominatorTreeBase<typename GraphTraits<N>::NodeType>& DT,
 184                FuncT& F);
 185
 186 template<class NodeT>
 187 class DominatorTreeBase : public DominatorBase<NodeT> {
 188 protected:
 189   typedef DenseMap<NodeT*, DomTreeNodeBase<NodeT>*> DomTreeNodeMapType;
 190   DomTreeNodeMapType DomTreeNodes;
 191   DomTreeNodeBase<NodeT> *RootNode;
 192
 193   bool DFSInfoValid;
 194   unsigned int SlowQueries;
 195   // Information record used during immediate dominators computation.
 196   struct InfoRec {
 197     unsigned DFSNum;
 198     unsigned Semi;
 199     unsigned Size;
 200     NodeT *Label, *Child;
 201     unsigned Parent, Ancestor;
 202
 203     InfoRec() : DFSNum(0), Semi(0), Size(0), Label(0), Child(0), Parent(0),
 204                 Ancestor(0) {}
 205   };
 206
 207   DenseMap<NodeT*, NodeT*> IDoms;
 208
 209   // Vertex - Map the DFS number to the BasicBlock*
 210   std::vector<NodeT*> Vertex;
 211
 212   // Info - Collection of information used during the computation of idoms.
 213   DenseMap<NodeT*, InfoRec> Info;
 214
 215   void reset() {
 216     for (typename DomTreeNodeMapType::iterator I = this->DomTreeNodes.begin(),
 217            E = DomTreeNodes.end(); I != E; ++I)
 218       delete I->second;
 219     DomTreeNodes.clear();
 220     IDoms.clear();
 221     this->Roots.clear();
 222     Vertex.clear();
 223     RootNode = 0;
 224   }
 225
 226   // NewBB is split and now it has one successor. Update dominator tree to
 227   // reflect this change.
 228   template<class N, class GraphT>
 229   void Split(DominatorTreeBase<typename GraphT::NodeType>& DT,
 230              typename GraphT::NodeType* NewBB) {
 231     assert(std::distance(GraphT::child_begin(NewBB),
 232                          GraphT::child_end(NewBB)) == 1 &&
 233            "NewBB should have a single successor!");
 234     typename GraphT::NodeType* NewBBSucc = *GraphT::child_begin(NewBB);
 235
 236     std::vector<typename GraphT::NodeType*> PredBlocks;
 237     typedef GraphTraits<Inverse<N> > InvTraits;
 238     for (typename InvTraits::ChildIteratorType PI =
 239          InvTraits::child_begin(NewBB),
 240          PE = InvTraits::child_end(NewBB); PI != PE; ++PI)
 241       PredBlocks.push_back(*PI);
 242
 243     assert(!PredBlocks.empty() && "No predblocks?");
 244
 245     bool NewBBDominatesNewBBSucc = true;
 246     for (typename InvTraits::ChildIteratorType PI =
 247          InvTraits::child_begin(NewBBSucc),
 248          E = InvTraits::child_end(NewBBSucc); PI != E; ++PI) {
 249       typename InvTraits::NodeType *ND = *PI;
 250       if (ND != NewBB && !DT.dominates(NewBBSucc, ND) &&
 251           DT.isReachableFromEntry(ND)) {
 252         NewBBDominatesNewBBSucc = false;
 253         break;
 254       }
 255     }
 256
 257     // Find NewBB's immediate dominator and create new dominator tree node for
 258     // NewBB.
 259     NodeT *NewBBIDom = 0;
 260     unsigned i = 0;
 261     for (i = 0; i < PredBlocks.size(); ++i)
 262       if (DT.isReachableFromEntry(PredBlocks[i])) {
 263         NewBBIDom = PredBlocks[i];
 264         break;
 265       }
 266
 267     // It's possible that none of the predecessors of NewBB are reachable;
 268     // in that case, NewBB itself is unreachable, so nothing needs to be
 269     // changed.
 270     if (!NewBBIDom)
 271       return;
 272
 273     for (i = i + 1; i < PredBlocks.size(); ++i) {
 274       if (DT.isReachableFromEntry(PredBlocks[i]))
 275         NewBBIDom = DT.findNearestCommonDominator(NewBBIDom, PredBlocks[i]);
 276     }
 277
 278     // Create the new dominator tree node... and set the idom of NewBB.
 279     DomTreeNodeBase<NodeT> *NewBBNode = DT.addNewBlock(NewBB, NewBBIDom);
 280
 281     // If NewBB strictly dominates other blocks, then it is now the immediate
 282     // dominator of NewBBSucc.  Update the dominator tree as appropriate.
 283     if (NewBBDominatesNewBBSucc) {
 284       DomTreeNodeBase<NodeT> *NewBBSuccNode = DT.getNode(NewBBSucc);
 285       DT.changeImmediateDominator(NewBBSuccNode, NewBBNode);
 286     }
 287   }
 288
 289 public:
 290   explicit DominatorTreeBase(bool isPostDom)
 291     : DominatorBase<NodeT>(isPostDom), DFSInfoValid(false), SlowQueries(0) {}
 292   virtual ~DominatorTreeBase() { reset(); }
 293
 294   /// compare - Return false if the other dominator tree base matches this
 295   /// dominator tree base. Otherwise return true.
 296   bool compare(DominatorTreeBase &Other) const {
 297
 298     const DomTreeNodeMapType &OtherDomTreeNodes = Other.DomTreeNodes;
 299     if (DomTreeNodes.size() != OtherDomTreeNodes.size())
 300       return true;
 301
 302     for (typename DomTreeNodeMapType::const_iterator
 303            I = this->DomTreeNodes.begin(),
 304            E = this->DomTreeNodes.end(); I != E; ++I) {
 305       NodeT *BB = I->first;
 306       typename DomTreeNodeMapType::const_iterator OI = OtherDomTreeNodes.find(BB);
 307       if (OI == OtherDomTreeNodes.end())
 308         return true;
 309
 310       DomTreeNodeBase<NodeT>* MyNd = I->second;
 311       DomTreeNodeBase<NodeT>* OtherNd = OI->second;
 312
 313       if (MyNd->compare(OtherNd))
 314         return true;
 315     }
 316
 317     return false;
 318   }
 319
 320   virtual void releaseMemory() { reset(); }
 321
 322   /// getNode - return the (Post)DominatorTree node for the specified basic
 323   /// block.  This is the same as using operator[] on this class.
 324   ///
 325   inline DomTreeNodeBase<NodeT> *getNode(NodeT *BB) const {
 326     typename DomTreeNodeMapType::const_iterator I = DomTreeNodes.find(BB);
 327     return I != DomTreeNodes.end() ? I->second : 0;
 328   }
 329
 330   /// getRootNode - This returns the entry node for the CFG of the function.  If
 331   /// this tree represents the post-dominance relations for a function, however,
 332   /// this root may be a node with the block == NULL.  This is the case when
 333   /// there are multiple exit nodes from a particular function.  Consumers of
 334   /// post-dominance information must be capable of dealing with this
 335   /// possibility.
 336   ///
 337   DomTreeNodeBase<NodeT> *getRootNode() { return RootNode; }
 338   const DomTreeNodeBase<NodeT> *getRootNode() const { return RootNode; }
 339
 340   /// properlyDominates - Returns true iff this dominates N and this != N.
 341   /// Note that this is not a constant time operation!
 342   ///
 343   bool properlyDominates(const DomTreeNodeBase<NodeT> *A,
 344                          const DomTreeNodeBase<NodeT> *B) const {
 345     if (A == 0 || B == 0) return false;
 346     return dominatedBySlowTreeWalk(A, B);
 347   }
 348
 349   inline bool properlyDominates(const NodeT *A, const NodeT *B) {
 350     if (A == B)
 351       return false;
 352
 353     // Cast away the const qualifiers here. This is ok since
 354     // this function doesn't actually return the values returned
 355     // from getNode.
 356     return properlyDominates(getNode(const_cast<NodeT *>(A)),
 357                              getNode(const_cast<NodeT *>(B)));
 358   }
 359
 360   bool dominatedBySlowTreeWalk(const DomTreeNodeBase<NodeT> *A,
 361                                const DomTreeNodeBase<NodeT> *B) const {
 362     const DomTreeNodeBase<NodeT> *IDom;
 363     if (A == 0 || B == 0) return false;
 364     while ((IDom = B->getIDom()) != 0 && IDom != A && IDom != B)
 365       B = IDom;   // Walk up the tree
 366     return IDom != 0;
 367   }
 368
 369
 370   /// isReachableFromEntry - Return true if A is dominated by the entry
 371   /// block of the function containing it.
 372   bool isReachableFromEntry(const NodeT* A) {
 373     assert(!this->isPostDominator() &&
 374            "This is not implemented for post dominators");
 375     return dominates(&A->getParent()->front(), A);
 376   }
 377
 378   /// dominates - Returns true iff A dominates B.  Note that this is not a
 379   /// constant time operation!
 380   ///
 381   inline bool dominates(const DomTreeNodeBase<NodeT> *A,
 382                         const DomTreeNodeBase<NodeT> *B) {
 383     if (B == A)
 384       return true;  // A node trivially dominates itself.
 385
 386     if (A == 0 || B == 0)
 387       return false;
 388
 389     // Compare the result of the tree walk and the dfs numbers, if expensive
 390     // checks are enabled.
 391 #ifdef XDEBUG
 392     assert((!DFSInfoValid ||
 393             (dominatedBySlowTreeWalk(A, B) == B->DominatedBy(A))) &&
 394            "Tree walk disagrees with dfs numbers!");
 395 #endif
 396
 397     if (DFSInfoValid)
 398       return B->DominatedBy(A);
 399
 400     // If we end up with too many slow queries, just update the
 401     // DFS numbers on the theory that we are going to keep querying.
 402     SlowQueries++;
 403     if (SlowQueries > 32) {
 404       updateDFSNumbers();
 405       return B->DominatedBy(A);
 406     }
 407
 408     return dominatedBySlowTreeWalk(A, B);
 409   }
 410
 411   inline bool dominates(const NodeT *A, const NodeT *B) {
 412     if (A == B)
 413       return true;
 414
 415     // Cast away the const qualifiers here. This is ok since
 416     // this function doesn't actually return the values returned
 417     // from getNode.
 418     return dominates(getNode(const_cast<NodeT *>(A)),
 419                      getNode(const_cast<NodeT *>(B)));
 420   }
 421
 422   NodeT *getRoot() const {
 423     assert(this->Roots.size() == 1 && "Should always have entry node!");
 424     return this->Roots[0];
 425   }
 426
 427   /// findNearestCommonDominator - Find nearest common dominator basic block
 428   /// for basic block A and B. If there is no such block then return NULL.
 429   NodeT *findNearestCommonDominator(NodeT *A, NodeT *B) {
 430     assert(A->getParent() == B->getParent() &&
 431            "Two blocks are not in same function");
 432
 433     // If either A or B is a entry block then it is nearest common dominator
 434     // (for forward-dominators).
 435     if (!this->isPostDominator()) {
 436       NodeT &Entry = A->getParent()->front();
 437       if (A == &Entry || B == &Entry)
 438         return &Entry;
 439     }
 440
 441     // If B dominates A then B is nearest common dominator.
 442     if (dominates(B, A))
 443       return B;
 444
 445     // If A dominates B then A is nearest common dominator.
 446     if (dominates(A, B))
 447       return A;
 448
 449     DomTreeNodeBase<NodeT> *NodeA = getNode(A);
 450     DomTreeNodeBase<NodeT> *NodeB = getNode(B);
 451
 452     // Collect NodeA dominators set.
 453     SmallPtrSet<DomTreeNodeBase<NodeT>*, 16> NodeADoms;
 454     NodeADoms.insert(NodeA);
 455     DomTreeNodeBase<NodeT> *IDomA = NodeA->getIDom();
 456     while (IDomA) {
 457       NodeADoms.insert(IDomA);
 458       IDomA = IDomA->getIDom();
 459     }
 460
 461     // Walk NodeB immediate dominators chain and find common dominator node.
 462     DomTreeNodeBase<NodeT> *IDomB = NodeB->getIDom();
 463     while (IDomB) {
 464       if (NodeADoms.count(IDomB) != 0)
 465         return IDomB->getBlock();
 466
 467       IDomB = IDomB->getIDom();
 468     }
 469
 470     return NULL;
 471   }
 472
 473   const NodeT *findNearestCommonDominator(const NodeT *A, const NodeT *B) {
 474     // Cast away the const qualifiers here. This is ok since
 475     // const is re-introduced on the return type.
 476     return findNearestCommonDominator(const_cast<NodeT *>(A),
 477                                       const_cast<NodeT *>(B));
 478   }
 479
 480   //===--------------------------------------------------------------------===//
 481   // API to update (Post)DominatorTree information based on modifications to
 482   // the CFG...
 483
 484   /// addNewBlock - Add a new node to the dominator tree information.  This
 485   /// creates a new node as a child of DomBB dominator node,linking it into
 486   /// the children list of the immediate dominator.
 487   DomTreeNodeBase<NodeT> *addNewBlock(NodeT *BB, NodeT *DomBB) {
 488     assert(getNode(BB) == 0 && "Block already in dominator tree!");
 489     DomTreeNodeBase<NodeT> *IDomNode = getNode(DomBB);
 490     assert(IDomNode && "Not immediate dominator specified for block!");
 491     DFSInfoValid = false;
 492     return DomTreeNodes[BB] =
 493       IDomNode->addChild(new DomTreeNodeBase<NodeT>(BB, IDomNode));
 494   }
 495
 496   /// changeImmediateDominator - This method is used to update the dominator
 497   /// tree information when a node's immediate dominator changes.
 498   ///
 499   void changeImmediateDominator(DomTreeNodeBase<NodeT> *N,
 500                                 DomTreeNodeBase<NodeT> *NewIDom) {
 501     assert(N && NewIDom && "Cannot change null node pointers!");
 502     DFSInfoValid = false;
 503     N->setIDom(NewIDom);
 504   }
 505
 506   void changeImmediateDominator(NodeT *BB, NodeT *NewBB) {
 507     changeImmediateDominator(getNode(BB), getNode(NewBB));
 508   }
 509
 510   /// eraseNode - Removes a node from the dominator tree. Block must not
 511   /// dominate any other blocks. Removes node from its immediate dominator's
 512   /// children list. Deletes dominator node associated with basic block BB.
 513   void eraseNode(NodeT *BB) {
 514     DomTreeNodeBase<NodeT> *Node = getNode(BB);
 515     assert(Node && "Removing node that isn't in dominator tree.");
 516     assert(Node->getChildren().empty() && "Node is not a leaf node.");
 517
 518       // Remove node from immediate dominator's children list.
 519     DomTreeNodeBase<NodeT> *IDom = Node->getIDom();
 520     if (IDom) {
 521       typename std::vector<DomTreeNodeBase<NodeT>*>::iterator I =
 522         std::find(IDom->Children.begin(), IDom->Children.end(), Node);
 523       assert(I != IDom->Children.end() &&
 524              "Not in immediate dominator children set!");
 525       // I am no longer your child...
 526       IDom->Children.erase(I);
 527     }
 528
 529     DomTreeNodes.erase(BB);
 530     delete Node;
 531   }
 532
 533   /// removeNode - Removes a node from the dominator tree.  Block must not
 534   /// dominate any other blocks.  Invalidates any node pointing to removed
 535   /// block.
 536   void removeNode(NodeT *BB) {
 537     assert(getNode(BB) && "Removing node that isn't in dominator tree.");
 538     DomTreeNodes.erase(BB);
 539   }
 540
 541   /// splitBlock - BB is split and now it has one successor. Update dominator
 542   /// tree to reflect this change.
 543   void splitBlock(NodeT* NewBB) {
 544     if (this->IsPostDominators)
 545       this->Split<Inverse<NodeT*>, GraphTraits<Inverse<NodeT*> > >(*this, NewBB);
 546     else
 547       this->Split<NodeT*, GraphTraits<NodeT*> >(*this, NewBB);
 548   }
 549
 550   /// print - Convert to human readable form
 551   ///
 552   void print(raw_ostream &o) const {
 553     o << "=============================--------------------------------\n";
 554     if (this->isPostDominator())
 555       o << "Inorder PostDominator Tree: ";
 556     else
 557       o << "Inorder Dominator Tree: ";
 558     if (!this->DFSInfoValid)
 559       o << "DFSNumbers invalid: " << SlowQueries << " slow queries.";
 560     o << "\n";
 561
 562     // The postdom tree can have a null root if there are no returns.
 563     if (getRootNode())
 564       PrintDomTree<NodeT>(getRootNode(), o, 1);
 565   }
 566
 567 protected:
 568   template<class GraphT>
 569   friend void Compress(DominatorTreeBase<typename GraphT::NodeType>& DT,
 570                        typename GraphT::NodeType* VIn);
 571
 572   template<class GraphT>
 573   friend typename GraphT::NodeType* Eval(
 574                                DominatorTreeBase<typename GraphT::NodeType>& DT,
 575                                          typename GraphT::NodeType* V);
 576
 577   template<class GraphT>
 578   friend unsigned DFSPass(DominatorTreeBase<typename GraphT::NodeType>& DT,
 579                           typename GraphT::NodeType* V,
 580                           unsigned N);
 581
 582   template<class FuncT, class N>
 583   friend void Calculate(DominatorTreeBase<typename GraphTraits<N>::NodeType>& DT,
 584                         FuncT& F);
 585
 586   /// updateDFSNumbers - Assign In and Out numbers to the nodes while walking
 587   /// dominator tree in dfs order.
 588   void updateDFSNumbers() {
 589     unsigned DFSNum = 0;
 590
 591     SmallVector<std::pair<DomTreeNodeBase<NodeT>*,
 592                 typename DomTreeNodeBase<NodeT>::iterator>, 32> WorkStack;
 593
 594     DomTreeNodeBase<NodeT> *ThisRoot = getRootNode();
 595
 596     if (!ThisRoot)
 597       return;
 598
 599     // Even in the case of multiple exits that form the post dominator root
 600     // nodes, do not iterate over all exits, but start from the virtual root
 601     // node. Otherwise bbs, that are not post dominated by any exit but by the
 602     // virtual root node, will never be assigned a DFS number.
 603     WorkStack.push_back(std::make_pair(ThisRoot, ThisRoot->begin()));
 604     ThisRoot->DFSNumIn = DFSNum++;
 605
 606     while (!WorkStack.empty()) {
 607       DomTreeNodeBase<NodeT> *Node = WorkStack.back().first;
 608       typename DomTreeNodeBase<NodeT>::iterator ChildIt =
 609         WorkStack.back().second;
 610
 611       // If we visited all of the children of this node, "recurse" back up the
 612       // stack setting the DFOutNum.
 613       if (ChildIt == Node->end()) {
 614         Node->DFSNumOut = DFSNum++;
 615         WorkStack.pop_back();
 616       } else {
 617         // Otherwise, recursively visit this child.
 618         DomTreeNodeBase<NodeT> *Child = *ChildIt;
 619         ++WorkStack.back().second;
 620
 621         WorkStack.push_back(std::make_pair(Child, Child->begin()));
 622         Child->DFSNumIn = DFSNum++;
 623       }
 624     }
 625
 626     SlowQueries = 0;
 627     DFSInfoValid = true;
 628   }
 629
 630   DomTreeNodeBase<NodeT> *getNodeForBlock(NodeT *BB) {
 631     typename DomTreeNodeMapType::iterator I = this->DomTreeNodes.find(BB);
 632     if (I != this->DomTreeNodes.end() && I->second)
 633       return I->second;
 634
 635     // Haven't calculated this node yet?  Get or calculate the node for the
 636     // immediate dominator.
 637     NodeT *IDom = getIDom(BB);
 638
 639     assert(IDom || this->DomTreeNodes[NULL]);
 640     DomTreeNodeBase<NodeT> *IDomNode = getNodeForBlock(IDom);
 641
 642     // Add a new tree node for this BasicBlock, and link it as a child of
 643     // IDomNode
 644     DomTreeNodeBase<NodeT> *C = new DomTreeNodeBase<NodeT>(BB, IDomNode);
 645     return this->DomTreeNodes[BB] = IDomNode->addChild(C);
 646   }
 647
 648   inline NodeT *getIDom(NodeT *BB) const {
 649     typename DenseMap<NodeT*, NodeT*>::const_iterator I = IDoms.find(BB);
 650     return I != IDoms.end() ? I->second : 0;
 651   }
 652
 653   inline void addRoot(NodeT* BB) {
 654     this->Roots.push_back(BB);
 655   }
 656
 657 public:
 658   /// recalculate - compute a dominator tree for the given function
 659   template<class FT>
 660   void recalculate(FT& F) {
 661     reset();
 662     this->Vertex.push_back(0);
 663
 664     if (!this->IsPostDominators) {
 665       // Initialize root
 666       this->Roots.push_back(&F.front());
 667       this->IDoms[&F.front()] = 0;
 668       this->DomTreeNodes[&F.front()] = 0;
 669
 670       Calculate<FT, NodeT*>(*this, F);
 671     } else {
 672       // Initialize the roots list
 673       for (typename FT::iterator I = F.begin(), E = F.end(); I != E; ++I) {
 674         if (std::distance(GraphTraits<FT*>::child_begin(I),
 675                           GraphTraits<FT*>::child_end(I)) == 0)
 676           addRoot(I);
 677
 678         // Prepopulate maps so that we don't get iterator invalidation issues later.
 679         this->IDoms[I] = 0;
 680         this->DomTreeNodes[I] = 0;
 681       }
 682
 683       Calculate<FT, Inverse<NodeT*> >(*this, F);
 684     }
 685   }
 686 };
 687
 688 EXTERN_TEMPLATE_INSTANTIATION(class DominatorTreeBase<BasicBlock>);
 689
 690 //===-------------------------------------
 691 /// DominatorTree Class - Concrete subclass of DominatorTreeBase that is used to
 692 /// compute a normal dominator tree.
 693 ///
 694 class DominatorTree : public FunctionPass {
 695 public:
 696   static char ID; // Pass ID, replacement for typeid
 697   DominatorTreeBase<BasicBlock>* DT;
 698
 699   DominatorTree() : FunctionPass(ID) {
 700     initializeDominatorTreePass(*PassRegistry::getPassRegistry());
 701     DT = new DominatorTreeBase<BasicBlock>(false);
 702   }
 703
 704   ~DominatorTree() {
 705     delete DT;
 706   }
 707
 708   DominatorTreeBase<BasicBlock>& getBase() { return *DT; }
 709
 710   /// getRoots - Return the root blocks of the current CFG.  This may include
 711   /// multiple blocks if we are computing post dominators.  For forward
 712   /// dominators, this will always be a single block (the entry node).
 713   ///
 714   inline const std::vector<BasicBlock*> &getRoots() const {
 715     return DT->getRoots();
 716   }
 717
 718   inline BasicBlock *getRoot() const {
 719     return DT->getRoot();
 720   }
 721
 722   inline DomTreeNode *getRootNode() const {
 723     return DT->getRootNode();
 724   }
 725
 726   /// compare - Return false if the other dominator tree matches this
 727   /// dominator tree. Otherwise return true.
 728   inline bool compare(DominatorTree &Other) const {
 729     DomTreeNode *R = getRootNode();
 730     DomTreeNode *OtherR = Other.getRootNode();
 731
 732     if (!R || !OtherR || R->getBlock() != OtherR->getBlock())
 733       return true;
 734
 735     if (DT->compare(Other.getBase()))
 736       return true;
 737
 738     return false;
 739   }
 740
 741   virtual bool runOnFunction(Function &F);
 742
 743   virtual void verifyAnalysis() const;
 744
 745   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 746     AU.setPreservesAll();
 747   }
 748
 749   inline bool dominates(const DomTreeNode* A, const DomTreeNode* B) const {
 750     return DT->dominates(A, B);
 751   }
 752
 753   inline bool dominates(const BasicBlock* A, const BasicBlock* B) const {
 754     return DT->dominates(A, B);
 755   }
 756
 757   // dominates - Return true if A dominates B. This performs the
 758   // special checks necessary if A and B are in the same basic block.
 759   bool dominates(const Instruction *A, const Instruction *B) const;
 760
 761   bool properlyDominates(const DomTreeNode *A, const DomTreeNode *B) const {
 762     return DT->properlyDominates(A, B);
 763   }
 764
 765   bool properlyDominates(const BasicBlock *A, const BasicBlock *B) const {
 766     return DT->properlyDominates(A, B);
 767   }
 768
 769   /// findNearestCommonDominator - Find nearest common dominator basic block
 770   /// for basic block A and B. If there is no such block then return NULL.
 771   inline BasicBlock *findNearestCommonDominator(BasicBlock *A, BasicBlock *B) {
 772     return DT->findNearestCommonDominator(A, B);
 773   }
 774
 775   inline const BasicBlock *findNearestCommonDominator(const BasicBlock *A,
 776                                                       const BasicBlock *B) {
 777     return DT->findNearestCommonDominator(A, B);
 778   }
 779
 780   inline DomTreeNode *operator[](BasicBlock *BB) const {
 781     return DT->getNode(BB);
 782   }
 783
 784   /// getNode - return the (Post)DominatorTree node for the specified basic
 785   /// block.  This is the same as using operator[] on this class.
 786   ///
 787   inline DomTreeNode *getNode(BasicBlock *BB) const {
 788     return DT->getNode(BB);
 789   }
 790
 791   /// addNewBlock - Add a new node to the dominator tree information.  This
 792   /// creates a new node as a child of DomBB dominator node,linking it into
 793   /// the children list of the immediate dominator.
 794   inline DomTreeNode *addNewBlock(BasicBlock *BB, BasicBlock *DomBB) {
 795     return DT->addNewBlock(BB, DomBB);
 796   }
 797
 798   /// changeImmediateDominator - This method is used to update the dominator
 799   /// tree information when a node's immediate dominator changes.
 800   ///
 801   inline void changeImmediateDominator(BasicBlock *N, BasicBlock* NewIDom) {
 802     DT->changeImmediateDominator(N, NewIDom);
 803   }
 804
 805   inline void changeImmediateDominator(DomTreeNode *N, DomTreeNode* NewIDom) {
 806     DT->changeImmediateDominator(N, NewIDom);
 807   }
 808
 809   /// eraseNode - Removes a node from the dominator tree. Block must not
 810   /// dominate any other blocks. Removes node from its immediate dominator's
 811   /// children list. Deletes dominator node associated with basic block BB.
 812   inline void eraseNode(BasicBlock *BB) {
 813     DT->eraseNode(BB);
 814   }
 815
 816   /// splitBlock - BB is split and now it has one successor. Update dominator
 817   /// tree to reflect this change.
 818   inline void splitBlock(BasicBlock* NewBB) {
 819     DT->splitBlock(NewBB);
 820   }
 821
 822   bool isReachableFromEntry(const BasicBlock* A) {
 823     return DT->isReachableFromEntry(A);
 824   }
 825
 826
 827   virtual void releaseMemory() {
 828     DT->releaseMemory();
 829   }
 830
 831   virtual void print(raw_ostream &OS, const Module* M= 0) const;
 832 };
 833
 834 //===-------------------------------------
 835 /// DominatorTree GraphTraits specialization so the DominatorTree can be
 836 /// iterable by generic graph iterators.
 837 ///
 838 template <> struct GraphTraits<DomTreeNode*> {
 839   typedef DomTreeNode NodeType;
 840   typedef NodeType::iterator  ChildIteratorType;
 841
 842   static NodeType *getEntryNode(NodeType *N) {
 843     return N;
 844   }
 845   static inline ChildIteratorType child_begin(NodeType *N) {
 846     return N->begin();
 847   }
 848   static inline ChildIteratorType child_end(NodeType *N) {
 849     return N->end();
 850   }
 851
 852   typedef df_iterator<DomTreeNode*> nodes_iterator;
 853
 854   static nodes_iterator nodes_begin(DomTreeNode *N) {
 855     return df_begin(getEntryNode(N));
 856   }
 857
 858   static nodes_iterator nodes_end(DomTreeNode *N) {
 859     return df_end(getEntryNode(N));
 860   }
 861 };
 862
 863 template <> struct GraphTraits<DominatorTree*>
 864   : public GraphTraits<DomTreeNode*> {
 865   static NodeType *getEntryNode(DominatorTree *DT) {
 866     return DT->getRootNode();
 867   }
 868
 869   static nodes_iterator nodes_begin(DominatorTree *N) {
 870     return df_begin(getEntryNode(N));
 871   }
 872
 873   static nodes_iterator nodes_end(DominatorTree *N) {
 874     return df_end(getEntryNode(N));
 875   }
 876 };
 877
 878
 879 } // End llvm namespace
 880
 881 #endif