Class to accumulate and hold information about a callee. More...

#include "llvm/IR/ModuleSummaryIndex.h"

Collaboration diagram for llvm::CalleeInfo:

[legend]

Public Types
enum	HotnessType : uint8_t { HotnessType::Unknown = 0, HotnessType::Cold = 1, HotnessType::None = 2, HotnessType::Hot = 3, HotnessType::Critical = 4 }

Public Member Functions
	CalleeInfo ()

	CalleeInfo (HotnessType Hotness, uint64_t RelBF)

void	updateHotness (const HotnessType OtherHotness)

HotnessType	getHotness () const

void	updateRelBlockFreq (uint64_t BlockFreq, uint64_t EntryFreq)
	Update `RelBlockFreq` from `BlockFreq` and `EntryFreq`. More...

Public Attributes
uint32_t	Hotness: 3

uint32_t	RelBlockFreq: 29
	The value stored in RelBlockFreq has to be interpreted as the digits of a scaled number with a scale of `-ScaleShift`. More...

Static Public Attributes
static constexpr int32_t	ScaleShift = 8

static constexpr uint64_t	MaxRelBlockFreq = (1 << 29) - 1

Detailed Description

Class to accumulate and hold information about a callee.

Definition at line 55 of file ModuleSummaryIndex.h.

Member Enumeration Documentation

◆ HotnessType

enum llvm::CalleeInfo::HotnessType : uint8_t

strong

Enumerator
Unknown
Cold
None
Hot
Critical

Definition at line 56 of file ModuleSummaryIndex.h.

Constructor & Destructor Documentation

◆ CalleeInfo() [1/2]

llvm::CalleeInfo::CalleeInfo ( )

inline

Definition at line 74 of file ModuleSummaryIndex.h.

◆ CalleeInfo() [2/2]

llvm::CalleeInfo::CalleeInfo	(	HotnessType	Hotness,
		uint64_t	RelBF
	)

inlineexplicit

Definition at line 76 of file ModuleSummaryIndex.h.

Member Function Documentation

◆ getHotness()

HotnessType llvm::CalleeInfo::getHotness ( ) const

inline

Definition at line 83 of file ModuleSummaryIndex.h.

References Hotness.

◆ updateHotness()

void llvm::CalleeInfo::updateHotness ( const HotnessType OtherHotness )

inline

Definition at line 79 of file ModuleSummaryIndex.h.

References Hotness, and llvm::max().

◆ updateRelBlockFreq()

void llvm::CalleeInfo::updateRelBlockFreq	(	uint64_t	BlockFreq,
		uint64_t	EntryFreq
	)

inline

Update RelBlockFreq from BlockFreq and EntryFreq.

BlockFreq is divided by EntryFreq and added to RelBlockFreq. To represent fractional values, the result is represented as a fixed point number with scale of -ScaleShift.

Definition at line 90 of file ModuleSummaryIndex.h.

References MaxRelBlockFreq, llvm::min(), RelBlockFreq, and ScaleShift.