LLVM 19.0.0git
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
llvm::MLInlineAdvisor Class Reference

#include "llvm/Analysis/MLInlineAdvisor.h"

Inheritance diagram for llvm::MLInlineAdvisor:
Inheritance graph
[legend]

Public Member Functions

 MLInlineAdvisor (Module &M, ModuleAnalysisManager &MAM, std::unique_ptr< MLModelRunner > ModelRunner, std::function< bool(CallBase &)> GetDefaultAdvice)
 
virtual ~MLInlineAdvisor ()=default
 
void onPassEntry (LazyCallGraph::SCC *SCC) override
 This must be called when the Inliner pass is entered, to allow the InlineAdvisor update internal state, as result of function passes run between Inliner pass runs (for the same module).
 
void onPassExit (LazyCallGraph::SCC *SCC) override
 This must be called when the Inliner pass is exited, as function passes may be run subsequently.
 
int64_t getIRSize (Function &F) const
 
void onSuccessfulInlining (const MLInlineAdvice &Advice, bool CalleeWasDeleted)
 
bool isForcedToStop () const
 
int64_t getLocalCalls (Function &F)
 
const MLModelRunner & getModelRunner () const
 
FunctionPropertiesInfo & getCachedFPI (Function &) const
 
- Public Member Functions inherited from llvm::InlineAdvisor
 InlineAdvisor (InlineAdvisor &&)=delete
 
virtual ~InlineAdvisor ()
 
std::unique_ptr< InlineAdvice > getAdvice (CallBase &CB, bool MandatoryOnly=false)
 Get an InlineAdvice containing a recommendation on whether to inline or not.
 
virtual void onPassEntry (LazyCallGraph::SCC *SCC=nullptr)
 This must be called when the Inliner pass is entered, to allow the InlineAdvisor update internal state, as result of function passes run between Inliner pass runs (for the same module).
 
virtual void onPassExit (LazyCallGraph::SCC *SCC=nullptr)
 This must be called when the Inliner pass is exited, as function passes may be run subsequently.
 
virtual void print (raw_ostream &OS) const
 Support for printer pass.
 
const char * getAnnotatedInlinePassName () const
 NOTE pass name is annotated only when inline advisor constructor provides InlineContext.
 

Protected Member Functions

std::unique_ptr< InlineAdvice > getAdviceImpl (CallBase &CB) override
 
std::unique_ptr< InlineAdvice > getMandatoryAdvice (CallBase &CB, bool Advice) override
 
virtual std::unique_ptr< MLInlineAdvice > getMandatoryAdviceImpl (CallBase &CB)
 
virtual std::unique_ptr< MLInlineAdvice > getAdviceFromModel (CallBase &CB, OptimizationRemarkEmitter &ORE)
 
unsigned getInitialFunctionLevel (const Function &F) const
 
- Protected Member Functions inherited from llvm::InlineAdvisor
 InlineAdvisor (Module &M, FunctionAnalysisManager &FAM, std::optional< InlineContext > IC=std::nullopt)
 
virtual std::unique_ptr< InlineAdvice > getAdviceImpl (CallBase &CB)=0
 
virtual std::unique_ptr< InlineAdvice > getMandatoryAdvice (CallBase &CB, bool Advice)
 
OptimizationRemarkEmitter & getCallerORE (CallBase &CB)
 

Protected Attributes

std::unique_ptr< MLModelRunner > ModelRunner
 
std::function< bool(CallBase &)> GetDefaultAdvice
 
- Protected Attributes inherited from llvm::InlineAdvisor
Module & M
 
FunctionAnalysisManager & FAM
 
const std::optional< InlineContext > IC
 
const std::string AnnotatedInlinePassName
 
std::unique_ptr< ImportedFunctionsInliningStatistics > ImportedFunctionsStats
 

Additional Inherited Members

- Protected Types inherited from llvm::InlineAdvisor
enum class  MandatoryInliningKind { NotMandatory , Always , Never }
 
