class SampleProfileReaderText

Declaration

class SampleProfileReaderText : public SampleProfileReader { /* full declaration omitted */ };

Description

Sample-based profile reader. Each profile contains sample counts for all the functions executed. Inside each function, statements are annotated with the collected samples on all the instructions associated with that statement. For this to produce meaningful data, the program needs to be compiled with some debug information (at minimum, line numbers: -gline-tables-only). Otherwise, it will be impossible to match IR instructions to the line numbers collected by the profiler. From the profile file, we are interested in collecting the following information: * A list of functions included in the profile (mangled names). * For each function F: 1. The total number of samples collected in F. 2. The samples collected at each line in F. To provide some protection against source code shuffling, line numbers should be relative to the start of the function. The reader supports two file formats: text and binary. The text format is useful for debugging and testing, while the binary format is more compact and I/O efficient. They can both be used interchangeably.

Declared at: llvm/include/llvm/ProfileData/SampleProfReader.h:561

Inherits from: SampleProfileReader

Member Variables

private std::list<SampleContextFrameVector> CSNameTable

CSNameTable is used to save full context vectors. This serves as an underlying immutable buffer for all clients.

Inherited from SampleProfileReader:

protected Profiles

protected Ctx

protected Buffer

protected MD5NameBuffer

protected Summary

protected Remapper

protected ProfileIsProbeBased = false

protected ProfileIsCS = false

protected ProfileIsPreInlined = false

protected CSProfileCount = 0

protected ProfileIsFS = false

protected Format = SPF_None

protected M = nullptr

protected MaskedBitFrom = 31

Method Overview

• public SampleProfileReaderText(std::unique_ptr<MemoryBuffer> B, llvm::LLVMContext & C)
• public static bool hasFormat(const llvm::MemoryBuffer & Buffer)
• public std::error_code readHeader()
• public std::error_code readImpl()

Inherited from SampleProfileReader:

• public collectFuncsFromModule
• protected computeSummary
• public create
• public create
• public dump
• public dumpFunctionProfile
• public dumpSectionInfo
• public getBuffer
• public getDiscriminatorMask
• public getFormat
• public getNameTable
• public getOrCreateSamplesFor
• public getProfileSymbolList
• public getProfiles
• public getRemapper
• public getSamplesFor
• public getSamplesFor
• public getSummary
• public hasUniqSuffix
• public profileIsCS
• public profileIsPreInlined
• public profileIsProbeBased
• public read
• public readHeader
• public readImpl
• public reportError
• public setDiscriminatorMaskedBitFrom
• public setModule
• public setSkipFlatProf
• protected takeSummary
• public useMD5

Methods

¶SampleProfileReaderText(
    std::unique_ptr<MemoryBuffer> B,
    llvm::LLVMContext& C)

Declared at: llvm/include/llvm/ProfileData/SampleProfReader.h:563

Parameters

std::unique_ptr<MemoryBuffer> B

llvm::LLVMContext& C

¶static bool hasFormat(
    const llvm::MemoryBuffer& Buffer)

Description

Return true if \p Buffer is in the format supported by this class.

Declared at: llvm/include/llvm/ProfileData/SampleProfReader.h:573

Parameters

const llvm::MemoryBuffer& Buffer

¶std::error_code readHeader()

Description

Read and validate the file header.

Declared at: llvm/include/llvm/ProfileData/SampleProfReader.h:567

¶std::error_code readImpl()

Description

Read sample profiles from the associated file.

Declared at: llvm/include/llvm/ProfileData/SampleProfReader.h:570