#include "mlir/IR/Remarks.h"

Inheritance diagram for mlir::remark::detail::Remark:

Classes
struct	Arg

Public Member Functions
	Remark (RemarkKind remarkKind, DiagnosticSeverity severity, Location loc, RemarkOpts opts)

void	insert (llvm::StringRef s)

void	insert (Arg a)

void	print (llvm::raw_ostream &os, bool printLocation=false) const
	Print the remark to the given output stream. More...

Location	getLocation () const

llvm::remarks::Remark	generateRemark () const
	Diagnostic -> Remark. More...

StringRef	getFunction () const

llvm::StringRef	getCategoryName () const

llvm::StringRef	getCombinedCategoryName () const

StringRef	getRemarkName () const

std::string	getMsg () const

ArrayRef< Arg >	getArgs () const

llvm::remarks::Type	getRemarkType () const

StringRef	getRemarkTypeString () const

Protected Attributes
RemarkKind	remarkKind
	Keeps the MLIR diagnostic kind, which is used to determine the diagnostic kind in the LLVM remark streamer. More...

StringRef	functionName
	Name of the convering function like interface. More...

Location	loc

StringRef	categoryName
	Sub category passname e.g., "Unroll" or "UnrollAndJam". More...

StringRef	subCategoryName
	Sub category name "Loop Optimizer". More...

SmallString< 64 >	fullCategoryName
	Combined name for category and sub-category. More...

StringRef	remarkName
	Remark identifier. More...

SmallVector< Arg, 4 >	args
	Args collected via the streaming interface. More...

Detailed Description

Definition at line 87 of file Remarks.h.

Constructor & Destructor Documentation

◆ Remark()

mlir::remark::detail::Remark::Remark	(	RemarkKind	remarkKind,
		DiagnosticSeverity	severity,
		Location	loc,
		RemarkOpts	opts
	)

inline

Definition at line 90 of file Remarks.h.

References categoryName, fullCategoryName, and subCategoryName.

Member Function Documentation

◆ generateRemark()

llvm::remarks::Remark Remark::generateRemark ( ) const

Diagnostic -> Remark.

Definition at line 133 of file Remarks.cpp.

References getArgs(), getCombinedCategoryName(), getFunction(), getLocation(), getRemarkName(), and getRemarkType().

Referenced by mlir::remark::detail::LLVMRemarkStreamer::streamOptimizationRemark().

◆ getArgs()

ArrayRef<Arg> mlir::remark::detail::Remark::getArgs ( ) const

inline

Definition at line 164 of file Remarks.h.

References args.

Referenced by generateRemark(), and print().

◆ getCategoryName()

llvm::StringRef mlir::remark::detail::Remark::getCategoryName ( ) const

inline

Definition at line 144 of file Remarks.h.

References categoryName.

Referenced by mlir::remark::detail::LLVMRemarkStreamer::streamOptimizationRemark().

◆ getCombinedCategoryName()

llvm::StringRef mlir::remark::detail::Remark::getCombinedCategoryName ( ) const

inline

Definition at line 146 of file Remarks.h.

References categoryName, fullCategoryName, and subCategoryName.

Referenced by generateRemark(), llvm::DenseMapInfo< mlir::remark::detail::Remark >::getHashValue(), llvm::DenseMapInfo< mlir::remark::detail::Remark >::isEqual(), and print().

◆ getFunction()

StringRef mlir::remark::detail::Remark::getFunction ( ) const

inline

Definition at line 138 of file Remarks.h.

References functionName.

Referenced by generateRemark(), and print().

◆ getLocation()

Location mlir::remark::detail::Remark::getLocation ( ) const

inline

Definition at line 134 of file Remarks.h.

References loc.

Referenced by generateRemark(), llvm::DenseMapInfo< mlir::remark::detail::Remark >::getHashValue(), llvm::DenseMapInfo< mlir::remark::detail::Remark >::isEqual(), and print().

◆ getMsg()

std::string Remark::getMsg ( ) const

Definition at line 93 of file Remarks.cpp.

References print().

◆ getRemarkName()

StringRef mlir::remark::detail::Remark::getRemarkName ( ) const

inline

Definition at line 156 of file Remarks.h.

References remarkName.

Referenced by generateRemark(), llvm::DenseMapInfo< mlir::remark::detail::Remark >::getHashValue(), and llvm::DenseMapInfo< mlir::remark::detail::Remark >::isEqual().

◆ getRemarkType()

llvm::remarks::Type Remark::getRemarkType ( ) const

Definition at line 117 of file Remarks.cpp.

References Failure, mlir::remark::RemarkAnalysis, mlir::remark::RemarkFailure, remarkKind, mlir::remark::RemarkMissed, mlir::remark::RemarkPassed, and mlir::remark::RemarkUnknown.

Referenced by generateRemark().

◆ getRemarkTypeString()

llvm::StringRef Remark::getRemarkTypeString ( ) const

Definition at line 101 of file Remarks.cpp.

References mlir::remark::RemarkAnalysis, mlir::remark::RemarkFailure, remarkKind, mlir::remark::RemarkMissed, mlir::remark::RemarkPassed, and mlir::remark::RemarkUnknown.

Referenced by print().

◆ insert() [1/2]

void Remark::insert ( Arg a )

Definition at line 35 of file Remarks.cpp.

References args.

◆ insert() [2/2]

void Remark::insert ( llvm::StringRef s )

Definition at line 34 of file Remarks.cpp.

References args.

Referenced by mlir::remark::detail::operator<<().

◆ print()

void Remark::print	(	llvm::raw_ostream &	os,
		bool	printLocation = `false`
	)		const

Print the remark to the given output stream.

Example output: [Missed] Category: Loop | Pass:Unroller | Function=main | Reason="tripCount=4 < threshold=256" [Failure] LoopOptimizer | Reason="failed due to unsupported pattern"

Definition at line 70 of file Remarks.cpp.

References categoryName, functionName, getArgs(), getCombinedCategoryName(), getFunction(), getLocation(), getRemarkTypeString(), printArgs(), and remarkName.

Referenced by getMsg().

Member Data Documentation

◆ args

SmallVector<Arg, 4> mlir::remark::detail::Remark::args

protected

Args collected via the streaming interface.

Definition at line 191 of file Remarks.h.

Referenced by getArgs(), insert(), and printArgs().

◆ categoryName

StringRef mlir::remark::detail::Remark::categoryName

protected

Sub category passname e.g., "Unroll" or "UnrollAndJam".

Definition at line 179 of file Remarks.h.

Referenced by getCategoryName(), getCombinedCategoryName(), print(), and Remark().

◆ fullCategoryName

SmallString<64> mlir::remark::detail::Remark::fullCategoryName

protected

Combined name for category and sub-category.

Definition at line 185 of file Remarks.h.

Referenced by getCombinedCategoryName(), and Remark().

◆ functionName

StringRef mlir::remark::detail::Remark::functionName

protected

Name of the convering function like interface.

Definition at line 175 of file Remarks.h.

Referenced by getFunction(), and print().

◆ loc

Location mlir::remark::detail::Remark::loc

protected

Definition at line 177 of file Remarks.h.

Referenced by mlir::remark::detail::RemarkEngine::emitOptimizationRemark(), mlir::remark::detail::RemarkEngine::emitOptimizationRemarkAnalysis(), mlir::remark::detail::RemarkEngine::emitOptimizationRemarkFailure(), mlir::remark::detail::RemarkEngine::emitOptimizationRemarkMiss(), and getLocation().

◆ remarkKind

RemarkKind mlir::remark::detail::Remark::remarkKind

protected

Keeps the MLIR diagnostic kind, which is used to determine the diagnostic kind in the LLVM remark streamer.

Definition at line 173 of file Remarks.h.

Referenced by getRemarkType(), and getRemarkTypeString().

◆ remarkName

StringRef mlir::remark::detail::Remark::remarkName

protected

Remark identifier.

Definition at line 188 of file Remarks.h.

Referenced by getRemarkName(), and print().

◆ subCategoryName

StringRef mlir::remark::detail::Remark::subCategoryName

protected

Sub category name "Loop Optimizer".

Definition at line 182 of file Remarks.h.

Referenced by getCombinedCategoryName(), and Remark().

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

include/mlir/IR/Remarks.h
lib/IR/Remarks.cpp

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Remark()

Member Function Documentation

◆ generateRemark()

◆ getArgs()

◆ getCategoryName()

◆ getCombinedCategoryName()

◆ getFunction()

◆ getLocation()

◆ getMsg()

◆ getRemarkName()

◆ getRemarkType()

◆ getRemarkTypeString()

◆ insert() [1/2]

◆ insert() [2/2]

◆ print()

Member Data Documentation

◆ args

◆ categoryName

◆ fullCategoryName

◆ functionName

◆ loc

◆ remarkKind

◆ remarkName

◆ subCategoryName