#include "llvm/ProfileData/SampleProfWriter.h"

Inheritance diagram for llvm::sampleprof::SampleProfileWriterExtBinaryBase:

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

Protected Member Functions
uint64_t	markSectionStart (SecType Type, uint32_t LayoutIdx)
	Return the current position and prepare to use it as the start position of a section given the section type `Type` and its position `LayoutIdx` in SectionHdrLayout.
std::error_code	addNewSection (SecType Sec, uint32_t LayoutIdx, uint64_t SectionStart)
	Add a new section into section header table given the section type `Type`, its position `LayoutIdx` in SectionHdrLayout and the location `SectionStart` where the section should be written to.
template<class SecFlagType>
void	addSectionFlag (SecType Type, SecFlagType Flag)
template<class SecFlagType>
void	addSectionFlag (uint32_t SectionIdx, SecFlagType Flag)
void	addContext (const SampleContext &Context) override
virtual std::error_code	writeCustomSection (SecType Type)=0
virtual void	verifySecLayout (SectionLayout SL)=0
virtual std::error_code	writeSections (const SampleProfileMap &ProfileMap)=0
virtual std::error_code	writeOneSection (SecType Type, uint32_t LayoutIdx, const SampleProfileMap &ProfileMap)
std::error_code	writeNameTable () override
std::error_code	writeContextIdx (const SampleContext &Context) override
std::error_code	writeCSNameIdx (const SampleContext &Context)
std::error_code	writeCSNameTableSection ()
std::error_code	writeFuncMetadata (const SampleProfileMap &Profiles)
std::error_code	writeFuncMetadata (const FunctionSamples &Profile)
std::error_code	writeNameTableSection (const SampleProfileMap &ProfileMap)
std::error_code	writeEytzingerNameTableSection (const SampleProfileMap &ProfileMap)
std::error_code	writeFuncOffsetTable (bool IsCS)
std::error_code	writeEytzingerFuncOffsetTable (bool IsCS)
std::error_code	writeLegacyFuncOffsetTable ()
std::error_code	writeProfileSymbolListSection ()
std::error_code	writeStringBasedProfileSymbolListSection ()
std::error_code	writeMD5ProfileSymbolListSection ()
Protected Member Functions inherited from llvm::sampleprof::SampleProfileWriterBinary
virtual MapVector< FunctionId, uint32_t > &	getNameTable ()
virtual std::error_code	writeMagicIdent (SampleProfileFormat Format)
std::error_code	writeSummary ()
std::error_code	writeNameIdx (FunctionId FName)
std::error_code	writeBody (const FunctionSamples &S)
void	addName (FunctionId FName)
void	addNames (const FunctionSamples &S)
std::error_code	writeCallsiteVTableProf (const CallsiteTypeMap &CallsiteTypeMap, raw_ostream &OS)
	Write `CallsiteTypeMap` to the output stream `OS`.
Protected Member Functions inherited from llvm::sampleprof::SampleProfileWriter
	SampleProfileWriter (std::unique_ptr< raw_ostream > &OS)
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
SectionLayout	SecLayout = DefaultLayout
SmallVector< SecHdrTableEntry, 8 >	SectionHdrLayout
uint64_t	SecLBRProfileStart = 0
Protected Attributes inherited from llvm::sampleprof::SampleProfileWriterBinary
MapVector< FunctionId, uint32_t >	NameTable
bool	WriteVTableProf = false
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_ostream >	OutputStream
	Output stream where to emit the profile to.
std::unique_ptr< ProfileSummary >	Summary
	Profile summary.
SampleProfileFormat	Format = SPF_None
	Profile format.
uint64_t	FormatVersion = sampleprof::DefaultVersion
	Format version to write.

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

Definition at line 328 of file SampleProfWriter.h.

Member Function Documentation

◆ addContext()

void SampleProfileWriterExtBinaryBase::addContext ( const SampleContext & Context )

overrideprotectedvirtual

Reimplemented from llvm::sampleprof::SampleProfileWriterBinary.

Definition at line 936 of file SampleProfWriter.cpp.

References llvm::sampleprof::SampleProfileWriterBinary::addName().

Referenced by writeNameTableSection().

◆ addNewSection()

std::error_code SampleProfileWriterExtBinaryBase::addNewSection	(	SecType	Sec,
		uint32_t	LayoutIdx,
		uint64_t	SectionStart )

protected

