13#ifndef MLIR_IR_DIAGNOSTICS_H
14#define MLIR_IR_DIAGNOSTICS_H
66 T val, std::enable_if_t<std::is_signed<T>::value &&
67 std::numeric_limits<T>::is_integer &&
68 sizeof(T) <=
sizeof(
int64_t)> * =
nullptr)
73 T val, std::enable_if_t<std::is_unsigned<T>::value &&
74 std::numeric_limits<T>::is_integer &&
75 sizeof(T) <=
sizeof(uint64_t)> * =
nullptr)
157 using NoteVector = std::vector<std::unique_ptr<Diagnostic>>;
161 : loc(loc), severity(severity) {}
176 template <
typename Arg>
177 std::enable_if_t<!std::is_convertible<Arg, StringRef>::value &&
178 std::is_constructible<DiagnosticArgument, Arg>::value,
212 template <
typename T,
typename ValueT = llvm::detail::ValueOfRange<T>>
213 std::enable_if_t<!std::is_constructible<DiagnosticArgument, T>::value,
221 template <
typename T>
224 c, [
this](
const auto &a) { *
this << a; }, [&]() { *
this << delim; });
229 template <
typename Arg1,
typename Arg2,
typename... Args>
231 append(std::forward<Arg1>(arg1));
232 return append(std::forward<Arg2>(arg2), std::forward<Args>(args)...);
235 template <
typename Arg>
237 *this << std::forward<Arg>(arg);
245 std::string
str()
const;
254 llvm::pointee_iterator<NoteVector::const_iterator>;
258 return llvm::make_pointee_range(notes);
261 return llvm::make_pointee_range(notes);
265 operator LogicalResult()
const;
268 operator ParseResult()
const {
return ParseResult(LogicalResult(*
this)); }
272 template <
typename T>
273 operator FailureOr<T>()
const {
295 std::vector<std::unique_ptr<char[]>> strings;
331 template <
typename Arg>
333 return append(std::forward<Arg>(arg));
335 template <
typename Arg>
337 return std::move(
append(std::forward<Arg>(arg)));
341 template <
typename... Args>
343 assert(isActive() &&
"diagnostic not active");
345 impl->append(std::forward<Args>(args)...);
348 template <
typename... Args>
350 return std::move(
append(std::forward<Args>(args)...));
355 assert(isActive() &&
"diagnostic not active");
356 return impl->attachNote(noteLoc);
371 operator LogicalResult()
const;
375 operator ParseResult()
const {
return ParseResult(LogicalResult(*
this)); }
380 template <
typename T>
381 operator FailureOr<T>()
const {
389 : owner(owner),
impl(std::move(
rhs)) {}
393 bool isActive()
const {
return impl.has_value(); }
396 bool isInFlight()
const {
return owner; }
399 friend DiagnosticEngine;
402 DiagnosticEngine *owner =
nullptr;
405 std::optional<Diagnostic> impl;
416class DiagnosticEngine {
448 template <typename FuncTy, typename RetT = decltype(std::declval<FuncTy>()(
449 std::declval<Diagnostic &>()))>
450 std::enable_if_t<std::is_same<RetT, void>::value,
HandlerID>
464 "notes should not be emitted directly");
478 std::unique_ptr<detail::DiagnosticEngineImpl>
impl;
498template <
typename... Args>
504template <
typename... Args>
510template <
typename... Args>
527 template <
typename FuncTy>
529 : handlerID(0), ctx(ctx) {
536 template <
typename FuncTy>
538 auto &diagEngine = ctx->getDiagEngine();
540 diagEngine.eraseHandler(handlerID);
541 handlerID = diagEngine.registerHandler(std::forward<FuncTy>(handler));
557struct SourceMgrDiagnosticHandlerImpl;
581 bool displaySourceLine =
true);
610 std::optional<Location> findLocToShow(
Location loc);
613 unsigned callStackLimit = 10;
615 std::unique_ptr<detail::SourceMgrDiagnosticHandlerImpl>
impl;
623struct SourceMgrDiagnosticVerifierHandlerImpl;
655 std::unique_ptr<detail::SourceMgrDiagnosticVerifierHandlerImpl>
impl;
663struct ParallelDiagnosticHandlerImpl;
693 std::unique_ptr<detail::ParallelDiagnosticHandlerImpl>
impl;
static std::string diag(const llvm::Value &value)
Attributes are known-constant values of operations.
A variant type that holds a single argument for a diagnostic.
DiagnosticArgumentKind
Enum that represents the different kinds of diagnostic arguments supported.
StringRef getAsString() const
Returns this argument as a string.
double getAsDouble() const
Returns this argument as a double.
DiagnosticArgument(Attribute attr)
Note: The constructors below are only exposed due to problems accessing constructors from type traits...
Type getAsType() const
Returns this argument as a Type.
int64_t getAsInteger() const
Returns this argument as a signed integer.
DiagnosticArgument(double val)
DiagnosticArgumentKind getKind() const
Returns the kind of this argument.
Attribute getAsAttribute() const
Returns this argument as an Attribute.
DiagnosticArgument(T val, std::enable_if_t< std::is_unsigned< T >::value &&std::numeric_limits< T >::is_integer &&sizeof(T)<=sizeof(uint64_t)> *=nullptr)
void print(raw_ostream &os) const
Outputs this argument to a stream.
DiagnosticArgument(float val)
uint64_t getAsUnsigned() const
Returns this argument as an unsigned integer.
DiagnosticArgument(StringRef val)
DiagnosticArgument(T val, std::enable_if_t< std::is_signed< T >::value &&std::numeric_limits< T >::is_integer &&sizeof(T)<=sizeof(int64_t)> *=nullptr)
This class is the main interface for diagnostics.
uint64_t HandlerID
A handle to a specific registered handler object.
std::enable_if_t< std::is_same< RetT, void >::value, HandlerID > registerHandler(FuncTy &&handler)
Set the diagnostic handler with a function that returns void.
friend class MLIRContextImpl
InFlightDiagnostic emit(Location loc, DiagnosticSeverity severity)
Create a new inflight diagnostic with the given location and severity.
void eraseHandler(HandlerID id)
Erase the registered diagnostic handler with the given identifier.
llvm::unique_function< LogicalResult(Diagnostic &)> HandlerTy
The handler type for MLIR diagnostics.
HandlerID registerHandler(HandlerTy handler)
Register a new handler for diagnostics to the engine.
This class contains all of the information necessary to report a diagnostic to the DiagnosticEngine.
DiagnosticSeverity getSeverity() const
Returns the severity of this diagnostic.
std::string str() const
Converts the diagnostic to a string.
std::enable_if_t<!std::is_constructible< DiagnosticArgument, T >::value, Diagnostic & > operator<<(T &&range)
Stream in a range.
Diagnostic & operator<<(const char(&val)[n])
Stream in a string literal.
Diagnostic & append(Arg &&arg)
Append one argument to the diagnostic.
Diagnostic & operator<<(Operation *op)
Location getLocation() const
Returns the source location for this diagnostic.
Diagnostic & attachNote(std::optional< Location > noteLoc=std::nullopt)
Attaches a note to this diagnostic.
MutableArrayRef< DiagnosticArgument > getArguments()
Returns the current list of diagnostic arguments.
llvm::pointee_iterator< NoteVector::iterator > note_iterator
iterator_range< note_iterator > getNotes()
Returns the notes held by this diagnostic.
Diagnostic(Location loc, DiagnosticSeverity severity)
std::enable_if_t<!std::is_convertible< Arg, StringRef >::value &&std::is_constructible< DiagnosticArgument, Arg >::value, Diagnostic & > operator<<(Arg &&val)
Stream operator for inserting new diagnostic arguments.
iterator_range< const_note_iterator > getNotes() const
llvm::pointee_iterator< NoteVector::const_iterator > const_note_iterator
Diagnostic & append(Arg1 &&arg1, Arg2 &&arg2, Args &&...args)
Append arguments to the diagnostic.
SmallVectorImpl< DiagnosticArgument > & getMetadata()
Returns the current list of diagnostic metadata.
ArrayRef< DiagnosticArgument > getArguments() const
Diagnostic & appendRange(const T &c, const char *delim=", ")
Append a range to the diagnostic.
Diagnostic & operator=(Diagnostic &&)=default
Diagnostic(Diagnostic &&)=default
void print(raw_ostream &os) const
Outputs this diagnostic to a stream.
Diagnostic & appendOp(Operation &op, const OpPrintingFlags &flags)
Append an operation with the given printing flags.
An instance of this location represents a tuple of file, line number, and column number.
This class represents a diagnostic that is inflight and set to be reported.
InFlightDiagnostic & operator<<(Arg &&arg) &
Stream operator for new diagnostic arguments.
InFlightDiagnostic && append(Args &&...args) &&
InFlightDiagnostic & append(Args &&...args) &
Append arguments to the diagnostic.
Diagnostic * getUnderlyingDiagnostic()
Returns the underlying diagnostic or nullptr if this diagnostic isn't active.
InFlightDiagnostic && operator<<(Arg &&arg) &&
InFlightDiagnostic()=default
void report()
Reports the diagnostic to the engine.
Diagnostic & attachNote(std::optional< Location > noteLoc=std::nullopt)
Attaches a note to this diagnostic.
InFlightDiagnostic(InFlightDiagnostic &&rhs)
void abandon()
Abandons this diagnostic so that it will no longer be reported.
Location objects represent source locations information in MLIR.
This class defines the main interface for locations in MLIR and acts as a non-nullable wrapper around...
MLIRContext is the top-level object for a collection of MLIR operations.
Set of flags used to control the behavior of the various IR print methods (e.g.
A wrapper class that allows for printing an operation with a set of flags, useful to act as a "stream...
Operation is the basic unit of execution within MLIR.
void eraseOrderIDForThread()
Remove the order id for the current thread.
~ParallelDiagnosticHandler()
ParallelDiagnosticHandler(MLIRContext *ctx)
void setOrderIDForThread(size_t orderID)
Set the order id for the current thread.
~ScopedDiagnosticHandler()
ScopedDiagnosticHandler(MLIRContext *ctx)
ScopedDiagnosticHandler(MLIRContext *ctx, FuncTy &&handler)
void setHandler(FuncTy &&handler)
Set the handler to manage via RAII.
void setCallStackLimit(unsigned limit)
Set the maximum depth that a call stack will be printed. Defaults to 10.
void emitDiagnostic(Location loc, Twine message, DiagnosticSeverity kind, bool displaySourceLine=true)
Emit the given diagnostic information with the held source manager.
raw_ostream & os
The output stream to use when printing diagnostics.
SourceMgrDiagnosticHandler(llvm::SourceMgr &mgr, MLIRContext *ctx, raw_ostream &os, ShouldShowLocFn &&shouldShowLocFn={})
~SourceMgrDiagnosticHandler()
ShouldShowLocFn shouldShowLocFn
A functor used when determining if a location for a diagnostic should be shown.
const llvm::MemoryBuffer * getBufferForFile(StringRef filename)
Get a memory buffer for the given file, or nullptr if no file is available.
llvm::SourceMgr & mgr
The source manager that we are wrapping.
llvm::unique_function< bool(Location)> ShouldShowLocFn
This type represents a functor used to filter out locations when printing a diagnostic.
~SourceMgrDiagnosticVerifierHandler()
SourceMgrDiagnosticVerifierHandler(llvm::SourceMgr &srcMgr, MLIRContext *ctx, raw_ostream &out, Level level=Level::All)
void registerInContext(MLIRContext *ctx)
Register this handler with the given context.
LogicalResult verify()
Returns the status of the handler and verifies that all expected diagnostics were emitted.
Instances of the Type class are uniqued, have an immutable identifier and an optional mutable compone...
This class represents an instance of an SSA value in the MLIR system, representing a computable value...
The OpAsmOpInterface, see OpAsmInterface.td for more details.
Include the generated interface declarations.
InFlightDiagnostic emitWarning(Location loc)
Utility method to emit a warning message using this location.
DiagnosticSeverity
Defines the different supported severity of a diagnostic.
raw_ostream & operator<<(raw_ostream &os, const AliasResult &result)
LogicalResult emitOptionalRemark(std::optional< Location > loc, Args &&...args)
LogicalResult emitOptionalError(std::optional< Location > loc, Args &&...args)
Overloads of the above emission functions that take an optionally null location.
InFlightDiagnostic emitError(Location loc)
Utility method to emit an error message using this location.
InFlightDiagnostic emitRemark(Location loc)
Utility method to emit a remark message using this location.
LogicalResult emitOptionalWarning(std::optional< Location > loc, Args &&...args)