Classes
class	DefaultFunctionPruningStrategy

class	FunctionPruningStrategy
	When writing a profile with size limit, user may want to use a different strategy to reduce function count other than dropping functions with fewest samples first. More...

class	FunctionSamples
	Representation of the samples collected for a function. More...

struct	LineLocation
	Represents the relative location of an instruction. More...

struct	LineLocationHash

class	ProfileConverter
	Helper class for profile conversion. More...

class	ProfiledCallGraph

struct	ProfiledCallGraphEdge

struct	ProfiledCallGraphNode

class	ProfileSymbolList
	ProfileSymbolList records the list of function symbols shown up in the binary used to generate the profile. More...

class	SampleContext

struct	SampleContextFrame

struct	SampleContextFrameHash

class	SampleContextTrimmer
	SampleContextTrimmer impelements helper functions to trim, merge cold context profiles. More...

class	SampleProfileReader
	Sample-based profile reader. More...

class	SampleProfileReaderBinary

class	SampleProfileReaderExtBinary

class	SampleProfileReaderExtBinaryBase
	SampleProfileReaderExtBinaryBase/SampleProfileWriterExtBinaryBase defines the basic structure of the extensible binary format. More...

class	SampleProfileReaderGCC

class	SampleProfileReaderItaniumRemapper
	SampleProfileReaderItaniumRemapper remaps the profile data from a sample profile data reader, by applying a provided set of equivalences between components of the symbol names in the profile. More...

class	SampleProfileReaderRawBinary

class	SampleProfileReaderText

class	SampleProfileWriter
	Sample-based profile writer. Base class. More...

class	SampleProfileWriterBinary
	Sample-based profile writer (binary format). More...

class	SampleProfileWriterExtBinary

class	SampleProfileWriterExtBinaryBase

class	SampleProfileWriterRawBinary

class	SampleProfileWriterText
	Sample-based profile writer (text format). More...

class	SampleRecord
	Representation of a single sample record. More...

class	SampleSorter
	Sort a LocationT->SampleT map by LocationT. More...

struct	SecHdrTableEntry

Typedefs
using	SampleContextFrameVector = SmallVector< SampleContextFrame, 1 >

using	SampleContextFrames = ArrayRef< SampleContextFrame >

using	BodySampleMap = std::map< LineLocation, SampleRecord >

using	FunctionSamplesMap = std::map< std::string, FunctionSamples, std::less<> >

using	CallsiteSampleMap = std::map< LineLocation, FunctionSamplesMap >

using	LocToLocMap = std::unordered_map< LineLocation, LineLocation, LineLocationHash >

using	SampleProfileMap = std::unordered_map< SampleContext, FunctionSamples, SampleContext::Hash >

using	NameFunctionSamples = std::pair< SampleContext, const FunctionSamples * >

using	InlineCallStack = SmallVector< FunctionSamples *, 10 >

Enumerations
enum	SampleProfileFormat { SPF_None = 0 , SPF_Text = 0x1 , SPF_Compact_Binary = 0x2 , SPF_GCC = 0x3 , SPF_Ext_Binary = 0x4 , SPF_Binary = 0xff }

enum	SampleProfileLayout { SPL_None = 0 , SPL_Nest = 0x1 , SPL_Flat = 0x2 }

enum	SecType { SecInValid = 0 , SecProfSummary = 1 , SecNameTable = 2 , SecProfileSymbolList = 3 , SecFuncOffsetTable = 4 , SecFuncMetadata = 5 , SecCSNameTable = 6 , SecFuncProfileFirst = 32 , SecLBRProfile = SecFuncProfileFirst }

enum class	SecCommonFlags : uint32_t { SecFlagInValid = 0 , SecFlagCompress = (1 << 0) , SecFlagFlat = (1 << 1) }

enum class	SecNameTableFlags : uint32_t { SecFlagInValid = 0 , SecFlagMD5Name = (1 << 0) , SecFlagFixedLengthMD5 = (1 << 1) , SecFlagUniqSuffix = (1 << 2) }

enum class	SecProfSummaryFlags : uint32_t { SecFlagInValid = 0 , SecFlagPartial = (1 << 0) , SecFlagFullContext = (1 << 1) , SecFlagFSDiscriminator = (1 << 2) , SecFlagIsPreInlined = (1 << 4) }