- Static Protected Member Functions inherited from llvm::InlineAdvisor
static MandatoryInliningKind getMandatoryKind (CallBase &CB, FunctionAnalysisManager &FAM, OptimizationRemarkEmitter &ORE)
 

Detailed Description

Definition at line 28 of file MLInlineAdvisor.h.

Constructor & Destructor Documentation

◆ MLInlineAdvisor()

MLInlineAdvisor::MLInlineAdvisor ( Module &  M,
ModuleAnalysisManager &  MAM,
std::unique_ptr< MLModelRunner >  ModelRunner,
std::function< bool(CallBase &)>  GetDefaultAdvice 
)

Definition at line 124 of file MLInlineAdvisor.cpp.

References assert(), F, llvm::LazyCallGraph::get(), getInlinableCS(), getLocalCalls(), I, instructions, llvm::InlineAdvisor::M, ModelRunner, and llvm::scc_begin().

◆ ~MLInlineAdvisor()

virtual llvm::MLInlineAdvisor::~MLInlineAdvisor ( )
virtualdefault

Member Function Documentation

◆ getAdviceFromModel()

std::unique_ptr< MLInlineAdvice > MLInlineAdvisor::getAdviceFromModel ( CallBase &  CB,
OptimizationRemarkEmitter &  ORE 
)
protectedvirtual

Definition at line 425 of file MLInlineAdvisor.cpp.

References ModelRunner.

Referenced by getAdviceImpl().

◆ getAdviceImpl()

std::unique_ptr< InlineAdvice > MLInlineAdvisor::getAdviceImpl ( CallBase &  CB)
overrideprotectedvirtual

Implements llvm::InlineAdvisor.

Definition at line 324 of file MLInlineAdvisor.cpp.

References llvm::InlineAdvisor::Always, llvm::CallBase::arg_begin(), llvm::CallBase::arg_end(), DEBUG_TYPE, F, llvm::InlineAdvisor::FAM, getAdviceFromModel(), getCachedFPI(), llvm::CallBase::getCalledFunction(), llvm::CallBase::getCaller(), GetDefaultAdvice, getInitialFunctionLevel(), llvm::getInliningCostEstimate(), llvm::getInliningCostFeatures(), getMandatoryAdvice(), llvm::InlineAdvisor::getMandatoryKind(), llvm::AnalysisManager< IRUnitT, ExtraArgTs >::getResult(), I, llvm::inlineCostFeatureToMlFeature(), InteractiveChannelBaseName, InteractiveIncludeDefault, ModelRunner, llvm::InlineAdvisor::Never, and llvm::NumberOfFeatures.

◆ getCachedFPI()

FunctionPropertiesInfo & MLInlineAdvisor::getCachedFPI ( Function &  F) const

Definition at line 315 of file MLInlineAdvisor.cpp.

References F, llvm::InlineAdvisor::FAM, and llvm::AnalysisManager< IRUnitT, ExtraArgTs >::getResult().

Referenced by getAdviceImpl(), getIRSize(), getLocalCalls(), onSuccessfulInlining(), and llvm::MLInlineAdvice::recordUnsuccessfulInliningImpl().

◆ getInitialFunctionLevel()

unsigned MLInlineAdvisor::getInitialFunctionLevel ( const Function &  F) const
protected

Definition at line 175 of file MLInlineAdvisor.cpp.

References F, and llvm::LazyCallGraph::lookup().

Referenced by getAdviceImpl().

◆ getIRSize()

int64_t llvm::MLInlineAdvisor::getIRSize ( Function &  F) const
inline

Definition at line 39 of file MLInlineAdvisor.h.

References F, getCachedFPI(), and llvm::FunctionPropertiesInfo::TotalInstructionCount.

Referenced by onSuccessfulInlining().

◆ getLocalCalls()

int64_t MLInlineAdvisor::getLocalCalls ( Function &  F)

Definition at line 261 of file MLInlineAdvisor.cpp.

References llvm::FunctionPropertiesInfo::DirectCallsToDefinedFunctions, F, and getCachedFPI().

Referenced by MLInlineAdvisor(), onPassEntry(), and onPassExit().

