LLVM 17.0.0git
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
llvm::sampleprof::SampleProfileWriterBinary Class Reference

Sample-based profile writer (binary format). More...

#include "llvm/ProfileData/SampleProfWriter.h"

Inheritance diagram for llvm::sampleprof::SampleProfileWriterBinary:
Inheritance graph
[legend]
Collaboration diagram for llvm::sampleprof::SampleProfileWriterBinary:
Collaboration graph
[legend]

Public Member Functions

 SampleProfileWriterBinary (std::unique_ptr< raw_ostream > &OS)
 
std::error_code writeSample (const FunctionSamples &S) override
 Write samples of a top-level function to a binary file.
 
- Public Member Functions inherited from llvm::sampleprof::SampleProfileWriter
virtual ~SampleProfileWriter ()=default
 
virtual std::error_code writeSample (const FunctionSamples &S)=0
 Write sample profiles in S.
 
virtual std::error_code write (const SampleProfileMap &ProfileMap)
 Write all the sample profiles in the given map of samples.
 
raw_ostream & getOutputStream ()
 
virtual void setProfileSymbolList (ProfileSymbolList *PSL)
 
virtual void setToCompressAllSections ()
 
virtual void setUseMD5 ()
 
virtual void setPartialProfile ()
 
virtual void resetSecLayout (SectionLayout SL)
 

Protected Member Functions

virtual MapVector< StringRef, uint32_t > & getNameTable ()
 
virtual std::error_code writeMagicIdent (SampleProfileFormat Format)
 
virtual std::error_code writeNameTable ()
 
std::error_code writeHeader (const SampleProfileMap &ProfileMap) override
 Write a file header for the profile file.
 
std::error_code writeSummary ()
 
virtual std::error_code writeContextIdx (const SampleContext &Context)
 
std::error_code writeNameIdx (StringRef FName)
 
std::error_code writeBody (const FunctionSamples &S)
 
void stablizeNameTable (MapVector< StringRef, uint32_t > &NameTable, std::set< StringRef > &V)
 
void addName (StringRef FName)
 
virtual void addContext (const SampleContext &Context)
 
void addNames (const FunctionSamples &S)
 
- Protected Member Functions inherited from llvm::sampleprof::SampleProfileWriter
 SampleProfileWriter (std::unique_ptr< raw_ostream > &OS)
 
virtual std::error_code writeHeader (const SampleProfileMap &ProfileMap)=0
 Write a file header for the profile file.
 
virtual std::error_code writeFuncProfiles (const SampleProfileMap &ProfileMap)
 
void computeSummary (const SampleProfileMap &ProfileMap)
 Compute summary for this profile.
 

Protected Attributes

MapVector< StringRef, uint32_t > NameTable
 
- Protected Attributes inherited from llvm::sampleprof::SampleProfileWriter
std::unique_ptr< raw_ostream > OutputStream
 Output stream where to emit the profile to.
 
std::unique_ptr< ProfileSummary > Summary
 Profile summary.
 
SampleProfileFormat Format = SPF_None
 Profile format.
 

Friends

ErrorOr< std::unique_ptr< SampleProfileWriter > > SampleProfileWriter::create (std::unique_ptr< raw_ostream > &OS, SampleProfileFormat Format)
 

Additional Inherited Members

- Static Public Member Functions inherited from llvm::sampleprof::SampleProfileWriter
static ErrorOr< std::unique_ptr< SampleProfileWriter > > create (StringRef Filename, SampleProfileFormat Format)
 Profile writer factory.
 
static ErrorOr< std::unique_ptr< SampleProfileWriter > > create (std::unique_ptr< raw_ostream > &OS, SampleProfileFormat Format)
 Create a new stream writer based on the value of Format.
 

Detailed Description

Sample-based profile writer (binary format).

Definition at line 120 of file SampleProfWriter.h.

Constructor & Destructor Documentation

◆ SampleProfileWriterBinary()

