LLVM  mainline
llvm::MachineDominatorTree Class Reference

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

#include <MachineDominators.h>

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

List of all members.

## Classes

struct  CriticalEdge
Helper structure used to hold all the basic blocks involved in the split of a critical edge.

## Public Member Functions

MachineDominatorTree ()
~MachineDominatorTree () override
DominatorTreeBase
< MachineBasicBlock > &
getBase ()
void getAnalysisUsage (AnalysisUsage &AU) const override
getAnalysisUsage - Subclasses that override getAnalysisUsage must call this.
const std::vector
< MachineBasicBlock * > &
getRoots () const
getRoots - Return the root blocks of the current CFG.
MachineBasicBlockgetRoot () const
MachineDomTreeNodegetRootNode () const
bool runOnMachineFunction (MachineFunction &F) override
runOnMachineFunction - This method must be overloaded to perform the desired machine code transformation or analysis.
bool dominates (const MachineDomTreeNode *A, const MachineDomTreeNode *B) const
bool dominates (const MachineBasicBlock *A, const MachineBasicBlock *B) const
bool dominates (const MachineInstr *A, const MachineInstr *B) const
bool properlyDominates (const MachineDomTreeNode *A, const MachineDomTreeNode *B) const
bool properlyDominates (const MachineBasicBlock *A, const MachineBasicBlock *B) const
MachineBasicBlockfindNearestCommonDominator (MachineBasicBlock *A, MachineBasicBlock *B)
findNearestCommonDominator - Find nearest common dominator basic block for basic block A and B.
MachineDomTreeNodeoperator[] (MachineBasicBlock *BB) const
MachineDomTreeNodegetNode (MachineBasicBlock *BB) const
getNode - return the (Post)DominatorTree node for the specified basic block.
void changeImmediateDominator (MachineBasicBlock *N, MachineBasicBlock *NewIDom)
changeImmediateDominator - This method is used to update the dominator tree information when a node's immediate dominator changes.
void changeImmediateDominator (MachineDomTreeNode *N, MachineDomTreeNode *NewIDom)
void eraseNode (MachineBasicBlock *BB)
eraseNode - Removes a node from the dominator tree.
void splitBlock (MachineBasicBlock *NewBB)
splitBlock - BB is split and now it has one successor.
bool isReachableFromEntry (const MachineBasicBlock *A)
isReachableFromEntry - Return true if A is dominated by the entry block of the function containing it.
void releaseMemory () override
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.
void print (raw_ostream &OS, const Module *) const override
print - Print out the internal state of the pass.
void recordSplitCriticalEdge (MachineBasicBlock *FromBB, MachineBasicBlock *ToBB, MachineBasicBlock *NewBB)
Record that the critical edge (FromBB, ToBB) has been split with NewBB.

## 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 41 of file MachineDominators.h.

## Constructor & Destructor Documentation

 MachineDominatorTree::MachineDominatorTree ( )

Definition at line 46 of file MachineDominators.cpp.

 MachineDominatorTree::~MachineDominatorTree ( )  [override]

Definition at line 52 of file MachineDominators.cpp.

References DT.

## Member Function Documentation

 MachineDomTreeNode* llvm::MachineDominatorTree::addNewBlock ( MachineBasicBlock * BB, MachineBasicBlock * DomBB )  [inline]

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 174 of file MachineDominators.h.

 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 183 of file MachineDominators.h.

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

Definition at line 189 of file MachineDominators.h.

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

Definition at line 105 of file MachineDominators.h.

Referenced by computeADRP(), isCandidate(), and ReplaceDominatedUses().

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

Definition at line 111 of file MachineDominators.h.

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

Definition at line 119 of file MachineDominators.h.

 void llvm::MachineDominatorTree::eraseNode ( MachineBasicBlock * BB )  [inline]

eraseNode - Removes a node from the dominator tree.

Block must not dominate any other blocks. Removes node from its immediate dominator's children list. Deletes dominator node associated with basic block BB.

Definition at line 198 of file MachineDominators.h.

 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 152 of file MachineDominators.h.

Referenced by PlaceBlockMarker().

 void llvm::MachineDominatorTree::getAnalysisUsage ( AnalysisUsage & AU ) const [override, 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.

 DominatorTreeBase& llvm::MachineDominatorTree::getBase ( )  [inline]

Definition at line 77 of file MachineDominators.h.

 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 166 of file MachineDominators.h.

References llvm::DominatorTreeBase< NodeT >::getNode().

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

Definition at line 93 of file MachineDominators.h.

References llvm::DominatorTreeBase< NodeT >::getRoot().

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

Definition at line 98 of file MachineDominators.h.

 const std::vector& 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 88 of file MachineDominators.h.

References llvm::DominatorBase< NodeT >::getRoots().

 bool llvm::MachineDominatorTree::isReachableFromEntry ( const MachineBasicBlock * A )  [inline]

isReachableFromEntry - Return true if A is dominated by the entry block of the function containing it.

Definition at line 212 of file MachineDominators.h.

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

Definition at line 158 of file MachineDominators.h.

References llvm::DominatorTreeBase< NodeT >::getNode().

 void MachineDominatorTree::print ( raw_ostream & O, const Module * M ) const [override, 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 60 of file MachineDominators.cpp.

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

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

Definition at line 138 of file MachineDominators.h.

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

Definition at line 144 of file MachineDominators.h.

 void llvm::MachineDominatorTree::recordSplitCriticalEdge ( MachineBasicBlock * FromBB, MachineBasicBlock * ToBB, MachineBasicBlock * NewBB )  [inline]

Record that the critical edge (FromBB, ToBB) has been split with NewBB.

This is best to use this method instead of directly update the underlying information, because this helps mitigating the number of time the DT information is invalidated.

Note:
Do not use this method with regular edges.
To benefit from the compile time improvement incurred by this method, the users of this method have to limit the queries to the DT interface between two edges splitting. In other words, they have to pack the splitting of critical edges as much as possible.

Definition at line 233 of file MachineDominators.h.

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

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

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

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

Implements llvm::MachineFunctionPass.

Definition at line 38 of file MachineDominators.cpp.

 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 205 of file MachineDominators.h.

## Member Data Documentation

Definition at line 71 of file MachineDominators.h.

 char MachineDominatorTree::ID = 0 [static]

Definition at line 70 of file MachineDominators.h.

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