An analysis pass which caches information about the entire Module. More...

#include "llvm/CodeGen/GCMetadata.h"

Inheritance diagram for llvm::GCModuleInfo:

[legend]

Public Types
using	FuncInfoVec = std::vector< std::unique_ptr< GCFunctionInfo > >
	List of per function info objects.

using	iterator = SmallVector< std::unique_ptr< GCStrategy >, 1 >::const_iterator

Public Member Functions
GCStrategy *	getGCStrategy (const StringRef Name)
	Lookup the GCStrategy object associated with the given gc name.

FuncInfoVec::iterator	funcinfo_begin ()

FuncInfoVec::iterator	funcinfo_end ()

	GCModuleInfo ()

void	clear ()
	clear - Resets the pass.

iterator	begin () const
	begin/end - Iterators for used strategies.

iterator	end () const

GCFunctionInfo &	getFunctionInfo (const Function &F)
	get - Look up function metadata.

Public Member Functions inherited from llvm::ImmutablePass
	ImmutablePass (char &pid)

	~ImmutablePass () override

virtual void	initializePass ()
	initializePass - This method may be overriden by immutable passes to allow them to perform various initialization actions they require.

ImmutablePass *	getAsImmutablePass () override

bool	runOnModule (Module &) override
	ImmutablePasses are never run.

Public Member Functions inherited from llvm::ModulePass
	ModulePass (char &pid)

	~ModulePass () override

Pass *	createPrinterPass (raw_ostream &OS, const std::string &Banner) const override
	createPrinterPass - Get a module printer pass.

virtual bool	runOnModule (Module &M)=0
	runOnModule - Virtual method overriden by subclasses to process the module being operated on.

void	assignPassManager (PMStack &PMS, PassManagerType T) override
	Find appropriate Module Pass Manager in the PM Stack and add self into that manager.

PassManagerType	getPotentialPassManagerType () const override
	Return what kind of Pass Manager can manage this pass.

Public Member Functions inherited from llvm::Pass
	Pass (PassKind K, char &pid)

	Pass (const Pass &)=delete

Pass &	operator= (const Pass &)=delete

virtual	~Pass ()

PassKind	getPassKind () const

virtual StringRef	getPassName () const
	getPassName - Return a nice clean name for a pass.

AnalysisID	getPassID () const
	getPassID - Return the PassID number that corresponds to this pass.

virtual bool	doInitialization (Module &)
	doInitialization - Virtual method overridden by subclasses to do any necessary initialization before any pass is run.

virtual bool	doFinalization (Module &)
	doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes have run.

virtual void	print (raw_ostream &OS, const Module *M) const
	print - Print out the internal state of the pass.

void	dump () const

virtual Pass *	createPrinterPass (raw_ostream &OS, const std::string &Banner) const =0
	createPrinterPass - Get a Pass appropriate to print the IR this pass operates on (Module, Function or MachineFunction).

virtual void	assignPassManager (PMStack &, PassManagerType)
	Each pass is responsible for assigning a pass manager to itself.

virtual void	preparePassManager (PMStack &)
	Check if available pass managers are suitable for this pass or not.

virtual PassManagerType	getPotentialPassManagerType () const
	Return what kind of Pass Manager can manage this pass.

void	setResolver (AnalysisResolver *AR)

AnalysisResolver *	getResolver () const

virtual void	getAnalysisUsage (AnalysisUsage &) const
	getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job.

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.

virtual void *	getAdjustedAnalysisPointer (AnalysisID ID)
	getAdjustedAnalysisPointer - This method is used when a pass implements an analysis interface through multiple inheritance.

virtual ImmutablePass *	getAsImmutablePass ()

virtual PMDataManager *	getAsPMDataManager ()

virtual void	verifyAnalysis () const
	verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information.

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.

bool	mustPreserveAnalysisID (char &AID) const
	mustPreserveAnalysisID - This method serves the same function as getAnalysisIfAvailable, but works if you just have an AnalysisID.

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.

template<typename AnalysisType >
AnalysisType &	getAnalysis (Function &F, bool *Changed=nullptr)
	getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function.

