class SampleProfileReaderRawBinary

Declaration

class SampleProfileReaderRawBinary : public SampleProfileReaderBinary { /* 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:657

Inherits from: SampleProfileReaderBinary

Member Variables

Inherited from SampleProfileReaderBinary:

protected Data = nullptr
protected End = nullptr
protected NameTable

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 SampleProfileReaderRawBinary(std::unique_ptr<MemoryBuffer> B, llvm::LLVMContext & C, llvm::sampleprof::SampleProfileFormat Format = SPF_Binary)
  • public static bool hasFormat(const llvm::MemoryBuffer & Buffer)
  • private std::error_code verifySPMagic(uint64_t Magic)

Inherited from SampleProfileReaderBinary:

Inherited from SampleProfileReader:

Methods

SampleProfileReaderRawBinary(
    std::unique_ptr<MemoryBuffer> B,
    llvm::LLVMContext& C,
    llvm::sampleprof::SampleProfileFormat Format =
        SPF_Binary)

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

Parameters

std::unique_ptr<MemoryBuffer> B
llvm::LLVMContext& C
llvm::sampleprof::SampleProfileFormat Format = SPF_Binary

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:667

Parameters

const llvm::MemoryBuffer& Buffer

std::error_code verifySPMagic(uint64_t Magic)

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

Parameters

uint64_t Magic