PMDataManager provides the common place to manage the analysis data used by pass managers. More...

#include "llvm/IR/LegacyPassManagers.h"

Inheritance diagram for llvm::PMDataManager:

[legend]

Collaboration diagram for llvm::PMDataManager:

[legend]

Public Member Functions
	PMDataManager ()

virtual	~PMDataManager ()

virtual Pass *	getAsPass ()=0

void	recordAvailableAnalysis (Pass *P)
	Augment AvailableAnalysis by adding analysis made available by pass P. More...

void	verifyPreservedAnalysis (Pass *P)
	verifyPreservedAnalysis – Verify analysis presreved by pass P. More...

void	removeNotPreservedAnalysis (Pass *P)
	Remove Analysis that is not preserved by the pass. More...

void	removeDeadPasses (Pass *P, StringRef Msg, enum PassDebuggingString)
	Remove dead passes used by P. More...

void	freePass (Pass *P, StringRef Msg, enum PassDebuggingString)
	Remove P. More...

void	add (Pass *P, bool ProcessAnalysis=true)
	Add pass P into the PassVector. More...

virtual void	addLowerLevelRequiredPass (Pass P, Pass RequiredPass)
	Add RequiredPass into list of lower level passes required by pass P. More...

virtual Pass *	getOnTheFlyPass (Pass *P, AnalysisID PI, Function &F)

void	initializeAnalysisInfo ()
	Initialize available analysis information. More...

bool	preserveHigherLevelAnalysis (Pass *P)

void	collectRequiredAndUsedAnalyses (SmallVectorImpl< Pass > &UsedPasses, SmallVectorImpl< AnalysisID > &ReqPassNotAvailable, Pass P)
	Populate UsedPasses with analysis pass that are used or required by pass P and are available. More...

void	initializeAnalysisImpl (Pass *P)
	All Required analyses should be available to the pass as it runs! Here we fill in the AnalysisImpls member of the pass so that it can successfully use the getAnalysis() method to retrieve the implementations it needs. More...

Pass *	findAnalysisPass (AnalysisID AID, bool Direction)
	Find the pass that implements Analysis AID. More...

PMTopLevelManager *	getTopLevelManager ()

void	setTopLevelManager (PMTopLevelManager *T)

unsigned	getDepth () const

void	setDepth (unsigned newDepth)

void	dumpLastUses (Pass *P, unsigned Offset) const

void	dumpPassArguments () const

void	dumpPassInfo (Pass *P, enum PassDebuggingString S1, enum PassDebuggingString S2, StringRef Msg)

void	dumpRequiredSet (const Pass *P) const

void	dumpPreservedSet (const Pass *P) const

void	dumpUsedSet (const Pass *P) const

unsigned	getNumContainedPasses () const

virtual PassManagerType	getPassManagerType () const

DenseMap< AnalysisID, Pass * > *	getAvailableAnalysis ()

void	populateInheritedAnalysis (PMStack &PMS)

unsigned	initSizeRemarkInfo (Module &M, StringMap< std::pair< unsigned, unsigned >> &FunctionToInstrCount)
	Set the initial size of the module if the user has specified that they want remarks for size. More...

void	emitInstrCountChangedRemark (Pass P, Module &M, int64_t Delta, unsigned CountBefore, StringMap< std::pair< unsigned, unsigned >> &FunctionToInstrCount, Function F=nullptr)
	Emit a remark signifying that the number of IR instructions in the module changed. More...

Protected Member Functions
bool	isPassDebuggingExecutionsOrMore () const
	isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions or higher is specified. More...

Protected Attributes
PMTopLevelManager *	TPM

SmallVector< Pass *, 16 >	PassVector

DenseMap< AnalysisID, Pass * > *	InheritedAnalysis [PMT_Last]

Detailed Description

PMDataManager provides the common place to manage the analysis data used by pass managers.

Definition at line 303 of file LegacyPassManagers.h.

Constructor & Destructor Documentation

◆ PMDataManager()

llvm::PMDataManager::PMDataManager ( )

inlineexplicit

Definition at line 305 of file LegacyPassManagers.h.

References llvm::ARM_AM::add, F(), and P.

◆ ~PMDataManager()

PMDataManager::~PMDataManager ( )

virtual

Definition at line 1353 of file LegacyPassManager.cpp.

References P.

Member Function Documentation

◆ add()

void PMDataManager::add	(	Pass *	P,
		bool	ProcessAnalysis = `true`
	)

Add pass P into the PassVector.

Update AvailableAnalysis appropriately if ProcessAnalysis is true.

Definition at line 1068 of file LegacyPassManager.cpp.