enum class	SecFuncMetadataFlags : uint32_t { SecFlagInvalid = 0 , SecFlagIsProbeBased = (1 << 0) , SecFlagHasAttribute = (1 << 1) }

enum class	SecFuncOffsetFlags : uint32_t { SecFlagInvalid = 0 , SecFlagOrdered = (1 << 0) }

enum	ContextStateMask { UnknownContext = 0x0 , RawContext = 0x1 , SyntheticContext = 0x2 , InlinedContext = 0x4 , MergedContext = 0x8 }

enum	ContextAttributeMask { ContextNone = 0x0 , ContextWasInlined = 0x1 , ContextShouldBeInlined = 0x2 , ContextDuplicatedIntoBase }

enum	HistType { HIST_TYPE_INTERVAL , HIST_TYPE_POW2 , HIST_TYPE_SINGLE_VALUE , HIST_TYPE_CONST_DELTA , HIST_TYPE_INDIR_CALL , HIST_TYPE_AVERAGE , HIST_TYPE_IOR , HIST_TYPE_INDIR_CALL_TOPN }

enum	SectionLayout { DefaultLayout , CtxSplitLayout , NumOfLayout }

enum	FSDiscriminatorPass { Base = 0 , Pass0 = 0 , Pass1 = 1 , Pass2 = 2 , Pass3 = 3 , Pass4 = 4 , PassLast = 4 }

Functions
static uint64_t	SPMagic (SampleProfileFormat Format=SPF_Binary)

static StringRef	getRepInFormat (StringRef Name, bool UseMD5, std::string &GUIDBuf)
	Get the proper representation of a string according to whether the current Format uses MD5 to represent the string.

static uint64_t	SPVersion ()

static std::string	getSecName (SecType Type)

template<class SecFlagType >
static void	verifySecFlag (SecType Type, SecFlagType Flag)

template<class SecFlagType >
static void	addSecFlag (SecHdrTableEntry &Entry, SecFlagType Flag)

template<class SecFlagType >
static void	removeSecFlag (SecHdrTableEntry &Entry, SecFlagType Flag)

template<class SecFlagType >
static bool	hasSecFlag (const SecHdrTableEntry &Entry, SecFlagType Flag)

raw_ostream &	operator<< (raw_ostream &OS, const LineLocation &Loc)

raw_ostream &	operator<< (raw_ostream &OS, const SampleRecord &Sample)

static hash_code	hash_value (const SampleContextFrame &arg)

static hash_code	hash_value (const SampleContext &arg)

raw_ostream &	operator<< (raw_ostream &OS, const FunctionSamples &FS)

void	sortFuncProfiles (const SampleProfileMap &ProfileMap, std::vector< NameFunctionSamples > &SortedProfiles)

Variables
const std::array< SmallVector< SecHdrTableEntry, 8 >, NumOfLayout >	ExtBinaryHdrLayoutTable

Typedef Documentation

◆ BodySampleMap

using llvm::sampleprof::BodySampleMap = typedef std::map<LineLocation, SampleRecord>

Definition at line 721 of file SampleProf.h.

◆ CallsiteSampleMap

using llvm::sampleprof::CallsiteSampleMap = typedef std::map<LineLocation, FunctionSamplesMap>

Definition at line 725 of file SampleProf.h.

◆ FunctionSamplesMap

using llvm::sampleprof::FunctionSamplesMap = typedef std::map<std::string, FunctionSamples, std::less<> >

Definition at line 724 of file SampleProf.h.

◆ InlineCallStack

using llvm::sampleprof::InlineCallStack = typedef SmallVector<FunctionSamples *, 10>

Definition at line 824 of file SampleProfReader.h.

◆ LocToLocMap

using llvm::sampleprof::LocToLocMap = typedef std::unordered_map<LineLocation, LineLocation, LineLocationHash>

Definition at line 726 of file SampleProf.h.

◆ NameFunctionSamples

using llvm::sampleprof::NameFunctionSamples = typedef std::pair<SampleContext, const FunctionSamples *>

Definition at line 1273 of file SampleProf.h.

◆ SampleContextFrames

using llvm::sampleprof::SampleContextFrames = typedef ArrayRef<SampleContextFrame>

Definition at line 505 of file SampleProf.h.

◆ SampleContextFrameVector

using llvm::sampleprof::SampleContextFrameVector = typedef SmallVector<SampleContextFrame, 1>

Definition at line 504 of file SampleProf.h.

◆ SampleProfileMap

