Common features for diagnostics dealing with optimization remarks that are used by both IR and MIR passes. More...

#include "llvm/IR/DiagnosticInfo.h"

Inheritance diagram for llvm::DiagnosticInfoOptimizationBase:

[legend]

Classes
struct	Argument
	Used in the streaming interface as the general argument type. More...

struct	setExtraArgs
	When an instance of this is inserted into the stream, the arguments following will not appear in the remark printed in the compiler output (-Rpass) but only in the optimization record file (-fsave-optimization-record). More...

struct	setIsVerbose
	Used to set IsVerbose via the stream interface. More...

Public Member Functions
	DiagnosticInfoOptimizationBase (enum DiagnosticKind Kind, enum DiagnosticSeverity Severity, const char *PassName, StringRef RemarkName, const Function &Fn, const DiagnosticLocation &Loc)
	`PassName` is the name of the pass emitting this diagnostic.

void	insert (StringRef S)

void	insert (Argument A)

void	insert (setIsVerbose V)

void	insert (setExtraArgs EA)

void	print (DiagnosticPrinter &DP) const override

virtual bool	isEnabled () const =0
	Return true if this optimization remark is enabled by one of of the LLVM command line flags (-pass-remarks, -pass-remarks-missed, or -pass-remarks-analysis).

StringRef	getPassName () const

StringRef	getRemarkName () const

std::string	getMsg () const

std::optional< uint64_t >	getHotness () const

void	setHotness (std::optional< uint64_t > H)

bool	isVerbose () const

ArrayRef< Argument >	getArgs () const

bool	isPassed () const

bool	isMissed () const

bool	isAnalysis () const

Public Member Functions inherited from llvm::DiagnosticInfoWithLocationBase
	DiagnosticInfoWithLocationBase (enum DiagnosticKind Kind, enum DiagnosticSeverity Severity, const Function &Fn, const DiagnosticLocation &Loc)
	`Fn` is the function where the diagnostic is being emitted.

bool	isLocationAvailable () const
	Return true if location information is available for this diagnostic.

std::string	getLocationStr () const
	Return a string with the location information for this diagnostic in the format "file:line:col".

void	getLocation (StringRef &RelativePath, unsigned &Line, unsigned &Column) const
	Return location information for this diagnostic in three parts: the relative source file path, line number and column.

std::string	getAbsolutePath () const
	Return the absolute path tot the file.

const Function &	getFunction () const

DiagnosticLocation	getLocation () const

Public Member Functions inherited from llvm::DiagnosticInfo
	DiagnosticInfo (int Kind, DiagnosticSeverity Severity)

virtual	~DiagnosticInfo ()=default

int	getKind () const

DiagnosticSeverity	getSeverity () const

virtual void	print (DiagnosticPrinter &DP) const =0
	Print using the given `DP` a user-friendly message.

Static Public Member Functions
static bool	classof (const DiagnosticInfo *DI)

Protected Attributes
const char *	PassName
	Name of the pass that triggers this report.

StringRef	RemarkName
	Textual identifier for the remark (single-word, camel-case).

std::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.

SmallVector< Argument, 4 >	Args
	Arguments collected via the streaming interface.

bool	IsVerbose = false
	The remark is expected to be noisy.

int	FirstExtraArgIndex = -1
	If positive, the index of the first argument that only appear in the optimization records and not in the remark printed in the compiler output.

Detailed Description

Common features for diagnostics dealing with optimization remarks that are used by both IR and MIR passes.

Definition at line 486 of file DiagnosticInfo.h.

Constructor & Destructor Documentation

◆ DiagnosticInfoOptimizationBase()

llvm::DiagnosticInfoOptimizationBase::DiagnosticInfoOptimizationBase	(	enum DiagnosticKind	Kind,
		enum DiagnosticSeverity	Severity,
		const char *	PassName,
		StringRef	RemarkName,
		const Function &	Fn,
		const DiagnosticLocation &	Loc
	)

inline

PassName is the name of the pass emitting this diagnostic.

RemarkName is a textual identifier for the remark (single-word, camel-case). Fn is the function where the diagnostic is being emitted. Loc is the location information to use in the diagnostic. If line table information is available, the diagnostic will include the source code location.

