LLVM 19.0.0git
Public Types | Public Member Functions | Static Public Member Functions | List of all members
llvm::InstrProfWriter Class Reference

#include "llvm/ProfileData/InstrProfWriter.h"

Public Types

using ProfilingData = SmallDenseMap< uint64_t, InstrProfRecord >
 

Public Member Functions

 InstrProfWriter (bool Sparse=false, uint64_t TemporalProfTraceReservoirSize=0, uint64_t MaxTemporalProfTraceLength=0)
 
 ~InstrProfWriter ()
 
StringMap< ProfilingData > & getProfileData ()
 
void addRecord (NamedInstrProfRecord &&I, uint64_t Weight, function_ref< void(Error)> Warn)
 Add function counts for the given function.
 
void addRecord (NamedInstrProfRecord &&I, function_ref< void(Error)> Warn)
 
void addTemporalProfileTraces (SmallVectorImpl< TemporalProfTraceTy > &SrcTraces, uint64_t SrcStreamSize)
 Add SrcTraces using reservoir sampling where SrcStreamSize is the total number of temporal profiling traces the source has seen.
 
void addMemProfRecord (const GlobalValue::GUID Id, const memprof::IndexedMemProfRecord &Record)
 Add a memprof record for a function identified by its Id.
 
bool addMemProfFrame (const memprof::FrameId, const memprof::Frame &F, function_ref< void(Error)> Warn)
 Add a memprof frame identified by the hash of the contents of the frame in FrameId.
 
void addBinaryIds (ArrayRef< llvm::object::BuildID > BIs)
 
void mergeRecordsFromWriter (InstrProfWriter &&IPW, function_ref< void(Error)> Warn)
 Merge existing function counts from the given writer.
 
Error write (raw_fd_ostream &OS)
 Write the profile to OS.
 
Error write (raw_string_ostream &OS)
 Write the profile to a string output stream OS.
 
Error writeText (raw_fd_ostream &OS)
 Write the profile in text format to OS.
 
void writeTextTemporalProfTraceData (raw_fd_ostream &OS, InstrProfSymtab &Symtab)
 Write temporal profile trace data to the header in text format to OS.
 
Error validateRecord (const InstrProfRecord &Func)
 
std::unique_ptr< MemoryBufferwriteBuffer ()
 Write the profile, returning the raw data. For testing.
 
Error mergeProfileKind (const InstrProfKind Other)
 Update the attributes of the current profile from the attributes specified.
 
InstrProfKind getProfileKind () const
 
void setValueProfDataEndianness (llvm::endianness Endianness)
 
void setOutputSparse (bool Sparse)
 
void overlapRecord (NamedInstrProfRecord &&Other, OverlapStats &Overlap, OverlapStats &FuncLevelOverlap, const OverlapFuncFilters &FuncFilter)
 

Static Public Member Functions

static void writeRecordInText (StringRef Name, uint64_t Hash, const InstrProfRecord &Counters, InstrProfSymtab &Symtab, raw_fd_ostream &OS)
 Write Record in text format to OS.
 

Detailed Description

Definition at line 37 of file InstrProfWriter.h.

Member Typedef Documentation

◆ ProfilingData

Definition at line 39 of file InstrProfWriter.h.

Constructor & Destructor Documentation

◆ InstrProfWriter()

InstrProfWriter::InstrProfWriter ( bool  Sparse = false,
uint64_t  TemporalProfTraceReservoirSize = 0,
uint64_t  MaxTemporalProfTraceLength = 0 
)

Definition at line 182 of file InstrProfWriter.cpp.

◆ ~InstrProfWriter()

InstrProfWriter::~InstrProfWriter ( )

Definition at line 189 of file InstrProfWriter.cpp.

Member Function Documentation

◆ addBinaryIds()

void InstrProfWriter::addBinaryIds ( ArrayRef< llvm::object::BuildID BIs)

Definition at line 295 of file InstrProfWriter.cpp.

References llvm::append_range().

Referenced by mergeRecordsFromWriter().

◆ addMemProfFrame()

bool InstrProfWriter::addMemProfFrame ( const memprof::FrameId  Id,
const memprof::Frame F,
function_ref< void(Error)>  Warn 
)

Add a memprof frame identified by the hash of the contents of the frame in FrameId.

Definition at line 279 of file InstrProfWriter.cpp.

References llvm::malformed.

Referenced by mergeRecordsFromWriter().

◆ addMemProfRecord()

void InstrProfWriter::addMemProfRecord ( const GlobalValue::GUID  Id,
const memprof::IndexedMemProfRecord Record 
)

Add a memprof record for a function identified by its Id.

Definition at line 268 of file InstrProfWriter.cpp.

References llvm::memprof::IndexedMemProfRecord::merge().

Referenced by mergeRecordsFromWriter().

◆ addRecord() [1/2]

void llvm::InstrProfWriter::addRecord ( NamedInstrProfRecord &&  I,
function_ref< void(Error)>  Warn 
)
inline

Definition at line 84 of file InstrProfWriter.h.

