LLVM 17.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
llvm::sampleprof::SampleProfileWriter Class Referenceabstract

Sample-based profile writer. Base class. More...

#include "llvm/ProfileData/SampleProfWriter.h"

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

Public Member Functions

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)
 

Static Public Member Functions

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.
 

Protected Member Functions

 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

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.
 

Detailed Description

Sample-based profile writer. Base class.

Definition at line 39 of file SampleProfWriter.h.

Constructor & Destructor Documentation

◆ ~SampleProfileWriter()

virtual llvm::sampleprof::SampleProfileWriter::~SampleProfileWriter ( )
virtualdefault

◆ SampleProfileWriter()

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

Definition at line 73 of file SampleProfWriter.h.

Member Function Documentation

◆ computeSummary()

void SampleProfileWriter::computeSummary ( const SampleProfileMap &  ProfileMap)
protected

Compute summary for this profile.

Definition at line 896 of file SampleProfWriter.cpp.

References Builder, llvm::ProfileSummaryBuilder::DefaultCutoffs, and Summary.

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

◆ create() [1/2]

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

Create a new stream writer based on the value of Format.

Create a sample profile stream writer based on the specified format.

For testing.

Parameters
OSThe output stream to store the profile data to.
FormatEncoding format for the profile file.
Returns
an error code indicating the status of the created writer.

Definition at line 866 of file SampleProfWriter.cpp.

References Format, llvm::sampleprof::FunctionSamples::ProfileIsCS, llvm::sampleprof::FunctionSamples::ProfileIsProbeBased, llvm::sampleprof::SPF_Binary, llvm::sampleprof::SPF_Compact_Binary, llvm::sampleprof::SPF_Ext_Binary, llvm::sampleprof::SPF_GCC, llvm::sampleprof::SPF_Text, llvm::unrecognized_format, and llvm::unsupported_writing_format.

◆ create() [2/2]

ErrorOr< std::unique_ptr< SampleProfileWriter > > SampleProfileWriter::create ( StringRef  Filename,
SampleProfileFormat  Format 
)
static

Profile writer factory.

Create a sample profile file writer based on the specified format.

Create a new file writer based on the value of Format.

Parameters
FilenameThe file to create.
FormatEncoding format for the profile file.
Returns
an error code indicating the status of the created writer.

Definition at line 844 of file SampleProfWriter.cpp.

References create(), Format, llvm::sys::fs::OF_None, llvm::sys::fs::OF_TextWithCRLF, llvm::sampleprof::SPF_Binary, llvm::sampleprof::SPF_Compact_Binary, and llvm::sampleprof::SPF_Ext_Binary.

Referenced by create().

◆ getOutputStream()

raw_ostream & llvm::sampleprof::SampleProfileWriter::getOutputStream ( )
inline

Definition at line 53 of file SampleProfWriter.h.

References OutputStream.

◆ resetSecLayout()

virtual void llvm::sampleprof::SampleProfileWriter::resetSecLayout ( SectionLayout  SL)
inlinevirtual

Reimplemented in llvm::sampleprof::SampleProfileWriterExtBinaryBase.

Definition at line 70 of file SampleProfWriter.h.

◆ setPartialProfile()

virtual void llvm::sampleprof::SampleProfileWriter::setPartialProfile ( )
inlinevirtual

Reimplemented in llvm::sampleprof::SampleProfileWriterExtBinaryBase.

Definition at line 69 of file SampleProfWriter.h.

◆ setProfileSymbolList()

virtual void llvm::sampleprof::SampleProfileWriter::setProfileSymbolList ( ProfileSymbolList *  PSL)
inlinevirtual

Reimplemented in llvm::sampleprof::SampleProfileWriterExtBinaryBase.

Definition at line 66 of file SampleProfWriter.h.

◆ setToCompressAllSections()

virtual void llvm::sampleprof::SampleProfileWriter::setToCompressAllSections ( )
inlinevirtual

Reimplemented in llvm::sampleprof::SampleProfileWriterExtBinaryBase.

Definition at line 67 of file SampleProfWriter.h.

