LLVM 19.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

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.
template<typename FunctionPruningStrategy = DefaultFunctionPruningStrategy>
std::error_code writeWithSizeLimit (SampleProfileMap &ProfileMap, size_t OutputSizeLimit)
 Write sample profiles up to given size limit, using the pruning strategy to drop some functions if necessary.
raw_ostreamgetOutputStream ()
virtual void setProfileSymbolList (ProfileSymbolList *PSL)
virtual void setToCompressAllSections ()
virtual void setUseMD5 ()
virtual void setPartialProfile ()
virtual void resetSecLayout (SectionLayout SL)

Protected Member Functions

virtual MapVector< FunctionId, 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 (FunctionId FName)
std::error_code writeBody (const FunctionSamples &S)
void stablizeNameTable (MapVector< FunctionId, uint32_t > &NameTable, std::set< FunctionId > &V)
void addName (FunctionId 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)
std::error_code writeWithSizeLimitInternal (SampleProfileMap &ProfileMap, size_t OutputSizeLimit, FunctionPruningStrategy *Strategy)
void computeSummary (const SampleProfileMap &ProfileMap)
 Compute summary for this profile.

Protected Attributes

MapVector< FunctionId, uint32_tNameTable
- Protected Attributes inherited from llvm::sampleprof::SampleProfileWriter
size_t LineCount
 For writeWithSizeLimit in text mode, each newline takes 1 additional byte on Windows when actually written to the file, but not written to a memory buffer.
std::unique_ptr< raw_ostreamOutputStream
 Output stream where to emit the profile to.
std::unique_ptr< ProfileSummarySummary
 Profile summary.
SampleProfileFormat Format = SPF_None
 Profile format.


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 191 of file SampleProfWriter.h.

Constructor & Destructor Documentation

◆ SampleProfileWriterBinary()

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

Definition at line 193 of file SampleProfWriter.h.

Member Function Documentation

◆ addContext()

void SampleProfileWriterBinary::addContext ( const SampleContext Context)

◆ addName()

void SampleProfileWriterBinary::addName ( FunctionId  FName)

◆ addNames()

void SampleProfileWriterBinary::addNames ( const FunctionSamples S)

◆ getNameTable()

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

Definition at line 199 of file SampleProfWriter.h.

References NameTable.

Referenced by addName(), and writeNameIdx().

◆ stablizeNameTable()

void SampleProfileWriterBinary::stablizeNameTable ( MapVector< FunctionId, uint32_t > &  NameTable,
std::set< FunctionId > &  V 

◆ writeBody()

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

◆ writeContextIdx()

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

◆ writeHeader()

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

◆ writeMagicIdent()

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

◆ writeNameIdx()

std::error_code SampleProfileWriterBinary::writeNameIdx ( FunctionId  FName)

◆ writeNameTable()

std::error_code SampleProfileWriterBinary::writeNameTable ( )

◆ writeSample()

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

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

true if the samples were written successfully, false otherwise.

Implements llvm::sampleprof::SampleProfileWriter.

Reimplemented in llvm::sampleprof::SampleProfileWriterExtBinaryBase.

Definition at line 870 of file SampleProfWriter.cpp.

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

◆ writeSummary()

std::error_code SampleProfileWriterBinary::writeSummary ( )

Friends And Related Function Documentation

◆ SampleProfileWriter::create

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

Member Data Documentation

◆ NameTable

MapVector<FunctionId, uint32_t> llvm::sampleprof::SampleProfileWriterBinary::NameTable

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