Performs function inlining on functions that are determined to be good candidates, such as private functions that are only called from a single call site. More...

#include <inlining.hpp>

Inheritance diagram for jlm::llvm::FunctionInlining:

[legend]

Collaboration diagram for jlm::llvm::FunctionInlining:

[legend]

Classes
struct	Context

class	Statistics

Public Member Functions
	~FunctionInlining () noexcept override

	FunctionInlining ()

	FunctionInlining (const FunctionInlining &)=delete

FunctionInlining &	operator= (const FunctionInlining &)=delete

void	Run (rvsdg::RvsdgModule &module, util::StatisticsCollector &statisticsCollector) override
	Perform RVSDG transformation. More...

Public Member Functions inherited from jlm::rvsdg::Transformation
virtual	~Transformation () noexcept

	Transformation (std::string_view Name)

const std::string_view &	GetName () const noexcept

void	Run (RvsdgModule &module)
	Perform RVSDG transformation. More...

Static Public Member Functions
static void	inlineCall (rvsdg::SimpleNode &callNode, const rvsdg::LambdaNode &callee)

static bool	canBeInlined (const rvsdg::LambdaNode &callee)

Private Member Functions
bool	shouldInline (rvsdg::SimpleNode &callNode, rvsdg::LambdaNode &caller, rvsdg::LambdaNode &callee)

void	considerCallForInlining (rvsdg::SimpleNode &callNode, rvsdg::LambdaNode &callerLambda)

void	visitIntraProceduralRegion (rvsdg::Region &region, rvsdg::LambdaNode &lambda)

void	visitLambda (rvsdg::LambdaNode &lambda)

void	visitInterProceduralRegion (rvsdg::Region &region)

Static Private Member Functions
static void	inlineCall (rvsdg::SimpleNode &callNode, rvsdg::LambdaNode &caller, const rvsdg::LambdaNode &callee)

static bool	canBeInlined (rvsdg::Region &region, bool topLevelRegion)

Private Attributes
std::unique_ptr< Context >	context_

Detailed Description

Performs function inlining on functions that are determined to be good candidates, such as private functions that are only called from a single call site.

Definition at line 24 of file inlining.hpp.

Constructor & Destructor Documentation

◆ ~FunctionInlining()

jlm::llvm::FunctionInlining::~FunctionInlining ( )

overridedefaultnoexcept

◆ FunctionInlining() [1/2]

jlm::llvm::FunctionInlining::FunctionInlining ( )

Definition at line 89 of file inlining.cpp.

◆ FunctionInlining() [2/2]

jlm::llvm::FunctionInlining::FunctionInlining ( const FunctionInlining & )

delete

Member Function Documentation

◆ canBeInlined() [1/2]

bool jlm::llvm::FunctionInlining::canBeInlined ( const rvsdg::LambdaNode & callee )

static

Determines if there is anything in the function callee that prevents it from being inlined.

Returns: true if nothing disqualifying inlining was found in the region.

Definition at line 395 of file inlining.cpp.

◆ canBeInlined() [2/2]

bool jlm::llvm::FunctionInlining::canBeInlined	(	rvsdg::Region &	region,
		bool	topLevelRegion
	)

staticprivate

Determines if there is anything in the region that would prevent a function from being inlined. Recurses into subregions.

Parameters

region	the region in question
topLevelRegion	true if the region is the top level region in its lambda node

Returns: true if nothing disqualifying inlining was found in the region.

Definition at line 344 of file inlining.cpp.

◆ considerCallForInlining()

void jlm::llvm::FunctionInlining::considerCallForInlining	(	rvsdg::SimpleNode &	callNode,
		rvsdg::LambdaNode &	callerLambda
	)

private

Determines if the given callNode is a call that can be inlined, and if it should be inlined. If yes, inlining is performed.

Parameters

callNode	the node containing the CallOperation
callerLambda	the lambda containing the call node, a.k.a. the caller