using llvm::sampleprof::SampleProfileMap = typedef std::unordered_map<SampleContext, FunctionSamples, SampleContext::Hash>

Definition at line 1270 of file SampleProf.h.

Enumeration Type Documentation

◆ ContextAttributeMask

enum llvm::sampleprof::ContextAttributeMask

Enumerator
ContextNone
ContextWasInlined
ContextShouldBeInlined
ContextDuplicatedIntoBase

Definition at line 461 of file SampleProf.h.

◆ ContextStateMask

enum llvm::sampleprof::ContextStateMask

Enumerator
UnknownContext
RawContext
SyntheticContext
InlinedContext
MergedContext

Definition at line 452 of file SampleProf.h.

◆ FSDiscriminatorPass

enum llvm::sampleprof::FSDiscriminatorPass

Enumerator
Base
Pass0
Pass1
Pass2
Pass3
Pass4
PassLast

Definition at line 57 of file Discriminator.h.

◆ HistType

enum llvm::sampleprof::HistType

Enumerator
HIST_TYPE_INTERVAL
HIST_TYPE_POW2
HIST_TYPE_SINGLE_VALUE
HIST_TYPE_CONST_DELTA
HIST_TYPE_INDIR_CALL
HIST_TYPE_AVERAGE
HIST_TYPE_IOR
HIST_TYPE_INDIR_CALL_TOPN

Definition at line 828 of file SampleProfReader.h.

◆ SampleProfileFormat

enum llvm::sampleprof::SampleProfileFormat

Enumerator
SPF_None
SPF_Text
SPF_Compact_Binary
SPF_GCC
SPF_Ext_Binary
SPF_Binary

Definition at line 90 of file SampleProf.h.

◆ SampleProfileLayout

enum llvm::sampleprof::SampleProfileLayout

Enumerator
SPL_None
SPL_Nest
SPL_Flat

Definition at line 99 of file SampleProf.h.

◆ SecCommonFlags

enum class llvm::sampleprof::SecCommonFlags : uint32_t

strong

Enumerator
SecFlagInValid
SecFlagCompress
SecFlagFlat

Definition at line 178 of file SampleProf.h.

◆ SecFuncMetadataFlags

enum class llvm::sampleprof::SecFuncMetadataFlags : uint32_t

strong

Enumerator
SecFlagInvalid
SecFlagIsProbeBased
SecFlagHasAttribute

Definition at line 215 of file SampleProf.h.

◆ SecFuncOffsetFlags

enum class llvm::sampleprof::SecFuncOffsetFlags : uint32_t

strong

Enumerator
SecFlagInvalid
SecFlagOrdered

Definition at line 221 of file SampleProf.h.

◆ SecNameTableFlags

enum class llvm::sampleprof::SecNameTableFlags : uint32_t

strong

Enumerator
SecFlagInValid
SecFlagMD5Name
SecFlagFixedLengthMD5
SecFlagUniqSuffix

Definition at line 188 of file SampleProf.h.

◆ SecProfSummaryFlags

enum class llvm::sampleprof::SecProfSummaryFlags : uint32_t

strong

Enumerator
SecFlagInValid
SecFlagPartial	SecFlagPartial means the profile is for common/shared code. The common profile is usually merged from profiles collected from running other targets.
SecFlagFullContext	SecFlagContext means this is context-sensitive flat profile for CSSPGO.
SecFlagFSDiscriminator	SecFlagFSDiscriminator means this profile uses flow-sensitive discriminators.
SecFlagIsPreInlined	SecFlagIsPreInlined means this profile contains ShouldBeInlined contexts thus this is CS preinliner computed.

Definition at line 198 of file SampleProf.h.

◆ SectionLayout

enum llvm::sampleprof::SectionLayout

Enumerator
DefaultLayout
CtxSplitLayout
NumOfLayout

Definition at line 29 of file SampleProfWriter.h.

◆ SecType

enum llvm::sampleprof::SecType

Enumerator
SecInValid
SecProfSummary
SecNameTable
SecProfileSymbolList
SecFuncOffsetTable
SecFuncMetadata
SecCSNameTable
SecFuncProfileFirst
SecLBRProfile

Definition at line 127 of file SampleProf.h.

Function Documentation

◆ addSecFlag()

template<class SecFlagType >

static void llvm::sampleprof::addSecFlag	(	SecHdrTableEntry &	Entry,
		SecFlagType	Flag
	)

inlinestatic