References assert(), llvm::SmallVectorImpl< T >::clear(), llvm::PassInfo::createPass(), llvm::SmallVectorBase::empty(), llvm::Pass::getAsPMDataManager(), llvm_unreachable, llvm::SmallVectorTemplateBase< T >::push_back(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), and llvm::Pass::setResolver().

Referenced by llvm::LoopPass::assignPassManager(), llvm::RegionPass::assignPassManager(), llvm::ModulePass::assignPassManager(), and llvm::FunctionPass::assignPassManager().

◆ addLowerLevelRequiredPass()

void PMDataManager::addLowerLevelRequiredPass	(	Pass *	P,
		Pass *	RequiredPass
	)

virtual

Add RequiredPass into list of lower level passes required by pass P.

RequiredPass is run on the fly by Pass Manager when P requests it through getAnalysis interface.

RequiredPass is run on the fly by Pass Manager when P requests it through getAnalysis interface. This should be handled by specific pass manager.

Definition at line 1326 of file LegacyPassManager.cpp.

References llvm::dbgs(), llvm::Pass::getPassName(), and llvm_unreachable.

◆ collectRequiredAndUsedAnalyses()

void PMDataManager::collectRequiredAndUsedAnalyses	(	SmallVectorImpl< Pass *> &	UP,
		SmallVectorImpl< AnalysisID > &	RP_NotAvail,
		Pass *	P
	)

Populate UsedPasses with analysis pass that are used or required by pass P and are available.

Populate UP with analysis pass that are used or required by pass P and are available.

Populate ReqPassNotAvailable with analysis pass that are required by pass P but are not available.

Populate RP_NotAvail with analysis pass that are required by pass P but are not available.

Definition at line 1143 of file LegacyPassManager.cpp.

References llvm::AnalysisUsage::getRequiredSet(), llvm::AnalysisUsage::getRequiredTransitiveSet(), llvm::AnalysisUsage::getUsedSet(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), and llvm::SmallVectorTemplateBase< T >::push_back().

◆ dumpLastUses()

void PMDataManager::dumpLastUses	(	Pass *	P,
		unsigned	Offset
	)		const

Definition at line 1203 of file LegacyPassManager.cpp.

References llvm::dbgs(), and llvm::Pass::dumpPassStructure().

Referenced by llvm::RGPassManager::dumpPassStructure(), and llvm::LPPassManager::dumpPassStructure().

◆ dumpPassArguments()

void PMDataManager::dumpPassArguments ( ) const

Definition at line 1219 of file LegacyPassManager.cpp.

References llvm::dbgs(), and P.

◆ dumpPassInfo()

void PMDataManager::dumpPassInfo	(	Pass *	P,
		enum PassDebuggingString	S1,
		enum PassDebuggingString	S2,
		StringRef	Msg
	)

Definition at line 1231 of file LegacyPassManager.cpp.

References llvm::dbgs(), llvm::EXECUTION_MSG, llvm::FREEING_MSG, llvm::Pass::getPassName(), llvm::MODIFICATION_MSG, now(), llvm::ON_BASICBLOCK_MSG, llvm::ON_CG_MSG, llvm::ON_FUNCTION_MSG, llvm::ON_LOOP_MSG, llvm::ON_MODULE_MSG, and llvm::ON_REGION_MSG.

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

◆ dumpPreservedSet()

void PMDataManager::dumpPreservedSet ( const Pass * P ) const

Definition at line 1284 of file LegacyPassManager.cpp.

References llvm::Pass::getAnalysisUsage(), and llvm::AnalysisUsage::getPreservedSet().

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

◆ dumpRequiredSet()

void PMDataManager::dumpRequiredSet ( const Pass * P ) const

Definition at line 1275 of file LegacyPassManager.cpp.

References llvm::Pass::getAnalysisUsage(), and llvm::AnalysisUsage::getRequiredSet().

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

◆ dumpUsedSet()

void PMDataManager::dumpUsedSet ( const Pass * P ) const

Definition at line 1293 of file LegacyPassManager.cpp.

References assert(), llvm::dbgs(), llvm::SmallVectorBase::empty(), llvm::Pass::getAnalysisUsage(), llvm::PassInfo::getPassName(), llvm::AnalysisUsage::getUsedSet(), P, and llvm::SmallVectorBase::size().

◆ emitInstrCountChangedRemark()

void PMDataManager::emitInstrCountChangedRemark	(	Pass *	P,
		Module &	M,
		int64_t	Delta,
		unsigned	CountBefore,
		StringMap< std::pair< unsigned, unsigned >> &	FunctionToInstrCount,
		Function *	F = `nullptr`
	)

Emit a remark signifying that the number of IR instructions in the module changed.

F is optionally passed by passes which run on Functions, and thus always know whether or not a non-empty function is available.

