#include "llvm/ProfileData/SampleProfReader.h"

Inheritance diagram for llvm::sampleprof::SampleProfileReaderBinary:

Collaboration diagram for llvm::sampleprof::SampleProfileReaderBinary:

[legend]

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

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

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

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

virtual	~SampleProfileReader ()=default

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

virtual void	collectFuncsToUse (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...

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 ()
	Return the profile summary. More...

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

Protected Member Functions
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 ()
	Read the next function profile instance. More...

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

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

Protected Attributes
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...

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

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 Twine &Filename, LLVMContext &C)
	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)
	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

Definition at line 374 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 376 of file SampleProfReader.h.

References llvm::sampleprof::SampleProfileReader::read(), llvm::sampleprof::SampleProfileReader::readHeader(), and readString().

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 411 of file SampleProfReader.h.

References llvm::Data.

◆ read()

std::error_code SampleProfileReaderBinary::read ( )

overridevirtual

Read sample profiles from the associated file.

Implements llvm::sampleprof::SampleProfileReader.

Reimplemented in llvm::sampleprof::SampleProfileReaderCompactBinary.

Definition at line 462 of file SampleProfReader.cpp.

References llvm::success.

◆ readFuncProfile()

std::error_code SampleProfileReaderBinary::readFuncProfile ( )

protected

Read the next function profile instance.

Definition at line 442 of file SampleProfReader.cpp.

References llvm::sampleprof::FunctionSamples::addHeadSamples(), llvm::sampleprof::SampleProfileReader::Profiles, llvm::sampleprof::FunctionSamples::setName(), and llvm::success.

◆ readHeader()

std::error_code SampleProfileReaderBinary::readHeader ( )

overridevirtual

Read and validate the file header.

Implements llvm::sampleprof::SampleProfileReader.

Definition at line 529 of file SampleProfReader.cpp.

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

◆ 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 289 of file SampleProfReader.cpp.

References llvm::Data, llvm::decodeULEB128(), llvm::malformed, and llvm::max().

◆ readProfile()

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

protected

Read the contents of the given profile instance.

Definition at line 366 of file SampleProfReader.cpp.

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

◆ 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 310 of file SampleProfReader.cpp.

References llvm::Data, and llvm::StringRef::size().

◆ 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 339 of file SampleProfReader.cpp.

References llvm::truncated_name_table.

◆ 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 324 of file SampleProfReader.cpp.

References llvm::Data.

Member Data Documentation

◆ Data

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

protected

Points to the current location in the buffer.

Definition at line 420 of file SampleProfReader.h.

◆ End

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

protected

Points to the end of the buffer.

Definition at line 423 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

◆ SampleProfileReaderBinary()

Member Function Documentation

◆ at_eof()

◆ read()

◆ readFuncProfile()

◆ readHeader()

◆ readNumber()

◆ readProfile()

◆ readString()

◆ readStringIndex()

◆ readUnencodedNumber()

Member Data Documentation

◆ Data

◆ End