LLVM
15.0.0git
|
Reader for the raw instrprof binary format from runtime. More...
#include "llvm/ProfileData/InstrProfReader.h"
Public Member Functions | |
RawInstrProfReader (std::unique_ptr< MemoryBuffer > DataBuffer, const InstrProfCorrelator *Correlator) | |
RawInstrProfReader (const RawInstrProfReader &)=delete | |
RawInstrProfReader & | operator= (const RawInstrProfReader &)=delete |
Error | readHeader () override |
Read the header. Required before reading first record. More... | |
Error | readNextRecord (NamedInstrProfRecord &Record) override |
Read a single record. More... | |
Error | printBinaryIds (raw_ostream &OS) override |
Print binary ids on stream OS. More... | |
bool | isIRLevelProfile () const override |
bool | hasCSIRLevelProfile () const override |
bool | instrEntryBBEnabled () const override |
bool | useDebugInfoCorrelate () const override |
Return true if we must provide debug info to create PGO profiles. More... | |
bool | hasSingleByteCoverage () const override |
Return true if the profile has single byte counters representing coverage. More... | |
bool | functionEntryOnly () const override |
Return true if the profile only instruments function entries. More... | |
InstrProfKind | getProfileKind () const override |
Returns a BitsetEnum describing the attributes of the raw instr profile. More... | |
InstrProfSymtab & | getSymtab () override |
Return the PGO symtab. More... | |
![]() | |
InstrProfReader ()=default | |
virtual | ~InstrProfReader ()=default |
InstrProfIterator | begin () |
Iterator over profile data. More... | |
InstrProfIterator | end () |
void | accumulateCounts (CountSumOrPercent &Sum, bool IsCS) |
Compute the sum of counts and return in Sum. More... | |
bool | isEOF () |
Return true if the reader has finished reading the profile data. More... | |
bool | hasError () |
Return true if the reader encountered an error reading profiling data. More... | |
Error | getError () |
Get the current error. More... | |
Static Public Member Functions | |
static bool | hasFormat (const MemoryBuffer &DataBuffer) |
![]() | |
static Expected< std::unique_ptr< InstrProfReader > > | create (const Twine &Path, const InstrProfCorrelator *Correlator=nullptr) |
Factory method to create an appropriately typed reader for the given instrprof file. More... | |
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. More... | |
Error | error (Error &&E) |
Error | success () |
Clear the current error and return a successful one. More... | |
![]() | |
std::unique_ptr< InstrProfSymtab > | Symtab |
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 258 of file InstrProfReader.h.
|
inline |
Definition at line 288 of file InstrProfReader.h.
|
delete |
|
inlineoverridevirtual |
Return true if the profile only instruments function entries.
Implements llvm::InstrProfReader.
Definition at line 321 of file InstrProfReader.h.
|
overridevirtual |
Returns a BitsetEnum describing the attributes of the raw instr profile.
Implements llvm::InstrProfReader.
Definition at line 317 of file InstrProfReader.cpp.
References getProfileKindFromVersion(), and llvm::IndexedInstrProf::Version.
|
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 328 of file InstrProfReader.h.
References assert(), and llvm::InstrProfReader::Symtab.
|
inlineoverridevirtual |
Implements llvm::InstrProfReader.
Definition at line 305 of file InstrProfReader.h.
|
static |
Definition at line 322 of file InstrProfReader.cpp.
References llvm::MemoryBuffer::getBufferSize(), llvm::MemoryBuffer::getBufferStart(), llvm::sys::getSwappedBytes(), and llvm::msf::Magic.
Referenced by llvm::InstrProfReader::create().
|
inlineoverridevirtual |
Return true if the profile has single byte counters representing coverage.
Implements llvm::InstrProfReader.
Definition at line 317 of file InstrProfReader.h.
|
inlineoverridevirtual |
Implements llvm::InstrProfReader.
Definition at line 309 of file InstrProfReader.h.
|
inlineoverridevirtual |
Implements llvm::InstrProfReader.
Definition at line 301 of file InstrProfReader.h.
|
delete |
|
overridevirtual |
Print binary ids on stream OS.
Reimplemented from llvm::InstrProfReader.
Definition at line 579 of file InstrProfReader.cpp.
References llvm::format(), I, llvm::malformed, RoundUp(), and std::swap().
|
overridevirtual |
Read the header. Required before reading first record.
Implements llvm::InstrProfReader.
Definition at line 332 of file InstrProfReader.cpp.
References llvm::bad_header, llvm::bad_magic, and error.
|
overridevirtual |
Read a single record.
Implements llvm::InstrProfReader.
Definition at line 547 of file InstrProfReader.cpp.
|
inlineoverridevirtual |
Return true if we must provide debug info to create PGO profiles.
Reimplemented from llvm::InstrProfReader.
Definition at line 313 of file InstrProfReader.h.