include/llvm/Analysis/Dominators.h

   1 //===- llvm/Analysis/Dominators.h - Dominator Info Calculation --*- C++ -*-===//
   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 // This file defines the following classes:
  11 //  1. DominatorTree: Represent dominators as an explicit tree structure.
  12 //  2. ETForest: Efficient data structure for dominance comparisons and
  13 //     nearest-common-ancestor queries.
  14 //  3. DominanceFrontier: Calculate and hold the dominance frontier for a
  15 //     function.
  16 //
  17 //  These data structures are listed in increasing order of complexity.  It
  18 //  takes longer to calculate the dominator frontier, for example, than the
  19 //  DominatorTree mapping.
  20 //
  21 //===----------------------------------------------------------------------===//
  22
  23 #ifndef LLVM_ANALYSIS_DOMINATORS_H
  24 #define LLVM_ANALYSIS_DOMINATORS_H
  25
  26 #include "llvm/Analysis/ET-Forest.h"
  27 #include "llvm/Pass.h"
  28 #include <set>
  29
  30 namespace llvm {
  31
  32 class Instruction;
  33
  34 template <typename GraphType> struct GraphTraits;
  35
  36 //===----------------------------------------------------------------------===//
  37 /// DominatorBase - Base class that other, more interesting dominator analyses
  38 /// inherit from.
  39 ///
  40 class DominatorBase : public FunctionPass {
  41 protected:
  42   std::vector<BasicBlock*> Roots;
  43   const bool IsPostDominators;
  44   inline DominatorBase(intptr_t ID, bool isPostDom) :
  45     FunctionPass(ID), Roots(), IsPostDominators(isPostDom) {}
  46 public:
  47
  48   /// getRoots -  Return the root blocks of the current CFG.  This may include
  49   /// multiple blocks if we are computing post dominators.  For forward
  50   /// dominators, this will always be a single block (the entry node).
  51   ///
  52   inline const std::vector<BasicBlock*> &getRoots() const { return Roots; }
  53
  54   /// isPostDominator - Returns true if analysis based of postdoms
  55   ///
  56   bool isPostDominator() const { return IsPostDominators; }
  57 };
  58
  59
  60 //===----------------------------------------------------------------------===//
  61 // DomTreeNode - Dominator Tree Node
  62
  63 class DomTreeNode {
  64   BasicBlock *TheBB;
  65   DomTreeNode *IDom;
  66   ETNode *ETN;
  67   std::vector<DomTreeNode*> Children;
  68 public:
  69   typedef std::vector<DomTreeNode*>::iterator iterator;
  70   typedef std::vector<DomTreeNode*>::const_iterator const_iterator;
  71
  72   iterator begin()             { return Children.begin(); }
  73   iterator end()               { return Children.end(); }
  74   const_iterator begin() const { return Children.begin(); }
  75   const_iterator end()   const { return Children.end(); }
  76
  77   inline BasicBlock *getBlock() const { return TheBB; }
  78   inline DomTreeNode *getIDom() const { return IDom; }
  79   inline ETNode *getETNode() const { return ETN; }
  80   inline const std::vector<DomTreeNode*> &getChildren() const { return Children; }
  81
  82   inline DomTreeNode(BasicBlock *BB, DomTreeNode *iDom, ETNode *E)
  83     : TheBB(BB), IDom(iDom), ETN(E) {
  84     if (IDom)
  85       ETN->setFather(IDom->getETNode());
  86   }
  87   inline DomTreeNode *addChild(DomTreeNode *C) { Children.push_back(C); return C; }
  88   void setIDom(DomTreeNode *NewIDom);
  89 };
  90
  91 //===----------------------------------------------------------------------===//
  92 /// DominatorTree - Calculate the immediate dominator tree for a function.
  93 ///
  94 class DominatorTreeBase : public DominatorBase {
  95
  96 protected:
  97   void reset();
  98   typedef std::map<BasicBlock*, DomTreeNode*> DomTreeNodeMapType;
  99   DomTreeNodeMapType DomTreeNodes;
 100   DomTreeNode *RootNode;
 101
 102   typedef std::map<BasicBlock*, ETNode*> ETMapType;
 103   ETMapType ETNodes;
 104
 105   bool DFSInfoValid;
 106   unsigned int SlowQueries;
 107   // Information record used during immediate dominators computation.
 108   struct InfoRec {
 109     unsigned Semi;
 110     unsigned Size;
 111     BasicBlock *Label, *Parent, *Child, *Ancestor;
 112
 113     std::vector<BasicBlock*> Bucket;
 114
 115     InfoRec() : Semi(0), Size(0), Label(0), Parent(0), Child(0), Ancestor(0){}
 116   };
 117
 118   std::map<BasicBlock*, BasicBlock*> IDoms;
 119
 120   // Vertex - Map the DFS number to the BasicBlock*
 121   std::vector<BasicBlock*> Vertex;
 122
 123   // Info - Collection of information used during the computation of idoms.
 124   std::map<BasicBlock*, InfoRec> Info;
 125
 126   public:
 127   DominatorTreeBase(intptr_t ID, bool isPostDom)
 128     : DominatorBase(ID, isPostDom), DFSInfoValid(false), SlowQueries(0) {}
 129   ~DominatorTreeBase() { reset(); }
 130
 131   virtual void releaseMemory() { reset(); }
 132
 133   /// getNode - return the (Post)DominatorTree node for the specified basic
 134   /// block.  This is the same as using operator[] on this class.
 135   ///
 136   inline DomTreeNode *getNode(BasicBlock *BB) const {
 137     DomTreeNodeMapType::const_iterator i = DomTreeNodes.find(BB);
 138     return (i != DomTreeNodes.end()) ? i->second : 0;
 139   }
 140
 141   inline DomTreeNode *operator[](BasicBlock *BB) const {
 142     return getNode(BB);
 143   }
 144
 145   /// getIDomBlock - return basic block BB's immediate domiantor basic block.
 146   ///
 147   BasicBlock *getIDomBlock(BasicBlock *BB) {
 148     DomTreeNode *N = getNode(BB);
 149     assert (N && "Missing dominator tree node");
 150     DomTreeNode *I = N->getIDom();
 151     assert (N && "Missing immediate dominator");
 152     return I->getBlock();
 153   }
 154
 155   /// getRootNode - This returns the entry node for the CFG of the function.  If
 156   /// this tree represents the post-dominance relations for a function, however,
 157   /// this root may be a node with the block == NULL.  This is the case when
 158   /// there are multiple exit nodes from a particular function.  Consumers of
 159   /// post-dominance information must be capable of dealing with this
 160   /// possibility.
 161   ///
 162   DomTreeNode *getRootNode() { return RootNode; }
 163   const DomTreeNode *getRootNode() const { return RootNode; }
 164
 165   /// properlyDominates - Returns true iff this dominates N and this != N.
 166   /// Note that this is not a constant time operation!
 167   ///
 168   bool properlyDominates(const DomTreeNode *A, DomTreeNode *B) const {
 169     if (A == 0 || B == 0) return false;
 170     return dominatedBySlowTreeWalk(A, B);
 171   }
 172
 173   inline bool properlyDominates(BasicBlock *A, BasicBlock *B) {
 174     return properlyDominates(getNode(A), getNode(B));
 175   }
 176
 177   bool dominatedBySlowTreeWalk(const DomTreeNode *A,
 178                                const DomTreeNode *B) const {
 179     const DomTreeNode *IDom;
 180     if (A == 0 || B == 0) return false;
 181     while ((IDom = B->getIDom()) != 0 && IDom != A)
 182       B = IDom;   // Walk up the tree
 183     return IDom != 0;
 184   }
 185
 186   void updateDFSNumbers();
 187
 188   /// dominates - Returns true iff this dominates N.  Note that this is not a
 189   /// constant time operation!
 190   ///
 191   inline bool dominates(const DomTreeNode *A, DomTreeNode *B) {
 192     if (B == A)
 193       return true;  // A node trivially dominates itself.
 194
 195     if (A == 0 || B == 0)
 196       return false;
 197
 198     ETNode *NodeA = A->getETNode();
 199     ETNode *NodeB = B->getETNode();
 200
 201     if (DFSInfoValid)
 202       return NodeB->DominatedBy(NodeA);
 203
 204     // If we end up with too many slow queries, just update the
 205     // DFS numbers on the theory that we are going to keep querying.
 206     SlowQueries++;
 207     if (SlowQueries > 32) {
 208       updateDFSNumbers();
 209       return NodeB->DominatedBy(NodeA);
 210     }
 211     //return NodeB->DominatedBySlow(NodeA);
 212     return dominatedBySlowTreeWalk(A, B);
 213   }
 214
 215   inline bool dominates(BasicBlock *A, BasicBlock *B) {
 216     if (A == B)
 217       return true;
 218
 219     return dominates(getNode(A), getNode(B));
 220   }
 221
 222   //===--------------------------------------------------------------------===//
 223   // API to update (Post)DominatorTree information based on modifications to
 224   // the CFG...
 225
 226   /// addNewBlock - Add a new node to the dominator tree information.  This
 227   /// creates a new node as a child of DomBB dominator node,linking it into
 228   /// the children list of the immediate dominator.
 229   DomTreeNode *addNewBlock(BasicBlock *BB, BasicBlock *DomBB) {
 230     assert(getNode(BB) == 0 && "Block already in dominator tree!");
 231     DomTreeNode *IDomNode = getNode(DomBB);
 232     assert(IDomNode && "Not immediate dominator specified for block!");
 233     DFSInfoValid = false;
 234     ETNode *E = new ETNode(BB);
 235     ETNodes[BB] = E;
 236     return DomTreeNodes[BB] =
 237       IDomNode->addChild(new DomTreeNode(BB, IDomNode, E));
 238   }
 239
 240   /// changeImmediateDominator - This method is used to update the dominator
 241   /// tree information when a node's immediate dominator changes.
 242   ///
 243   void changeImmediateDominator(DomTreeNode *N, DomTreeNode *NewIDom) {
 244     assert(N && NewIDom && "Cannot change null node pointers!");
 245     DFSInfoValid = false;
 246     N->setIDom(NewIDom);
 247   }
 248
 249   void changeImmediateDominator(BasicBlock *BB, BasicBlock *NewBB) {
 250     changeImmediateDominator(getNode(BB), getNode(NewBB));
 251   }
 252
 253   /// removeNode - Removes a node from the dominator tree.  Block must not
 254   /// dominate any other blocks.  Invalidates any node pointing to removed
 255   /// block.
 256   void removeNode(BasicBlock *BB) {
 257     assert(getNode(BB) && "Removing node that isn't in dominator tree.");
 258     DomTreeNodes.erase(BB);
 259   }
 260
 261   /// print - Convert to human readable form
 262   ///
 263   virtual void print(std::ostream &OS, const Module* = 0) const;
 264   void print(std::ostream *OS, const Module* M = 0) const {
 265     if (OS) print(*OS, M);
 266   }
 267   virtual void dump();
 268 };
 269
 270 //===-------------------------------------
 271 /// DominatorTree Class - Concrete subclass of DominatorTreeBase that is used to
 272 /// compute a normal dominator tree.
 273 ///
 274 class DominatorTree : public DominatorTreeBase {
 275 public:
 276   static char ID; // Pass ID, replacement for typeid
 277   DominatorTree() : DominatorTreeBase((intptr_t)&ID, false) {}
 278
 279   BasicBlock *getRoot() const {
 280     assert(Roots.size() == 1 && "Should always have entry node!");
 281     return Roots[0];
 282   }
 283
 284   virtual bool runOnFunction(Function &F);
 285
 286   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 287     AU.setPreservesAll();
 288   }
 289 private:
 290   void calculate(Function& F);
 291   DomTreeNode *getNodeForBlock(BasicBlock *BB);
 292   unsigned DFSPass(BasicBlock *V, InfoRec &VInfo, unsigned N);
 293   void Compress(BasicBlock *V);
 294   BasicBlock *Eval(BasicBlock *v);
 295   void Link(BasicBlock *V, BasicBlock *W, InfoRec &WInfo);
 296   inline BasicBlock *getIDom(BasicBlock *BB) const {
 297       std::map<BasicBlock*, BasicBlock*>::const_iterator I = IDoms.find(BB);
 298       return I != IDoms.end() ? I->second : 0;
 299     }
 300 };
 301
 302 //===-------------------------------------
 303 /// DominatorTree GraphTraits specialization so the DominatorTree can be
 304 /// iterable by generic graph iterators.
 305 ///
 306 template <> struct GraphTraits<DomTreeNode*> {
 307   typedef DomTreeNode NodeType;
 308   typedef NodeType::iterator  ChildIteratorType;
 309
 310   static NodeType *getEntryNode(NodeType *N) {
 311     return N;
 312   }
 313   static inline ChildIteratorType child_begin(NodeType* N) {
 314     return N->begin();
 315   }
 316   static inline ChildIteratorType child_end(NodeType* N) {
 317     return N->end();
 318   }
 319 };
 320
 321 template <> struct GraphTraits<DominatorTree*>
 322   : public GraphTraits<DomTreeNode*> {
 323   static NodeType *getEntryNode(DominatorTree *DT) {
 324     return DT->getRootNode();
 325   }
 326 };
 327
 328
 329 //===-------------------------------------
 330 /// ET-Forest Class - Class used to construct forwards and backwards
 331 /// ET-Forests
 332 ///
 333 class ETForestBase : public DominatorBase {
 334 public:
 335   ETForestBase(intptr_t ID, bool isPostDom)
 336     : DominatorBase(ID, isPostDom), Nodes(),
 337       DFSInfoValid(false), SlowQueries(0) {}
 338
 339   virtual void releaseMemory() { reset(); }
 340
 341   typedef std::map<BasicBlock*, ETNode*> ETMapType;
 342
 343   // FIXME : There is no need to make this interface public.
 344   // Fix predicate simplifier.
 345   void updateDFSNumbers();
 346
 347   /// dominates - Return true if A dominates B.
 348   ///
 349   inline bool dominates(BasicBlock *A, BasicBlock *B) {
 350     if (A == B)
 351       return true;
 352
 353     ETNode *NodeA = getNode(A);
 354     ETNode *NodeB = getNode(B);
 355
 356     if (DFSInfoValid)
 357       return NodeB->DominatedBy(NodeA);
 358     else {
 359       // If we end up with too many slow queries, just update the
 360       // DFS numbers on the theory that we are going to keep querying.
 361       SlowQueries++;
 362       if (SlowQueries > 32) {
 363         updateDFSNumbers();
 364         return NodeB->DominatedBy(NodeA);
 365       }
 366       return NodeB->DominatedBySlow(NodeA);
 367     }
 368   }
 369
 370   // dominates - Return true if A dominates B. This performs the
 371   // special checks necessary if A and B are in the same basic block.
 372   bool dominates(Instruction *A, Instruction *B);
 373
 374   /// properlyDominates - Return true if A dominates B and A != B.
 375   ///
 376   bool properlyDominates(BasicBlock *A, BasicBlock *B) {
 377     return dominates(A, B) && A != B;
 378   }
 379
 380   /// isReachableFromEntry - Return true if A is dominated by the entry
 381   /// block of the function containing it.
 382   const bool isReachableFromEntry(BasicBlock* A);
 383
 384   /// Return the nearest common dominator of A and B.
 385   BasicBlock *nearestCommonDominator(BasicBlock *A, BasicBlock *B) const  {
 386     ETNode *NodeA = getNode(A);
 387     ETNode *NodeB = getNode(B);
 388
 389     ETNode *Common = NodeA->NCA(NodeB);
 390     if (!Common)
 391       return NULL;
 392     return Common->getData<BasicBlock>();
 393   }
 394
 395   /// Return the immediate dominator of A.
 396   BasicBlock *getIDom(BasicBlock *A) const {
 397     ETNode *NodeA = getNode(A);
 398     if (!NodeA) return 0;
 399     const ETNode *idom = NodeA->getFather();
 400     return idom ? idom->getData<BasicBlock>() : 0;
 401   }
 402
 403   void getETNodeChildren(BasicBlock *A, std::vector<BasicBlock*>& children) const {
 404     ETNode *NodeA = getNode(A);
 405     if (!NodeA) return;
 406     const ETNode* son = NodeA->getSon();
 407
 408     if (!son) return;
 409     children.push_back(son->getData<BasicBlock>());
 410
 411     const ETNode* brother = son->getBrother();
 412     while (brother != son) {
 413       children.push_back(brother->getData<BasicBlock>());
 414       brother = brother->getBrother();
 415     }
 416   }
 417
 418   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 419     AU.setPreservesAll();
 420     AU.addRequired<DominatorTree>();
 421   }
 422   //===--------------------------------------------------------------------===//
 423   // API to update Forest information based on modifications
 424   // to the CFG...
 425
 426   /// addNewBlock - Add a new block to the CFG, with the specified immediate
 427   /// dominator.
 428   ///
 429   void addNewBlock(BasicBlock *BB, BasicBlock *IDom);
 430
 431   /// setImmediateDominator - Update the immediate dominator information to
 432   /// change the current immediate dominator for the specified block
 433   /// to another block.  This method requires that BB for NewIDom
 434   /// already have an ETNode, otherwise just use addNewBlock.
 435   ///
 436   void setImmediateDominator(BasicBlock *BB, BasicBlock *NewIDom);
 437   /// print - Convert to human readable form
 438   ///
 439   virtual void print(std::ostream &OS, const Module* = 0) const;
 440   void print(std::ostream *OS, const Module* M = 0) const {
 441     if (OS) print(*OS, M);
 442   }
 443   virtual void dump();
 444 protected:
 445   /// getNode - return the (Post)DominatorTree node for the specified basic
 446   /// block.  This is the same as using operator[] on this class.
 447   ///
 448   inline ETNode *getNode(BasicBlock *BB) const {
 449     ETMapType::const_iterator i = Nodes.find(BB);
 450     return (i != Nodes.end()) ? i->second : 0;
 451   }
 452
 453   inline ETNode *operator[](BasicBlock *BB) const {
 454     return getNode(BB);
 455   }
 456
 457   void reset();
 458   ETMapType Nodes;
 459   bool DFSInfoValid;
 460   unsigned int SlowQueries;
 461
 462 };
 463
 464 //==-------------------------------------
 465 /// ETForest Class - Concrete subclass of ETForestBase that is used to
 466 /// compute a forwards ET-Forest.
 467
 468 class ETForest : public ETForestBase {
 469 public:
 470   static char ID; // Pass identification, replacement for typeid
 471
 472   ETForest() : ETForestBase((intptr_t)&ID, false) {}
 473
 474   BasicBlock *getRoot() const {
 475     assert(Roots.size() == 1 && "Should always have entry node!");
 476     return Roots[0];
 477   }
 478
 479   virtual bool runOnFunction(Function &F) {
 480     reset();     // Reset from the last time we were run...
 481     DominatorTree &DT = getAnalysis<DominatorTree>();
 482     Roots = DT.getRoots();
 483     calculate(DT);
 484     return false;
 485   }
 486
 487   void calculate(const DominatorTree &DT);
 488   // FIXME : There is no need to make getNodeForBlock public. Fix
 489   // predicate simplifier.
 490   ETNode *getNodeForBlock(BasicBlock *BB);
 491 };
 492
 493 //===----------------------------------------------------------------------===//
 494 /// DominanceFrontierBase - Common base class for computing forward and inverse
 495 /// dominance frontiers for a function.
 496 ///
 497 class DominanceFrontierBase : public DominatorBase {
 498 public:
 499   typedef std::set<BasicBlock*>             DomSetType;    // Dom set for a bb
 500   typedef std::map<BasicBlock*, DomSetType> DomSetMapType; // Dom set map
 501 protected:
 502   DomSetMapType Frontiers;
 503 public:
 504   DominanceFrontierBase(intptr_t ID, bool isPostDom)
 505     : DominatorBase(ID, isPostDom) {}
 506
 507   virtual void releaseMemory() { Frontiers.clear(); }
 508
 509   // Accessor interface:
 510   typedef DomSetMapType::iterator iterator;
 511   typedef DomSetMapType::const_iterator const_iterator;
 512   iterator       begin()       { return Frontiers.begin(); }
 513   const_iterator begin() const { return Frontiers.begin(); }
 514   iterator       end()         { return Frontiers.end(); }
 515   const_iterator end()   const { return Frontiers.end(); }
 516   iterator       find(BasicBlock *B)       { return Frontiers.find(B); }
 517   const_iterator find(BasicBlock *B) const { return Frontiers.find(B); }
 518
 519   void addBasicBlock(BasicBlock *BB, const DomSetType &frontier) {
 520     assert(find(BB) == end() && "Block already in DominanceFrontier!");
 521     Frontiers.insert(std::make_pair(BB, frontier));
 522   }
 523
 524   void addToFrontier(iterator I, BasicBlock *Node) {
 525     assert(I != end() && "BB is not in DominanceFrontier!");
 526     I->second.insert(Node);
 527   }
 528
 529   void removeFromFrontier(iterator I, BasicBlock *Node) {
 530     assert(I != end() && "BB is not in DominanceFrontier!");
 531     assert(I->second.count(Node) && "Node is not in DominanceFrontier of BB");
 532     I->second.erase(Node);
 533   }
 534
 535   /// print - Convert to human readable form
 536   ///
 537   virtual void print(std::ostream &OS, const Module* = 0) const;
 538   void print(std::ostream *OS, const Module* M = 0) const {
 539     if (OS) print(*OS, M);
 540   }
 541   virtual void dump();
 542 };
 543
 544
 545 //===-------------------------------------
 546 /// DominanceFrontier Class - Concrete subclass of DominanceFrontierBase that is
 547 /// used to compute a forward dominator frontiers.
 548 ///
 549 class DominanceFrontier : public DominanceFrontierBase {
 550 public:
 551   static char ID; // Pass ID, replacement for typeid
 552   DominanceFrontier() :
 553     DominanceFrontierBase((intptr_t)& ID, false) {}
 554
 555   BasicBlock *getRoot() const {
 556     assert(Roots.size() == 1 && "Should always have entry node!");
 557     return Roots[0];
 558   }
 559
 560   virtual bool runOnFunction(Function &) {
 561     Frontiers.clear();
 562     DominatorTree &DT = getAnalysis<DominatorTree>();
 563     Roots = DT.getRoots();
 564     assert(Roots.size() == 1 && "Only one entry block for forward domfronts!");
 565     calculate(DT, DT[Roots[0]]);
 566     return false;
 567   }
 568
 569   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 570     AU.setPreservesAll();
 571     AU.addRequired<DominatorTree>();
 572   }
 573
 574 private:
 575   const DomSetType &calculate(const DominatorTree &DT,
 576                               const DomTreeNode *Node);
 577 };
 578
 579
 580 } // End llvm namespace
 581
 582 #endif