Definition at line 411 of file inlining.cpp.

◆ inlineCall() [1/2]

void jlm::llvm::FunctionInlining::inlineCall	(	rvsdg::SimpleNode &	callNode,
		const rvsdg::LambdaNode &	callee
	)

static

Performs inlining of the given call node, targeting the given callee function

Parameters

callNode	the call to inline
callee	the function being inlined

Definition at line 337 of file inlining.cpp.

◆ inlineCall() [2/2]

void jlm::llvm::FunctionInlining::inlineCall	(	rvsdg::SimpleNode &	callNode,
		rvsdg::LambdaNode &	caller,
		const rvsdg::LambdaNode &	callee
	)

staticprivate

Performs inlining of the given call

Parameters

callNode	the node containing the CallOperation
caller	the lambda node of the caller
callee	the lambda node of the callee

Definition at line 278 of file inlining.cpp.

◆ operator=()

FunctionInlining& jlm::llvm::FunctionInlining::operator= ( const FunctionInlining & )

delete

◆ Run()

void jlm::llvm::FunctionInlining::Run	(	rvsdg::RvsdgModule &	module,
		util::StatisticsCollector &	statisticsCollector
	)

overridevirtual

Perform RVSDG transformation.

Note: This method is expected to be called multiple times. An implementation is required to reset the objects' internal state to ensure correct behavior after every invocation.

Parameters

module	RVSDG module the transformation is performed on.
statisticsCollector	Statistics collector for collecting transformation statistics.

Implements jlm::rvsdg::Transformation.

Definition at line 504 of file inlining.cpp.

◆ shouldInline()

bool jlm::llvm::FunctionInlining::shouldInline	(	rvsdg::SimpleNode &	callNode,
		rvsdg::LambdaNode &	caller,
		rvsdg::LambdaNode &	callee
	)

private

Determines if the given call should be inlined or not.

Parameters

callNode	the node containing the CallOperation
caller	the lambda node of the caller
callee	the lambda node of the callee

Returns

Definition at line 401 of file inlining.cpp.

◆ visitInterProceduralRegion()

void jlm::llvm::FunctionInlining::visitInterProceduralRegion ( rvsdg::Region & region )

private

Visits all lambda nodes in the given region, including in subregions. In each visited lambda, inlining transformations are applied if determined to be beneficial.

Parameters

region the region in question

Definition at line 486 of file inlining.cpp.

◆ visitIntraProceduralRegion()

void jlm::llvm::FunctionInlining::visitIntraProceduralRegion	(	rvsdg::Region &	region,
		rvsdg::LambdaNode &	lambda
	)

private

Recursively visits all call operations in the region and its subregions, and performs inlining if determined to be beneficial.

Parameters

region	the region being visited
lambda	the function to which the region belongs

Definition at line 443 of file inlining.cpp.

◆ visitLambda()

void jlm::llvm::FunctionInlining::visitLambda ( rvsdg::LambdaNode & lambda )

private

Visits the given function, performing inlining of calls inside it, and storing facts about it that may be relevant when considering inlining calls to the function.

Parameters

lambda the function in question

Definition at line 467 of file inlining.cpp.

Member Data Documentation

◆ context_

std::unique_ptr<Context> jlm::llvm::FunctionInlining::context_

private

Definition at line 129 of file inlining.hpp.

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

jlm/llvm/opt/inlining.hpp
jlm/llvm/opt/inlining.cpp

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~FunctionInlining()

◆ FunctionInlining() [1/2]

◆ FunctionInlining() [2/2]

Member Function Documentation

◆ canBeInlined() [1/2]

◆ canBeInlined() [2/2]

◆ considerCallForInlining()

◆ inlineCall() [1/2]

◆ inlineCall() [2/2]

◆ operator=()

◆ Run()

◆ shouldInline()

◆ visitInterProceduralRegion()

◆ visitIntraProceduralRegion()

◆ visitLambda()

Member Data Documentation

◆ context_