class SampleProfileWriter

Declaration

class SampleProfileWriter { /* full declaration omitted */ };

Description

Sample-based profile writer. Base class.

Declared at: llvm/include/llvm/ProfileData/SampleProfWriter.h:32

Member Variables

protected std::unique_ptr<raw_ostream> OutputStream

Output stream where to emit the profile to.

protected std::unique_ptr<ProfileSummary> Summary

Profile summary.

protected llvm::sampleprof::SampleProfileFormat Format = SPF_None

Profile format.

Method Overview

• protected SampleProfileWriter(std::unique_ptr<raw_ostream> & OS)
• protected void computeSummary(const StringMap<llvm::sampleprof::FunctionSamples> & ProfileMap)
• public static ErrorOr<std::unique_ptr<SampleProfileWriter>> create(llvm::StringRef Filename, llvm::sampleprof::SampleProfileFormat Format)
• public static ErrorOr<std::unique_ptr<SampleProfileWriter>> create(std::unique_ptr<raw_ostream> & OS, llvm::sampleprof::SampleProfileFormat Format)
• public llvm::raw_ostream & getOutputStream()
• public virtual void setProfileSymbolList(llvm::sampleprof::ProfileSymbolList * PSL)
• public virtual std::error_code write(const StringMap<llvm::sampleprof::FunctionSamples> & ProfileMap)
• protected virtual std::error_code writeFuncProfiles(const StringMap<llvm::sampleprof::FunctionSamples> & ProfileMap)
• protected virtual std::error_code writeHeader(const StringMap<llvm::sampleprof::FunctionSamples> & ProfileMap)
• public virtual std::error_code writeSample(const llvm::sampleprof::FunctionSamples & S)
• public virtual ~SampleProfileWriter()

Methods

¶SampleProfileWriter(
    std::unique_ptr<raw_ostream>& OS)

Declared at: llvm/include/llvm/ProfileData/SampleProfWriter.h:62

Parameters

std::unique_ptr<raw_ostream>& OS

¶void computeSummary(
    const StringMap<
        llvm::sampleprof::FunctionSamples>&
        ProfileMap)

Description

Compute summary for this profile.

Declared at: llvm/include/llvm/ProfileData/SampleProfWriter.h:80

Parameters

const StringMap< llvm::sampleprof::FunctionSamples>& ProfileMap

¶static ErrorOr<
    std::unique_ptr<SampleProfileWriter>>
create(
    llvm::StringRef Filename,
    llvm::sampleprof::SampleProfileFormat Format)

Description

Profile writer factory. Create a new file writer based on the value of \p Format.

Declared at: llvm/include/llvm/ProfileData/SampleProfWriter.h:52

Parameters

llvm::StringRef Filename

llvm::sampleprof::SampleProfileFormat Format

¶static ErrorOr<
    std::unique_ptr<SampleProfileWriter>>
create(
    std::unique_ptr<raw_ostream>& OS,
    llvm::sampleprof::SampleProfileFormat Format)

Description

Create a new stream writer based on the value of \p Format. For testing.

Declared at: llvm/include/llvm/ProfileData/SampleProfWriter.h:57

Parameters

std::unique_ptr<raw_ostream>& OS

llvm::sampleprof::SampleProfileFormat Format

¶llvm::raw_ostream& getOutputStream()

Declared at: llvm/include/llvm/ProfileData/SampleProfWriter.h:46

¶virtual void setProfileSymbolList(
    llvm::sampleprof::ProfileSymbolList* PSL)

Declared at: llvm/include/llvm/ProfileData/SampleProfWriter.h:59

Parameters

llvm::sampleprof::ProfileSymbolList* PSL

¶virtual std::error_code write(
    const StringMap<
        llvm::sampleprof::FunctionSamples>&
        ProfileMap)

Description

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

Declared at: llvm/include/llvm/ProfileData/SampleProfWriter.h:44

Parameters

const StringMap< llvm::sampleprof::FunctionSamples>& ProfileMap

Returns

status code of the file update operation.

¶virtual std::error_code writeFuncProfiles(
    const StringMap<
        llvm::sampleprof::FunctionSamples>&
        ProfileMap)

Declared at: llvm/include/llvm/ProfileData/SampleProfWriter.h:71

Parameters

const StringMap< llvm::sampleprof::FunctionSamples>& ProfileMap

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

Description

Write a file header for the profile file.

Declared at: llvm/include/llvm/ProfileData/SampleProfWriter.h:67

Parameters

const StringMap< llvm::sampleprof::FunctionSamples>& ProfileMap

¶virtual std::error_code writeSample(
    const llvm::sampleprof::FunctionSamples& S)

Description

Write sample profiles in \p S.

Declared at: llvm/include/llvm/ProfileData/SampleProfWriter.h:39

Parameters

const llvm::sampleprof::FunctionSamples& S

Returns

status code of the file update operation.

¶virtual ~SampleProfileWriter()

Declared at: llvm/include/llvm/ProfileData/SampleProfWriter.h:34