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

#include "llvm/ProfileData/SampleProfReader.h"

Inheritance diagram for llvm::sampleprof::SampleProfileReaderExtBinaryBase:

[legend]

Collaboration diagram for llvm::sampleprof::SampleProfileReaderExtBinaryBase:

[legend]

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

std::error_code	readImpl () override
	Read sample profiles in extensible format from the associated file. More...

uint64_t	getSectionSize (SecType Type)
	Get the total size of all `Type` sections. More...

uint64_t	getFileSize ()
	Get the total size of header and all sections. More...

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

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

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

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

virtual	~SampleProfileReader ()=default

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

void	dumpFunctionProfile (StringRef FName, raw_ostream &OS=dbgs())
	Print the profile for `FName` on stream `OS`. More...

virtual void	collectFuncsFrom (const Module &M)

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

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

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

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

StringMap< FunctionSamples > &	getProfiles ()
	Return all the profiles. More...

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

ProfileSummary &	getSummary () const
	Return the profile summary. More...

MemoryBuffer *	getBuffer () const

SampleProfileFormat	getFormat () const
	Return the profile format. More...

virtual std::unique_ptr< ProfileSymbolList >	getProfileSymbolList ()

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

Protected Member Functions
std::error_code	readSecHdrTableEntry ()

std::error_code	readSecHdrTable ()

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

virtual std::error_code	verifySPMagic (uint64_t Magic) override=0

virtual std::error_code	readOneSection (const uint8_t *Start, uint64_t Size, const SecHdrTableEntry &Entry)=0

Protected Member Functions inherited from llvm::sampleprof::SampleProfileReaderBinary
template<typename T >
ErrorOr< T >	readNumber ()
	Read a numeric value of type T from the profile. More...

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

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

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

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

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

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

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

std::error_code	readSummary ()
	Read profile summary. More...

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

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

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

Protected Attributes
std::vector< SecHdrTableEntry >	SecHdrTable

std::unique_ptr< ProfileSymbolList >	ProfSymList

Protected Attributes inherited from llvm::sampleprof::SampleProfileReaderBinary
const uint8_t *	Data = nullptr
	Points to the current location in the buffer. More...

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

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

Protected Attributes inherited from llvm::sampleprof::SampleProfileReader
StringMap< FunctionSamples >	Profiles
	Map every function to its associated profile. More...

LLVMContext &	Ctx
	LLVM context used to emit diagnostics. More...

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

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

std::unique_ptr< SampleProfileReaderItaniumRemapper >	Remapper

SampleProfileFormat	Format = SPF_None
	The format of sample. More...

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, const std::string RemapFilename="")
	Create a sample profile reader appropriate to the file format. More...

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

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. More...

Detailed Description

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

The format is organized in sections except the magic and version number at the beginning. There is a section table before all the sections, and each entry in the table describes the entry type, start, size and attributes. The format in each section is defined by the section itself.

It is easy to add a new section while maintaining the backward compatibility of the profile. Nothing extra needs to be done. If we want to extend an existing section, like add cache misses information in addition to the sample count in the profile body, we can add a new section with the extension and retire the existing section, and we could choose to keep the parser of the old section if we want the reader to be able to read both new and old format profile.

SampleProfileReaderExtBinary/SampleProfileWriterExtBinary define the commonly used sections of a profile in extensible binary format. It is possible to define other types of profile inherited from SampleProfileReaderExtBinaryBase/SampleProfileWriterExtBinaryBase.

Definition at line 580 of file SampleProfReader.h.

Constructor & Destructor Documentation

◆ SampleProfileReaderExtBinaryBase()

llvm::sampleprof::SampleProfileReaderExtBinaryBase::SampleProfileReaderExtBinaryBase	(	std::unique_ptr< MemoryBuffer >	B,
		LLVMContext &	C,
		SampleProfileFormat	Format
	)

inline

Definition at line 600 of file SampleProfReader.h.

References llvm::dbgs().

Member Function Documentation

◆ dumpSectionInfo()

