Reader for the simple text based instrprof format. More...

#include "llvm/ProfileData/InstrProfReader.h"

Inheritance diagram for llvm::TextInstrProfReader:

Collaboration diagram for llvm::TextInstrProfReader:

Public Member Functions
	TextInstrProfReader (std::unique_ptr< MemoryBuffer > DataBuffer_)

	TextInstrProfReader (const TextInstrProfReader &)=delete

TextInstrProfReader &	operator= (const TextInstrProfReader &)=delete

uint64_t	getVersion () const override
	Return the profile version.

bool	isIRLevelProfile () const override

bool	hasCSIRLevelProfile () const override

bool	instrEntryBBEnabled () const override

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.

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

Error	readHeader () override
	Read the header.

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

InstrProfSymtab &	getSymtab () override
	Return the PGO symtab.

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	useDebugInfoCorrelate () const
	Return true if we must provide debug info to create PGO profiles.

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

Static Public Member Functions
static bool	hasFormat (const MemoryBuffer &Buffer)
	Return true if the given buffer is in text instrprof format.

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

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

Detailed Description

Reader for the simple text based instrprof format.

This format is a simple text format that's suitable for test data. Records are separated by one or more blank lines, and record fields are separated by new lines.

Each record consists of a function name, a function hash, a number of counters, and then each counter value, in that order.

Definition at line 213 of file InstrProfReader.h.

Constructor & Destructor Documentation

◆ TextInstrProfReader() [1/2]

llvm::TextInstrProfReader::TextInstrProfReader ( std::unique_ptr< MemoryBuffer > DataBuffer_ )

inline

Definition at line 225 of file InstrProfReader.h.

◆ TextInstrProfReader() [2/2]

llvm::TextInstrProfReader::TextInstrProfReader ( const TextInstrProfReader & )

delete

Member Function Documentation

◆ functionEntryOnly()

bool llvm::TextInstrProfReader::functionEntryOnly ( ) const

inlineoverridevirtual

Return true if the profile only instruments function entries.

Implements llvm::InstrProfReader.

Definition at line 253 of file InstrProfReader.h.

References llvm::FunctionEntryOnly.

◆ getProfileKind()

InstrProfKind llvm::TextInstrProfReader::getProfileKind ( ) const

inlineoverridevirtual

Returns a BitsetEnum describing the attributes of the profile.

To check individual attributes prefer using the helpers above.

Implements llvm::InstrProfReader.

Definition at line 262 of file InstrProfReader.h.

◆ getSymtab()

InstrProfSymtab & llvm::TextInstrProfReader::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 270 of file InstrProfReader.h.

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