Add a new section into section header table given the section type Type, its position LayoutIdx in SectionHdrLayout and the location SectionStart where the section should be written to.

Definition at line 218 of file SampleProfWriter.cpp.

References assert(), llvm::sampleprof::hasSecFlag(), llvm::sampleprof::SampleProfileWriter::OutputStream, llvm::sampleprof::SecFlagCompress, SectionHdrLayout, and llvm::success.

Referenced by writeOneSection().

◆ addSectionFlag() [1/2]

template<class SecFlagType>

void llvm::sampleprof::SampleProfileWriterExtBinaryBase::addSectionFlag	(	SecType	Type,
		SecFlagType	Flag )

inlineprotected

Definition at line 381 of file SampleProfWriter.h.

References llvm::sampleprof::addSecFlag(), and SectionHdrLayout.

Referenced by setPartialProfile(), setToCompressSection(), setUseMD5(), writeEytzingerFuncOffsetTable(), writeLegacyFuncOffsetTable(), writeNameTableSection(), and writeOneSection().

◆ addSectionFlag() [2/2]

template<class SecFlagType>

void llvm::sampleprof::SampleProfileWriterExtBinaryBase::addSectionFlag	(	uint32_t	SectionIdx,
		SecFlagType	Flag )

inlineprotected

Definition at line 388 of file SampleProfWriter.h.

References llvm::sampleprof::addSecFlag(), and SectionHdrLayout.

◆ markSectionStart()

uint64_t SampleProfileWriterExtBinaryBase::markSectionStart	(	SecType	Type,
		uint32_t	LayoutIdx )

protected

Return the current position and prepare to use it as the start position of a section given the section type Type and its position LayoutIdx in SectionHdrLayout.

Definition at line 184 of file SampleProfWriter.cpp.

References assert(), llvm::sampleprof::hasSecFlag(), llvm::sampleprof::SampleProfileWriter::OutputStream, llvm::sampleprof::SecFlagCompress, and SectionHdrLayout.

Referenced by writeOneSection().

◆ resetSecLayout()

void llvm::sampleprof::SampleProfileWriterExtBinaryBase::resetSecLayout ( SectionLayout SL )

inline

Definition at line 363 of file SampleProfWriter.h.

References assert(), llvm::sampleprof::ExtBinaryHdrLayoutTable, SecLayout, SectionHdrLayout, and verifySecLayout().

Referenced by setUseCtxSplitLayout().

◆ setPartialProfile()

void llvm::sampleprof::SampleProfileWriterExtBinaryBase::setPartialProfile ( )

inlineoverridevirtual

Reimplemented from llvm::sampleprof::SampleProfileWriter.

Definition at line 351 of file SampleProfWriter.h.

References addSectionFlag(), llvm::sampleprof::SecFlagPartial, and llvm::sampleprof::SecProfSummary.

◆ setProfileSymbolList()

void llvm::sampleprof::SampleProfileWriterExtBinaryBase::setProfileSymbolList ( ProfileSymbolList * PSL )

inlineoverridevirtual

Reimplemented from llvm::sampleprof::SampleProfileWriter.

Definition at line 355 of file SampleProfWriter.h.

◆ setToCompressAllSections()

void SampleProfileWriterExtBinaryBase::setToCompressAllSections ( )

overridevirtual

Reimplemented from llvm::sampleprof::SampleProfileWriter.

Definition at line 990 of file SampleProfWriter.cpp.

References llvm::sampleprof::addSecFlag(), llvm::sampleprof::SecFlagCompress, and SectionHdrLayout.

◆ setToCompressSection()

void SampleProfileWriterExtBinaryBase::setToCompressSection ( SecType Type )

Definition at line 995 of file SampleProfWriter.cpp.

References addSectionFlag(), and llvm::sampleprof::SecFlagCompress.

Referenced by writeOneSection().

◆ setUseCtxSplitLayout()

void llvm::sampleprof::SampleProfileWriterExtBinaryBase::setUseCtxSplitLayout ( )

inlineoverridevirtual

Reimplemented from llvm::sampleprof::SampleProfileWriter.

Definition at line 359 of file SampleProfWriter.h.

References llvm::sampleprof::CtxSplitLayout, and resetSecLayout().

◆ setUseMD5()

void llvm::sampleprof::SampleProfileWriterExtBinaryBase::setUseMD5 ( )

inlineoverridevirtual

Reimplemented from llvm::sampleprof::SampleProfileWriter.

Definition at line 340 of file SampleProfWriter.h.