◆ setUseMD5()

virtual void llvm::sampleprof::SampleProfileWriter::setUseMD5 ( )
inlinevirtual

Reimplemented in llvm::sampleprof::SampleProfileWriterExtBinaryBase.

Definition at line 68 of file SampleProfWriter.h.

◆ write()

std::error_code SampleProfileWriter::write ( const SampleProfileMap &  ProfileMap)
virtual

Write all the sample profiles in the given map of samples.

Returns
status code of the file update operation.

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

Definition at line 54 of file SampleProfWriter.cpp.

References llvm::success, writeFuncProfiles(), and writeHeader().

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

◆ writeFuncProfiles()

std::error_code SampleProfileWriter::writeFuncProfiles ( const SampleProfileMap &  ProfileMap)
protectedvirtual

Definition at line 44 of file SampleProfWriter.cpp.

References I, llvm::sampleprof::sortFuncProfiles(), llvm::success, and writeSample().

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

◆ writeHeader()

virtual std::error_code llvm::sampleprof::SampleProfileWriter::writeHeader ( const SampleProfileMap &  ProfileMap)
protectedpure virtual

Write a file header for the profile file.

Implemented in llvm::sampleprof::SampleProfileWriterText, llvm::sampleprof::SampleProfileWriterBinary, and llvm::sampleprof::SampleProfileWriterCompactBinary.

Referenced by write().

◆ writeSample()

virtual std::error_code llvm::sampleprof::SampleProfileWriter::writeSample ( const FunctionSamples &  S)
pure virtual

Write sample profiles in S.

Returns
status code of the file update operation.

Implemented in llvm::sampleprof::SampleProfileWriterText, llvm::sampleprof::SampleProfileWriterBinary, llvm::sampleprof::SampleProfileWriterExtBinaryBase, and llvm::sampleprof::SampleProfileWriterCompactBinary.

Referenced by writeFuncProfiles().

Member Data Documentation

◆ Format

SampleProfileFormat llvm::sampleprof::SampleProfileWriter::Format = SPF_None
protected

Profile format.

Definition at line 92 of file SampleProfWriter.h.

Referenced by create(), llvm::sampleprof::SampleProfileWriterBinary::writeHeader(), and llvm::sampleprof::SampleProfileWriterBinary::writeMagicIdent().

◆ OutputStream

std::unique_ptr<raw_ostream> llvm::sampleprof::SampleProfileWriter::OutputStream
protected

Output stream where to emit the profile to.

Definition at line 83 of file SampleProfWriter.h.

Referenced by llvm::sampleprof::SampleProfileWriterExtBinaryBase::addNewSection(), getOutputStream(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::markSectionStart(), llvm::sampleprof::SampleProfileWriterBinary::writeBody(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeCSNameIdx(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeCSNameTableSection(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeFuncMetadata(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeFuncOffsetTable(), llvm::sampleprof::SampleProfileWriterCompactBinary::writeFuncOffsetTable(), llvm::sampleprof::SampleProfileWriterCompactBinary::writeHeader(), llvm::sampleprof::SampleProfileWriterBinary::writeMagicIdent(), llvm::sampleprof::SampleProfileWriterBinary::writeNameIdx(), llvm::sampleprof::SampleProfileWriterBinary::writeNameTable(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeNameTable(), llvm::sampleprof::SampleProfileWriterCompactBinary::writeNameTable(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeOneSection(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeProfileSymbolListSection(), llvm::sampleprof::SampleProfileWriterText::writeSample(), llvm::sampleprof::SampleProfileWriterBinary::writeSample(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeSample(), llvm::sampleprof::SampleProfileWriterCompactBinary::writeSample(), and llvm::sampleprof::SampleProfileWriterBinary::writeSummary().

◆ Summary

std::unique_ptr<ProfileSummary> llvm::sampleprof::SampleProfileWriter::Summary
protected

Profile summary.

Definition at line 86 of file SampleProfWriter.h.

Referenced by computeSummary(), and llvm::sampleprof::SampleProfileWriterBinary::writeSummary().

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