Definition at line 529 of file DiagnosticInfo.h.

Member Function Documentation

◆ classof()

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

inlinestatic

Definition at line 562 of file DiagnosticInfo.h.

References llvm::DK_FirstMachineRemark, llvm::DK_FirstRemark, llvm::DK_LastMachineRemark, llvm::DK_LastRemark, and llvm::DiagnosticInfo::getKind().

◆ getArgs()

ArrayRef< Argument > llvm::DiagnosticInfoOptimizationBase::getArgs ( ) const

inline

Definition at line 560 of file DiagnosticInfo.h.

References Args.

◆ getHotness()

std::optional< uint64_t > llvm::DiagnosticInfoOptimizationBase::getHotness ( ) const

inline

Definition at line 555 of file DiagnosticInfo.h.

References Hotness.

Referenced by llvm::OptimizationRemarkEmitter::emit().

◆ getMsg()

std::string DiagnosticInfoOptimizationBase::getMsg ( ) const

Definition at line 434 of file DiagnosticInfo.cpp.

References Args, FirstExtraArgIndex, llvm::make_range(), and OS.

Referenced by EmitAndPrintRemark(), and print().

◆ getPassName()

StringRef llvm::DiagnosticInfoOptimizationBase::getPassName ( ) const

inline

Definition at line 552 of file DiagnosticInfo.h.

References PassName.

Referenced by llvm::LLVMRemarkStreamer::emit(), llvm::MachineOptimizationRemark::isEnabled(), llvm::MachineOptimizationRemarkMissed::isEnabled(), llvm::MachineOptimizationRemarkAnalysis::isEnabled(), llvm::OptimizationRemark::isEnabled(), llvm::OptimizationRemarkMissed::isEnabled(), llvm::OptimizationRemarkAnalysis::isEnabled(), and llvm::OptimizationRemarkAnalysis::shouldAlwaysPrint().

◆ getRemarkName()

StringRef llvm::DiagnosticInfoOptimizationBase::getRemarkName ( ) const

inline

Definition at line 553 of file DiagnosticInfo.h.

References RemarkName.

◆ insert() [1/4]

void DiagnosticInfoOptimizationBase::insert ( Argument A )

Definition at line 422 of file DiagnosticInfo.cpp.

References A, and Args.

◆ insert() [2/4]

void DiagnosticInfoOptimizationBase::insert ( setExtraArgs EA )

Definition at line 430 of file DiagnosticInfo.cpp.

References Args, and FirstExtraArgIndex.

◆ insert() [3/4]

void DiagnosticInfoOptimizationBase::insert ( setIsVerbose V )

Definition at line 426 of file DiagnosticInfo.cpp.

References IsVerbose.

◆ insert() [4/4]

void DiagnosticInfoOptimizationBase::insert ( StringRef S )

Definition at line 418 of file DiagnosticInfo.cpp.

References Args.

◆ isAnalysis()

bool llvm::DiagnosticInfoOptimizationBase::isAnalysis ( ) const

inline

Definition at line 579 of file DiagnosticInfo.h.

References llvm::DK_MachineOptimizationRemarkAnalysis, llvm::DK_OptimizationRemarkAnalysis, and llvm::DiagnosticInfo::getKind().

◆ isEnabled()

virtual bool llvm::DiagnosticInfoOptimizationBase::isEnabled ( ) const

pure virtual

Return true if this optimization remark is enabled by one of of the LLVM command line flags (-pass-remarks, -pass-remarks-missed, or -pass-remarks-analysis).

Note that this only handles the LLVM flags. We cannot access Clang flags from here (they are handled in BackendConsumer::OptimizationRemarkHandler).

Implemented in llvm::MachineOptimizationRemark, llvm::MachineOptimizationRemarkMissed, llvm::MachineOptimizationRemarkAnalysis, llvm::OptimizationRemark, llvm::OptimizationRemarkMissed, llvm::OptimizationRemarkAnalysis, and llvm::DiagnosticInfoOptimizationFailure.

◆ isMissed()

