LLVM  3.7.0
Public Types | Public Member Functions | Static Public Attributes | List of all members
llvm::DominanceFrontier Class Reference

#include <DominanceFrontier.h>

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

Public Types

typedef DominatorTreeBase
< BasicBlock
DomTreeT
 
typedef DomTreeNodeBase
< BasicBlock
DomTreeNodeT
 
typedef DominanceFrontierBase
< BasicBlock >::DomSetType 
DomSetType
 
typedef DominanceFrontierBase
< BasicBlock >::iterator 
iterator
 
typedef DominanceFrontierBase
< BasicBlock >::const_iterator 
const_iterator
 

Public Member Functions

 DominanceFrontier ()
 
ForwardDominanceFrontierBase
< BasicBlock > & 
getBase ()
 
const std::vector< BasicBlock * > & getRoots () const
 
BasicBlockgetRoot () const
 
bool isPostDominator () const
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
iterator find (BasicBlock *B)
 
const_iterator find (BasicBlock *B) const
 
iterator addBasicBlock (BasicBlock *BB, const DomSetType &frontier)
 
void removeBlock (BasicBlock *BB)
 
void addToFrontier (iterator I, BasicBlock *Node)
 
void removeFromFrontier (iterator I, BasicBlock *Node)
 
bool compareDomSet (DomSetType &DS1, const DomSetType &DS2) const
 
bool compare (DominanceFrontierBase< BasicBlock > &Other) const
 
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. More...
 
bool runOnFunction (Function &) override
 runOnFunction - Virtual method overriden by subclasses to do the per-function processing of the pass. More...
 
void getAnalysisUsage (AnalysisUsage &AU) const override
 getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job. More...
 
void print (raw_ostream &OS, const Module *=nullptr) const override
 print - Print out the internal state of the pass. More...
 
void dump () const
 
- Public Member Functions inherited from llvm::FunctionPass
 FunctionPass (char &pid)
 
PasscreatePrinterPass (raw_ostream &O, const std::string &Banner) const override
 createPrinterPass - Get a function printer pass. More...
 
void assignPassManager (PMStack &PMS, PassManagerType T) override
 Find appropriate Function Pass Manager or Call Graph Pass Manager in the PM Stack and add self into that manager. More...
 
PassManagerType getPotentialPassManagerType () const override
 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
 getPassName - Return a nice clean name for a pass. More...
 
AnalysisID getPassID () const
 getPassID - Return the PassID number that corresponds to this pass. More...
 
virtual bool doInitialization (Module &)
 doInitialization - Virtual method overridden by subclasses to do any necessary initialization before any pass is run. More...
 
virtual bool doFinalization (Module &)
 doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes have run. More...
 
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)
 getAdjustedAnalysisPointer - This method is used when a pass implements an analysis interface through multiple inheritance. More...
 
virtual ImmutablePassgetAsImmutablePass ()
 
virtual PMDataManagergetAsPMDataManager ()
 
virtual void verifyAnalysis () const
 verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information. More...
 
virtual void dumpPassStructure (unsigned Offset=0)
 
template<typename AnalysisType >
AnalysisType * getAnalysisIfAvailable () const
 getAnalysisIfAvailable<AnalysisType>() - Subclasses use this function to get analysis information that might be around, for example to update it. More...
 
bool mustPreserveAnalysisID (char &AID) const
 mustPreserveAnalysisID - This method serves the same function as getAnalysisIfAvailable, but works if you just have an AnalysisID. More...
 
template<typename AnalysisType >
AnalysisType & getAnalysis () const
 getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function. More...
 
template<typename AnalysisType >
AnalysisType & getAnalysis (Function &F)
 getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function. More...
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI) const
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI, Function &F)
 

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::FunctionPass
bool skipOptnoneFunction (const Function &F) const
 skipOptnoneFunction - This function has Attribute::OptimizeNone and most transformation passes should skip it. More...
 

Detailed Description

