LLVM  6.0.0svn
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 write (const FunctionSamples &S)=0
 Write sample profiles in S. More...
 
std::error_code write (const StringMap< FunctionSamples > &ProfileMap)
 Write all the sample profiles in the given map of samples. More...
 
raw_ostreamgetOutputStream ()
 

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_ostreamOutputStream
 Output stream where to emit the profile to. More...
 
std::unique_ptr< ProfileSummarySummary
 Profile summary. More...
 

Detailed Description

Sample-based profile writer. Base class.

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

References writeHeader().

Member Function Documentation

◆ computeSummary()

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

◆ 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
FilenameThe file to create.
FormatEncoding format for the profile file.
Returns
an error code indicating the status of the created writer.

Definition at line 258 of file SampleProfWriter.cpp.

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

Referenced by getOutputStream(), llvm::sampleprof::SampleProfileWriterBinary::SampleProfileWriterBinary(), 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
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 279 of file SampleProfWriter.cpp.

References llvm::sampleprof::SPF_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 48 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::SampleProfileWriterBinary, and llvm::sampleprof::SampleProfileWriterText.

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

◆ write() [2/2]

std::error_code SampleProfileWriter::write ( const StringMap< FunctionSamples > &  ProfileMap)

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

Returns
status code of the file update operation.

Definition at line 41 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

Member Data Documentation

◆ OutputStream

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

◆ Summary

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

Profile summary.

Definition at line 73 of file SampleProfWriter.h.

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


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