bool llvm::DiagnosticInfoOptimizationBase::isMissed ( ) const

inline

Definition at line 574 of file DiagnosticInfo.h.

References llvm::DK_MachineOptimizationRemarkMissed, llvm::DK_OptimizationRemarkMissed, and llvm::DiagnosticInfo::getKind().

◆ isPassed()

bool llvm::DiagnosticInfoOptimizationBase::isPassed ( ) const

inline

Definition at line 569 of file DiagnosticInfo.h.

References llvm::DK_MachineOptimizationRemark, llvm::DK_OptimizationRemark, and llvm::DiagnosticInfo::getKind().

◆ isVerbose()

bool llvm::DiagnosticInfoOptimizationBase::isVerbose ( ) const

inline

Definition at line 558 of file DiagnosticInfo.h.

References IsVerbose.

◆ print()

void DiagnosticInfoOptimizationBase::print ( DiagnosticPrinter & DP ) const

overridevirtual

See also: DiagnosticInfo::print.

Implements llvm::DiagnosticInfo.

Definition at line 278 of file DiagnosticInfo.cpp.

References llvm::DiagnosticInfoWithLocationBase::getLocationStr(), getMsg(), and Hotness.

◆ setHotness()

void llvm::DiagnosticInfoOptimizationBase::setHotness ( std::optional< uint64_t > H )

inline

Definition at line 556 of file DiagnosticInfo.h.

References H, and Hotness.

Member Data Documentation

◆ Args

SmallVector<Argument, 4> llvm::DiagnosticInfoOptimizationBase::Args

protected

Arguments collected via the streaming interface.

Definition at line 600 of file DiagnosticInfo.h.

Referenced by llvm::DiagnosticInfoIROptimization::DiagnosticInfoIROptimization(), getArgs(), getMsg(), and insert().

◆ FirstExtraArgIndex

int llvm::DiagnosticInfoOptimizationBase::FirstExtraArgIndex = -1

protected

If positive, the index of the first argument that only appear in the optimization records and not in the remark printed in the compiler output.

Definition at line 608 of file DiagnosticInfo.h.

Referenced by getMsg(), and insert().

◆ Hotness

std::optional<uint64_t> llvm::DiagnosticInfoOptimizationBase::Hotness

protected

If profile information is available, this is the number of times the corresponding code was executed in a profile instrumentation run.

Definition at line 597 of file DiagnosticInfo.h.

Referenced by getHotness(), print(), and setHotness().

◆ IsVerbose

bool llvm::DiagnosticInfoOptimizationBase::IsVerbose = false

protected

The remark is expected to be noisy.

Definition at line 603 of file DiagnosticInfo.h.

Referenced by insert(), and isVerbose().

◆ PassName

const char* llvm::DiagnosticInfoOptimizationBase::PassName

protected

Name of the pass that triggers this report.

If this matches the regular expression given in -Rpass=regexp, then the remark will be emitted.

Definition at line 588 of file DiagnosticInfo.h.

Referenced by getPassName().

◆ RemarkName

StringRef llvm::DiagnosticInfoOptimizationBase::RemarkName

protected

Textual identifier for the remark (single-word, camel-case).

Can be used by external tools reading the output file for optimization remarks to identify the remark.

Definition at line 593 of file DiagnosticInfo.h.

Referenced by getRemarkName().

The documentation for this class was generated from the following files:

include/llvm/IR/DiagnosticInfo.h
lib/IR/DiagnosticInfo.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DiagnosticInfoOptimizationBase()

Member Function Documentation

◆ classof()

◆ getArgs()

◆ getHotness()

◆ getMsg()

◆ getPassName()

◆ getRemarkName()

◆ insert() [1/4]

◆ insert() [2/4]

◆ insert() [3/4]

◆ insert() [4/4]

◆ isAnalysis()

◆ isEnabled()

◆ isMissed()

◆ isPassed()

◆ isVerbose()

◆ print()

◆ setHotness()

Member Data Documentation

◆ Args

◆ FirstExtraArgIndex

◆ Hotness

◆ IsVerbose

◆ PassName

◆ RemarkName