14#ifndef LLVM_PROFILEDATA_INSTRPROFREADER_H
15#define LLVM_PROFILEDATA_INSTRPROFREADER_H
49template <
class record_type = NamedInstrProfRecord,
50 class reader_type = InstrProfReader>
60 reader_type *Reader =
nullptr;
80 return Reader ==
RHS.Reader;
83 return Reader !=
RHS.Reader;
93 std::string LastErrorMsg;
170 LastErrorMsg = ErrMsg;
173 return make_error<InstrProfError>(Err, ErrMsg);
178 LastError = IPE.
get();
181 return make_error<InstrProfError>(LastError, LastErrorMsg);
197 return make_error<InstrProfError>(LastError, LastErrorMsg);
208 create(std::unique_ptr<MemoryBuffer> Buffer,
237 std::unique_ptr<MemoryBuffer> DataBuffer;
245 Error readTemporalProfTraceData();
249 : DataBuffer(
std::
move(DataBuffer_)), Line(*DataBuffer,
true,
'#') {}
268 return static_cast<bool>(ProfileKind &
310template <
class IntPtrT>
314 std::unique_ptr<MemoryBuffer> DataBuffer;
319 std::vector<std::pair<uint64_t, uint64_t>> TemporalProfTimestamps;
320 bool ShouldSwapBytes;
330 const char *CountersStart;
331 const char *CountersEnd;
332 const char *BitmapStart;
333 const char *BitmapEnd;
334 const char *NamesStart;
335 const char *NamesEnd;
338 const uint8_t *ValueDataStart;
345 const uint8_t *BinaryIdsStart;
350 : DataBuffer(
std::
move(DataBuffer)),
365 return (Version & VARIANT_MASK_IR_PROF) != 0;
369 return (Version & VARIANT_MASK_CSIR_PROF) != 0;
373 return (Version & VARIANT_MASK_INSTR_ENTRY) != 0;
377 return (Version & VARIANT_MASK_DBG_CORRELATE) != 0;
381 return (Version & VARIANT_MASK_BYTE_COVERAGE) != 0;
385 return (Version & VARIANT_MASK_FUNCTION_ENTRY_ONLY) != 0;
390 assert(!(Version & VARIANT_MASK_MEMPROF));
395 return (Version & VARIANT_MASK_TEMPORAL_PROF) != 0;
410 Error createSymtab(InstrProfSymtab &
Symtab);
411 Error readNextHeader(
const char *CurrentPos);
412 Error
readHeader(
const RawInstrProf::Header &Header);
414 template <
class IntT> IntT swap(IntT
Int)
const {
420 if (!ShouldSwapBytes)
428 inline uint8_t getNumPaddingBytes(
uint64_t SizeInBytes) {
432 Error readName(NamedInstrProfRecord &Record);
433 Error readFuncHash(NamedInstrProfRecord &Record);
434 Error readRawCounts(InstrProfRecord &Record);
435 Error readRawBitmapBytes(InstrProfRecord &Record);
436 Error readValueProfilingData(InstrProfRecord &Record);
437 bool atEnd()
const {
return Data == DataEnd; }
447 CountersDelta -=
sizeof(*Data);
448 BitmapDelta -=
sizeof(*Data);
451 ValueDataStart += CurValueDataSize;
454 const char *getNextHeaderPos()
const {
456 return (
const char *)ValueDataStart;
459 StringRef getName(
uint64_t NameRef)
const {
460 return Symtab->getFuncName(swap(NameRef));
463 int getCounterTypeSize()
const {
471namespace IndexedInstrProf {
480 std::vector<NamedInstrProfRecord> DataBuffer;
482 unsigned FormatVersion;
490 : HashType(HashType), FormatVersion(FormatVersion) {}
505 static std::pair<offset_type, offset_type>
507 using namespace support;
509 offset_type KeyLen = endian::readNext<offset_type, little, unaligned>(
D);
510 offset_type DataLen = endian::readNext<offset_type, little, unaligned>(
D);
511 return std::make_pair(KeyLen, DataLen);
519 const unsigned char *
const End);
524 ValueProfDataEndianness = Endianness;
561template <
typename HashTableImpl>
564template <
typename HashTableImpl>
567 std::unique_ptr<HashTableImpl> HashTable;
568 typename HashTableImpl::data_iterator RecordIterator;
575 const unsigned char *
const Payload,
576 const unsigned char *
const Base,
586 return RecordIterator == HashTable->data_end();
590 HashTable->getInfoObj().setValueProfDataEndianness(Endianness);
596 return (FormatVersion & VARIANT_MASK_IR_PROF) != 0;
600 return (FormatVersion & VARIANT_MASK_CSIR_PROF) != 0;
604 return (FormatVersion & VARIANT_MASK_INSTR_ENTRY) != 0;
608 return (FormatVersion & VARIANT_MASK_BYTE_COVERAGE) != 0;
612 return (FormatVersion & VARIANT_MASK_FUNCTION_ENTRY_ONLY) != 0;
616 return (FormatVersion & VARIANT_MASK_MEMPROF) != 0;
620 return (FormatVersion & VARIANT_MASK_TEMPORAL_PROF) != 0;
626 return Symtab.
create(HashTable->keys());
643 std::unique_ptr<MemoryBuffer> DataBuffer;
645 std::unique_ptr<MemoryBuffer> RemappingBuffer;
647 std::unique_ptr<InstrProfReaderIndexBase>
Index;
649 std::unique_ptr<InstrProfReaderRemapper> Remapper;
651 std::unique_ptr<ProfileSummary> Summary;
653 std::unique_ptr<ProfileSummary> CS_Summary;
657 std::unique_ptr<MemProfRecordHashTable> MemProfRecordTable;
659 std::unique_ptr<MemProfFrameHashTable> MemProfFrameTable;
663 const uint8_t *BinaryIdsStart =
nullptr;
666 unsigned RecordIndex;
672 const unsigned char *Cur,
bool UseCS);
676 std::unique_ptr<MemoryBuffer> DataBuffer,
677 std::unique_ptr<MemoryBuffer> RemappingBuffer =
nullptr)
678 : DataBuffer(
std::
move(DataBuffer)),
679 RemappingBuffer(
std::
move(RemappingBuffer)), RecordIndex(0) {}
687 return Index->hasCSIRLevelProfile();
691 return Index->instrEntryBBEnabled();
695 return Index->hasSingleByteCoverage();
703 return Index->hasTemporalProfile();
709 return Index->getProfileKind();
730 uint64_t *MismatchedFuncSum =
nullptr);
738 std::vector<uint64_t> &Counts);
742 std::vector<uint8_t> &BitmapBytes);
748 assert(CS_Summary &&
"No context sensitive profile summary");
749 return CS_Summary->getMaxFunctionCount();
751 assert(Summary &&
"No profile summary");
752 return Summary->getMaxFunctionCount();
759 const Twine &RemappingPath =
"");
762 create(std::unique_ptr<MemoryBuffer> Buffer,
763 std::unique_ptr<MemoryBuffer> RemappingBuffer =
nullptr);
767 Index->setValueProfDataEndianness(Endianness);
779 assert(CS_Summary &&
"No context sensitive summary");
782 assert(Summary &&
"No profile summary");
This file declares a library for handling Build IDs and using them to find debug info.
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
InstrProfLookupTrait::offset_type offset_type
InstrProfLookupTrait::data_type data_type
Defines facilities for reading and writing on-disk hash tables.
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Lightweight error class with error context and mandatory checking.
static ErrorSuccess success()
Create a success value.
Tagged union holding either a T or a Error.
Reader for the indexed binary instrprof format.
uint64_t getVersion() const override
Return the profile version.
Error readNextRecord(NamedInstrProfRecord &Record) override
Read a single record.
static Expected< std::unique_ptr< IndexedInstrProfReader > > create(const Twine &Path, vfs::FileSystem &FS, const Twine &RemappingPath="")
Factory method to create an indexed reader.
IndexedInstrProfReader(const IndexedInstrProfReader &)=delete
Expected< memprof::MemProfRecord > getMemProfRecord(uint64_t FuncNameHash)
Return the memprof record for the function identified by llvm::md5(Name).
Error readHeader() override
Read the file header.
Error printBinaryIds(raw_ostream &OS) override
Print binary ids.
bool hasTemporalProfile() const override
Return true if this has a temporal profile.
void setValueProfDataEndianness(support::endianness Endianness)
bool hasSingleByteCoverage() const override
Return true if the profile has single byte counters representing coverage.
InstrProfSymtab & getSymtab() override
Return the PGO symtab.
ProfileSummary & getSummary(bool UseCS)
Return the profile summary.
static bool hasFormat(const MemoryBuffer &DataBuffer)
Return true if the given buffer is in an indexed instrprof format.
Expected< InstrProfRecord > getInstrProfRecord(StringRef FuncName, uint64_t FuncHash, StringRef DeprecatedFuncName="", uint64_t *MismatchedFuncSum=nullptr)
Return the NamedInstrProfRecord associated with FuncName and FuncHash.
bool hasMemoryProfile() const override
Return true if profile includes a memory profile.
bool functionEntryOnly() const override
Return true if the profile only instruments function entries.
uint64_t getMaximumFunctionCount(bool UseCS)
Return the maximum of all known function counts.
Error getFunctionCounts(StringRef FuncName, uint64_t FuncHash, std::vector< uint64_t > &Counts)
Fill Counts with the profile data for the given function name.
Error getFunctionBitmapBytes(StringRef FuncName, uint64_t FuncHash, std::vector< uint8_t > &BitmapBytes)
Fill Bitmap Bytes with the profile data for the given function name.
InstrProfKind getProfileKind() const override
Returns a BitsetEnum describing the attributes of the indexed instr profile.
IndexedInstrProfReader(std::unique_ptr< MemoryBuffer > DataBuffer, std::unique_ptr< MemoryBuffer > RemappingBuffer=nullptr)
Error readBinaryIds(std::vector< llvm::object::BuildID > &BinaryIds) override
Read a list of binary ids.
bool hasCSIRLevelProfile() const override
IndexedInstrProfReader & operator=(const IndexedInstrProfReader &)=delete
bool instrEntryBBEnabled() const override
bool isIRLevelProfile() const override
InstrProfCorrelatorImpl - A child of InstrProfCorrelator with a template pointer type so that the Pro...
InstrProfCorrelator - A base class used to create raw instrumentation data to their functions.
static std::pair< instrprof_error, std::string > take(Error E)
Consume an Error and return the raw enum value contained within it, and the optional error message.
const std::string & getMessage() const
instrprof_error get() const
A file format agnostic iterator over profiling data.
bool operator==(const InstrProfIterator &RHS) const
InstrProfIterator(reader_type *Reader)
InstrProfIterator & operator++()
bool operator!=(const InstrProfIterator &RHS) const
value_type * operator->()
std::ptrdiff_t difference_type
std::input_iterator_tag iterator_category
InstrProfIterator()=default
Trait for lookups into the on-disk hash table for the binary instrprof format.
InstrProfLookupTrait(IndexedInstrProf::HashT HashType, unsigned FormatVersion)
void setValueProfDataEndianness(support::endianness Endianness)
StringRef ReadKey(const unsigned char *D, offset_type N)
static std::pair< offset_type, offset_type > ReadKeyDataLength(const unsigned char *&D)
static StringRef GetExternalKey(StringRef K)
data_type ReadData(StringRef K, const unsigned char *D, offset_type N)
bool readValueProfilingData(const unsigned char *&D, const unsigned char *const End)
hash_value_type ComputeHash(StringRef K)
static bool EqualKey(StringRef A, StringRef B)
static StringRef GetInternalKey(StringRef K)
Error populateSymtab(InstrProfSymtab &Symtab) override
bool hasSingleByteCoverage() const override
void advanceToNextKey() override
bool hasCSIRLevelProfile() const override
InstrProfKind getProfileKind() const override
Error getRecords(ArrayRef< NamedInstrProfRecord > &Data) override
bool functionEntryOnly() const override
~InstrProfReaderIndex() override=default
uint64_t getVersion() const override
bool isIRLevelProfile() const override
bool hasMemoryProfile() const override
bool hasTemporalProfile() const override
bool instrEntryBBEnabled() const override
void setValueProfDataEndianness(support::endianness Endianness) override
bool atEnd() const override
A remapper that applies remappings based on a symbol remapping file.
Name matcher supporting fuzzy matching of symbol names to names in profiles.
virtual Error getRecords(StringRef FuncName, ArrayRef< NamedInstrProfRecord > &Data)=0
virtual ~InstrProfReaderRemapper()=default
virtual Error populateRemappings()
Base class and interface for reading profiling data of any known instrprof format.
InstrProfIterator begin()
Iterator over profile data.
virtual bool instrEntryBBEnabled() const =0
virtual Error readNextRecord(NamedInstrProfRecord &Record)=0
Read a single record.
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.
virtual Error readBinaryIds(std::vector< llvm::object::BuildID > &BinaryIds)
Read a list of binary ids.
virtual bool functionEntryOnly() const =0
Return true if the profile only instruments function entries.
std::unique_ptr< InstrProfSymtab > Symtab
Error getError()
Get the current error.
virtual InstrProfSymtab & getSymtab()=0
Return the PGO symtab.
InstrProfReader()=default
virtual bool hasSingleByteCoverage() const =0
Return true if the profile has single byte counters representing coverage.
virtual bool hasTemporalProfile() const =0
Return true if this has a temporal profile.
Error success()
Clear the current error and return a successful one.
bool hasError()
Return true if the reader encountered an error reading profiling data.
virtual InstrProfKind getProfileKind() const =0
Returns a BitsetEnum describing the attributes of the profile.
SmallVector< TemporalProfTraceTy > TemporalProfTraces
A list of temporal profile traces.
uint64_t TemporalProfTraceStreamSize
The total number of temporal profile traces seen.
virtual Error printBinaryIds(raw_ostream &OS)
Print binary ids.
virtual bool useDebugInfoCorrelate() const
Return true if we must provide debug info to create PGO profiles.
uint64_t getTemporalProfTraceStreamSize()
virtual uint64_t getVersion() const =0
Return the profile version.
virtual bool hasMemoryProfile() const =0
Return true if profile includes a memory profile.
virtual SmallVector< TemporalProfTraceTy > & getTemporalProfTraces(std::optional< uint64_t > Weight={})
virtual bool hasCSIRLevelProfile() const =0
virtual bool isIRLevelProfile() const =0
virtual ~InstrProfReader()=default
virtual Error readHeader()=0
Read the header. Required before reading first record.
Error error(instrprof_error Err, const std::string &ErrMsg="")
Set the current error and return same.
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.
A symbol table used for function PGO name look-up with keys (such as pointers, md5hash values) to the...
Error create(object::SectionRef &Section)
Create InstrProfSymtab from an object file section which contains function PGO names.
This interface provides simple read-only access to a block of memory, and provides simple methods for...
Provides lookup and iteration over an on disk hash table.
Reader for the raw instrprof binary format from runtime.
bool functionEntryOnly() const override
Return true if the profile only instruments function entries.
Error readHeader() override
Read the header. Required before reading first record.
Error readNextRecord(NamedInstrProfRecord &Record) override
Read a single record.
Error printBinaryIds(raw_ostream &OS) override
Print binary ids.
static bool hasFormat(const MemoryBuffer &DataBuffer)
RawInstrProfReader & operator=(const RawInstrProfReader &)=delete
bool hasSingleByteCoverage() const override
Return true if the profile has single byte counters representing coverage.
bool useDebugInfoCorrelate() const override
Return true if we must provide debug info to create PGO profiles.
bool isIRLevelProfile() const override
InstrProfKind getProfileKind() const override
Returns a BitsetEnum describing the attributes of the raw instr profile.
bool hasMemoryProfile() const override
Return true if profile includes a memory profile.
InstrProfSymtab & getSymtab() override
Return the PGO symtab.
Error readBinaryIds(std::vector< llvm::object::BuildID > &BinaryIds) override
Read a list of binary ids.
bool hasTemporalProfile() const override
Return true if this has a temporal profile.
bool instrEntryBBEnabled() const override
RawInstrProfReader(std::unique_ptr< MemoryBuffer > DataBuffer, const InstrProfCorrelator *Correlator)
uint64_t getVersion() const override
Return the profile version.
SmallVector< TemporalProfTraceTy > & getTemporalProfTraces(std::optional< uint64_t > Weight={}) override
RawInstrProfReader(const RawInstrProfReader &)=delete
bool hasCSIRLevelProfile() const override
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StringRef - Represent a constant reference to a string, i.e.
Reader for the simple text based instrprof format.
bool isIRLevelProfile() const override
uint64_t getVersion() const override
Return the profile version.
static bool hasFormat(const MemoryBuffer &Buffer)
Return true if the given buffer is in text instrprof format.
TextInstrProfReader(std::unique_ptr< MemoryBuffer > DataBuffer_)
bool hasSingleByteCoverage() const override
Return true if the profile has single byte counters representing coverage.
Error readNextRecord(NamedInstrProfRecord &Record) override
Read a single record.
TextInstrProfReader(const TextInstrProfReader &)=delete
bool hasMemoryProfile() const override
Return true if profile includes a memory profile.
bool hasCSIRLevelProfile() const override
InstrProfSymtab & getSymtab() override
Return the PGO symtab.
bool instrEntryBBEnabled() const override
bool functionEntryOnly() const override
Return true if the profile only instruments function entries.
InstrProfKind getProfileKind() const override
Returns a BitsetEnum describing the attributes of the profile.
bool hasTemporalProfile() const override
Return true if this has a temporal profile.
Error readHeader() override
Read the header.
TextInstrProfReader & operator=(const TextInstrProfReader &)=delete
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
A forward iterator which reads text lines from a buffer.
This class implements an extremely fast bulk output stream that can only output to a stream.
The virtual file system interface.
unsigned char getSwappedBytes(unsigned char C)
This is an optimization pass for GlobalISel generic memory operations.
void handleAllErrors(Error E, HandlerTs &&... Handlers)
Behaves the same as handleErrors, except that by contract all errors must be handled by the given han...
auto dyn_cast_or_null(const Y &Val)
support::endianness getHostEndianness()
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
InstrProfKind
An enum describing the attributes of an instrumented profile.
@ FunctionEntryInstrumentation
Implement std::hash so that hash_code can be used in STL containers.
virtual Error populateSymtab(InstrProfSymtab &)=0
virtual Error getRecords(ArrayRef< NamedInstrProfRecord > &Data)=0
virtual ~InstrProfReaderIndexBase()=default
virtual InstrProfKind getProfileKind() const =0
virtual bool hasTemporalProfile() const =0
virtual bool isIRLevelProfile() const =0
virtual void advanceToNextKey()=0
virtual bool hasMemoryProfile() const =0
virtual bool hasCSIRLevelProfile() const =0
virtual uint64_t getVersion() const =0
virtual bool atEnd() const =0
virtual bool instrEntryBBEnabled() const =0
virtual Error getRecords(StringRef FuncName, ArrayRef< NamedInstrProfRecord > &Data)=0
virtual void setValueProfDataEndianness(support::endianness Endianness)=0
virtual bool functionEntryOnly() const =0
virtual bool hasSingleByteCoverage() const =0
Profiling information for a single function.