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