struct Remark

Declaration

struct Remark { /* full declaration omitted */ };

Description

A remark type used for both emission and parsing.

Declared at: llvm/include/llvm/Remarks/Remark.h:67

Member Variables

public llvm::remarks::Type RemarkType = Type::Unknown
The type of the remark.
public llvm::StringRef PassName
Name of the pass that triggers the emission of this remark.
public llvm::StringRef RemarkName
Textual identifier for the remark (single-word, camel-case). Can be used by external tools reading the output file for remarks to identify the remark.
public llvm::StringRef FunctionName
Mangled name of the function that triggers the emssion of this remark.
public Optional<llvm::remarks::RemarkLocation> Loc
The location in the source file of the remark.
public Optional<uint64_t> Hotness
If profile information is available, this is the number of times the corresponding code was executed in a profile instrumentation run.
public SmallVector<llvm::remarks::Argument, 5> Args
Arguments collected via the streaming interface.

Method Overview

Methods

Remark()

Declared at: llvm/include/llvm/Remarks/Remark.h:92

Remark(llvm::remarks::Remark&&)

Declared at: llvm/include/llvm/Remarks/Remark.h:93

Parameters

llvm::remarks::Remark&&

llvm::remarks::Remark clone() const

Description

Clone this remark to explicitly ask for a copy.

Declared at: llvm/include/llvm/Remarks/Remark.h:100

std::string getArgsAsMsg() const

Description

Return a message composed from the arguments as a string.

Declared at: llvm/include/llvm/Remarks/Remark.h:97