Reader for the raw instrprof binary format from runtime. More...

#include "llvm/ProfileData/InstrProfReader.h"

Inheritance diagram for llvm::RawInstrProfReader< IntPtrT >:

Public Member Functions
	RawInstrProfReader (std::unique_ptr< MemoryBuffer > DataBuffer, const InstrProfCorrelator Correlator, const object::BuildIDFetcher BIDFetcher, const InstrProfCorrelator::ProfCorrelatorKind BIDFetcherCorrelatorKind, std::function< void(Error)> Warn)

	RawInstrProfReader (const RawInstrProfReader &)=delete

RawInstrProfReader &	operator= (const RawInstrProfReader &)=delete

Error	readHeader () override
	Read the header. Required before reading first record.

Error	readNextRecord (NamedInstrProfRecord &Record) override
	Read a single record.

Error	readBinaryIds (std::vector< llvm::object::BuildID > &BinaryIds) override
	Read a list of binary ids.

Error	printBinaryIds (raw_ostream &OS) override
	Print binary ids.

uint64_t	getVersion () const override
	Return the profile version.

bool	isIRLevelProfile () const override

bool	hasCSIRLevelProfile () const override

bool	instrEntryBBEnabled () const override

bool	instrLoopEntriesEnabled () const override
	Return true if the profile instruments all loop entries.

bool	hasSingleByteCoverage () const override
	Return true if the profile has single byte counters representing coverage.

bool	functionEntryOnly () const override
	Return true if the profile only instruments function entries.

bool	hasMemoryProfile () const override
	Return true if profile includes a memory profile.

bool	hasTemporalProfile () const override
	Return true if this has a temporal profile.

InstrProfKind	getProfileKind () const override
	Returns a BitsetEnum describing the attributes of the raw instr profile.

InstrProfSymtab &	getSymtab () override
	Return the PGO symtab.

SmallVector< TemporalProfTraceTy > &	getTemporalProfTraces (std::optional< uint64_t > Weight={}) override

Public Member Functions inherited from llvm::InstrProfReader
	InstrProfReader ()=default

virtual	~InstrProfReader ()=default

virtual Error	readHeader ()=0
	Read the header. Required before reading first record.

virtual Error	readNextRecord (NamedInstrProfRecord &Record)=0
	Read a single record.

virtual Error	readBinaryIds (std::vector< llvm::object::BuildID > &BinaryIds)
	Read a list of binary ids.

virtual Error	printBinaryIds (raw_ostream &OS)
	Print binary ids.

InstrProfIterator	begin ()
	Iterator over profile data.

InstrProfIterator	end ()

virtual uint64_t	getVersion () const =0
	Return the profile version.

virtual bool	isIRLevelProfile () const =0

virtual bool	hasCSIRLevelProfile () const =0

virtual bool	instrEntryBBEnabled () const =0

virtual bool	instrLoopEntriesEnabled () const =0
	Return true if the profile instruments all loop entries.

virtual bool	hasSingleByteCoverage () const =0
	Return true if the profile has single byte counters representing coverage.

virtual bool	functionEntryOnly () const =0
	Return true if the profile only instruments function entries.

virtual bool	hasMemoryProfile () const =0
	Return true if profile includes a memory profile.

virtual bool	hasTemporalProfile () const =0
	Return true if this has a temporal profile.

virtual InstrProfKind	getProfileKind () const =0
	Returns a BitsetEnum describing the attributes of the profile.

virtual InstrProfSymtab &	getSymtab ()=0
	Return the PGO symtab.

void	accumulateCounts (CountSumOrPercent &Sum, bool IsCS)
	Compute the sum of counts and return in Sum.

bool	isEOF ()
	Return true if the reader has finished reading the profile data.

bool	hasError ()
	Return true if the reader encountered an error reading profiling data.

Error	getError ()
	Get the current error.

virtual SmallVector< TemporalProfTraceTy > &	getTemporalProfTraces (std::optional< uint64_t > Weight={})

uint64_t	getTemporalProfTraceStreamSize ()

Static Public Member Functions
static bool	hasFormat (const MemoryBuffer &DataBuffer)