llvm::sampleprof::SampleProfileWriterBinary::SampleProfileWriterBinary ( std::unique_ptr< raw_ostream > &  OS)
inline

Definition at line 122 of file SampleProfWriter.h.

Member Function Documentation

◆ addContext()

void SampleProfileWriterBinary::addContext ( const SampleContext &  Context)
protectedvirtual

Reimplemented in llvm::sampleprof::SampleProfileWriterExtBinaryBase.

Definition at line 548 of file SampleProfWriter.cpp.

References addName(), and Context.

Referenced by writeHeader().

◆ addName()

void SampleProfileWriterBinary::addName ( StringRef  FName)
protected

Definition at line 543 of file SampleProfWriter.cpp.

References getNameTable().

Referenced by addContext(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::addContext(), and addNames().

◆ addNames()

void SampleProfileWriterBinary::addNames ( const FunctionSamples &  S)
protected

Definition at line 552 of file SampleProfWriter.cpp.

References addName(), addNames(), llvm::sampleprof::FunctionSamples::getBodySamples(), llvm::sampleprof::FunctionSamples::getCallsiteSamples(), llvm::sampleprof::SampleRecord::getCallTargets(), llvm::sampleprof::FunctionSamples::getName(), and I.

Referenced by addNames(), writeHeader(), and llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeNameTableSection().

◆ getNameTable()

virtual MapVector< StringRef, uint32_t > & llvm::sampleprof::SampleProfileWriterBinary::getNameTable ( )
inlineprotectedvirtual

Definition at line 128 of file SampleProfWriter.h.

References NameTable.

Referenced by addName(), and writeNameIdx().

◆ stablizeNameTable()

void SampleProfileWriterBinary::stablizeNameTable ( MapVector< StringRef, uint32_t > &  NameTable,
std::set< StringRef > &  V 
)
inlineprotected

Definition at line 580 of file SampleProfWriter.cpp.

References I, N, and NameTable.

Referenced by writeNameTable(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeNameTable(), and llvm::sampleprof::SampleProfileWriterCompactBinary::writeNameTable().

◆ writeBody()

std::error_code SampleProfileWriterBinary::writeBody ( const FunctionSamples &  S)
protected

Definition at line 775 of file SampleProfWriter.cpp.

References Callee, llvm::sampleprof::LineLocation::Discriminator, llvm::encodeULEB128(), llvm::sampleprof::FunctionSamples::getBodySamples(), llvm::sampleprof::FunctionSamples::getCallsiteSamples(), llvm::sampleprof::SampleRecord::getCallTargets(), llvm::sampleprof::FunctionSamples::getContext(), llvm::sampleprof::SampleRecord::getSamples(), llvm::sampleprof::SampleRecord::getSortedCallTargets(), llvm::sampleprof::FunctionSamples::getTotalSamples(), I, llvm::sampleprof::LineLocation::LineOffset, llvm::sampleprof::SampleProfileWriter::OutputStream, llvm::StringMapImpl::size(), llvm::success, writeBody(), writeContextIdx(), and writeNameIdx().

Referenced by writeBody(), writeSample(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeSample(), and llvm::sampleprof::SampleProfileWriterCompactBinary::writeSample().

◆ writeContextIdx()

std::error_code SampleProfileWriterBinary::writeContextIdx ( const SampleContext &  Context)
protectedvirtual

Reimplemented in llvm::sampleprof::SampleProfileWriterExtBinaryBase.

Definition at line 529 of file SampleProfWriter.cpp.

References assert(), Context, and writeNameIdx().

Referenced by writeBody().

◆ writeHeader()

std::error_code SampleProfileWriterBinary::writeHeader ( const SampleProfileMap &  ProfileMap)
overrideprotectedvirtual

Write a file header for the profile file.

Implements llvm::sampleprof::SampleProfileWriter.

Reimplemented in llvm::sampleprof::SampleProfileWriterCompactBinary.

Definition at line 652 of file SampleProfWriter.cpp.

References addContext(), addNames(), assert(), llvm::sampleprof::SampleProfileWriter::computeSummary(), llvm::sampleprof::SampleProfileWriter::Format, I, llvm::success, writeMagicIdent(), writeNameTable(), and writeSummary().

Referenced by llvm::sampleprof::SampleProfileWriterCompactBinary::writeHeader().

◆ writeMagicIdent()

std::error_code SampleProfileWriterBinary::writeMagicIdent ( SampleProfileFormat  Format)
protectedvirtual

Definition at line 643 of file SampleProfWriter.cpp.

References llvm::encodeULEB128(), llvm::sampleprof::SampleProfileWriter::Format, llvm::sampleprof::SampleProfileWriter::OutputStream, llvm::sampleprof::SPMagic(), llvm::sampleprof::SPVersion(), and llvm::success.

Referenced by writeHeader().

◆ writeNameIdx()

std::error_code SampleProfileWriterBinary::writeNameIdx ( StringRef  FName)
protected

Definition at line 534 of file SampleProfWriter.cpp.

References llvm::encodeULEB128(), getNameTable(), llvm::sampleprof::SampleProfileWriter::OutputStream, llvm::success, and llvm::truncated_name_table.

Referenced by writeBody(), writeContextIdx(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeContextIdx(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeCSNameTableSection(), and llvm::sampleprof::SampleProfileWriterCompactBinary::writeFuncOffsetTable().

◆ writeNameTable()

std::error_code SampleProfileWriterBinary::writeNameTable ( )
protectedvirtual

Reimplemented in llvm::sampleprof::SampleProfileWriterExtBinaryBase, and llvm::sampleprof::SampleProfileWriterCompactBinary.

Definition at line 590 of file SampleProfWriter.cpp.

References llvm::encodeULEB128(), N, NameTable, llvm::sampleprof::SampleProfileWriter::OutputStream, stablizeNameTable(), and llvm::success.

Referenced by writeHeader(), and llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeNameTable().

◆ writeSample()

std::error_code SampleProfileWriterBinary::writeSample ( const FunctionSamples &  S)
overridevirtual

Write samples of a top-level function to a binary file.

Returns
true if the samples were written successfully, false otherwise.

Implements llvm::sampleprof::SampleProfileWriter.

Reimplemented in llvm::sampleprof::SampleProfileWriterExtBinaryBase, and llvm::sampleprof::SampleProfileWriterCompactBinary.

Definition at line 822 of file SampleProfWriter.cpp.

References llvm::encodeULEB128(), llvm::sampleprof::FunctionSamples::getHeadSamples(), llvm::sampleprof::SampleProfileWriter::OutputStream, and writeBody().

◆ writeSummary()

std::error_code SampleProfileWriterBinary::writeSummary ( )
protected

Definition at line 758 of file SampleProfWriter.cpp.

References llvm::encodeULEB128(), llvm::sampleprof::SampleProfileWriter::OutputStream, llvm::success, and llvm::sampleprof::SampleProfileWriter::Summary.

Referenced by writeHeader(), and llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeOneSection().

Friends And Related Function Documentation

◆ SampleProfileWriter::create

ErrorOr< std::unique_ptr< SampleProfileWriter > > SampleProfileWriter::create ( std::unique_ptr< raw_ostream > &  OS,
SampleProfileFormat  Format 
)
friend

Member Data Documentation

◆ NameTable

MapVector<StringRef, uint32_t> llvm::sampleprof::SampleProfileWriterBinary::NameTable
protected

Definition at line 139 of file SampleProfWriter.h.

Referenced by getNameTable(), stablizeNameTable(), writeNameTable(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeNameTable(), llvm::sampleprof::SampleProfileWriterCompactBinary::writeNameTable(), and llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeNameTableSection().

The documentation for this class was generated from the following files:
Generated on Tue Jan 31 2023 08:43:11 for LLVM by doxygen 1.9.6