Definition at line 257 of file SampleProf.h.

References verifySecFlag().

Referenced by llvm::sampleprof::SampleProfileWriterExtBinaryBase::addSectionFlag(), and llvm::sampleprof::SampleProfileWriterExtBinaryBase::setToCompressAllSections().

◆ getRepInFormat()

static StringRef llvm::sampleprof::getRepInFormat	(	StringRef	Name,
		bool	UseMD5,
		std::string &	GUIDBuf
	)

inlinestatic

Get the proper representation of a string according to whether the current Format uses MD5 to represent the string.

Definition at line 114 of file SampleProf.h.

References llvm::GlobalValue::getGUID(), and Name.

Referenced by llvm::sampleprof::FunctionSamples::findFunctionSamplesAt(), llvm::SampleContextTracker::getBaseSamplesFor(), llvm::SampleContextTracker::getCalleeContextSamplesFor(), llvm::sampleprof::SampleProfileReader::getOrCreateSamplesFor(), and llvm::sampleprof::SampleProfileReader::getSamplesFor().

◆ getSecName()

static std::string llvm::sampleprof::getSecName ( SecType Type )

inlinestatic

Definition at line 140 of file SampleProf.h.

References SecCSNameTable, SecFuncMetadata, SecFuncOffsetTable, SecInValid, SecLBRProfile, SecNameTable, SecProfileSymbolList, and SecProfSummary.

Referenced by llvm::sampleprof::SampleProfileReaderExtBinaryBase::dumpSectionInfo().

◆ hash_value() [1/2]

static hash_code llvm::sampleprof::hash_value ( const SampleContext & arg )

inlinestatic

Definition at line 713 of file SampleProf.h.

References llvm::sampleprof::SampleContext::getContextFrames(), llvm::sampleprof::SampleContext::getName(), llvm::sampleprof::SampleContext::hasContext(), and hash_value().

◆ hash_value() [2/2]

static hash_code llvm::sampleprof::hash_value ( const SampleContextFrame & arg )

inlinestatic

Definition at line 499 of file SampleProf.h.

References llvm::sampleprof::LineLocation::Discriminator, llvm::sampleprof::SampleContextFrame::FuncName, llvm::hash_combine(), llvm::sampleprof::LineLocation::LineOffset, and llvm::sampleprof::SampleContextFrame::Location.

Referenced by llvm::sampleprof::SampleContext::getHashCode(), and hash_value().

◆ hasSecFlag()

template<class SecFlagType >

static bool llvm::sampleprof::hasSecFlag	(	const SecHdrTableEntry &	Entry,
		SecFlagType	Flag
	)

inlinestatic

Definition at line 273 of file SampleProf.h.

References verifySecFlag().

