LLVM  6.0.0svn
Classes | Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
llvm::DiagnosticInfoOptimizationBase Class Referenceabstract

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:
Inheritance graph
[legend]
Collaboration diagram for llvm::DiagnosticInfoOptimizationBase:
Collaboration graph
[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. More...
 
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). More...
 
StringRef getPassName () const
 
std::string getMsg () const
 
Optional< uint64_t > getHotness () const
 
void setHotness (Optional< uint64_t > H)
 
bool isVerbose () 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. More...
 
bool isLocationAvailable () const
 Return true if location information is available for this diagnostic. More...
 
const std::string getLocationStr () const
 Return a string with the location information for this diagnostic in the format "file:line:col". More...
 
void getLocation (StringRef *Filename, unsigned *Line, unsigned *Column) const
 Return location information for this diagnostic in three parts: the source file name, line number and column. More...
 
const FunctiongetFunction () 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
 

Static Public Member Functions

static bool classof (const DiagnosticInfo *DI)
 

Protected Attributes

const charPassName
 Name of the pass that triggers this report. More...
 
StringRef RemarkName
 Textual identifier for the remark (single-word, camel-case). More...
 
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. More...
 
SmallVector< Argument, 4 > Args
 Arguments collected via the streaming interface. More...
 
bool IsVerbose = false
 The remark is expected to be noisy. More...
 
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. More...
 

Friends

struct yaml::MappingTraits< DiagnosticInfoOptimizationBase *>
 

Detailed Description

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

Definition at line 394 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 433 of file DiagnosticInfo.h.

References isEnabled(), and llvm::DiagnosticInfo::print().

Member Function Documentation

◆ classof()

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

◆ getHotness()

Optional<uint64_t> llvm::DiagnosticInfoOptimizationBase::getHotness ( ) const
inline

Definition at line 458 of file DiagnosticInfo.h.

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

◆ getMsg()

std::string DiagnosticInfoOptimizationBase::getMsg ( ) const

◆ getPassName()

StringRef llvm::DiagnosticInfoOptimizationBase::getPassName ( ) const
inline

◆ insert() [1/4]

void DiagnosticInfoOptimizationBase::insert ( StringRef  S)

Definition at line 318 of file DiagnosticInfo.cpp.

References Args.

◆ insert() [2/4]

void DiagnosticInfoOptimizationBase::insert ( Argument  A)

Definition at line 322 of file DiagnosticInfo.cpp.

References Args.

◆ insert() [3/4]

void DiagnosticInfoOptimizationBase::insert ( setIsVerbose  V)

Definition at line 326 of file DiagnosticInfo.cpp.

References IsVerbose.

◆ insert() [4/4]

void DiagnosticInfoOptimizationBase::insert ( setExtraArgs  EA)

Definition at line 330 of file DiagnosticInfo.cpp.

References Args, and FirstExtraArgIndex.

◆ isAnalysis()

bool llvm::DiagnosticInfoOptimizationBase::isAnalysis ( ) const
inline

◆ 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::DiagnosticInfoOptimizationFailure, llvm::OptimizationRemarkAnalysis, llvm::OptimizationRemarkMissed, llvm::OptimizationRemark, llvm::MachineOptimizationRemarkAnalysis, llvm::MachineOptimizationRemarkMissed, and llvm::MachineOptimizationRemark.

◆ isMissed()

bool llvm::DiagnosticInfoOptimizationBase::isMissed ( ) const
inline

◆ isPassed()

bool llvm::DiagnosticInfoOptimizationBase::isPassed ( ) const
inline

◆ isVerbose()

bool llvm::DiagnosticInfoOptimizationBase::isVerbose ( ) const
inline

Definition at line 461 of file DiagnosticInfo.h.

◆ print()

void DiagnosticInfoOptimizationBase::print ( DiagnosticPrinter DP) const
overridevirtual

◆ setHotness()

void llvm::DiagnosticInfoOptimizationBase::setHotness ( Optional< uint64_t >  H)
inline

Friends And Related Function Documentation

◆ yaml::MappingTraits< DiagnosticInfoOptimizationBase *>

Definition at line 511 of file DiagnosticInfo.h.

Member Data Documentation

◆ Args

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

Arguments collected via the streaming interface.

Definition at line 501 of file DiagnosticInfo.h.

Referenced by llvm::DiagnosticInfoIROptimization::DiagnosticInfoIROptimization(), 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 509 of file DiagnosticInfo.h.

Referenced by getMsg(), and insert().

◆ Hotness

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 498 of file DiagnosticInfo.h.

Referenced by getMsg(), and print().

◆ IsVerbose

bool llvm::DiagnosticInfoOptimizationBase::IsVerbose = false
protected

The remark is expected to be noisy.

Definition at line 504 of file DiagnosticInfo.h.

Referenced by insert().

◆ 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 489 of file DiagnosticInfo.h.

Referenced by getMsg().

◆ RemarkName

StringRef llvm::DiagnosticInfoOptimizationBase::RemarkName
protected

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

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

Definition at line 494 of file DiagnosticInfo.h.

Referenced by getMsg().


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