References addSectionFlag(), llvm::sampleprof::SecFlagFixedLengthMD5, llvm::sampleprof::SecFlagMD5Name, and llvm::sampleprof::SecNameTable.

◆ verifySecLayout()

virtual void llvm::sampleprof::SampleProfileWriterExtBinaryBase::verifySecLayout ( SectionLayout SL )

protectedpure virtual

Referenced by resetSecLayout().

◆ write()

std::error_code SampleProfileWriterExtBinaryBase::write ( const SampleProfileMap & ProfileMap )

overridevirtual

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

Returns: status code of the file update operation.

Reimplemented from llvm::sampleprof::SampleProfileWriter.

Definition at line 234 of file SampleProfWriter.cpp.

References llvm::sampleprof::SampleProfileWriterBinary::NameTable, llvm::success, and writeSections().

◆ writeContextIdx()

std::error_code SampleProfileWriterExtBinaryBase::writeContextIdx ( const SampleContext & Context )

overrideprotectedvirtual

Reimplemented from llvm::sampleprof::SampleProfileWriterBinary.

Definition at line 255 of file SampleProfWriter.cpp.

References writeCSNameIdx(), and llvm::sampleprof::SampleProfileWriterBinary::writeNameIdx().

Referenced by writeFuncMetadata(), writeLegacyFuncOffsetTable(), and writeSections().

◆ writeCSNameIdx()

std::error_code SampleProfileWriterExtBinaryBase::writeCSNameIdx ( const SampleContext & Context )

protected

Definition at line 264 of file SampleProfWriter.cpp.

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

Referenced by writeContextIdx(), and writeSections().

◆ writeCSNameTableSection()

std::error_code SampleProfileWriterExtBinaryBase::writeCSNameTableSection ( )

protected

Definition at line 577 of file SampleProfWriter.cpp.

References llvm::encodeULEB128(), llvm::little, llvm::sampleprof::SampleProfileWriter::OutputStream, stabilizeTable(), llvm::success, and llvm::sampleprof::SampleProfileWriterBinary::writeNameIdx().

Referenced by writeOneSection(), and writeSections().

◆ writeCustomSection()

virtual std::error_code llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeCustomSection ( SecType Type )

protectedpure virtual

Referenced by writeOneSection().

◆ writeEytzingerFuncOffsetTable()

std::error_code SampleProfileWriterExtBinaryBase::writeEytzingerFuncOffsetTable ( bool IsCS )

protected

Definition at line 294 of file SampleProfWriter.cpp.

References addSectionFlag(), assert(), llvm::is_contained(), llvm::sampleprof::SampleProfileWriterBinary::NameTable, llvm::sampleprof::SampleProfileWriter::OutputStream, llvm::sampleprof::SecFlagEytzinger, llvm::sampleprof::SecFuncOffsetTable, llvm::success, and llvm::too_large.

Referenced by writeFuncOffsetTable(), and writeSections().

◆ writeEytzingerNameTableSection()

std::error_code SampleProfileWriterExtBinaryBase::writeEytzingerNameTableSection ( const SampleProfileMap & ProfileMap )

protected

Definition at line 536 of file SampleProfWriter.cpp.

References llvm::detail::DenseSetImpl< ValueT, MapTy >::contains(), llvm::sampleprof::CS, llvm::sampleprof::CtxSplitLayout, llvm::sampleprof::Flat, I, llvm::detail::DenseSetImpl< ValueT, MapTy >::insert(), llvm::sampleprof::SampleProfileWriterBinary::NameTable, llvm::sampleprof::SampleProfileWriter::OutputStream, SecLayout, and llvm::success.

Referenced by writeNameTableSection(), and writeSections().

◆ writeFuncMetadata() [1/2]

std::error_code SampleProfileWriterExtBinaryBase::writeFuncMetadata ( const FunctionSamples & Profile )

protected

Definition at line 372 of file SampleProfWriter.cpp.

References llvm::encodeULEB128(), llvm::sampleprof::SampleContext::getAllAttributes(), llvm::sampleprof::FunctionSamples::getCallsiteSamples(), llvm::sampleprof::FunctionSamples::getContext(), llvm::sampleprof::FunctionSamples::getFunctionHash(), llvm::sampleprof::SampleProfileWriter::OutputStream, llvm::sampleprof::FunctionSamples::ProfileIsCS, llvm::sampleprof::FunctionSamples::ProfileIsPreInlined, llvm::sampleprof::FunctionSamples::ProfileIsProbeBased, llvm::success, writeContextIdx(), and writeFuncMetadata().

