LLVM  12.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)
 
virtual std::error_code writeSample (const FunctionSamples &S) override
 Write samples of a top-level function to a binary file. More...
 
- Public Member Functions inherited from llvm::sampleprof::SampleProfileWriter
virtual ~SampleProfileWriter ()=default
 
virtual std::error_code write (const StringMap< FunctionSamples > &ProfileMap)
 Write all the sample profiles in the given map of samples. More...
 
raw_ostream & getOutputStream ()
 
virtual void setProfileSymbolList (ProfileSymbolList *PSL)
 
virtual void setToCompressAllSections ()
 
virtual void setUseMD5 ()
 
virtual void setPartialProfile ()
 

Protected Member Functions

virtual std::error_code writeMagicIdent (SampleProfileFormat Format)
 
virtual std::error_code writeNameTable ()
 
virtual std::error_code writeHeader (const StringMap< FunctionSamples > &ProfileMap) override
 Write a file header for the profile file. More...
 
std::error_code writeSummary ()
 
std::error_code writeNameIdx (StringRef FName)
 
std::error_code writeBody (const FunctionSamples &S)
 
void stablizeNameTable (std::set< StringRef > &V)
 
void addName (StringRef FName)
 
void addNames (const FunctionSamples &S)
 
- Protected Member Functions inherited from llvm::sampleprof::SampleProfileWriter
 SampleProfileWriter (std::unique_ptr< raw_ostream > &OS)
 
virtual std::error_code writeFuncProfiles (const StringMap< FunctionSamples > &ProfileMap)
 
void computeSummary (const StringMap< FunctionSamples > &ProfileMap)
 Compute summary for this profile. More...
 

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. More...
 
std::unique_ptr< ProfileSummary > Summary
 Profile summary. More...
 
SampleProfileFormat Format = SPF_None
 Profile format. More...
 

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. More...
 
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. More...
 

Detailed Description

Sample-based profile writer (binary format).

Definition at line 115 of file SampleProfWriter.h.

Constructor & Destructor Documentation

◆ SampleProfileWriterBinary()

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

Definition at line 117 of file SampleProfWriter.h.

Member Function Documentation

◆ addName()

void SampleProfileWriterBinary::addName ( StringRef  FName)
protected

Definition at line 367 of file SampleProfWriter.cpp.

References NameTable.

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

◆ addNames()

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

Definition at line 371 of file SampleProfWriter.cpp.

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

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

◆ stablizeNameTable()

void SampleProfileWriterBinary::stablizeNameTable ( std::set< StringRef > &  V)
inlineprotected

Definition at line 388 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 579 of file SampleProfWriter.cpp.

References Callee, llvm::sampleprof::LineLocation::Discriminator, llvm::encodeULEB128(), llvm::X86AS::FS, llvm::sampleprof::FunctionSamples::getBodySamples(), llvm::sampleprof::FunctionSamples::getCallsiteSamples(), llvm::sampleprof::SampleRecord::getCallTargets(), llvm::sampleprof::FunctionSamples::getName(), 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, and writeNameIdx().

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

◆ writeHeader()

std::error_code SampleProfileWriterBinary::writeHeader ( const StringMap< FunctionSamples > &  ProfileMap)
overrideprotectedvirtual

Write a file header for the profile file.

Implements llvm::sampleprof::SampleProfileWriter.

Reimplemented in llvm::sampleprof::SampleProfileWriterCompactBinary.

Definition at line 457 of file SampleProfWriter.cpp.

References addName(), addNames(), 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 449 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 359 of file SampleProfWriter.cpp.

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

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

◆ writeNameTable()

std::error_code SampleProfileWriterBinary::writeNameTable ( )
protectedvirtual

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

Definition at line 397 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::SampleProfileWriterCompactBinary, and llvm::sampleprof::SampleProfileWriterExtBinaryBase.

Definition at line 627 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 563 of file SampleProfWriter.cpp.

References llvm::encodeULEB128(), llvm::sampleprof::SampleProfileWriter::OutputStream, 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 132 of file SampleProfWriter.h.

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

The documentation for this class was generated from the following files:
Generated on Fri Jan 15 2021 19:08:10 for LLVM by   doxygen 1.8.15