#include "llvm/ProfileData/SampleProfReader.h"

Inheritance diagram for llvm::sampleprof::SampleProfileReaderBinary:

[legend]

Collaboration diagram for llvm::sampleprof::SampleProfileReaderBinary:

[legend]

Public Member Functions
	SampleProfileReaderBinary (std::unique_ptr< MemoryBuffer > B, LLVMContext &C, SampleProfileFormat Format=SPF_None)

std::error_code	readHeader () override
	Read and validate the file header.

std::error_code	readImpl () override
	Read sample profiles from the associated file.

std::vector< StringRef > *	getNameTable () override
	It includes all the names that have samples either in outline instance or inline instance.

Public Member Functions inherited from llvm::sampleprof::SampleProfileReader
	SampleProfileReader (std::unique_ptr< MemoryBuffer > B, LLVMContext &C, SampleProfileFormat Format=SPF_None)

virtual	~SampleProfileReader ()=default

virtual std::error_code	readHeader ()=0
	Read and validate the file header.

void	setDiscriminatorMaskedBitFrom (FSDiscriminatorPass P)
	Set the bits for FS discriminators.

uint32_t	getDiscriminatorMask () const
	Get the bitmask the discriminators: For FS profiles, return the bit mask for this pass.

std::error_code	read ()
	The interface to read sample profiles from the associated file.

virtual std::error_code	readImpl ()=0
	The implementaion to read sample profiles from the associated file.

void	dumpFunctionProfile (SampleContext FContext, raw_ostream &OS=dbgs())
	Print the profile for `FContext` on stream `OS`.

virtual bool	collectFuncsFromModule ()
	Collect functions with definitions in Module M.

void	dump (raw_ostream &OS=dbgs())
	Print all the profiles on stream `OS`.

void	dumpJson (raw_ostream &OS=dbgs())
	Print all the profiles on stream `OS` in the JSON format.

FunctionSamples *	getSamplesFor (const Function &F)
	Return the samples collected for function `F`.

FunctionSamples *	getOrCreateSamplesFor (const Function &F)
	Return the samples collected for function `F`, create empty FunctionSamples if it doesn't exist.

virtual FunctionSamples *	getSamplesFor (StringRef Fname)
	Return the samples collected for function `F`.

SampleProfileMap &	getProfiles ()
	Return all the profiles.

void	reportError (int64_t LineNumber, const Twine &Msg) const
	Report a parse error message.

ProfileSummary &	getSummary () const
	Return the profile summary.

MemoryBuffer *	getBuffer () const

SampleProfileFormat	getFormat () const
	Return the profile format.

bool	profileIsProbeBased () const
	Whether input profile is based on pseudo probes.

bool	profileIsCS () const
	Whether input profile is fully context-sensitive.

bool	profileIsPreInlined () const
	Whether input profile contains ShouldBeInlined contexts.

virtual std::unique_ptr< ProfileSymbolList >	getProfileSymbolList ()

virtual std::vector< StringRef > *	getNameTable ()
	It includes all the names that have samples either in outline instance or inline instance.

virtual bool	dumpSectionInfo (raw_ostream &OS=dbgs())

virtual bool	useMD5 ()
	Return whether names in the profile are all MD5 numbers.

virtual void	setSkipFlatProf (bool Skip)
	Don't read profile without context if the flag is set.

virtual bool	hasUniqSuffix ()
	Return whether any name in the profile contains ".__uniq." suffix.

SampleProfileReaderItaniumRemapper *	getRemapper ()

void	setModule (const Module *Mod)

Protected Member Functions
template<typename T >
ErrorOr< T >	readNumber ()
	Read a numeric value of type T from the profile.

template<typename T >
ErrorOr< T >	readUnencodedNumber ()
	Read a numeric value of type T from the profile.

ErrorOr< StringRef >	readString ()
	Read a string from the profile.

template<typename T >
ErrorOr< uint32_t >	readStringIndex (T &Table)
	Read the string index and check whether it overflows the table.

bool	at_eof () const
	Return true if we've reached the end of file.

std::error_code	readFuncProfile (const uint8_t *Start)
	Read the next function profile instance.

std::error_code	readProfile (FunctionSamples &FProfile)
	Read the contents of the given profile instance.

