LLVM 17.0.0git
|
Reader for the indexed binary instrprof format. More...
#include "llvm/ProfileData/InstrProfReader.h"
Public Member Functions | |
IndexedInstrProfReader (std::unique_ptr< MemoryBuffer > DataBuffer, std::unique_ptr< MemoryBuffer > RemappingBuffer=nullptr) | |
IndexedInstrProfReader (const IndexedInstrProfReader &)=delete | |
IndexedInstrProfReader & | operator= (const IndexedInstrProfReader &)=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 indexed instr profile. | |
Error | readHeader () override |
Read the file header. | |
Error | readNextRecord (NamedInstrProfRecord &Record) override |
Read a single record. | |
Expected< InstrProfRecord > | getInstrProfRecord (StringRef FuncName, uint64_t FuncHash, uint64_t *MismatchedFuncSum=nullptr) |
Return the NamedInstrProfRecord associated with FuncName and FuncHash. | |
Expected< memprof::MemProfRecord > | getMemProfRecord (uint64_t FuncNameHash) |
Return the memprof record for the function identified by llvm::md5(Name). | |
Error | getFunctionCounts (StringRef FuncName, uint64_t FuncHash, std::vector< uint64_t > &Counts) |
Fill Counts with the profile data for the given function name. | |
uint64_t | getMaximumFunctionCount (bool UseCS) |
Return the maximum of all known function counts. | |
void | setValueProfDataEndianness (support::endianness Endianness) |
InstrProfSymtab & | getSymtab () override |
Return the PGO symtab. | |
ProfileSummary & | getSummary (bool UseCS) |
Return the profile summary. | |
Error | readBinaryIds (std::vector< llvm::object::BuildID > &BinaryIds) override |
Read a list of binary ids. | |
Error | printBinaryIds (raw_ostream &OS) override |
Print binary ids. | |
![]() | |
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 &DataBuffer) |
Return true if the given buffer is in an indexed instrprof format. | |
static Expected< std::unique_ptr< IndexedInstrProfReader > > | create (const Twine &Path, vfs::FileSystem &FS, const Twine &RemappingPath="") |
Factory method to create an indexed reader. | |
static Expected< std::unique_ptr< IndexedInstrProfReader > > | create (std::unique_ptr< MemoryBuffer > Buffer, std::unique_ptr< MemoryBuffer > RemappingBuffer=nullptr) |
![]() | |
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 | |
![]() | |
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. | |
![]() | |
std::unique_ptr< InstrProfSymtab > | Symtab |
Reader for the indexed binary instrprof format.
Definition at line 594 of file InstrProfReader.h.
|
inline |
Definition at line 629 of file InstrProfReader.h.
|
delete |
|
static |
Factory method to create an indexed reader.
Definition at line 201 of file InstrProfReader.cpp.
References create(), E, setupMemoryBuffer(), and llvm::Twine::str().
Referenced by annotateAllFunctions(), create(), and llvm::coverage::CoverageMapping::load().
|
static |
Definition at line 223 of file InstrProfReader.cpp.
References llvm::bad_magic, E, hasFormat(), and initializeReader().
|
inlineoverridevirtual |
Return true if the profile only instruments function entries.
Implements llvm::InstrProfReader.
Definition at line 652 of file InstrProfReader.h.
Error IndexedInstrProfReader::getFunctionCounts | ( | StringRef | FuncName, |
uint64_t | FuncHash, | ||
std::vector< uint64_t > & | Counts | ||
) |
Fill Counts with the profile data for the given function name.
Definition at line 1174 of file InstrProfReader.cpp.
References E, error, getInstrProfRecord(), and llvm::InstrProfReader::success().
Expected< InstrProfRecord > IndexedInstrProfReader::getInstrProfRecord | ( | StringRef | FuncName, |
uint64_t | FuncHash, | ||
uint64_t * | MismatchedFuncSum = nullptr |
||
) |
Return the NamedInstrProfRecord associated with FuncName and FuncHash.
When return a hash_mismatch error and MismatchedFuncSum is not nullptr, the sum of all counters in the mismatched function will be set to MismatchedFuncSum. If there are multiple instances of mismatched functions, MismatchedFuncSum returns the maximum.
Definition at line 1092 of file InstrProfReader.cpp.
References llvm::Data, error, llvm::NamedInstrProfRecord::hasCSFlagInHash(), llvm::hash_mismatch, I, and llvm::unknown_function.
Referenced by getFunctionCounts().
Return the maximum of all known function counts.
UseCS
indicates whether to use the context-sensitive count.
Definition at line 689 of file InstrProfReader.h.
References assert().
Expected< memprof::MemProfRecord > IndexedInstrProfReader::getMemProfRecord | ( | uint64_t | FuncNameHash | ) |
Return the memprof record for the function identified by llvm::md5(Name).
Definition at line 1138 of file InstrProfReader.cpp.
References llvm::hash_mismatch, llvm::invalid_prof, and llvm::unknown_function.
|
inlineoverridevirtual |
Returns a BitsetEnum describing the attributes of the indexed instr profile.
Implements llvm::InstrProfReader.
Definition at line 658 of file InstrProfReader.h.
|
inline |
Return the profile summary.
UseCS
indicates whether to use the context-sensitive summary.
Definition at line 720 of file InstrProfReader.h.
References assert().
|
overridevirtual |
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 1079 of file InstrProfReader.cpp.
References llvm::consumeError(), E, error, llvm::InstrProfReader::Symtab, and llvm::InstrProfError::take().
|
inlineoverridevirtual |
Return the profile version.
Implements llvm::InstrProfReader.
Definition at line 638 of file InstrProfReader.h.
|
inlineoverridevirtual |
Implements llvm::InstrProfReader.
Definition at line 640 of file InstrProfReader.h.
|
static |
Return true if the given buffer is in an indexed instrprof format.
Definition at line 910 of file InstrProfReader.cpp.
References llvm::MemoryBuffer::getBufferSize(), llvm::MemoryBuffer::getBufferStart(), and llvm::IndexedInstrProf::Magic.
Referenced by llvm::InstrProfReader::create(), and create().
|
inlineoverridevirtual |
Return true if profile includes a memory profile.
Implements llvm::InstrProfReader.
Definition at line 654 of file InstrProfReader.h.
|
inlineoverridevirtual |
Return true if the profile has single byte counters representing coverage.
Implements llvm::InstrProfReader.
Definition at line 648 of file InstrProfReader.h.
|
inlineoverridevirtual |
Implements llvm::InstrProfReader.
Definition at line 644 of file InstrProfReader.h.
|
inlineoverridevirtual |
Implements llvm::InstrProfReader.
Definition at line 639 of file InstrProfReader.h.
|
delete |
|
overridevirtual |
Print binary ids.
Reimplemented from llvm::InstrProfReader.
Definition at line 1206 of file InstrProfReader.cpp.
References llvm::support::little, OS, and printBinaryIdsInternal().
|
overridevirtual |
Read a list of binary ids.
Reimplemented from llvm::InstrProfReader.
Definition at line 1200 of file InstrProfReader.cpp.
References llvm::support::little, and readBinaryIdsInternal().
Referenced by llvm::coverage::CoverageMapping::load().
|
overridevirtual |
Read the file header.
Implements llvm::InstrProfReader.
Definition at line 975 of file InstrProfReader.cpp.
References llvm::bad_header, llvm::OnDiskIterableChainedHashTable< Info >::Create(), E, error, llvm::IndexedInstrProf::Last, llvm::malformed, Ptr, llvm::IndexedInstrProf::Header::readFromBuffer(), llvm::memprof::readMemProfSchema(), llvm::InstrProfReader::success(), llvm::truncated, and llvm::unsupported_hash_type.
|
overridevirtual |
Read a single record.
Implements llvm::InstrProfReader.
Definition at line 1185 of file InstrProfReader.cpp.
References llvm::Data, E, error, and llvm::InstrProfReader::success().
|
inline |
Definition at line 709 of file InstrProfReader.h.