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

#include "llvm/ProfileData/SampleProfWriter.h"

Inheritance diagram for llvm::sampleprof::SampleProfileWriter:

[legend]

Collaboration diagram for llvm::sampleprof::SampleProfileWriter:

Public Member Functions
virtual	~SampleProfileWriter ()=default

virtual std::error_code	write (const FunctionSamples &S)=0
	Write sample profiles in `S`. More...

virtual std::error_code	write (const StringMap< FunctionSamples > &ProfileMap)
	Write all the sample profiles in the given map of samples. More...

raw_ostream &	getOutputStream ()

Static Public Member Functions
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...

Protected Member Functions
	SampleProfileWriter (std::unique_ptr< raw_ostream > &OS)

virtual std::error_code	writeHeader (const StringMap< FunctionSamples > &ProfileMap)=0
	Write a file header for the profile file. More...

void	computeSummary (const StringMap< FunctionSamples > &ProfileMap)
	Compute summary for this profile. More...

Protected Attributes
std::unique_ptr< raw_ostream >	OutputStream
	Output stream where to emit the profile to. More...

std::unique_ptr< ProfileSummary >	Summary
	Profile summary. More...

Detailed Description

Sample-based profile writer. Base class.

Definition at line 33 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 61 of file SampleProfWriter.h.

References writeHeader().

Member Function Documentation

◆ computeSummary()

void SampleProfileWriter::computeSummary ( const StringMap< FunctionSamples > & ProfileMap )

protected

Compute summary for this profile.

Definition at line 394 of file SampleProfWriter.cpp.

References llvm::SampleProfileSummaryBuilder::addRecord(), llvm::ProfileSummaryBuilder::DefaultCutoffs, llvm::SampleProfileSummaryBuilder::getSummary(), I, and Summary.

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

◆ create() [1/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

Filename	The file to create.
Format	Encoding format for the profile file.

Returns: an error code indicating the status of the created writer.

Definition at line 351 of file SampleProfWriter.cpp.

References llvm::sys::fs::F_None, llvm::sys::fs::F_Text, llvm::sampleprof::SPF_Binary, and llvm::sampleprof::SPF_Compact_Binary.

Referenced by getOutputStream(), and llvm::sampleprof::SampleProfileWriterText::writeHeader().

◆ create() [2/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

OS	The output stream to store the profile data to.
Format	Encoding format for the profile file.

Returns: an error code indicating the status of the created writer.

Definition at line 372 of file SampleProfWriter.cpp.

References llvm::sampleprof::SPF_Binary, llvm::sampleprof::SPF_Compact_Binary, llvm::sampleprof::SPF_GCC, llvm::sampleprof::SPF_Text, llvm::unrecognized_format, and llvm::unsupported_writing_format.

◆ getOutputStream()

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

inline

Definition at line 47 of file SampleProfWriter.h.

References create(), llvm::Format, and OutputStream.

◆ write() [1/2]

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

pure virtual

Write sample profiles in S.

Returns: status code of the file update operation.

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

Referenced by write(), llvm::sampleprof::SampleProfileWriterText::write(), and llvm::sampleprof::SampleProfileWriterCompactBinary::write().

◆ write() [2/2]

std::error_code SampleProfileWriter::write ( const StringMap< FunctionSamples > & 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::SampleProfileWriterCompactBinary.

Definition at line 44 of file SampleProfWriter.cpp.

References B, I, llvm::success, write(), and writeHeader().

◆ writeHeader()

virtual std::error_code llvm::sampleprof::SampleProfileWriter::writeHeader ( const StringMap< FunctionSamples > & ProfileMap )

protectedpure virtual

Write a file header for the profile file.

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

Referenced by SampleProfileWriter(), llvm::sampleprof::SampleProfileWriterBinary::SampleProfileWriterBinary(), and write().

Member Data Documentation

◆ OutputStream

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

protected

Output stream where to emit the profile to.

Definition at line 69 of file SampleProfWriter.h.

◆ Summary

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

protected

Profile summary.

Definition at line 72 of file SampleProfWriter.h.

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

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~SampleProfileWriter()

◆ SampleProfileWriter()

Member Function Documentation

◆ computeSummary()

◆ create() [1/2]

◆ create() [2/2]

◆ getOutputStream()

◆ write() [1/2]

◆ write() [2/2]

◆ writeHeader()

Member Data Documentation

◆ OutputStream

◆ Summary