LLVM API Documentation

Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

llvm::DominatorTree Class Reference

#include <Dominators.h>

Inheritance diagram for llvm::DominatorTree:

Inheritance graph
[legend]
Collaboration diagram for llvm::DominatorTree:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 DominatorTree ()
 ~DominatorTree ()
DominatorTreeBase< BasicBlock > & getBase ()
const std::vector< BasicBlock * > & getRoots () const
BasicBlock * getRoot () const
DomTreeNode * getRootNode () const
bool compare (DominatorTree &Other) const
virtual bool runOnFunction (Function &F)
virtual void getAnalysisUsage (AnalysisUsage &AU) const
bool dominates (DomTreeNode *A, DomTreeNode *B) const
bool dominates (BasicBlock *A, BasicBlock *B) const
bool dominates (Instruction *A, Instruction *B) const
bool properlyDominates (const DomTreeNode *A, DomTreeNode *B) const
bool properlyDominates (BasicBlock *A, BasicBlock *B) const
BasicBlock * findNearestCommonDominator (BasicBlock *A, BasicBlock *B)
DomTreeNode * operator[] (BasicBlock *BB) const
DomTreeNode * getNode (BasicBlock *BB) const
DomTreeNode * addNewBlock (BasicBlock *BB, BasicBlock *DomBB)
void changeImmediateDominator (BasicBlock *N, BasicBlock *NewIDom)
void changeImmediateDominator (DomTreeNode *N, DomTreeNode *NewIDom)
void eraseNode (BasicBlock *BB)
void splitBlock (BasicBlock *NewBB)
bool isReachableFromEntry (BasicBlock *A)
virtual void releaseMemory ()
virtual void print (std::ostream &OS, const Module *M=0) const

Public Attributes

DominatorTreeBase< BasicBlock > * DT

Static Public Attributes

char ID = 0

Detailed Description

DominatorTree Class - Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree.

Definition at line 718 of file Dominators.h.

Constructor & Destructor Documentation

llvm::DominatorTree::DominatorTree (   )  [inline]
 

Definition at line 723 of file Dominators.h.

llvm::DominatorTree::~DominatorTree (   )  [inline]
 

Definition at line 727 of file Dominators.h.

Member Function Documentation

DomTreeNode* llvm::DominatorTree::addNewBlock (  BasicBlock *  BB,
BasicBlock *  DomBB
)  [inline]
 

addNewBlock - Add a new node to the dominator tree information. This creates a new node as a child of DomBB dominator node,linking it into the children list of the immediate dominator.

Definition at line 831 of file Dominators.h.

References llvm::DomTreeNode.

Referenced by CloneDominatorInfo(), LoopRotate::preserveCanonicalLoopForm(), llvm::SplitBlock(), and llvm::SplitCriticalEdge().

void llvm::DominatorTree::changeImmediateDominator (  DomTreeNode *  N,
DomTreeNode *  NewIDom
)  [inline]
 

Definition at line 842 of file Dominators.h.

void llvm::DominatorTree::changeImmediateDominator (  BasicBlock *  N,
BasicBlock *  NewIDom
)  [inline]
 

changeImmediateDominator - This method is used to update the dominator tree information when a node's immediate dominator changes.

Definition at line 838 of file Dominators.h.

Referenced by llvm::MergeBlockIntoPredecessor(), LoopRotate::preserveCanonicalLoopForm(), LoopDeletion::runOnLoop(), llvm::SplitBlock(), and llvm::SplitCriticalEdge().

bool llvm::DominatorTree::compare (  DominatorTree &  Other  )  const [inline]
 

compare - Return false if the other dominator tree matches this dominator tree. Otherwise return true.

Definition at line 752 of file Dominators.h.

References llvm::DomTreeNode, getBase(), llvm::DomTreeNodeBase< NodeT >::getBlock(), and getRootNode().

Referenced by llvm::PMDataManager::verifyDomInfo().

bool llvm::DominatorTree::dominates (  Instruction *  A,
Instruction *  B
)  const [inline]
 

Definition at line 781 of file Dominators.h.

References llvm::BasicBlock::begin(), and llvm::Instruction::getParent().

bool llvm::DominatorTree::dominates (  BasicBlock *  A,
BasicBlock *  B
)  const [inline]
 

Definition at line 775 of file Dominators.h.

bool llvm::DominatorTree::dominates (  DomTreeNode *  A,
DomTreeNode *  B
)  const [inline]
 

Definition at line 771 of file Dominators.h.

Referenced by llvm::DominanceFrontier::changeImmediateDominator(), PromoteMem2Reg::dominates(), FindPHIToPartitionLoops(), IVUseShouldUsePostIncValue(), LoopRotate::preserveCanonicalLoopForm(), LCSSA::ProcessInstruction(), DSE::runOnBasicBlock(), LoopDeletion::SingleDominatingExit(), llvm::DominanceFrontier::splitBlock(), llvm::SplitBlockPredecessors(), llvm::SplitCriticalEdge(), and Verifier::visitInstruction().

void llvm::DominatorTree::eraseNode (  BasicBlock *  BB  )  [inline]
 

eraseNode - Removes a node from the dominator tree. Block must not domiante any other blocks. Removes node from its immediate dominator's children list. Deletes dominator node associated with basic block BB.

Definition at line 849 of file Dominators.h.

Referenced by llvm::MergeBlockIntoPredecessor(), and LoopDeletion::runOnLoop().

BasicBlock* llvm::DominatorTree::findNearestCommonDominator (  BasicBlock *  A,
BasicBlock *  B
)  [inline]
 