References addRecord(), and I.

◆ addRecord() [2/2]

void InstrProfWriter::addRecord ( NamedInstrProfRecord &&  I,
uint64_t  Weight,
function_ref< void(Error)>  Warn 
)

Add function counts for the given function.

If there are already counts for this function and the hash and number of counts match, each counter is summed. Optionally scale counts by Weight.

Definition at line 200 of file InstrProfWriter.cpp.

References addRecord(), I, and Name.

Referenced by addRecord(), and mergeRecordsFromWriter().

◆ addTemporalProfileTraces()

void InstrProfWriter::addTemporalProfileTraces ( SmallVectorImpl< TemporalProfTraceTy > &  SrcTraces,
uint64_t  SrcStreamSize 
)

Add SrcTraces using reservoir sampling where SrcStreamSize is the total number of temporal profiling traces the source has seen.

Definition at line 319 of file InstrProfWriter.cpp.

References llvm::SmallVectorTemplateCommon< T, typename >::begin(), llvm::SmallVectorTemplateCommon< T, typename >::end(), I, llvm::SetVector< T, Vector, Set, N >::insert(), llvm::shuffle(), std::swap(), and llvm::zip().

Referenced by mergeRecordsFromWriter().

◆ getProfileData()

StringMap< ProfilingData > & llvm::InstrProfWriter::getProfileData ( )
inline

Definition at line 77 of file InstrProfWriter.h.

◆ getProfileKind()

InstrProfKind llvm::InstrProfWriter::getProfileKind ( ) const
inline

Definition at line 169 of file InstrProfWriter.h.

◆ mergeProfileKind()

Error llvm::InstrProfWriter::mergeProfileKind ( const InstrProfKind  Other)
inline

Update the attributes of the current profile from the attributes specified.

An error is returned if IR and FE profiles are mixed.

Definition at line 134 of file InstrProfWriter.h.

References A, B, llvm::FrontendInstrumentation, llvm::FunctionEntryInstrumentation, llvm::FunctionEntryOnly, llvm::Other, llvm::Error::success(), llvm::Unknown, and llvm::unsupported_version.

◆ mergeRecordsFromWriter()

void InstrProfWriter::mergeRecordsFromWriter ( InstrProfWriter &&  IPW,
function_ref< void(Error)>  Warn 
)

Merge existing function counts from the given writer.

Definition at line 355 of file InstrProfWriter.cpp.

References addBinaryIds(), addMemProfFrame(), addMemProfRecord(), addRecord(), addTemporalProfileTraces(), and I.

◆ overlapRecord()

void InstrProfWriter::overlapRecord ( NamedInstrProfRecord &&  Other,
OverlapStats Overlap,
OverlapStats FuncLevelOverlap,
const OverlapFuncFilters FuncFilter 
)

◆ setOutputSparse()

void InstrProfWriter::setOutputSparse ( bool  Sparse)

Definition at line 196 of file InstrProfWriter.cpp.

◆ setValueProfDataEndianness()

void InstrProfWriter::setValueProfDataEndianness ( llvm::endianness  Endianness)

◆ validateRecord()

Error InstrProfWriter::validateRecord ( const InstrProfRecord Func)

◆ write() [1/2]

Error InstrProfWriter::write ( raw_fd_ostream OS)

Write the profile to OS.

Definition at line 666 of file InstrProfWriter.cpp.

References OS.

Referenced by writeBuffer().

◆ write() [2/2]

Error InstrProfWriter::write ( raw_string_ostream OS)

Write the profile to a string output stream OS.

Definition at line 672 of file InstrProfWriter.cpp.

References OS.

◆ writeBuffer()

std::unique_ptr< MemoryBuffer > InstrProfWriter::writeBuffer ( )

Write the profile, returning the raw data. For testing.

Definition at line 677 of file InstrProfWriter.cpp.

References llvm::Data, E, llvm::MemoryBuffer::getMemBufferCopy(), OS, and write().

◆ writeRecordInText()

void InstrProfWriter::writeRecordInText ( StringRef  Name,
uint64_t  Hash,
const InstrProfRecord Counters,
InstrProfSymtab Symtab,
raw_fd_ostream OS 
)
static

Write Record in text format to OS.

Definition at line 710 of file InstrProfWriter.cpp.

References llvm::InstrProfSymtab::getFuncOrVarNameIfDefined(), I, Name, OS, ValueProfKindStr, and llvm::raw_ostream::write_hex().

Referenced by writeText().

◆ writeText()

Error InstrProfWriter::writeText ( raw_fd_ostream OS)

◆ writeTextTemporalProfTraceData()

void InstrProfWriter::writeTextTemporalProfTraceData ( raw_fd_ostream OS,
InstrProfSymtab Symtab 
)

Write temporal profile trace data to the header in text format to OS.

Definition at line 812 of file InstrProfWriter.cpp.

References llvm::InstrProfSymtab::getFuncOrVarName(), OS, and llvm::Trace::size().

Referenced by writeText().


The documentation for this class was generated from the following files: