#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.
Location	getLocation () const
llvm::remarks::Remark	generateRemark () const
	Diagnostic -> Remark.
StringRef	getFunction () const
StringRef	getRawFunction () const
	Return the stored function name, which may be empty.
llvm::StringRef	getCategoryName () const
llvm::StringRef	getSubCategoryName () const
llvm::StringRef	getCombinedCategoryName () const
StringRef	getRemarkName () const
StringRef	getRawRemarkName () const
	Return the stored remark name, which may be empty.
std::string	getMsg () const
ArrayRef< Arg >	getArgs () const
	Return arguments, owned until mutation or destruction.
llvm::remarks::Type	getRemarkType () const
RemarkId	getId () const
	Get this remark's unique ID (0 if not assigned).
void	setId (RemarkId newId)
	Set this remark's unique ID. Also adds it as an Arg for serialization.
ArrayRef< RemarkId >	getRelatedRemarkIds () const
	Get the list of related remark IDs.
void	setRelatedRemarkIds (ArrayRef< RemarkId > ids)
	Replace the list of related remark IDs.
void	addRelatedRemark (RemarkId relatedId)
	Add a related ID and its generated argument.
bool	hasRelatedRemarks () const
	Check if this remark has any related remarks.
RemarkKind	getRemarkKind () const
	Get the remark kind.
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.
std::string	functionName
	Name of the covering function like interface.
Location	loc
std::string	categoryName
	Category name e.g., "Unroll" or "UnrollAndJam".
std::string	subCategoryName
	Sub category name e.g., "Loop Optimizer".
SmallString< 64 >	fullCategoryName
	Combined name for category and sub-category.
std::string	remarkName
	Remark identifier.
SmallVector< Arg, 4 >	args
	Args collected via the streaming interface.
RemarkId	id
	Unique ID for this remark (assigned by RemarkEngine).
SmallVector< RemarkId >	relatedRemarks
	IDs of related remarks (e.g., parent analysis that enabled this opt).

Detailed Description

Definition at line 217 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 220 of file Remarks.h.

References addRelatedRemark(), categoryName, functionName, if(), loc, mlir::remark::RemarkOpts::relatedId, remarkKind, remarkName, and subCategoryName.

Referenced by mlir::remark::detail::OptRemarkBase< RemarkKind::RemarkAnalysis, DiagnosticSeverity::Remark >::OptRemarkBase().

Member Function Documentation

◆ addRelatedRemark()

void mlir::remark::detail::Remark::addRelatedRemark ( RemarkId relatedId )

inline

Add a related ID and its generated argument.

Definition at line 346 of file Remarks.h.

References args, mlir::remark::RemarkId::getValue(), mlir::remark::detail::Remark::Arg::isLink, and relatedRemarks.

Referenced by Remark(), and setRelatedRemarkIds().

◆ generateRemark()

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

Diagnostic -> Remark.

Definition at line 154 of file Remarks.cpp.

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

◆ getArgs()

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

inline

Return arguments, owned until mutation or destruction.

Definition at line 321 of file Remarks.h.

References args.

Referenced by generateRemark(), and print().

◆ getCategoryName()

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

inline

Definition at line 295 of file Remarks.h.

References categoryName.

◆ getCombinedCategoryName()

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

inline

Definition at line 299 of file Remarks.h.

References categoryName, fullCategoryName, and subCategoryName.

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

◆ getFunction()

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

inline

Definition at line 286 of file Remarks.h.

References functionName.

Referenced by generateRemark(), and print().

◆ getId()

RemarkId mlir::remark::detail::Remark::getId ( ) const

inline

Get this remark's unique ID (0 if not assigned).

Definition at line 330 of file Remarks.h.

References id.

◆ getLocation()

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

inline

Definition at line 282 of file Remarks.h.

References loc.

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

◆ getMsg()

std::string Remark::getMsg ( ) const

Definition at line 114 of file Remarks.cpp.

References print().

◆ getRawFunction()

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

inline

Return the stored function name, which may be empty.

Definition at line 293 of file Remarks.h.

References functionName.

◆ getRawRemarkName()

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

inline

Return the stored remark name, which may be empty.

Definition at line 316 of file Remarks.h.

References remarkName.

◆ getRelatedRemarkIds()

ArrayRef< RemarkId > mlir::remark::detail::Remark::getRelatedRemarkIds ( ) const

inline

Get the list of related remark IDs.

Definition at line 340 of file Remarks.h.

References relatedRemarks.

◆ getRemarkKind()

RemarkKind mlir::remark::detail::Remark::getRemarkKind ( ) const

inline

Get the remark kind.

Definition at line 359 of file Remarks.h.

References remarkKind.

Referenced by llvm::DenseMapInfo< mlir::remark::detail::Remark >::getHashValue().

◆ getRemarkName()

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

inline

Definition at line 309 of file Remarks.h.

References remarkName.

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

◆ getRemarkType()

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

Definition at line 138 of file Remarks.cpp.

References 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 122 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().

◆ getSubCategoryName()

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

inline

Definition at line 297 of file Remarks.h.

