Sample-based profile writer (text format). More...

#include "llvm/ProfileData/SampleProfWriter.h"

Inheritance diagram for llvm::sampleprof::SampleProfileWriterText:

Collaboration diagram for llvm::sampleprof::SampleProfileWriterText:

Public Member Functions
std::error_code	write (const FunctionSamples &S) override
	Write samples to a text 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 ()

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

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

Protected Member Functions inherited from llvm::sampleprof::SampleProfileWriter
	SampleProfileWriter (std::unique_ptr< raw_ostream > &OS)

void	computeSummary (const StringMap< FunctionSamples > &ProfileMap)
	Compute summary for this profile. 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...

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

Detailed Description

Sample-based profile writer (text format).

Definition at line 79 of file SampleProfWriter.h.

Constructor & Destructor Documentation

◆ SampleProfileWriterText()

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

inlineprotected

Definition at line 84 of file SampleProfWriter.h.

Member Function Documentation

◆ write()

std::error_code SampleProfileWriterText::write ( const FunctionSamples & S )

overridevirtual

Write samples to a text file.

Note: it may be tempting to implement this in terms of FunctionSamples::print(). Please don't. The dump functionality is intended for debugging and has no specified form.

The format used here is more structured and deliberate because it needs to be parsed by the SampleProfileReaderText class.

Implements llvm::sampleprof::SampleProfileWriter.

Definition at line 86 of file SampleProfWriter.cpp.

References llvm::sampleprof::LineLocation::Discriminator, llvm::sampleprof::FunctionSamples::getBodySamples(), llvm::sampleprof::FunctionSamples::getCallsiteSamples(), llvm::sampleprof::SampleRecord::getCallTargets(), llvm::sampleprof::FunctionSamples::getHeadSamples(), llvm::sampleprof::FunctionSamples::getName(), llvm::sampleprof::SampleRecord::getSamples(), llvm::sampleprof::FunctionSamples::getTotalSamples(), I, Indent, llvm::sampleprof::LineLocation::LineOffset, llvm::sampleprof::SampleProfileWriter::OutputStream, llvm::success, and llvm::sampleprof::SampleProfileWriter::write().