class OptimizationRemarkAnalysis

Declaration

class OptimizationRemarkAnalysis : public DiagnosticInfoIROptimization { /* full declaration omitted */ };

Description

Diagnostic information for optimization analysis remarks.

Declared at: llvm/include/llvm/IR/DiagnosticInfo.h:758

Inherits from: DiagnosticInfoIROptimization

Member Variables

public static const char* AlwaysPrint

Inherited from DiagnosticInfoOptimizationBase:

protected PassName

protected RemarkName

protected Hotness

protected Args

protected IsVerbose = false

protected FirstExtraArgIndex = -1

Method Overview

• public OptimizationRemarkAnalysis(const char * PassName, llvm::StringRef RemarkName, const llvm::DiagnosticLocation & Loc, const llvm::Value * CodeRegion)
• public OptimizationRemarkAnalysis(const char * PassName, llvm::StringRef Prepend, const llvm::OptimizationRemarkAnalysis & Orig)
• public OptimizationRemarkAnalysis(const char * PassName, llvm::StringRef RemarkName, const llvm::Instruction * Inst)
• protected OptimizationRemarkAnalysis(enum DiagnosticKind Kind, const char * PassName, const llvm::Function & Fn, const llvm::DiagnosticLocation & Loc, const llvm::Twine & Msg)
• protected OptimizationRemarkAnalysis(enum DiagnosticKind Kind, const char * PassName, llvm::StringRef RemarkName, const llvm::DiagnosticLocation & Loc, const llvm::Value * CodeRegion)
• public static bool classof(const llvm::DiagnosticInfo * DI)
• public bool isEnabled() const
• public bool shouldAlwaysPrint() const

Inherited from DiagnosticInfoIROptimization:

• public classof
• public getCodeRegion

Inherited from DiagnosticInfoOptimizationBase:

• public classof
• public getArgs
• public getHotness
• public getMsg
• public getPassName
• public getRemarkName
• public insert
• public insert
• public insert
• public insert
• public isAnalysis
• public isEnabled
• public isMissed
• public isPassed
• public isVerbose
• public print
• public setHotness

Inherited from DiagnosticInfoWithLocationBase:

• public getAbsolutePath
• public getFunction
• public getLocation
• public getLocation
• public getLocationStr
• public isLocationAvailable

Inherited from DiagnosticInfo:

• public getKind
• public getSeverity
• public print

Methods

¶OptimizationRemarkAnalysis(
    const char* PassName,
    llvm::StringRef RemarkName,
    const llvm::DiagnosticLocation& Loc,
    const llvm::Value* CodeRegion)

Description

\p PassName is the name of the pass emitting this diagnostic. If this name matches the regular expression given in -Rpass-analysis=, then the diagnostic will be emitted. \p RemarkName is a textual identifier for the remark (single-word, camel-case). \p Loc is the debug location and \p CodeRegion is the region that the optimization operates on (currently only block is supported).

Declared at: llvm/include/llvm/IR/DiagnosticInfo.h:766

Parameters

const char* PassName

llvm::StringRef RemarkName

const llvm::DiagnosticLocation& Loc

const llvm::Value* CodeRegion

¶OptimizationRemarkAnalysis(
    const char* PassName,
    llvm::StringRef Prepend,
    const llvm::OptimizationRemarkAnalysis& Orig)

Description

This is ctor variant allows a pass to build an optimization remark from an existing remark. This is useful when a transformation pass (e.g LV) wants to emit a remark (\p Orig) generated by one of its analyses (e.g. LAA) as its own analysis remark. The string \p Prepend will be emitted before the original message.

Declared at: llvm/include/llvm/IR/DiagnosticInfo.h:777

Parameters

const char* PassName

llvm::StringRef Prepend

const llvm::OptimizationRemarkAnalysis& Orig

¶OptimizationRemarkAnalysis(
    const char* PassName,
    llvm::StringRef RemarkName,
    const llvm::Instruction* Inst)

Description

Same as above but \p Inst is used to derive code region and debug location.

Declared at: llvm/include/llvm/IR/DiagnosticInfo.h:783

Parameters

const char* PassName

llvm::StringRef RemarkName

const llvm::Instruction* Inst

¶OptimizationRemarkAnalysis(
    enum DiagnosticKind Kind,
    const char* PassName,
    const llvm::Function& Fn,
    const llvm::DiagnosticLocation& Loc,
    const llvm::Twine& Msg)

Declared at: llvm/include/llvm/IR/DiagnosticInfo.h:798

Parameters

enum DiagnosticKind Kind

const char* PassName

const llvm::Function& Fn

const llvm::DiagnosticLocation& Loc

const llvm::Twine& Msg

¶OptimizationRemarkAnalysis(
    enum DiagnosticKind Kind,
    const char* PassName,
    llvm::StringRef RemarkName,
    const llvm::DiagnosticLocation& Loc,
    const llvm::Value* CodeRegion)

Declared at: llvm/include/llvm/IR/DiagnosticInfo.h:803

Parameters

enum DiagnosticKind Kind

const char* PassName

llvm::StringRef RemarkName

const llvm::DiagnosticLocation& Loc

const llvm::Value* CodeRegion

¶static bool classof(
    const llvm::DiagnosticInfo* DI)

Declared at: llvm/include/llvm/IR/DiagnosticInfo.h:786

Parameters

const llvm::DiagnosticInfo* DI

¶bool isEnabled() const

Declared at: llvm/include/llvm/IR/DiagnosticInfo.h:791

¶bool shouldAlwaysPrint() const

Declared at: llvm/include/llvm/IR/DiagnosticInfo.h:795