References subCategoryName.

◆ hasRelatedRemarks()

bool mlir::remark::detail::Remark::hasRelatedRemarks ( ) const

inline

Check if this remark has any related remarks.

Definition at line 356 of file Remarks.h.

References relatedRemarks.

◆ insert() [1/2]

void Remark::insert ( Arg a )

Definition at line 47 of file Remarks.cpp.

References args.

◆ insert() [2/2]

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

Definition at line 46 of file Remarks.cpp.

References args.

Referenced by mlir::remark::detail::operator<<(), mlir::remark::detail::operator<<(), and 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 91 of file Remarks.cpp.

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

Referenced by getMsg().

◆ setId()

void mlir::remark::detail::Remark::setId ( RemarkId newId )

inline

Set this remark's unique ID. Also adds it as an Arg for serialization.

Definition at line 333 of file Remarks.h.

References args.

◆ setRelatedRemarkIds()

void Remark::setRelatedRemarkIds ( ArrayRef< RemarkId > ids )

Replace the list of related remark IDs.

Definition at line 49 of file Remarks.cpp.

References addRelatedRemark(), args, copy(), mlir::remark::detail::Remark::Arg::isLink, and relatedRemarks.

Member Data Documentation

◆ args

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

protected

Args collected via the streaming interface.

Definition at line 388 of file Remarks.h.

Referenced by addRelatedRemark(), getArgs(), insert(), insert(), printArgs(), setId(), and setRelatedRemarkIds().

◆ categoryName

std::string mlir::remark::detail::Remark::categoryName

protected

Category name e.g., "Unroll" or "UnrollAndJam".

Stored as std::string to ensure the Remark owns its data.

Definition at line 374 of file Remarks.h.

Referenced by getCategoryName(), getCombinedCategoryName(), mlir::remark::detail::RemarkEngine::isAnalysisOptRemarkEnabled(), mlir::remark::detail::RemarkEngine::isFailedOptRemarkEnabled(), mlir::remark::detail::RemarkEngine::isMissedOptRemarkEnabled(), mlir::remark::detail::RemarkEngine::isPassedOptRemarkEnabled(), mlir::remark::detail::RemarkEngine::isRemarkEnabled(), print(), and Remark().

◆ fullCategoryName

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

protected

Combined name for category and sub-category.

Definition at line 381 of file Remarks.h.

Referenced by getCombinedCategoryName().

◆ functionName

std::string mlir::remark::detail::Remark::functionName

protected

Name of the covering function like interface.

Stored as std::string to ensure the Remark owns its data.

Definition at line 369 of file Remarks.h.

Referenced by getFunction(), getRawFunction(), print(), and Remark().

◆ id

RemarkId mlir::remark::detail::Remark::id

protected

Unique ID for this remark (assigned by RemarkEngine).

Definition at line 391 of file Remarks.h.

Referenced by getId().

◆ loc

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

protected

Definition at line 371 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(), getLocation(), mlir::remark::detail::OptRemarkBase< RemarkKind::RemarkAnalysis, DiagnosticSeverity::Remark >::OptRemarkBase(), and Remark().

◆ relatedRemarks

SmallVector<RemarkId> mlir::remark::detail::Remark::relatedRemarks

protected

IDs of related remarks (e.g., parent analysis that enabled this opt).

Definition at line 394 of file Remarks.h.

Referenced by addRelatedRemark(), getRelatedRemarkIds(), hasRelatedRemarks(), and setRelatedRemarkIds().

◆ 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 366 of file Remarks.h.

Referenced by getRemarkKind(), getRemarkType(), getRemarkTypeString(), and Remark().

◆ remarkName

std::string mlir::remark::detail::Remark::remarkName

protected

Remark identifier.

Stored as std::string to ensure the Remark owns its data.

Definition at line 385 of file Remarks.h.

Referenced by getRawRemarkName(), getRemarkName(), print(), and Remark().

◆ subCategoryName

std::string mlir::remark::detail::Remark::subCategoryName

protected

Sub category name e.g., "Loop Optimizer".

Stored as std::string to ensure the Remark owns its data.

Definition at line 378 of file Remarks.h.

Referenced by getCombinedCategoryName(), getSubCategoryName(), 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

◆ addRelatedRemark()

◆ generateRemark()

◆ getArgs()

◆ getCategoryName()

◆ getCombinedCategoryName()

◆ getFunction()

◆ getId()

◆ getLocation()

◆ getMsg()

◆ getRawFunction()

◆ getRawRemarkName()

◆ getRelatedRemarkIds()

◆ getRemarkKind()

◆ getRemarkName()

◆ getRemarkType()

◆ getRemarkTypeString()

◆ getSubCategoryName()

◆ hasRelatedRemarks()

◆ insert() [1/2]

◆ insert() [2/2]

◆ print()

◆ setId()

◆ setRelatedRemarkIds()

Member Data Documentation

◆ args

◆ categoryName

◆ fullCategoryName

◆ functionName

◆ id

◆ loc

◆ relatedRemarks

◆ remarkKind

◆ remarkName

◆ subCategoryName