◆ getMandatoryAdvice()

std::unique_ptr< InlineAdvice > MLInlineAdvisor::getMandatoryAdvice ( CallBase &  CB,
bool  Advice 
)
overrideprotectedvirtual

Reimplemented from llvm::InlineAdvisor.

Definition at line 439 of file MLInlineAdvisor.cpp.

References llvm::InlineAdvisor::getCallerORE(), and getMandatoryAdviceImpl().

Referenced by getAdviceImpl().

◆ getMandatoryAdviceImpl()

std::unique_ptr< MLInlineAdvice > MLInlineAdvisor::getMandatoryAdviceImpl ( CallBase &  CB)
protectedvirtual

Definition at line 455 of file MLInlineAdvisor.cpp.

References llvm::InlineAdvisor::getCallerORE().

Referenced by getMandatoryAdvice().

◆ getModelRunner()

const MLModelRunner & llvm::MLInlineAdvisor::getModelRunner ( ) const
inline

Definition at line 47 of file MLInlineAdvisor.h.

References ModelRunner.

◆ isForcedToStop()

bool llvm::MLInlineAdvisor::isForcedToStop ( ) const
inline

Definition at line 45 of file MLInlineAdvisor.h.

◆ onPassEntry()

void MLInlineAdvisor::onPassEntry ( LazyCallGraph::SCC *  SCC)
overridevirtual

This must be called when the Inliner pass is entered, to allow the InlineAdvisor update internal state, as result of function passes run between Inliner pass runs (for the same module).

Reimplemented from llvm::InlineAdvisor.

Definition at line 179 of file MLInlineAdvisor.cpp.

References assert(), getLocalCalls(), I, and N.

◆ onPassExit()

void MLInlineAdvisor::onPassExit ( LazyCallGraph::SCC *  SCC)
overridevirtual

This must be called when the Inliner pass is exited, as function passes may be run subsequently.

This allows an implementation of InlineAdvisor to prepare for a partial update, based on the optional SCC.

Reimplemented from llvm::InlineAdvisor.

Definition at line 231 of file MLInlineAdvisor.cpp.

References assert(), getFunction(), getLocalCalls(), I, KeepFPICache, and N.

◆ onSuccessfulInlining()

void MLInlineAdvisor::onSuccessfulInlining ( const MLInlineAdvice &  Advice,
bool  CalleeWasDeleted 
)

Definition at line 270 of file MLInlineAdvisor.cpp.

References llvm::PreservedAnalyses::abandon(), llvm::PreservedAnalyses::all(), assert(), llvm::MLInlineAdvice::CalleeIRSize, llvm::MLInlineAdvice::CallerAndCalleeEdges, llvm::MLInlineAdvice::CallerIRSize, llvm::FunctionPropertiesInfo::DirectCallsToDefinedFunctions, llvm::InlineAdvisor::FAM, getCachedFPI(), llvm::MLInlineAdvice::getCallee(), llvm::MLInlineAdvice::getCaller(), getIRSize(), if(), llvm::AnalysisManager< IRUnitT, ExtraArgTs >::invalidate(), SizeIncreaseThreshold, and llvm::MLInlineAdvice::updateCachedCallerFPI().

Referenced by llvm::MLInlineAdvice::recordInliningImpl(), and llvm::MLInlineAdvice::recordInliningWithCalleeDeletedImpl().

Member Data Documentation

◆ GetDefaultAdvice

std::function<bool(CallBase &)> llvm::MLInlineAdvisor::GetDefaultAdvice
protected

Definition at line 67 of file MLInlineAdvisor.h.

Referenced by getAdviceImpl().

◆ ModelRunner

std::unique_ptr<MLModelRunner> llvm::MLInlineAdvisor::ModelRunner
protected

Definition at line 66 of file MLInlineAdvisor.h.

Referenced by getAdviceFromModel(), getAdviceImpl(), getModelRunner(), and MLInlineAdvisor().

The documentation for this class was generated from the following files:
Generated on Mon Apr 22 2024 20:03:50 for LLVM by doxygen 1.9.6