Skip to content

[mlir][IR][NFC] Listener::notifyMatchFailure returns void #80704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -992,7 +992,7 @@ class TrackingListener : public RewriterBase::Listener,
/// Notify the listener that the pattern failed to match the given operation,
/// and provide a callback to populate a diagnostic with the reason why the
/// failure occurred.
LogicalResult
void
notifyMatchFailure(Location loc,
function_ref<void(Diagnostic &)> reasonCallback) override;

Expand Down
19 changes: 6 additions & 13 deletions mlir/include/mlir/IR/PatternMatch.h
Original file line number Diff line number Diff line change
Expand Up @@ -437,11 +437,9 @@ class RewriterBase : public OpBuilder {
/// reason why the failure occurred. This method allows for derived
/// listeners to optionally hook into the reason why a rewrite failed, and
/// display it to users.
virtual LogicalResult
virtual void
notifyMatchFailure(Location loc,
function_ref<void(Diagnostic &)> reasonCallback) {
return failure();
}
function_ref<void(Diagnostic &)> reasonCallback) {}

static bool classof(const OpBuilder::Listener *base);
};
Expand Down Expand Up @@ -480,12 +478,11 @@ class RewriterBase : public OpBuilder {
if (auto *rewriteListener = dyn_cast<RewriterBase::Listener>(listener))
rewriteListener->notifyOperationRemoved(op);
}
LogicalResult notifyMatchFailure(
void notifyMatchFailure(
Location loc,
function_ref<void(Diagnostic &)> reasonCallback) override {
if (auto *rewriteListener = dyn_cast<RewriterBase::Listener>(listener))
return rewriteListener->notifyMatchFailure(loc, reasonCallback);
return failure();
rewriteListener->notifyMatchFailure(loc, reasonCallback);
}

private:
Expand Down Expand Up @@ -688,20 +685,16 @@ class RewriterBase : public OpBuilder {
template <typename CallbackT>
std::enable_if_t<!std::is_convertible<CallbackT, Twine>::value, LogicalResult>
notifyMatchFailure(Location loc, CallbackT &&reasonCallback) {
#ifndef NDEBUG
if (auto *rewriteListener = dyn_cast_if_present<Listener>(listener))
return rewriteListener->notifyMatchFailure(
rewriteListener->notifyMatchFailure(
loc, function_ref<void(Diagnostic &)>(reasonCallback));
return failure();
#else
return failure();
#endif
}
template <typename CallbackT>
std::enable_if_t<!std::is_convertible<CallbackT, Twine>::value, LogicalResult>
notifyMatchFailure(Operation *op, CallbackT &&reasonCallback) {
if (auto *rewriteListener = dyn_cast_if_present<Listener>(listener))
return rewriteListener->notifyMatchFailure(
rewriteListener->notifyMatchFailure(
op->getLoc(), function_ref<void(Diagnostic &)>(reasonCallback));
return failure();
}
Expand Down
2 changes: 1 addition & 1 deletion mlir/include/mlir/Transforms/DialectConversion.h
Original file line number Diff line number Diff line change
Expand Up @@ -740,7 +740,7 @@ class ConversionPatternRewriter final : public PatternRewriter,
void cancelOpModification(Operation *op) override;

/// PatternRewriter hook for notifying match failure reasons.
LogicalResult
void
notifyMatchFailure(Location loc,
function_ref<void(Diagnostic &)> reasonCallback) override;
using PatternRewriter::notifyMatchFailure;
Expand Down
3 changes: 1 addition & 2 deletions mlir/lib/Dialect/Transform/IR/TransformInterfaces.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1265,14 +1265,13 @@ DiagnosedSilenceableFailure transform::TrackingListener::findReplacementOp(
return diag;
}

LogicalResult transform::TrackingListener::notifyMatchFailure(
void transform::TrackingListener::notifyMatchFailure(
Location loc, function_ref<void(Diagnostic &)> reasonCallback) {
LLVM_DEBUG({
Diagnostic diag(loc, DiagnosticSeverity::Remark);
reasonCallback(diag);
DBGS() << "Match Failure : " << diag.str() << "\n";
});
return failure();
}

void transform::TrackingListener::notifyOperationRemoved(Operation *op) {
Expand Down
15 changes: 7 additions & 8 deletions mlir/lib/Transforms/Utils/DialectConversion.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -921,9 +921,8 @@ struct ConversionPatternRewriterImpl {
Block::iterator before);

/// Notifies that a pattern match failed for the given reason.
LogicalResult
notifyMatchFailure(Location loc,
function_ref<void(Diagnostic &)> reasonCallback);
void notifyMatchFailure(Location loc,
function_ref<void(Diagnostic &)> reasonCallback);

//===--------------------------------------------------------------------===//
// State
Expand Down Expand Up @@ -1236,10 +1235,11 @@ LogicalResult ConversionPatternRewriterImpl::remapValues(
legalTypes.clear();
if (failed(currentTypeConverter->convertType(origType, legalTypes))) {
Location operandLoc = inputLoc ? *inputLoc : operand.getLoc();
return notifyMatchFailure(operandLoc, [=](Diagnostic &diag) {
notifyMatchFailure(operandLoc, [=](Diagnostic &diag) {
diag << "unable to convert type for " << valueDiagTag << " #"
<< it.index() << ", type was " << origType;
});
return failure();
}
// TODO: There currently isn't any mechanism to do 1->N type conversion
// via the PatternRewriter replacement API, so for now we just ignore it.
Expand Down Expand Up @@ -1419,7 +1419,7 @@ void ConversionPatternRewriterImpl::notifyBlockBeingInlined(
blockActions.push_back(BlockAction::getInline(block, srcBlock, before));
}

LogicalResult ConversionPatternRewriterImpl::notifyMatchFailure(
void ConversionPatternRewriterImpl::notifyMatchFailure(
Location loc, function_ref<void(Diagnostic &)> reasonCallback) {
LLVM_DEBUG({
Diagnostic diag(loc, DiagnosticSeverity::Remark);
Expand All @@ -1428,7 +1428,6 @@ LogicalResult ConversionPatternRewriterImpl::notifyMatchFailure(
if (notifyCallback)
notifyCallback(diag);
});
return failure();
}

//===----------------------------------------------------------------------===//
Expand Down Expand Up @@ -1615,9 +1614,9 @@ void ConversionPatternRewriter::cancelOpModification(Operation *op) {
rootUpdates.erase(rootUpdates.begin() + updateIdx);
}

LogicalResult ConversionPatternRewriter::notifyMatchFailure(
void ConversionPatternRewriter::notifyMatchFailure(
Location loc, function_ref<void(Diagnostic &)> reasonCallback) {
return impl->notifyMatchFailure(loc, reasonCallback);
impl->notifyMatchFailure(loc, reasonCallback);
}

void ConversionPatternRewriter::moveOpBefore(Operation *op, Block *block,
Expand Down
7 changes: 3 additions & 4 deletions mlir/lib/Transforms/Utils/GreedyPatternRewriteDriver.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ class GreedyPatternRewriteDriver : public PatternRewriter,
void notifyBlockRemoved(Block *block) override;

/// For debugging only: Notify the driver of a pattern match failure.
LogicalResult
void
notifyMatchFailure(Location loc,
function_ref<void(Diagnostic &)> reasonCallback) override;

Expand Down Expand Up @@ -726,16 +726,15 @@ void GreedyPatternRewriteDriver::notifyOperationReplaced(
config.listener->notifyOperationReplaced(op, replacement);
}

LogicalResult GreedyPatternRewriteDriver::notifyMatchFailure(
void GreedyPatternRewriteDriver::notifyMatchFailure(
Location loc, function_ref<void(Diagnostic &)> reasonCallback) {
LLVM_DEBUG({
Diagnostic diag(loc, DiagnosticSeverity::Remark);
reasonCallback(diag);
logger.startLine() << "** Failure : " << diag.str() << "\n";
});
if (config.listener)
return config.listener->notifyMatchFailure(loc, reasonCallback);
return failure();
config.listener->notifyMatchFailure(loc, reasonCallback);
}

//===----------------------------------------------------------------------===//
Expand Down