std::error_code	readMagicIdent ()
	Read the contents of Magic number and Version number.

std::error_code	readSummary ()
	Read profile summary.

virtual std::error_code	readNameTable ()
	Read the whole name table.

virtual ErrorOr< StringRef >	readStringFromTable ()
	Read a string indirectly via the name table.

virtual ErrorOr< SampleContext >	readSampleContextFromTable ()

Protected Member Functions inherited from llvm::sampleprof::SampleProfileReader
void	computeSummary ()
	Compute summary for this profile.

Protected Attributes
const uint8_t *	Data = nullptr
	Points to the current location in the buffer.

const uint8_t *	End = nullptr
	Points to the end of the buffer.

std::vector< StringRef >	NameTable
	Function name table.

Protected Attributes inherited from llvm::sampleprof::SampleProfileReader
SampleProfileMap	Profiles
	Map every function to its associated profile.

LLVMContext &	Ctx
	LLVM context used to emit diagnostics.

std::unique_ptr< MemoryBuffer >	Buffer
	Memory buffer holding the profile file.

std::unordered_set< std::string >	MD5NameBuffer
	Extra name buffer holding names created on demand.

std::unique_ptr< ProfileSummary >	Summary
	Profile summary information.

std::unique_ptr< SampleProfileReaderItaniumRemapper >	Remapper

bool	ProfileIsProbeBased = false
	Whether samples are collected based on pseudo probes.

bool	ProfileIsCS = false
	Whether function profiles are context-sensitive flat profiles.

bool	ProfileIsPreInlined = false
	Whether function profile contains ShouldBeInlined contexts.

uint32_t	CSProfileCount = 0
	Number of context-sensitive profiles.

bool	ProfileIsFS = false
	Whether the function profiles use FS discriminators.

SampleProfileFormat	Format = SPF_None
	The format of sample.

const Module *	M = nullptr
	The current module being compiled if SampleProfileReader is used by compiler.

uint32_t	MaskedBitFrom = 31
	Zero out the discriminator bits higher than bit MaskedBitFrom (0 based).

Additional Inherited Members
Static Public Member Functions inherited from llvm::sampleprof::SampleProfileReader
static ErrorOr< std::unique_ptr< SampleProfileReader > >	create (const std::string Filename, LLVMContext &C, vfs::FileSystem &FS, FSDiscriminatorPass P=FSDiscriminatorPass::Base, const std::string RemapFilename="")
	Create a sample profile reader appropriate to the file format.

static ErrorOr< std::unique_ptr< SampleProfileReader > >	create (std::unique_ptr< MemoryBuffer > &B, LLVMContext &C, vfs::FileSystem &FS, FSDiscriminatorPass P=FSDiscriminatorPass::Base, const std::string RemapFilename="")
	Create a sample profile reader from the supplied memory buffer.

Static Protected Member Functions inherited from llvm::sampleprof::SampleProfileReader
static std::unique_ptr< ProfileSummary >	takeSummary (SampleProfileReader &Reader)
	Take ownership of the summary of this reader.

Detailed Description

Definition at line 588 of file SampleProfReader.h.

Constructor & Destructor Documentation

◆ SampleProfileReaderBinary()

llvm::sampleprof::SampleProfileReaderBinary::SampleProfileReaderBinary	(	std::unique_ptr< MemoryBuffer >	B,
		LLVMContext &	C,
		SampleProfileFormat	Format = `SPF_None`
	)

inline

Definition at line 590 of file SampleProfReader.h.

Member Function Documentation

◆ at_eof()

bool llvm::sampleprof::SampleProfileReaderBinary::at_eof ( ) const

inlineprotected

Return true if we've reached the end of file.

Definition at line 629 of file SampleProfReader.h.

References Data, and End.

Referenced by readImpl().

◆ getNameTable()

std::vector< StringRef > * llvm::sampleprof::SampleProfileReaderBinary::getNameTable ( )

inlineoverridevirtual

It includes all the names that have samples either in outline instance or inline instance.

Reimplemented from llvm::sampleprof::SampleProfileReader.

Definition at line 602 of file SampleProfReader.h.

References NameTable.

◆ readFuncProfile()

std::error_code SampleProfileReaderBinary::readFuncProfile ( const uint8_t * Start )

protected

Read the next function profile instance.