bool SampleProfileReaderExtBinaryBase::dumpSectionInfo ( raw_ostream & OS = dbgs() )

overridevirtual

Reimplemented from llvm::sampleprof::SampleProfileReader.

Definition at line 863 of file SampleProfReader.cpp.

References assert(), getSecFlagsStr(), llvm::sampleprof::getSecName(), llvm::BTF::HeaderSize, llvm::sampleprof::SecHdrTableEntry::Offset, llvm::sampleprof::SecHdrTableEntry::Size, and llvm::sampleprof::SecHdrTableEntry::Type.

◆ getFileSize()

uint64_t SampleProfileReaderExtBinaryBase::getFileSize ( )

Get the total size of header and all sections.

Definition at line 823 of file SampleProfReader.cpp.

References llvm::max(), llvm::sampleprof::SecHdrTableEntry::Offset, and llvm::sampleprof::SecHdrTableEntry::Size.

◆ getSectionSize()

uint64_t SampleProfileReaderExtBinaryBase::getSectionSize ( SecType Type )

Get the total size of all Type sections.

Definition at line 815 of file SampleProfReader.cpp.

References llvm::sampleprof::SecHdrTableEntry::Size, and llvm::sampleprof::SecHdrTableEntry::Type.

◆ readHeader()

std::error_code SampleProfileReaderExtBinaryBase::readHeader ( )

overrideprotectedvirtual

Read and validate the file header.

Reimplemented from llvm::sampleprof::SampleProfileReaderBinary.

Definition at line 800 of file SampleProfReader.cpp.

References llvm::sampleprof::SampleProfileReader::Buffer, and llvm::Data.

◆ readImpl()

std::error_code SampleProfileReaderExtBinaryBase::readImpl ( )

overridevirtual

Read sample profiles in extensible format from the associated file.

Reimplemented from llvm::sampleprof::SampleProfileReaderBinary.

Definition at line 619 of file SampleProfReader.cpp.

References llvm::sampleprof::SampleProfileReader::Buffer, llvm::Data, llvm::sampleprof::hasSecFlag(), llvm::malformed, llvm::sampleprof::SecHdrTableEntry::Offset, llvm::sampleprof::SecFlagCompress, and llvm::sampleprof::SecHdrTableEntry::Size.

◆ readOneSection()

virtual std::error_code llvm::sampleprof::SampleProfileReaderExtBinaryBase::readOneSection	(	const uint8_t *	Start,
		uint64_t	Size,
		const SecHdrTableEntry &	Entry
	)

protectedpure virtual

◆ readSecHdrTable()

std::error_code SampleProfileReaderExtBinaryBase::readSecHdrTable ( )

protected

Definition at line 788 of file SampleProfReader.cpp.

References llvm::success.

◆ readSecHdrTableEntry()

std::error_code SampleProfileReaderExtBinaryBase::readSecHdrTableEntry ( )

protected

Definition at line 762 of file SampleProfReader.cpp.

◆ verifySPMagic()

virtual std::error_code llvm::sampleprof::SampleProfileReaderExtBinaryBase::verifySPMagic ( uint64_t Magic )

overrideprotectedpure virtual

Implements llvm::sampleprof::SampleProfileReaderBinary.

Member Data Documentation

◆ ProfSymList

std::unique_ptr<ProfileSymbolList> llvm::sampleprof::SampleProfileReaderExtBinaryBase::ProfSymList

protected

Definition at line 591 of file SampleProfReader.h.

◆ SecHdrTable

std::vector<SecHdrTableEntry> llvm::sampleprof::SampleProfileReaderExtBinaryBase::SecHdrTable

protected

Definition at line 590 of file SampleProfReader.h.

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

◆ SampleProfileReaderExtBinaryBase()

Member Function Documentation

◆ dumpSectionInfo()

◆ getFileSize()

◆ getSectionSize()

◆ readHeader()

◆ readImpl()

◆ readOneSection()

◆ readSecHdrTable()

◆ readSecHdrTableEntry()

◆ verifySPMagic()

Member Data Documentation

◆ ProfSymList

◆ SecHdrTable