FunctionToInstrCount maps the name of a Function to a pair. The first member of the pair is the IR count of the Function before running P, and the second member is the IR count of the Function after running P.

Definition at line 165 of file LegacyPassManager.cpp.

References llvm::Module::begin(), llvm::Function::begin(), llvm::LLVMContext::diagnose(), llvm::Module::end(), F(), llvm::find_if(), llvm::for_each(), llvm::Pass::getAsPMDataManager(), llvm::Function::getContext(), llvm::Pass::getPassName(), and llvm::StringRef::str().

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

◆ findAnalysisPass()

Pass * PMDataManager::findAnalysisPass	(	AnalysisID	AID,
		bool	SearchParent
	)

Find the pass that implements Analysis AID.

If desired pass is not found then return NULL.

Definition at line 1187 of file LegacyPassManager.cpp.

References I, and if().

◆ freePass()

void PMDataManager::freePass	(	Pass *	P,
		StringRef	Msg,
		enum PassDebuggingString	DBG_STR
	)

Remove P.

Definition at line 1037 of file LegacyPassManager.cpp.

References llvm::FREEING_MSG, llvm::Pass::getPassID(), llvm::getPassTimer(), P, llvm::Pass::releaseMemory(), and X.

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

◆ getAsPass()

virtual Pass* llvm::PMDataManager::getAsPass ( )

pure virtual

Implemented in llvm::legacy::PassManagerImpl, llvm::FPPassManager, llvm::legacy::FunctionPassManagerImpl, llvm::LPPassManager, and llvm::RGPassManager.

Referenced by llvm::PMTopLevelManager::setLastUser().

◆ getAvailableAnalysis()

DenseMap<AnalysisID, Pass*>* llvm::PMDataManager::getAvailableAnalysis ( )

inline

Definition at line 394 of file LegacyPassManagers.h.

◆ getDepth()

unsigned llvm::PMDataManager::getDepth ( ) const

inline

Definition at line 373 of file LegacyPassManagers.h.

References llvm::Depth.

Referenced by llvm::PMStack::push(), and llvm::PMTopLevelManager::setLastUser().

◆ getNumContainedPasses()

unsigned llvm::PMDataManager::getNumContainedPasses ( ) const

inline

Definition at line 385 of file LegacyPassManagers.h.

Referenced by llvm::LPPassManager::cloneBasicBlockSimpleAnalysis(), llvm::LPPassManager::deleteSimpleAnalysisLoop(), llvm::LPPassManager::deleteSimpleAnalysisValue(), llvm::RGPassManager::dumpPassStructure(), llvm::LPPassManager::dumpPassStructure(), llvm::legacy::FunctionPassManagerImpl::releaseMemoryOnTheFly(), llvm::RGPassManager::runOnFunction(), and llvm::LPPassManager::runOnFunction().

◆ getOnTheFlyPass()

Pass * PMDataManager::getOnTheFlyPass	(	Pass *	P,
		AnalysisID	PI,
		Function &	F
	)

virtual

Definition at line 1348 of file LegacyPassManager.cpp.

References llvm_unreachable.

◆ getPassManagerType()

virtual PassManagerType llvm::PMDataManager::getPassManagerType ( ) const

inlinevirtual

Reimplemented in llvm::FPPassManager, llvm::LPPassManager, and llvm::RGPassManager.

Definition at line 389 of file LegacyPassManagers.h.

References assert(), and llvm::PMT_Unknown.

Referenced by llvm::LoopPass::assignPassManager(), llvm::CallGraphSCCPass::assignPassManager(), llvm::RegionPass::assignPassManager(), llvm::ModulePass::assignPassManager(), llvm::FunctionPass::assignPassManager(), llvm::BasicBlockPass::assignPassManager(), llvm::LoopPass::preparePassManager(), llvm::RegionPass::preparePassManager(), and llvm::PMStack::push().

◆ getTopLevelManager()

PMTopLevelManager* llvm::PMDataManager::getTopLevelManager ( )

inline

Definition at line 370 of file LegacyPassManagers.h.

◆ initializeAnalysisImpl()

void PMDataManager::initializeAnalysisImpl ( Pass * P )

All Required analyses should be available to the pass as it runs! Here we fill in the AnalysisImpls member of the pass so that it can successfully use the getAnalysis() method to retrieve the implementations it needs.

Definition at line 1170 of file LegacyPassManager.cpp.

References llvm::AnalysisResolver::addAnalysisImplsPair(), assert(), llvm::AnalysisUsage::getRequiredSet(), and llvm::Pass::getResolver().

Referenced by llvm::RGPassManager::runOnFunction(), llvm::LPPassManager::runOnFunction(), and llvm::PMTopLevelManager::schedulePass().