Definition at line 663 of file SampleProfReader.cpp.

References llvm::sampleprof::FunctionSamples::addHeadSamples(), llvm::sampleprof::SampleProfileReader::CSProfileCount, Data, llvm::ErrorOr< T >::getError(), llvm::sampleprof::SampleProfileReader::Profiles, readProfile(), readSampleContextFromTable(), llvm::sampleprof::FunctionSamples::setContext(), and llvm::success.

Referenced by llvm::sampleprof::SampleProfileReaderExtBinaryBase::readFuncProfiles(), readImpl(), and llvm::sampleprof::SampleProfileReaderCompactBinary::readImpl().

◆ readHeader()

std::error_code SampleProfileReaderBinary::readHeader ( )

overridevirtual

Read and validate the file header.

Implements llvm::sampleprof::SampleProfileReader.

Reimplemented in llvm::sampleprof::SampleProfileReaderExtBinaryBase.

Definition at line 1415 of file SampleProfReader.cpp.

References llvm::sampleprof::SampleProfileReader::Buffer, Data, End, readMagicIdent(), readNameTable(), readSummary(), and llvm::success.

◆ readImpl()

std::error_code SampleProfileReaderBinary::readImpl ( )

overridevirtual

Read sample profiles from the associated file.

Implements llvm::sampleprof::SampleProfileReader.

Reimplemented in llvm::sampleprof::SampleProfileReaderExtBinaryBase, and llvm::sampleprof::SampleProfileReaderCompactBinary.

Definition at line 686 of file SampleProfReader.cpp.

References at_eof(), Data, llvm::sampleprof::FunctionSamples::ProfileIsFS, llvm::sampleprof::SampleProfileReader::ProfileIsFS, ProfileIsFSDisciminator, readFuncProfile(), and llvm::success.

◆ readMagicIdent()

std::error_code SampleProfileReaderBinary::readMagicIdent ( )

protected

Read the contents of Magic number and Version number.

Definition at line 1397 of file SampleProfReader.cpp.

References llvm::sampleprof::SPVersion(), llvm::success, and llvm::unsupported_version.

Referenced by readHeader(), and llvm::sampleprof::SampleProfileReaderExtBinaryBase::readHeader().

◆ readNameTable()

std::error_code SampleProfileReaderBinary::readNameTable ( )

protectedvirtual

Read the whole name table.

Definition at line 1068 of file SampleProfReader.cpp.

References I, Name, NameTable, readString(), Size, and llvm::success.

Referenced by readHeader(), and llvm::sampleprof::SampleProfileReaderExtBinaryBase::readNameTableSec().

◆ readNumber()

template<typename T >

ErrorOr< T > SampleProfileReaderBinary::readNumber

protected

Read a numeric value of type T from the profile.

If an error occurs during decoding, a diagnostic message is emitted and EC is set.

Returns: the read value.

Definition at line 468 of file SampleProfReader.cpp.

References Data, llvm::decodeULEB128(), End, llvm::malformed, llvm::sampleprof::SampleProfileReader::reportError(), llvm::success, and llvm::truncated.

◆ readProfile()

std::error_code SampleProfileReaderBinary::readProfile ( FunctionSamples & FProfile )

protected

Read the contents of the given profile instance.

Definition at line 580 of file SampleProfReader.cpp.

References llvm::sampleprof::FunctionSamples::addBodySamples(), llvm::sampleprof::FunctionSamples::addCalledTargetSamples(), llvm::sampleprof::FunctionSamples::addTotalSamples(), llvm::sampleprof::FunctionSamples::functionSamplesAt(), llvm::sampleprof::SampleProfileReader::getDiscriminatorMask(), I, isOffsetLegal(), readProfile(), readStringFromTable(), llvm::sampleprof::FunctionSamples::setName(), and llvm::success.

Referenced by readFuncProfile(), and readProfile().

◆ readSampleContextFromTable()

ErrorOr< SampleContext > SampleProfileReaderBinary::readSampleContextFromTable ( )

protectedvirtual

Reimplemented in llvm::sampleprof::SampleProfileReaderExtBinaryBase.

Definition at line 536 of file SampleProfReader.cpp.

References readStringFromTable().

Referenced by readFuncProfile().

◆ readString()

ErrorOr< StringRef > SampleProfileReaderBinary::readString ( )

