LLVM  6.0.0svn
Public Member Functions | Protected Member Functions | List of all members
llvm::RegionPass Class Referenceabstract

A pass that runs on each Region in a function. More...

#include "llvm/Analysis/RegionPass.h"

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

Public Member Functions

 RegionPass (char &pid)
 
To be implemented by every RegionPass
virtual bool runOnRegion (Region *R, RGPassManager &RGM)=0
 Run the pass on a specific Region. More...
 
PasscreatePrinterPass (raw_ostream &O, const std::string &Banner) const override
 Get a pass to print the LLVM IR in the region. More...
 
virtual bool doInitialization (Region *R, RGPassManager &RGM)
 
virtual bool doFinalization ()
 
PassManager API
void preparePassManager (PMStack &PMS) override
 Check if available pass managers are suitable for this pass or not. More...
 
void assignPassManager (PMStack &PMS, PassManagerType PMT=PMT_RegionPassManager) override
 Assign pass manager to manage this pass. 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 StringRef 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...
 
virtual void print (raw_ostream &O, const Module *M) const
 print - Print out the internal state of the pass. More...
 
void dump () const
 
void setResolver (AnalysisResolver *AR)
 
AnalysisResolvergetResolver () const
 
virtual void getAnalysisUsage (AnalysisUsage &) const
 getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job. More...
 
virtual void releaseMemory ()
 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...
 
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)
 

Protected Member Functions

bool skipRegion (Region &R) const
 Optional passes call this function to check whether the pass should be skipped. More...
 

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)
 

Detailed Description

A pass that runs on each Region in a function.

RegionPass is managed by RGPassManager.

Definition at line 34 of file RegionPass.h.

Constructor & Destructor Documentation

◆ RegionPass()

llvm::RegionPass::RegionPass ( char pid)
inlineexplicit

Member Function Documentation

◆ assignPassManager()

void RegionPass::assignPassManager ( PMStack PMS,
PassManagerType  PMT = PMT_RegionPassManager 
)
overridevirtual

◆ createPrinterPass()

Pass * RegionPass::createPrinterPass ( raw_ostream O,
const std::string &  Banner 
) const
overridevirtual

Get a pass to print the LLVM IR in the region.

Get the printer pass.

Parameters
OThe output stream to print the Region.
BannerThe banner to separate different printed passes.
Returns
The pass to print the LLVM IR in the region.

Implements llvm::Pass.

Definition at line 280 of file RegionPass.cpp.

Referenced by RegionPass().

◆ doFinalization()

virtual bool llvm::RegionPass::doFinalization ( )
inlinevirtual

◆ doInitialization()

virtual bool llvm::RegionPass::doInitialization ( Region R,
RGPassManager RGM 
)
inlinevirtual

Definition at line 64 of file RegionPass.h.

Referenced by llvm::RGPassManager::runOnFunction().

◆ getPotentialPassManagerType()

PassManagerType llvm::RegionPass::getPotentialPassManagerType ( ) const
inlineoverridevirtual

Return what kind of Pass Manager can manage this pass.

Reimplemented from llvm::Pass.

Definition at line 77 of file RegionPass.h.

References llvm::PMT_RegionPassManager, and skipRegion().

◆ preparePassManager()

void RegionPass::preparePassManager ( PMStack )
overridevirtual

Check if available pass managers are suitable for this pass or not.

Reimplemented from llvm::Pass.

Definition at line 226 of file RegionPass.cpp.

References llvm::PMStack::empty(), llvm::PMDataManager::getPassManagerType(), llvm::PMT_RegionPassManager, llvm::PMStack::pop(), llvm::PMDataManager::preserveHigherLevelAnalysis(), and llvm::PMStack::top().

Referenced by doFinalization().

◆ runOnRegion()

virtual bool llvm::RegionPass::runOnRegion ( Region R,
RGPassManager RGM 
)
pure virtual

Run the pass on a specific Region.

Accessing regions not contained in the current region is not allowed.

Parameters
RThe region this pass is run on.
RGMThe RegionPassManager that manages this Pass.
Returns
True if the pass modifies this Region.

Referenced by RegionPass(), and llvm::RGPassManager::runOnFunction().

◆ skipRegion()

bool RegionPass::skipRegion ( Region R) const
protected

Optional passes call this function to check whether the pass should be skipped.

This is the case when optimization bisect is over the limit.

Definition at line 285 of file RegionPass.cpp.

References llvm::dbgs(), DEBUG, F, llvm::Function::getContext(), llvm::RegionBase< Tr >::getEntry(), llvm::Function::getEntryBlock(), llvm::Value::getName(), llvm::LLVMContext::getOptBisect(), llvm::RGPassManager::getPassName(), llvm::Function::hasFnAttribute(), and llvm::OptBisect::shouldRunPass().

Referenced by getPotentialPassManagerType().


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