Static Public Member Functions inherited from llvm::InstrProfReader
static Expected< std::unique_ptr< InstrProfReader > >	create (const Twine &Path, vfs::FileSystem &FS, const InstrProfCorrelator Correlator=nullptr, const object::BuildIDFetcher BIDFetcher=nullptr, const InstrProfCorrelator::ProfCorrelatorKind BIDFetcherCorrelatorKind=InstrProfCorrelator::ProfCorrelatorKind::NONE, std::function< void(Error)> Warn=nullptr)
	Factory method to create an appropriately typed reader for the given instrprof file.

static Expected< std::unique_ptr< InstrProfReader > >	create (std::unique_ptr< MemoryBuffer > Buffer, const InstrProfCorrelator Correlator=nullptr, const object::BuildIDFetcher BIDFetcher=nullptr, const InstrProfCorrelator::ProfCorrelatorKind BIDFetcherCorrelatorKind=InstrProfCorrelator::ProfCorrelatorKind::NONE, std::function< void(Error)> Warn=nullptr)

Additional Inherited Members
Protected Member Functions inherited from llvm::InstrProfReader
Error	error (instrprof_error Err, const std::string &ErrMsg="")
	Set the current error and return same.

Error	error (Error &&E)

Error	success ()
	Clear the current error and return a successful one.

Protected Attributes inherited from llvm::InstrProfReader
std::unique_ptr< InstrProfSymtab >	Symtab

SmallVector< TemporalProfTraceTy >	TemporalProfTraces
	A list of temporal profile traces.

uint64_t	TemporalProfTraceStreamSize = 0
	The total number of temporal profile traces seen.

Detailed Description

template<class IntPtrT>
class llvm::RawInstrProfReader< IntPtrT >

Reader for the raw instrprof binary format from runtime.

This format is a raw memory dump of the instrumentation-based profiling data from the runtime. It has no index.

Templated on the unsigned type whose size matches pointers on the platform that wrote the profile.

Definition at line 325 of file InstrProfReader.h.

Constructor & Destructor Documentation

◆ RawInstrProfReader() [1/2]

template<class IntPtrT >

llvm::RawInstrProfReader< IntPtrT >::RawInstrProfReader	(	std::unique_ptr< MemoryBuffer >	DataBuffer,
		const InstrProfCorrelator *	Correlator,
		const object::BuildIDFetcher *	BIDFetcher,
		const InstrProfCorrelator::ProfCorrelatorKind	BIDFetcherCorrelatorKind,
		std::function< void(Error)>	Warn
	)

inline

Definition at line 375 of file InstrProfReader.h.

◆ RawInstrProfReader() [2/2]

template<class IntPtrT >

llvm::RawInstrProfReader< IntPtrT >::RawInstrProfReader ( const RawInstrProfReader< IntPtrT > & )

delete

Member Function Documentation

◆ functionEntryOnly()

template<class IntPtrT >

bool llvm::RawInstrProfReader< IntPtrT >::functionEntryOnly ( ) const

inlineoverridevirtual

Return true if the profile only instruments function entries.

Implements llvm::InstrProfReader.

Definition at line 418 of file InstrProfReader.h.

◆ getProfileKind()

template<class IntPtrT >

InstrProfKind RawInstrProfReader::getProfileKind

overridevirtual

Returns a BitsetEnum describing the attributes of the raw instr profile.

Implements llvm::InstrProfReader.

Definition at line 477 of file InstrProfReader.cpp.

References getProfileKindFromVersion(), and llvm::Version.

◆ getSymtab()

template<class IntPtrT >

InstrProfSymtab & llvm::RawInstrProfReader< IntPtrT >::getSymtab ( )

inlineoverridevirtual

Return the PGO symtab.

There are three different readers: Raw, Text, and Indexed profile readers. The first two types of readers are used only by llvm-profdata tool, while the indexed profile reader is also used by llvm-cov tool and the compiler ( backend or frontend). Since creating PGO symtab can create significant runtime and memory overhead (as it touches data for the whole program), InstrProfSymtab for the indexed profile reader should be created on demand and it is recommended to be only used for dumping purpose with llvm-proftool, not with the compiler.

Implements llvm::InstrProfReader.

Definition at line 435 of file InstrProfReader.h.

References assert(), and llvm::InstrProfReader::Symtab.