LLVM API Documentation

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
llvm::MachineDominatorTree Class Reference

#include <MachineDominators.h>

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

Public Member Functions

 MachineDominatorTree ()
 
 ~MachineDominatorTree ()
 
DominatorTreeBase
< MachineBasicBlock > & 
getBase ()
 
virtual void getAnalysisUsage (AnalysisUsage &AU) const
 
const std::vector
< MachineBasicBlock * > & 
getRoots () const
 
MachineBasicBlockgetRoot () const
 
MachineDomTreeNodegetRootNode () const
 
virtual bool runOnMachineFunction (MachineFunction &F)
 
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)
 
MachineDomTreeNodeoperator[] (MachineBasicBlock *BB) const
 
MachineDomTreeNodegetNode (MachineBasicBlock *BB) const
 
MachineDomTreeNodeaddNewBlock (MachineBasicBlock *BB, MachineBasicBlock *DomBB)
 
void changeImmediateDominator (MachineBasicBlock *N, MachineBasicBlock *NewIDom)
 
void changeImmediateDominator (MachineDomTreeNode *N, MachineDomTreeNode *NewIDom)
 
void eraseNode (MachineBasicBlock *BB)
 
void splitBlock (MachineBasicBlock *NewBB)
 
bool isReachableFromEntry (const MachineBasicBlock *A)
 
virtual void releaseMemory ()
 
virtual void print (raw_ostream &OS, const Module *) const
 
- Public Member Functions inherited from llvm::FunctionPass
 FunctionPass (char &pid)
 
PasscreatePrinterPass (raw_ostream &O, const std::string &Banner) const
 createPrinterPass - Get a function printer pass. More...
 
virtual void assignPassManager (PMStack &PMS, PassManagerType T)
 
virtual PassManagerType getPotentialPassManagerType () const
 Return what kind of Pass Manager can manage this pass. More...
 
- Public Member Functions inherited from llvm::Pass
 Pass (PassKind K, char &pid)
 
virtual ~Pass ()
 
PassKind getPassKind () const
 
virtual const char * getPassName () const
 
AnalysisID getPassID () const
 getPassID - Return the PassID number that corresponds to this pass. More...
 
virtual bool doInitialization (Module &)
 
virtual bool doFinalization (Module &)
 
void dump () const
 
virtual void preparePassManager (PMStack &)
 Check if available pass managers are suitable for this pass or not. More...
 
void setResolver (AnalysisResolver *AR)
 
AnalysisResolvergetResolver () const
 
virtual void * getAdjustedAnalysisPointer (AnalysisID ID)
 
virtual ImmutablePassgetAsImmutablePass ()
 
virtual PMDataManagergetAsPMDataManager ()
 
virtual void verifyAnalysis () const
 
virtual void dumpPassStructure (unsigned Offset=0)
 
template<typename AnalysisType >
AnalysisType * getAnalysisIfAvailable () const
 
bool mustPreserveAnalysisID (char &AID) const
 
template<typename AnalysisType >
AnalysisType & getAnalysis () const
 
template<typename AnalysisType >
AnalysisType & getAnalysis (Function &F)
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI) const
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI, Function &F)
 

Public Attributes

DominatorTreeBase
< MachineBasicBlock > * 
DT
 

Static Public Attributes

static char ID = 0
 

Additional Inherited Members

- Static Public Member Functions inherited from llvm::Pass
static const PassInfolookupPassInfo (const void *TI)
 
static const PassInfolookupPassInfo (StringRef Arg)
 
static PasscreatePass (AnalysisID ID)
 
- Protected Member Functions inherited from llvm::MachineFunctionPass
 MachineFunctionPass (char &ID)
 

Detailed Description

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

Definition at line 40 of file MachineDominators.h.

Constructor & Destructor Documentation

MachineDominatorTree::MachineDominatorTree ( )
MachineDominatorTree::~MachineDominatorTree ( )

Definition at line 49 of file MachineDominators.cpp.

References DT.

Member Function Documentation

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

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

References DT.

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

Definition at line 145 of file MachineDominators.h.

References DT.

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

Definition at line 71 of file MachineDominators.h.

References DT.

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

Definition at line 76 of file MachineDominators.h.

References DT.

bool llvm::MachineDominatorTree::dominates ( const MachineInstr A,
const MachineInstr B 
) const
inline
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 153 of file MachineDominators.h.

References DT.

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

References DT.

virtual void llvm::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.

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

Definition at line 49 of file MachineDominators.h.

References DT.

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

References DT.

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

Definition at line 61 of file MachineDominators.h.

References DT.

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

Definition at line 65 of file MachineDominators.h.

References DT.

Referenced by llvm::GraphTraits< MachineDominatorTree * >::getEntryNode().

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

References DT.

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

References DT.

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

Definition at line 118 of file MachineDominators.h.

References DT.

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

References DT.

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

Definition at line 101 of file MachineDominators.h.

References DT.

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

Definition at line 106 of file MachineDominators.h.

References DT.

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 53 of file MachineDominators.cpp.

References DT.

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 37 of file MachineDominators.cpp.

References DT.

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

References DT.

Member Data Documentation

DominatorTreeBase<MachineBasicBlock>* llvm::MachineDominatorTree::DT
char MachineDominatorTree::ID = 0
static

Definition at line 42 of file MachineDominators.h.


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