LLVM API Documentation

llvm::MachineDominatorTree Class Reference

#include <MachineDominators.h>

Inheritance diagram for llvm::MachineDominatorTree:
[legend]
Collaboration diagram for llvm::MachineDominatorTree:
[legend]

List of all members.

Public Member Functions

 MachineDominatorTree ()
 ~MachineDominatorTree ()
DominatorTreeBase
< MachineBasicBlock > & 
getBase ()
virtual void getAnalysisUsage (AnalysisUsage &AU) const
const std::vector
< MachineBasicBlock * > & 
getRoots () const
MachineBasicBlock * getRoot () const
MachineDomTreeNode * getRootNode () const
virtual bool runOnMachineFunction (MachineFunction &F)
bool dominates (MachineDomTreeNode *A, MachineDomTreeNode *B) const
bool dominates (MachineBasicBlock *A, MachineBasicBlock *B) const
bool dominates (MachineInstr *A, MachineInstr *B) const
bool properlyDominates (const MachineDomTreeNode *A, MachineDomTreeNode *B) const
bool properlyDominates (MachineBasicBlock *A, MachineBasicBlock *B) const
MachineBasicBlock * findNearestCommonDominator (MachineBasicBlock *A, MachineBasicBlock *B)
MachineDomTreeNode * operator[] (MachineBasicBlock *BB) const
MachineDomTreeNode * getNode (MachineBasicBlock *BB) const
MachineDomTreeNode * addNewBlock (MachineBasicBlock *BB, MachineBasicBlock *DomBB)
void changeImmediateDominator (MachineBasicBlock *N, MachineBasicBlock *NewIDom)
void changeImmediateDominator (MachineDomTreeNode *N, MachineDomTreeNode *NewIDom)
void eraseNode (MachineBasicBlock *BB)
void splitBlock (MachineBasicBlock *NewBB)
virtual void releaseMemory ()
virtual void print (std::ostream &OS, const Module *M=0) const

Public Attributes

DominatorTreeBase
< MachineBasicBlock > * 
DT

Static Public Attributes

static char ID = 0


Detailed Description

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

Definition at line 42 of file MachineDominators.h.


Constructor & Destructor Documentation

MachineDominatorTree::MachineDominatorTree (  ) 

Definition at line 41 of file MachineDominators.cpp.

References DT.

MachineDominatorTree::~MachineDominatorTree (  ) 

Definition at line 46 of file MachineDominators.cpp.

References DT.


Member Function Documentation

DominatorTreeBase<MachineBasicBlock>& llvm::MachineDominatorTree::getBase (  )  [inline]

Definition at line 51 of file MachineDominators.h.

References DT.

void MachineDominatorTree::getAnalysisUsage ( AnalysisUsage &  AU  )  const [virtual]

getAnalysisUsage - Subclasses that override getAnalysisUsage must call this.

For MachineFunctionPasses, calling AU.preservesCFG() indicates that the pass does not modify the MachineBasicBlock CFG.

Reimplemented from llvm::MachineFunctionPass.

Definition at line 30 of file MachineDominators.cpp.

References llvm::MachineFunctionPass::getAnalysisUsage(), and llvm::AnalysisUsage::setPreservesAll().

const std::vector<MachineBasicBlock*>& llvm::MachineDominatorTree::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 59 of file MachineDominators.h.

References DT, and llvm::DominatorTree::getRoots().

MachineBasicBlock* llvm::MachineDominatorTree::getRoot (  )  const [inline]

Definition at line 63 of file MachineDominators.h.

References DT, and llvm::DominatorTree::getRoot().

MachineDomTreeNode* llvm::MachineDominatorTree::getRootNode (  )  const [inline]

bool MachineDominatorTree::runOnMachineFunction ( MachineFunction &  MF  )  [virtual]

runOnMachineFunction - This method must be overloaded to perform the desired machine code transformation or analysis.

Implements llvm::MachineFunctionPass.

Definition at line 35 of file MachineDominators.cpp.

References DT.

bool llvm::MachineDominatorTree::dominates ( MachineDomTreeNode *  A,
MachineDomTreeNode *  B 
) const [inline]

Definition at line 73 of file MachineDominators.h.

References llvm::DominatorTree::dominates(), and DT.

bool llvm::MachineDominatorTree::dominates ( MachineBasicBlock *  A,
MachineBasicBlock *  B 
) const [inline]

Definition at line 77 of file MachineDominators.h.

References llvm::DominatorTree::dominates(), and DT.

bool llvm::MachineDominatorTree::dominates ( MachineInstr *  A,
MachineInstr *  B 
) const [inline]

bool llvm::MachineDominatorTree::properlyDominates ( const MachineDomTreeNode *  A,
MachineDomTreeNode *  B 
) const [inline]

Definition at line 100 of file MachineDominators.h.

References DT, and llvm::DominatorTree::properlyDominates().

bool llvm::MachineDominatorTree::properlyDominates ( MachineBasicBlock *  A,
MachineBasicBlock *  B 
) const [inline]

Definition at line 105 of file MachineDominators.h.

References DT, and llvm::DominatorTree::properlyDominates().

MachineBasicBlock* llvm::MachineDominatorTree::findNearestCommonDominator ( MachineBasicBlock *  A,
MachineBasicBlock *  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 112 of file MachineDominators.h.

References DT, and llvm::DominatorTree::findNearestCommonDominator().

MachineDomTreeNode* llvm::MachineDominatorTree::operator[] ( MachineBasicBlock *  BB  )  const [inline]

Definition at line 117 of file MachineDominators.h.

References DT, and llvm::DominatorTree::getNode().

MachineDomTreeNode* llvm::MachineDominatorTree::getNode ( MachineBasicBlock *  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 124 of file MachineDominators.h.

References DT, and llvm::DominatorTree::getNode().

MachineDomTreeNode* llvm::MachineDominatorTree::addNewBlock ( MachineBasicBlock *  BB,
MachineBasicBlock *  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 131 of file MachineDominators.h.

References llvm::DominatorTree::addNewBlock(), and DT.

void llvm::MachineDominatorTree::changeImmediateDominator ( MachineBasicBlock *  N,
MachineBasicBlock *  NewIDom 
) [inline]

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

Definition at line 139 of file MachineDominators.h.

References llvm::DominatorTree::changeImmediateDominator(), and DT.

void llvm::MachineDominatorTree::changeImmediateDominator ( MachineDomTreeNode *  N,
MachineDomTreeNode *  NewIDom 
) [inline]

Definition at line 144 of file MachineDominators.h.

References llvm::DominatorTree::changeImmediateDominator(), and DT.

void llvm::MachineDominatorTree::eraseNode ( MachineBasicBlock *  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 152 of file MachineDominators.h.

References DT, and llvm::DominatorTree::eraseNode().

void llvm::MachineDominatorTree::splitBlock ( MachineBasicBlock *  NewBB  )  [inline]

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

Definition at line 158 of file MachineDominators.h.

References DT, and llvm::DominatorTree::splitBlock().

void MachineDominatorTree::releaseMemory (  )  [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 51 of file MachineDominators.cpp.

References DT.

virtual void llvm::MachineDominatorTree::print ( std::ostream &  O,
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 165 of file MachineDominators.h.

References DT, M, and llvm::DominatorTree::print().


Member Data Documentation

char MachineDominatorTree::ID = 0 [static]

Definition at line 44 of file MachineDominators.h.


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