Referenced by llvm::sampleprof::SampleProfileWriterExtBinaryBase::addNewSection(), getSecFlagsStr(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::markSectionStart(), llvm::sampleprof::SampleProfileReaderExtBinaryBase::readImpl(), and llvm::sampleprof::SampleProfileReaderExtBinaryBase::readOneSection().

◆ operator<<() [1/3]

raw_ostream & llvm::sampleprof::operator<<	(	raw_ostream &	OS,
		const FunctionSamples &	FS
	)

Definition at line 195 of file SampleProf.cpp.

References OS.

◆ operator<<() [2/3]

raw_ostream & llvm::sampleprof::operator<<	(	raw_ostream &	OS,
		const LineLocation &	Loc
	)

Definition at line 111 of file SampleProf.cpp.

References OS, and llvm::sampleprof::LineLocation::print().

◆ operator<<() [3/3]

raw_ostream & llvm::sampleprof::operator<<	(	raw_ostream &	OS,
		const SampleRecord &	Sample
	)

Definition at line 148 of file SampleProf.cpp.

References OS, and llvm::sampleprof::SampleRecord::print().

◆ removeSecFlag()

template<class SecFlagType >

static void llvm::sampleprof::removeSecFlag	(	SecHdrTableEntry &	Entry,
		SecFlagType	Flag
	)

inlinestatic

Definition at line 265 of file SampleProf.h.

References verifySecFlag().

◆ sortFuncProfiles()

void llvm::sampleprof::sortFuncProfiles	(	const SampleProfileMap &	ProfileMap,
		std::vector< NameFunctionSamples > &	SortedProfiles
	)

Definition at line 201 of file SampleProf.cpp.

References A, assert(), B, I, and llvm::stable_sort().

Referenced by llvm::sampleprof::DefaultFunctionPruningStrategy::DefaultFunctionPruningStrategy(), llvm::sampleprof::SampleProfileReader::dump(), llvm::sampleprof::SampleProfileReader::dumpJson(), and llvm::sampleprof::SampleProfileWriter::writeFuncProfiles().

◆ SPMagic()

static uint64_t llvm::sampleprof::SPMagic ( SampleProfileFormat Format = SPF_Binary )

inlinestatic

Definition at line 105 of file SampleProf.h.

References llvm::Format.

Referenced by llvm::sampleprof::SampleProfileReaderRawBinary::hasFormat(), llvm::sampleprof::SampleProfileReaderExtBinary::hasFormat(), and llvm::sampleprof::SampleProfileWriterBinary::writeMagicIdent().

◆ SPVersion()

static uint64_t llvm::sampleprof::SPVersion ( )

inlinestatic

Definition at line 122 of file SampleProf.h.

Referenced by llvm::sampleprof::SampleProfileReaderBinary::readMagicIdent(), and llvm::sampleprof::SampleProfileWriterBinary::writeMagicIdent().

◆ verifySecFlag()

template<class SecFlagType >

static void llvm::sampleprof::verifySecFlag	(	SecType	Type,
		SecFlagType	Flag
	)

inlinestatic

Definition at line 230 of file SampleProf.h.

References llvm_unreachable, SecFuncMetadata, SecFuncOffsetTable, SecNameTable, and SecProfSummary.

Referenced by addSecFlag(), hasSecFlag(), and removeSecFlag().

Variable Documentation

◆ ExtBinaryHdrLayoutTable

const std::array<SmallVector<SecHdrTableEntry, 8>, NumOfLayout> llvm::sampleprof::ExtBinaryHdrLayoutTable

Initial value:

= {
        
        SmallVector<SecHdrTableEntry, 8>({{SecProfSummary, 0, 0, 0, 0},
                                          {SecNameTable, 0, 0, 0, 0},
                                          {SecCSNameTable, 0, 0, 0, 0},
                                          {SecFuncOffsetTable, 0, 0, 0, 0},
                                          {SecLBRProfile, 0, 0, 0, 0},
                                          {SecProfileSymbolList, 0, 0, 0, 0},
                                          {SecFuncMetadata, 0, 0, 0, 0}}),
        
        SmallVector<SecHdrTableEntry, 8>({{SecProfSummary, 0, 0, 0, 0},
                                          {SecNameTable, 0, 0, 0, 0},
                                          
                                          {SecFuncOffsetTable, 0, 0, 0, 0},
                                          {SecLBRProfile, 0, 0, 0, 0},
                                          
                                          {SecFuncOffsetTable, 0, 0, 0, 0},
                                          {SecLBRProfile, 0, 0, 0, 0},
                                          {SecProfileSymbolList, 0, 0, 0, 0},
                                          {SecFuncMetadata, 0, 0, 0, 0}}),
}

Definition at line 227 of file SampleProfWriter.h.

Referenced by llvm::sampleprof::SampleProfileWriterExtBinaryBase::resetSecLayout().

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ BodySampleMap

◆ CallsiteSampleMap

◆ FunctionSamplesMap

◆ InlineCallStack

◆ LocToLocMap

◆ NameFunctionSamples

◆ SampleContextFrames

◆ SampleContextFrameVector

◆ SampleProfileMap

Enumeration Type Documentation

◆ ContextAttributeMask

◆ ContextStateMask

◆ FSDiscriminatorPass

◆ HistType

◆ SampleProfileFormat

◆ SampleProfileLayout

◆ SecCommonFlags

◆ SecFuncMetadataFlags

◆ SecFuncOffsetFlags

◆ SecNameTableFlags

◆ SecProfSummaryFlags

◆ SectionLayout

◆ SecType

Function Documentation

◆ addSecFlag()

◆ getRepInFormat()

◆ getSecName()

◆ hash_value() [1/2]

◆ hash_value() [2/2]

◆ hasSecFlag()

◆ operator<<() [1/3]

◆ operator<<() [2/3]

◆ operator<<() [3/3]

◆ removeSecFlag()

◆ sortFuncProfiles()

◆ SPMagic()

◆ SPVersion()

◆ verifySecFlag()

Variable Documentation

◆ ExtBinaryHdrLayoutTable