llvm::InlineCost Class Reference

Represents the cost of inlining a function. More...

#include "llvm/Analysis/InlineCost.h"

Public Member Functions
	operator bool () const
	Test whether the inline cost is low enough for inlining. More...
bool	isAlways () const
bool	isNever () const
bool	isVariable () const
int	getCost () const
	Get the inline cost estimate. More...
int	getThreshold () const
	Get the threshold against which the cost was computed. More...
const char *	getReason () const
	Get the reason of Always or Never. More...
int	getCostDelta () const
	Get the cost delta from the threshold for inlining. More...

Static Public Member Functions
static InlineCost	get (int Cost, int Threshold)
static InlineCost	getAlways (const char *Reason)
static InlineCost	getNever (const char *Reason)

Detailed Description

Represents the cost of inlining a function.

This supports special values for functions which should "always" or "never" be inlined. Otherwise, the cost represents a unitless amount; smaller values increase the likelihood of the function being inlined.

Objects of this type also provide the adjusted threshold for inlining based on the information available for a particular callsite. They can be directly tested to determine if inlining should occur given the cost and threshold for this cost metric.

Definition at line 63 of file InlineCost.h.

Member Function Documentation

get()

static InlineCost llvm::InlineCost::get ( int  Cost, int  Threshold  )

inlinestatic

Definition at line 86 of file InlineCost.h.

References assert().

Referenced by llvm::getInlineCost().

getAlways()

static InlineCost llvm::InlineCost::getAlways ( const char *  Reason )

inlinestatic

Definition at line 91 of file InlineCost.h.

Referenced by llvm::createAlwaysInlinerLegacyPass(), llvm::getInlineCost(), and isWrapperOnlyCall().

getCost()

int llvm::InlineCost::getCost ( ) const

inline

Get the inline cost estimate.

It is an error to call this on an "always" or "never" InlineCost.

Definition at line 109 of file InlineCost.h.

References assert().

Referenced by hasProfileData(), operator<<(), shouldBeDeferred(), and shouldInline().

getCostDelta()

int llvm::InlineCost::getCostDelta ( ) const

inline

Get the cost delta from the threshold for inlining.

Only valid if the cost is of the variable kind. Returns a negative value if the cost is too high to inline.

Definition at line 130 of file InlineCost.h.

Referenced by hasProfileData(), and shouldBeDeferred().

getNever()

static InlineCost llvm::InlineCost::getNever ( const char *  Reason )

inlinestatic

Definition at line 94 of file InlineCost.h.

Referenced by llvm::createAlwaysInlinerLegacyPass(), llvm::getInlineCost(), and isWrapperOnlyCall().

getReason()

const char* llvm::InlineCost::getReason ( ) const

inline

Get the reason of Always or Never.

Definition at line 121 of file InlineCost.h.

References assert().

Referenced by operator<<().

getThreshold()

int llvm::InlineCost::getThreshold ( ) const

inline

Get the threshold against which the cost was computed.

Definition at line 115 of file InlineCost.h.

References assert(), and Threshold.

Referenced by operator<<().

isAlways()

bool llvm::InlineCost::isAlways ( ) const

inline

Definition at line 103 of file InlineCost.h.

Referenced by emit_inlined_into(), hasProfileData(), operator<<(), shouldBeDeferred(), and shouldInline().

isNever()

bool llvm::InlineCost::isNever ( ) const

inline

Definition at line 104 of file InlineCost.h.

Referenced by callsiteIsHot(), hasProfileData(), operator<<(), and shouldInline().

isVariable()

bool llvm::InlineCost::isVariable ( ) const

inline

Definition at line 105 of file InlineCost.h.

operator bool()

llvm::InlineCost::operator bool ( ) const

inlineexplicit

Test whether the inline cost is low enough for inlining.

Definition at line 99 of file InlineCost.h.

References Threshold.

---

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

• include/llvm/Analysis/InlineCost.h