template<typename AnalysisType >
AnalysisType &	getAnalysisID (AnalysisID PI) const

template<typename AnalysisType >
AnalysisType &	getAnalysisID (AnalysisID PI, Function &F, bool *Changed=nullptr)

Static Public Attributes
static char	ID = 0

Additional Inherited Members
Static Public Member Functions inherited from llvm::Pass
static const PassInfo *	lookupPassInfo (const void *TI)

static const PassInfo *	lookupPassInfo (StringRef Arg)

static Pass *	createPass (AnalysisID ID)

Protected Member Functions inherited from llvm::ModulePass
bool	skipModule (Module &M) const
	Optional passes call this function to check whether the pass should be skipped.

Detailed Description

An analysis pass which caches information about the entire Module.

Records both the function level information used by GCRoots and a cache of the 'active' gc strategy objects for the current Module.

Definition at line 203 of file GCMetadata.h.

Member Typedef Documentation

◆ FuncInfoVec

using llvm::GCModuleInfo::FuncInfoVec = std::vector<std::unique_ptr<GCFunctionInfo> >

List of per function info objects.

In theory, Each of these may be associated with a different GC.

Definition at line 217 of file GCMetadata.h.

◆ iterator

using llvm::GCModuleInfo::iterator = SmallVector<std::unique_ptr<GCStrategy>, 1>::const_iterator

Definition at line 232 of file GCMetadata.h.

Constructor & Destructor Documentation

◆ GCModuleInfo()

GCModuleInfo::GCModuleInfo ( )

Definition at line 88 of file GCMetadata.cpp.

References llvm::PassRegistry::getPassRegistry(), and llvm::initializeGCModuleInfoPass().

Member Function Documentation

◆ begin()

iterator llvm::GCModuleInfo::begin ( ) const

inline

begin/end - Iterators for used strategies.

Definition at line 245 of file GCMetadata.h.

References llvm::SmallVectorTemplateCommon< T, typename >::begin().

◆ clear()

void GCModuleInfo::clear ( )

clear - Resets the pass.

Any pass, which uses GCModuleInfo, should call it in doFinalization().

Definition at line 107 of file GCMetadata.cpp.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::clear().

◆ end()

iterator llvm::GCModuleInfo::end ( ) const

inline

Definition at line 246 of file GCMetadata.h.

References llvm::SmallVectorTemplateCommon< T, typename >::end().

◆ funcinfo_begin()

FuncInfoVec::iterator llvm::GCModuleInfo::funcinfo_begin ( )

inline

Definition at line 219 of file GCMetadata.h.

◆ funcinfo_end()

FuncInfoVec::iterator llvm::GCModuleInfo::funcinfo_end ( )

inline

Definition at line 220 of file GCMetadata.h.

◆ getFunctionInfo()

GCFunctionInfo & GCModuleInfo::getFunctionInfo ( const Function & F )

get - Look up function metadata.

This is currently assumed have the side effect of initializing the associated GCStrategy. That will soon change.

Definition at line 92 of file GCMetadata.cpp.

References assert(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::end(), F, llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::find(), getGCStrategy(), and I.

◆ getGCStrategy()

GCStrategy * GCModuleInfo::getGCStrategy ( const StringRef Name )

Lookup the GCStrategy object associated with the given gc name.

Objects are owned internally; No caller should attempt to delete the returned objects.

Definition at line 115 of file GCMetadata.cpp.

References llvm::getGCStrategy(), and Name.

Referenced by getFunctionInfo().

Member Data Documentation

◆ ID

char GCModuleInfo::ID = 0

static

Definition at line 234 of file GCMetadata.h.

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

include/llvm/CodeGen/GCMetadata.h
lib/CodeGen/GCMetadata.cpp

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ FuncInfoVec

◆ iterator

Constructor & Destructor Documentation

◆ GCModuleInfo()

Member Function Documentation

◆ begin()

◆ clear()

◆ end()

◆ funcinfo_begin()

◆ funcinfo_end()

◆ getFunctionInfo()

◆ getGCStrategy()

Member Data Documentation

◆ ID