Definition at line 136 of file DominanceFrontier.h.

Member Typedef Documentation

Definition at line 144 of file DominanceFrontier.h.

Definition at line 142 of file DominanceFrontier.h.

Definition at line 141 of file DominanceFrontier.h.

Definition at line 140 of file DominanceFrontier.h.

Definition at line 143 of file DominanceFrontier.h.

Constructor & Destructor Documentation

Dominance Frontier true DominanceFrontier::DominanceFrontier ( )

Member Function Documentation

iterator llvm::DominanceFrontier::addBasicBlock ( BasicBlock BB,
const DomSetType frontier 
)
inline

Definition at line 172 of file DominanceFrontier.h.

void llvm::DominanceFrontier::addToFrontier ( iterator  I,
BasicBlock Node 
)
inline

Definition at line 178 of file DominanceFrontier.h.

iterator llvm::DominanceFrontier::begin ( )
inline

Definition at line 160 of file DominanceFrontier.h.

const_iterator llvm::DominanceFrontier::begin ( ) const
inline

Definition at line 162 of file DominanceFrontier.h.

bool llvm::DominanceFrontier::compare ( DominanceFrontierBase< BasicBlock > &  Other) const
inline

Definition at line 190 of file DominanceFrontier.h.

bool llvm::DominanceFrontier::compareDomSet ( DomSetType DS1,
const DomSetType DS2 
) const
inline

Definition at line 186 of file DominanceFrontier.h.

void DominanceFrontier::dump ( ) const

Definition at line 54 of file DominanceFrontier.cpp.

References llvm::dbgs(), and print().

iterator llvm::DominanceFrontier::end ( )
inline

Definition at line 164 of file DominanceFrontier.h.

const_iterator llvm::DominanceFrontier::end ( ) const
inline

Definition at line 166 of file DominanceFrontier.h.

iterator llvm::DominanceFrontier::find ( BasicBlock B)
inline

Definition at line 168 of file DominanceFrontier.h.

const_iterator llvm::DominanceFrontier::find ( BasicBlock B) const
inline

Definition at line 170 of file DominanceFrontier.h.

void DominanceFrontier::getAnalysisUsage ( AnalysisUsage ) const
overridevirtual

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 44 of file DominanceFrontier.cpp.

References llvm::AnalysisUsage::addRequired(), and llvm::AnalysisUsage::setPreservesAll().

ForwardDominanceFrontierBase<BasicBlock>& llvm::DominanceFrontier::getBase ( )
inline

Definition at line 150 of file DominanceFrontier.h.

BasicBlock* llvm::DominanceFrontier::getRoot ( ) const
inline

Definition at line 156 of file DominanceFrontier.h.

const std::vector<BasicBlock *>& llvm::DominanceFrontier::getRoots ( ) const
inline

Definition at line 152 of file DominanceFrontier.h.

bool llvm::DominanceFrontier::isPostDominator ( ) const
inline

Definition at line 158 of file DominanceFrontier.h.

void DominanceFrontier::print ( raw_ostream O,
const Module M = nullptr 
) const
overridevirtual

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 49 of file DominanceFrontier.cpp.

Referenced by dump().

void DominanceFrontier::releaseMemory ( )
overridevirtual

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 34 of file DominanceFrontier.cpp.

Referenced by runOnFunction().

void llvm::DominanceFrontier::removeBlock ( BasicBlock BB)
inline

Definition at line 176 of file DominanceFrontier.h.

void llvm::DominanceFrontier::removeFromFrontier ( iterator  I,
BasicBlock Node 
)
inline

Definition at line 182 of file DominanceFrontier.h.

bool DominanceFrontier::runOnFunction ( Function F)
overridevirtual

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

Implements llvm::FunctionPass.

Definition at line 38 of file DominanceFrontier.cpp.

References releaseMemory().

Member Data Documentation

char DominanceFrontier::ID = 0
static

Definition at line 146 of file DominanceFrontier.h.


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