findNearestCommonDominator - Find nearest common dominator basic block for basic block A and B. If there is no such block then return NULL.

Definition at line 813 of file Dominators.h.

virtual void llvm::DominatorTree::getAnalysisUsage (  AnalysisUsage &  AU  )  const [inline, virtual]
 

getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job. If a pass specifies that it uses a particular analysis result to this function, it can then use the getAnalysis<AnalysisType>() function, below.

Reimplemented from llvm::Pass.

Definition at line 767 of file Dominators.h.

References llvm::AnalysisUsage::setPreservesAll().

DominatorTreeBase<BasicBlock>& llvm::DominatorTree::getBase (   )  [inline]
 

Definition at line 732 of file Dominators.h.

Referenced by compare(), and llvm::PMDataManager::verifyDomInfo().

DomTreeNode* llvm::DominatorTree::getNode (  BasicBlock *  BB  )  const [inline]
 

getNode - return the (Post)DominatorTree node for the specified basic block. This is the same as using operator[] on this class.

Definition at line 824 of file Dominators.h.

References llvm::DomTreeNode.

Referenced by CloneDominatorInfo(), llvm::MergeBlockIntoPredecessor(), LoopRotate::preserveCanonicalLoopForm(), LCSSA::ProcessInstruction(), LICM::runOnLoop(), llvm::SplitBlock(), llvm::SplitCriticalEdge(), and llvm::PMDataManager::verifyDomInfo().

BasicBlock* llvm::DominatorTree::getRoot (   )  const [inline]
 

Definition at line 742 of file Dominators.h.

DomTreeNode* llvm::DominatorTree::getRootNode (   )  const [inline]
 

Definition at line 746 of file Dominators.h.

References llvm::DomTreeNode.

Referenced by compare(), DomTreeDFS::DomTreeDFS(), and llvm::GraphTraits< DominatorTree * >::getEntryNode().

const std::vector<BasicBlock*>& llvm::DominatorTree::getRoots (   )  const [inline]
 

getRoots - Return the root blocks of the current CFG. This may include multiple blocks if we are computing post dominators. For forward dominators, this will always be a single block (the entry node).

Definition at line 738 of file Dominators.h.

Referenced by llvm::DominanceFrontier::runOnFunction(), and llvm::PMDataManager::verifyDomInfo().

bool llvm::DominatorTree::isReachableFromEntry (  BasicBlock *  A  )  [inline]
 

Definition at line 859 of file Dominators.h.

DomTreeNode* llvm::DominatorTree::operator[] (  BasicBlock *  BB  )  const [inline]
 

Definition at line 817 of file Dominators.h.

References llvm::DomTreeNode.

virtual void llvm::DominatorTree::print (  std::ostream &  OS,
const Module *  M = 0
)  const [inline, virtual]
 

print - Print out the internal state of the pass. This is called by Analyze to print out the contents of an analysis. Otherwise it is not necessary to implement this method. Beware that the module pointer MAY be null. This automatically forwards to a virtual function that does not provide the Module* in case the analysis doesn't need it it can just be ignored.

Reimplemented from llvm::Pass.

Definition at line 868 of file Dominators.h.

bool llvm::DominatorTree::properlyDominates (  BasicBlock *  A,
BasicBlock *  B
)  const [inline]
 

Definition at line 807 of file Dominators.h.

bool llvm::DominatorTree::properlyDominates (  const DomTreeNode *  A,
DomTreeNode *  B
)  const [inline]
 

Definition at line 803 of file Dominators.h.

Referenced by llvm::DominanceFrontier::calculate(), ValueTable::lookup_or_add(), and PromoteMem2Reg::properlyDominates().

virtual void llvm::DominatorTree::releaseMemory (   )  [inline, virtual]
 

releaseMemory() - This member can be implemented by a pass if it wants to be able to release its memory when it is no longer needed. The default behavior of passes is to hold onto memory for the entire duration of their lifetime (which is the entire compile time). For pipelined passes, this is not a big deal because that memory gets recycled every time the pass is invoked on another program unit. For IP passes, it is more important to free memory when it is unused.

Optionally implement this function to release pass memory when it is no longer used.

Reimplemented from llvm::Pass.

Definition at line 864 of file Dominators.h.

bool DominatorTree::runOnFunction (  Function &  F  )  [virtual]
 

runOnFunction - Virtual method overriden by subclasses to do the per-function processing of the pass.

Implements llvm::FunctionPass.

Definition at line 59 of file Dominators.cpp.

References DT, and llvm::DominatorTreeBase< NodeT >::recalculate().

Referenced by LoopUnswitch::runOnLoop(), and LoopUnroll::runOnLoop().

void llvm::DominatorTree::splitBlock (  BasicBlock *  NewBB  )  [inline]
 

splitBlock - BB is split and now it has one successor. Update dominator tree to reflect this change.

Definition at line 855 of file Dominators.h.

Referenced by llvm::SplitBlockPredecessors().

Member Data Documentation

DominatorTreeBase<BasicBlock>* llvm::DominatorTree::DT
 

Definition at line 721 of file Dominators.h.

Referenced by runOnFunction().

char DominatorTree::ID = 0 [static]
 

Definition at line 55 of file Dominators.cpp.

The documentation for this class was generated from the following files:

Generated on Sun Sep 7 02:50:37 2008 for LLVM by Doxygen1.3.9.1
Copyright © 2003-2007 University of Illinois at Urbana-Champaign. All Rights Reserved.

This web site is hosted by the Computer Science Department at the University of Illinois at Urbana-Champaign.