◆ writeFuncMetadata() [2/2]

std::error_code SampleProfileWriterExtBinaryBase::writeFuncMetadata ( const SampleProfileMap & Profiles )

protected

Definition at line 404 of file SampleProfWriter.cpp.

References llvm::sampleprof::FunctionSamples::ProfileIsCS, llvm::sampleprof::FunctionSamples::ProfileIsPreInlined, llvm::sampleprof::FunctionSamples::ProfileIsProbeBased, llvm::success, and writeFuncMetadata().

Referenced by writeFuncMetadata(), writeFuncMetadata(), writeOneSection(), and writeSections().

◆ writeFuncOffsetTable()

std::error_code SampleProfileWriterExtBinaryBase::writeFuncOffsetTable ( bool IsCS )

protected

Definition at line 282 of file SampleProfWriter.cpp.

References llvm::sampleprof::FunctionSamples::ProfileIsCS, llvm::unsupported_writing_format, writeEytzingerFuncOffsetTable(), WriteEytzingerNameTables, and writeLegacyFuncOffsetTable().

Referenced by writeOneSection(), and writeSections().

◆ writeLegacyFuncOffsetTable()

std::error_code SampleProfileWriterExtBinaryBase::writeLegacyFuncOffsetTable ( )

protected

Definition at line 336 of file SampleProfWriter.cpp.

References addSectionFlag(), llvm::encodeULEB128(), llvm::Offset, llvm::sampleprof::SampleProfileWriter::OutputStream, llvm::sampleprof::FunctionSamples::ProfileIsCS, llvm::sampleprof::SecFlagOrdered, llvm::sampleprof::SecFuncOffsetTable, llvm::success, and writeContextIdx().

Referenced by writeFuncOffsetTable(), and writeSections().

◆ writeMD5ProfileSymbolListSection()

std::error_code SampleProfileWriterExtBinaryBase::writeMD5ProfileSymbolListSection ( )

protected

Definition at line 615 of file SampleProfWriter.cpp.

References assert(), llvm::EytzingerTable< T >::create(), llvm::sampleprof::SampleProfileWriter::OutputStream, llvm::success, llvm::Table, and llvm::raw_ostream::write().

Referenced by writeProfileSymbolListSection(), and writeSections().

◆ writeNameTable()

std::error_code SampleProfileWriterExtBinaryBase::writeNameTable ( )

overrideprotectedvirtual

Reimplemented from llvm::sampleprof::SampleProfileWriterBinary.

Definition at line 431 of file SampleProfWriter.cpp.

References llvm::encodeULEB128(), llvm::little, llvm::sampleprof::SampleProfileWriterBinary::NameTable, llvm::sampleprof::SampleProfileWriter::OutputStream, stabilizeTable(), llvm::success, llvm::support::endian::Writer::write(), and llvm::sampleprof::SampleProfileWriterBinary::writeNameTable().

Referenced by writeNameTableSection(), and writeSections().

◆ writeNameTableSection()

std::error_code SampleProfileWriterExtBinaryBase::writeNameTableSection ( const SampleProfileMap & ProfileMap )

protected

Definition at line 447 of file SampleProfWriter.cpp.

References addContext(), llvm::sampleprof::SampleProfileWriterBinary::addNames(), addSectionFlag(), I, llvm::sampleprof::SampleProfileWriterBinary::NameTable, llvm::sampleprof::FunctionSamples::ProfileIsCS, llvm::sampleprof::SecFlagUniqSuffix, llvm::sampleprof::SecNameTable, llvm::success, llvm::sampleprof::FunctionSamples::UniqSuffix, llvm::unsupported_writing_format, WriteEytzingerNameTables, writeEytzingerNameTableSection(), and writeNameTable().

Referenced by writeOneSection(), and writeSections().

◆ writeOneSection()

std::error_code SampleProfileWriterExtBinaryBase::writeOneSection	(	SecType	Type,
		uint32_t	LayoutIdx,
		const SampleProfileMap &	ProfileMap )

protectedvirtual

Definition at line 633 of file SampleProfWriter.cpp.

Referenced by writeSections().

◆ writeProfileSymbolListSection()

std::error_code SampleProfileWriterExtBinaryBase::writeProfileSymbolListSection ( )

protected

Definition at line 596 of file SampleProfWriter.cpp.

