class OptimizationRemark

Declaration

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

Description

Diagnostic information for applied optimization remarks.

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

Inherits from: DiagnosticInfoIROptimization

Member Variables

Inherited from DiagnosticInfoOptimizationBase:

protected PassName

protected RemarkName

protected Hotness

protected Args

protected IsVerbose = false

protected FirstExtraArgIndex = -1

Method Overview

• public OptimizationRemark(const char * PassName, llvm::StringRef RemarkName, const llvm::DiagnosticLocation & Loc, const llvm::Value * CodeRegion)
• public OptimizationRemark(const char * PassName, llvm::StringRef RemarkName, const llvm::Instruction * Inst)
• public OptimizationRemark(const char * PassName, llvm::StringRef RemarkName, const llvm::Function * Func)
• private OptimizationRemark(const char * PassName, const llvm::Function & Fn, const llvm::DiagnosticLocation & Loc, const llvm::Twine & Msg)
• public static bool classof(const llvm::DiagnosticInfo * DI)
• public bool isEnabled() 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

¶OptimizationRemark(
    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=, 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:698

Parameters

const char* PassName

llvm::StringRef RemarkName

const llvm::DiagnosticLocation& Loc

const llvm::Value* CodeRegion

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

Description

Same as above, but the debug location and code region are derived from \p Instr.

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

Parameters

const char* PassName

llvm::StringRef RemarkName

const llvm::Instruction* Inst

¶OptimizationRemark(const char* PassName,
                   llvm::StringRef RemarkName,
                   const llvm::Function* Func)

Description

Same as above, but the debug location and code region are derived from \p Func.

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

Parameters

const char* PassName

llvm::StringRef RemarkName

const llvm::Function* Func

¶OptimizationRemark(
    const char* PassName,
    const llvm::Function& Fn,
    const llvm::DiagnosticLocation& Loc,
    const llvm::Twine& Msg)

Description

This is deprecated now and only used by the function API below.\p PassName is the name of the pass emitting this diagnostic. If this name matches the regular expression given in -Rpass=, then the diagnostic will be emitted. \p Fn is the function where the diagnostic is being emitted. \p Loc is the location information to use in the diagnostic. If line table information is available, the diagnostic will include the source code location. \p Msg is the message to show. Note that this class does not copy this message, so this reference must be valid for the whole life time of the diagnostic.

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

Parameters

const char* PassName

const llvm::Function& Fn

const llvm::DiagnosticLocation& Loc

const llvm::Twine& Msg

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

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

Parameters

const llvm::DiagnosticInfo* DI

¶bool isEnabled() const

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