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]

Public Member Functions
	PMDataManager ()

virtual	~PMDataManager ()

virtual Pass *	getAsPass ()=0

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

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

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

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

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

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

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

virtual std::tuple< Pass *, bool >	getOnTheFlyPass (Pass *P, AnalysisID PI, Function &F)

void	initializeAnalysisInfo ()
	Initialize available analysis information.

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.

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.

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

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.

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.

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

Protected Attributes
PMTopLevelManager *	TPM = nullptr

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 295 of file LegacyPassManagers.h.

Constructor & Destructor Documentation

◆ PMDataManager()

llvm::PMDataManager::PMDataManager ( )

inlineexplicit

Definition at line 297 of file LegacyPassManagers.h.

References initializeAnalysisInfo().

◆ ~PMDataManager()

PMDataManager::~PMDataManager ( )

virtual

Definition at line 1269 of file LegacyPassManager.cpp.

References P, and PassVector.

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 993 of file LegacyPassManager.cpp.

References addLowerLevelRequiredPass(), assert(), llvm::SmallVectorImpl< T >::clear(), collectRequiredAndUsedAnalyses(), llvm::PassInfo::createPass(), DM, llvm::SmallVectorBase< Size_T >::empty(), llvm::PMTopLevelManager::findAnalysisPassInfo(), getAsPass(), getDepth(), llvm_unreachable, P, PassVector, llvm::SmallVectorTemplateBase< T, bool >::push_back(), recordAvailableAnalysis(), removeNotPreservedAnalysis(), llvm::PMTopLevelManager::setLastUser(), and TPM.

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 1241 of file LegacyPassManager.cpp.

References llvm::dbgs(), llvm::PMTopLevelManager::dumpArguments(), llvm::PMTopLevelManager::dumpPasses(), llvm::Pass::getPassName(), llvm_unreachable, P, and TPM.

Referenced by add().

◆ 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 1068 of file LegacyPassManager.cpp.

References findAnalysisPass(), llvm::PMTopLevelManager::findAnalysisUsage(), llvm::AnalysisUsage::getRequiredSet(), llvm::AnalysisUsage::getUsedSet(), P, llvm::SmallVectorTemplateBase< T, bool >::push_back(), and TPM.

Referenced by add().

◆ dumpLastUses()

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

Definition at line 1122 of file LegacyPassManager.cpp.

References llvm::PMTopLevelManager::collectLastUses(), llvm::dbgs(), llvm::Offset, P, PassDebugging, and TPM.

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

◆ dumpPassArguments()

void PMDataManager::dumpPassArguments ( ) const

Definition at line 1140 of file LegacyPassManager.cpp.

References llvm::dbgs(), llvm::PMTopLevelManager::findAnalysisPassInfo(), P, PassVector, and TPM.

◆ dumpPassInfo()

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

Definition at line 1149 of file LegacyPassManager.cpp.

References llvm::dbgs(), llvm::EXECUTION_MSG, llvm::FREEING_MSG, getDepth(), llvm::MODIFICATION_MSG, llvm::ON_CG_MSG, llvm::ON_FUNCTION_MSG, llvm::ON_LOOP_MSG, llvm::ON_MODULE_MSG, llvm::ON_REGION_MSG, P, PassDebugging, and S1.

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

◆ dumpPreservedSet()

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

Definition at line 1199 of file LegacyPassManager.cpp.

References llvm::AnalysisUsage::getPreservedSet(), P, and PassDebugging.

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

◆ dumpRequiredSet()

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

Definition at line 1190 of file LegacyPassManager.cpp.

References llvm::AnalysisUsage::getRequiredSet(), P, and PassDebugging.

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

◆ dumpUsedSet()

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

Definition at line 1208 of file LegacyPassManager.cpp.

References llvm::AnalysisUsage::getUsedSet(), P, and PassDebugging.

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

◆ 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 88 of file LegacyPassManager.cpp.

References llvm::Function::empty(), F, llvm::find_if(), P, and PassName.

Referenced by llvm::FPPassManager::runOnFunction(), and 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 1106 of file LegacyPassManager.cpp.

References llvm::PMTopLevelManager::findAnalysisPass(), I, and TPM.

Referenced by collectRequiredAndUsedAnalyses(), llvm::AnalysisResolver::getAnalysisIfAvailable(), initializeAnalysisImpl(), and verifyPreservedAnalysis().

◆ freePass()

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

Remove P.

Definition at line 975 of file LegacyPassManager.cpp.

References dumpPassInfo(), llvm::FREEING_MSG, llvm::getPassTimer(), P, and X.

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

◆ getAsPass()

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

pure virtual

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

Referenced by add().

◆ getAvailableAnalysis()

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

inline

Definition at line 385 of file LegacyPassManagers.h.

◆ getDepth()

unsigned llvm::PMDataManager::getDepth ( ) const

inline

Definition at line 364 of file LegacyPassManagers.h.

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

◆ getNumContainedPasses()

unsigned llvm::PMDataManager::getNumContainedPasses ( ) const

inline

Definition at line 376 of file LegacyPassManagers.h.

References PassVector.

Referenced by llvm::FPPassManager::cleanup(), llvm::FPPassManager::doFinalization(), llvm::FPPassManager::doInitialization(), llvm::LPPassManager::dumpPassStructure(), llvm::RGPassManager::dumpPassStructure(), llvm::FPPassManager::dumpPassStructure(), llvm::legacy::FunctionPassManagerImpl::releaseMemoryOnTheFly(), llvm::FPPassManager::runOnFunction(), llvm::LPPassManager::runOnFunction(), and llvm::RGPassManager::runOnFunction().

◆ getOnTheFlyPass()

std::tuple< Pass *, bool > PMDataManager::getOnTheFlyPass	(	Pass *	P,
		AnalysisID	PI,
		Function &	F
	)

virtual

Definition at line 1263 of file LegacyPassManager.cpp.

References llvm_unreachable.

Referenced by llvm::AnalysisResolver::findImplPass().

◆ getPassManagerType()

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

inlinevirtual

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

Definition at line 380 of file LegacyPassManagers.h.

References assert(), and llvm::PMT_Unknown.

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

◆ getTopLevelManager()

PMTopLevelManager * llvm::PMDataManager::getTopLevelManager ( )

inline

Definition at line 361 of file LegacyPassManagers.h.

References TPM.

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

◆ 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 1089 of file LegacyPassManager.cpp.

References llvm::AnalysisResolver::addAnalysisImplsPair(), assert(), findAnalysisPass(), llvm::PMTopLevelManager::findAnalysisUsage(), llvm::AnalysisUsage::getRequiredSet(), P, and TPM.

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