References writeMD5ProfileSymbolListSection(), WriteMD5ProfSymList, and writeStringBasedProfileSymbolListSection().

Referenced by writeOneSection(), and writeSections().

◆ writeSample()

std::error_code SampleProfileWriterExtBinaryBase::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.

Reimplemented from llvm::sampleprof::SampleProfileWriterBinary.

Definition at line 273 of file SampleProfWriter.cpp.

References llvm::encodeULEB128(), llvm::sampleprof::FunctionSamples::getContext(), llvm::sampleprof::FunctionSamples::getHeadSamples(), llvm::Offset, llvm::sampleprof::SampleProfileWriter::OutputStream, SecLBRProfileStart, and llvm::sampleprof::SampleProfileWriterBinary::writeBody().

◆ writeSections()

virtual std::error_code llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeSections ( const SampleProfileMap & ProfileMap )

protectedpure virtual

References Profile, writeContextIdx(), writeCSNameIdx(), writeCSNameTableSection(), writeEytzingerFuncOffsetTable(), writeEytzingerNameTableSection(), writeFuncMetadata(), writeFuncOffsetTable(), writeLegacyFuncOffsetTable(), writeMD5ProfileSymbolListSection(), writeNameTable(), writeNameTableSection(), writeOneSection(), writeProfileSymbolListSection(), and writeStringBasedProfileSymbolListSection().

Referenced by write().

◆ writeStringBasedProfileSymbolListSection()

std::error_code SampleProfileWriterExtBinaryBase::writeStringBasedProfileSymbolListSection ( )

protected

Definition at line 603 of file SampleProfWriter.cpp.

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

Referenced by writeProfileSymbolListSection(), and writeSections().

Member Data Documentation

◆ SecLayout

SectionLayout llvm::sampleprof::SampleProfileWriterExtBinaryBase::SecLayout = DefaultLayout

protected

Definition at line 427 of file SampleProfWriter.h.

Referenced by resetSecLayout(), and writeEytzingerNameTableSection().

◆ SecLBRProfileStart

uint64_t llvm::sampleprof::SampleProfileWriterExtBinaryBase::SecLBRProfileStart = 0

protected

Definition at line 438 of file SampleProfWriter.h.

Referenced by writeOneSection(), and writeSample().

◆ SectionHdrLayout

SmallVector<SecHdrTableEntry, 8> llvm::sampleprof::SampleProfileWriterExtBinaryBase::SectionHdrLayout

protected

Initial value:

=

ExtBinaryHdrLayoutTable[DefaultLayout]

llvm::sampleprof::ExtBinaryHdrLayoutTable

const std::array< SmallVector< SecHdrTableEntry, 8 >, NumOfLayout > ExtBinaryHdrLayoutTable

Definition SampleProfWriter.h:252

llvm::sampleprof::DefaultLayout

@ DefaultLayout

Definition SampleProfWriter.h:32

Definition at line 432 of file SampleProfWriter.h.

Referenced by addNewSection(), addSectionFlag(), addSectionFlag(), markSectionStart(), resetSecLayout(), setToCompressAllSections(), and writeOneSection().

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

include/llvm/ProfileData/SampleProfWriter.h
lib/ProfileData/SampleProfWriter.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addContext()

◆ addNewSection()

◆ addSectionFlag() [1/2]

◆ addSectionFlag() [2/2]

◆ markSectionStart()

◆ resetSecLayout()

◆ setPartialProfile()

◆ setProfileSymbolList()

◆ setToCompressAllSections()

◆ setToCompressSection()

◆ setUseCtxSplitLayout()

◆ setUseMD5()

◆ verifySecLayout()

◆ write()

◆ writeContextIdx()

◆ writeCSNameIdx()

◆ writeCSNameTableSection()

◆ writeCustomSection()

◆ writeEytzingerFuncOffsetTable()

◆ writeEytzingerNameTableSection()

◆ writeFuncMetadata() [1/2]

◆ writeFuncMetadata() [2/2]

◆ writeFuncOffsetTable()

◆ writeLegacyFuncOffsetTable()

◆ writeMD5ProfileSymbolListSection()

◆ writeNameTable()

◆ writeNameTableSection()

◆ writeOneSection()

◆ writeProfileSymbolListSection()

◆ writeSample()

◆ writeSections()

◆ writeStringBasedProfileSymbolListSection()

Member Data Documentation

◆ SecLayout

◆ SecLBRProfileStart

◆ SectionHdrLayout