ImmutableAnalysis abstraction for fetching the Eviction Advisor. More...

#include "llvm/CodeGen/RegAllocEvictionAdvisor.h"

Inheritance diagram for llvm::RegAllocEvictionAdvisorAnalysisLegacy:

Public Types
enum class	AdvisorMode : int { Default , Release , Development }

Public Member Functions
	RegAllocEvictionAdvisorAnalysisLegacy (AdvisorMode Mode)
RegAllocEvictionAdvisorProvider &	getProvider ()
	Get an advisor for the given context (i.e. machine function, etc)
AdvisorMode	getAdvisorMode () const
virtual void	logRewardIfNeeded (const MachineFunction &MF, function_ref< float()> GetReward)
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.
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
StringRef	getPassArgument () const
	Return a nice clean name for a pass corresponding to that used to enable the pass in opt.
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 void	preparePassManager (PMStack &)
	Check if available pass managers are suitable for this pass or not.
void	setResolver (AnalysisResolver *AR)
AnalysisResolver *	getResolver () const
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 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

Protected Member Functions
void	getAnalysisUsage (AnalysisUsage &AU) const override
	getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job.
Protected Member Functions inherited from llvm::ModulePass
bool	skipModule (const Module &M) const
	Optional passes call this function to check whether the pass should be skipped.

Protected Attributes
std::unique_ptr< RegAllocEvictionAdvisorProvider >	Provider

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)

Detailed Description

ImmutableAnalysis abstraction for fetching the Eviction Advisor.

We model it as an analysis to decouple the user from the implementation insofar as dependencies on other analyses goes. The motivation for it being an immutable pass is twofold:

in the ML implementation case, the evaluator is stateless but (especially in the development mode) expensive to set up. With an immutable pass, we set it up once.
in the 'development' mode ML case, we want to capture the training log during allocation (this is a log of features encountered and decisions made), and then measure a score, potentially a few steps after allocation completes. So we need the properties of an immutable pass to keep the logger state around until we can make that measurement.

Because we need to offer additional services in 'development' mode, the implementations of this analysis need to implement RTTI support.

Definition at line 199 of file RegAllocEvictionAdvisor.h.

Member Enumeration Documentation

◆ AdvisorMode

enum class llvm::RegAllocEvictionAdvisorAnalysisLegacy::AdvisorMode : int

strong

Enumerator
Default
Release
Development

Definition at line 201 of file RegAllocEvictionAdvisor.h.

Constructor & Destructor Documentation

◆ RegAllocEvictionAdvisorAnalysisLegacy()

llvm::RegAllocEvictionAdvisorAnalysisLegacy::RegAllocEvictionAdvisorAnalysisLegacy ( AdvisorMode Mode )

inline

Definition at line 203 of file RegAllocEvictionAdvisor.h.

References ID, and llvm::ImmutablePass::ImmutablePass().

Referenced by INITIALIZE_PASS(), and INITIALIZE_PASS().

Member Function Documentation

◆ getAdvisorMode()

AdvisorMode llvm::RegAllocEvictionAdvisorAnalysisLegacy::getAdvisorMode ( ) const

inline

Definition at line 210 of file RegAllocEvictionAdvisor.h.

◆ getAnalysisUsage()

void llvm::RegAllocEvictionAdvisorAnalysisLegacy::getAnalysisUsage ( AnalysisUsage & ) const

inlineoverrideprotectedvirtual

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 217 of file RegAllocEvictionAdvisor.h.

References llvm::AnalysisUsage::setPreservesAll().

Referenced by INITIALIZE_PASS().

◆ getProvider()

RegAllocEvictionAdvisorProvider & llvm::RegAllocEvictionAdvisorAnalysisLegacy::getProvider ( )

inline

Get an advisor for the given context (i.e. machine function, etc)

Definition at line 208 of file RegAllocEvictionAdvisor.h.

References Provider.

◆ logRewardIfNeeded()

virtual void llvm::RegAllocEvictionAdvisorAnalysisLegacy::logRewardIfNeeded	(	const MachineFunction &	MF,
		function_ref< float()>	GetReward )

inlinevirtual

Definition at line 211 of file RegAllocEvictionAdvisor.h.

Referenced by INITIALIZE_PASS().

Member Data Documentation

◆ ID

char RegAllocEvictionAdvisorAnalysisLegacy::ID = 0

static

Definition at line 205 of file RegAllocEvictionAdvisor.h.

Referenced by RegAllocEvictionAdvisorAnalysisLegacy().

◆ Provider

std::unique_ptr<RegAllocEvictionAdvisorProvider> llvm::RegAllocEvictionAdvisorAnalysisLegacy::Provider

protected

Definition at line 220 of file RegAllocEvictionAdvisor.h.

Referenced by getProvider().

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

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AdvisorMode

Constructor & Destructor Documentation

◆ RegAllocEvictionAdvisorAnalysisLegacy()

Member Function Documentation

◆ getAdvisorMode()

◆ getAnalysisUsage()

◆ getProvider()

◆ logRewardIfNeeded()

Member Data Documentation

◆ ID

◆ Provider