protected

Read a string from the profile.

If an error occurs during decoding, a diagnostic message is emitted and EC is set.

Returns: the read value.

Definition at line 489 of file SampleProfReader.cpp.

References Data, End, llvm::sampleprof::SampleProfileReader::reportError(), and llvm::truncated.

Referenced by readNameTable().

◆ readStringFromTable()

ErrorOr< StringRef > SampleProfileReaderBinary::readStringFromTable ( )

protectedvirtual

Read a string indirectly via the name table.

Reimplemented in llvm::sampleprof::SampleProfileReaderExtBinaryBase.

Definition at line 528 of file SampleProfReader.cpp.

References Idx, NameTable, and readStringIndex().

Referenced by readProfile(), readSampleContextFromTable(), and llvm::sampleprof::SampleProfileReaderExtBinaryBase::readStringFromTable().

◆ readStringIndex()

template<typename T >

ErrorOr< uint32_t > SampleProfileReaderBinary::readStringIndex ( T & Table )

inlineprotected

Read the string index and check whether it overflows the table.

Definition at line 518 of file SampleProfReader.cpp.

References Idx, and llvm::truncated_name_table.

Referenced by readStringFromTable(), and llvm::sampleprof::SampleProfileReaderExtBinaryBase::readStringFromTable().

◆ readSummary()

std::error_code SampleProfileReaderBinary::readSummary ( )

protected

Read profile summary.

Definition at line 1496 of file SampleProfReader.cpp.

References llvm::ProfileSummary::PSK_Sample, llvm::success, and llvm::sampleprof::SampleProfileReader::Summary.

Referenced by readHeader(), and llvm::sampleprof::SampleProfileReaderExtBinaryBase::readOneSection().

◆ readUnencodedNumber()

template<typename T >

ErrorOr< T > SampleProfileReaderBinary::readUnencodedNumber

protected

Read a numeric value of type T from the profile.

The value is saved without encoded.

Definition at line 503 of file SampleProfReader.cpp.

References Data, End, llvm::sampleprof::SampleProfileReader::reportError(), and llvm::truncated.

Member Data Documentation

◆ Data

const uint8_t* llvm::sampleprof::SampleProfileReaderBinary::Data = nullptr

protected

Points to the current location in the buffer.

Definition at line 647 of file SampleProfReader.h.

◆ End

const uint8_t* llvm::sampleprof::SampleProfileReaderBinary::End = nullptr

protected

Points to the end of the buffer.

Definition at line 650 of file SampleProfReader.h.

Referenced by at_eof(), llvm::sampleprof::SampleProfileReaderExtBinaryBase::readFuncMetadata(), llvm::sampleprof::SampleProfileReaderExtBinaryBase::readFuncProfiles(), readHeader(), llvm::sampleprof::SampleProfileReaderExtBinaryBase::readHeader(), llvm::sampleprof::SampleProfileReaderExtBinaryBase::readImpl(), readNumber(), llvm::sampleprof::SampleProfileReaderExtBinaryBase::readOneSection(), llvm::sampleprof::SampleProfileReaderExtBinaryBase::readProfileSymbolList(), readString(), and readUnencodedNumber().

◆ NameTable

std::vector<StringRef> llvm::sampleprof::SampleProfileReaderBinary::NameTable

protected

Function name table.

Definition at line 653 of file SampleProfReader.h.

Referenced by getNameTable(), llvm::sampleprof::SampleProfileReaderExtBinaryBase::readMD5NameTable(), readNameTable(), readStringFromTable(), and llvm::sampleprof::SampleProfileReaderExtBinaryBase::readStringFromTable().

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

include/llvm/ProfileData/SampleProfReader.h
lib/ProfileData/SampleProfReader.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SampleProfileReaderBinary()

Member Function Documentation

◆ at_eof()

◆ getNameTable()

◆ readFuncProfile()

◆ readHeader()

◆ readImpl()

◆ readMagicIdent()

◆ readNameTable()

◆ readNumber()

◆ readProfile()

◆ readSampleContextFromTable()

◆ readString()

◆ readStringFromTable()

◆ readStringIndex()

◆ readSummary()

◆ readUnencodedNumber()

Member Data Documentation

◆ Data

◆ End

◆ NameTable