[MLIR] Migrate pattern application / dialect conversion to the LDBG logging format #150991
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@llvm/pr-subscribers-llvm-support Author: Mehdi Amini (joker-eph) ChangesThis prefix the output with the DEBUG_TYPE. Full diff: https://github.com/llvm/llvm-project/pull/150991.diff 3 Files Affected:
diff --git a/llvm/include/llvm/Support/DebugLog.h b/llvm/include/llvm/Support/DebugLog.h
index 8fca2d5e2816b..1b4fe9d13030f 100644
--- a/llvm/include/llvm/Support/DebugLog.h
+++ b/llvm/include/llvm/Support/DebugLog.h
@@ -85,7 +85,8 @@ namespace impl {
class LLVM_ABI raw_ldbg_ostream final : public raw_ostream {
std::string Prefix;
raw_ostream &Os;
- bool HasPendingNewline = true;
+ bool HasPendingNewline;
+ bool ShouldPrintNewline;
/// Split the line on newlines and insert the prefix before each newline.
/// Forward everything to the underlying stream.
@@ -117,13 +118,17 @@ class LLVM_ABI raw_ldbg_ostream final : public raw_ostream {
}
public:
- explicit raw_ldbg_ostream(std::string Prefix, raw_ostream &Os)
- : Prefix(std::move(Prefix)), Os(Os) {
+ explicit raw_ldbg_ostream(std::string Prefix, raw_ostream &Os,
+ bool HasPendingNewline = true,
+ bool ShouldPrintNewline = true)
+ : Prefix(std::move(Prefix)), Os(Os), HasPendingNewline(HasPendingNewline),
+ ShouldPrintNewline(ShouldPrintNewline) {
SetUnbuffered();
}
~raw_ldbg_ostream() final {
flushEol();
- Os << '\n';
+ if (ShouldPrintNewline)
+ Os << '\n';
}
void flushEol() {
if (HasPendingNewline) {
diff --git a/mlir/lib/Rewrite/PatternApplicator.cpp b/mlir/lib/Rewrite/PatternApplicator.cpp
index b2b372b7b1249..e13bcff2767ec 100644
--- a/mlir/lib/Rewrite/PatternApplicator.cpp
+++ b/mlir/lib/Rewrite/PatternApplicator.cpp
@@ -13,7 +13,7 @@
#include "mlir/Rewrite/PatternApplicator.h"
#include "ByteCode.h"
-#include "llvm/Support/Debug.h"
+#include "llvm/Support/DebugLog.h"
#ifndef NDEBUG
#include "llvm/ADT/ScopeExit.h"
@@ -51,9 +51,7 @@ static Operation *getDumpRootOp(Operation *op) {
return op;
}
static void logSucessfulPatternApplication(Operation *op) {
- llvm::dbgs() << "// *** IR Dump After Pattern Application ***\n";
- op->dump();
- llvm::dbgs() << "\n\n";
+ LDBG(2) << "// *** IR Dump After Pattern Application ***\n" << *op << "\n";
}
#endif
@@ -208,8 +206,8 @@ LogicalResult PatternApplicator::matchAndRewrite(
result =
bytecode->rewrite(rewriter, *pdlMatch, *mutableByteCodeState);
} else {
- LLVM_DEBUG(llvm::dbgs() << "Trying to match \""
- << bestPattern->getDebugName() << "\"\n");
+ LDBG() << "Trying to match \"" << bestPattern->getDebugName()
+ << "\"";
const auto *pattern =
static_cast<const RewritePattern *>(bestPattern);
@@ -223,9 +221,8 @@ LogicalResult PatternApplicator::matchAndRewrite(
[&] { rewriter.setListener(oldListener); });
#endif
result = pattern->matchAndRewrite(op, rewriter);
- LLVM_DEBUG(llvm::dbgs()
- << "\"" << bestPattern->getDebugName() << "\" result "
- << succeeded(result) << "\n");
+ LDBG() << " -> matchAndRewrite "
+ << (succeeded(result) ? "successful" : "failed");
}
// Process the result of the pattern application.
diff --git a/mlir/lib/Transforms/Utils/DialectConversion.cpp b/mlir/lib/Transforms/Utils/DialectConversion.cpp
index 08803e082b057..abd75558e290f 100644
--- a/mlir/lib/Transforms/Utils/DialectConversion.cpp
+++ b/mlir/lib/Transforms/Utils/DialectConversion.cpp
@@ -20,6 +20,7 @@
#include "llvm/ADT/ScopeExit.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/Support/Debug.h"
+#include "llvm/Support/DebugLog.h"
#include "llvm/Support/FormatVariadic.h"
#include "llvm/Support/SaveAndRestore.h"
#include "llvm/Support/ScopedPrinter.h"
@@ -1129,8 +1130,14 @@ struct ConversionPatternRewriterImpl : public RewriterBase::Listener {
/// verification.
SmallPtrSet<Operation *, 1> pendingRootUpdates;
+ /// A raw output stream used to prefix the debug log.
+ llvm::impl::raw_ldbg_ostream os{(Twine("[") + DEBUG_TYPE + "] ").str(),
+ llvm::dbgs(), /*HasPendingNewline=*/false,
+ /*ShouldPrintNewline=*/false};
+
/// A logger used to emit diagnostics during the conversion process.
- llvm::ScopedPrinter logger{llvm::dbgs()};
+ llvm::ScopedPrinter logger{os};
+ std::string logPrefix;
#endif
};
} // namespace detail
|
|
@llvm/pr-subscribers-mlir-core Author: Mehdi Amini (joker-eph) ChangesThis prefix the output with the DEBUG_TYPE. Full diff: https://github.com/llvm/llvm-project/pull/150991.diff 3 Files Affected:
diff --git a/llvm/include/llvm/Support/DebugLog.h b/llvm/include/llvm/Support/DebugLog.h
index 8fca2d5e2816b..1b4fe9d13030f 100644
--- a/llvm/include/llvm/Support/DebugLog.h
+++ b/llvm/include/llvm/Support/DebugLog.h
@@ -85,7 +85,8 @@ namespace impl {
class LLVM_ABI raw_ldbg_ostream final : public raw_ostream {
std::string Prefix;
raw_ostream &Os;
- bool HasPendingNewline = true;
+ bool HasPendingNewline;
+ bool ShouldPrintNewline;
/// Split the line on newlines and insert the prefix before each newline.
/// Forward everything to the underlying stream.
@@ -117,13 +118,17 @@ class LLVM_ABI raw_ldbg_ostream final : public raw_ostream {
}
public:
- explicit raw_ldbg_ostream(std::string Prefix, raw_ostream &Os)
- : Prefix(std::move(Prefix)), Os(Os) {
+ explicit raw_ldbg_ostream(std::string Prefix, raw_ostream &Os,
+ bool HasPendingNewline = true,
+ bool ShouldPrintNewline = true)
+ : Prefix(std::move(Prefix)), Os(Os), HasPendingNewline(HasPendingNewline),
+ ShouldPrintNewline(ShouldPrintNewline) {
SetUnbuffered();
}
~raw_ldbg_ostream() final {
flushEol();
- Os << '\n';
+ if (ShouldPrintNewline)
+ Os << '\n';
}
void flushEol() {
if (HasPendingNewline) {
diff --git a/mlir/lib/Rewrite/PatternApplicator.cpp b/mlir/lib/Rewrite/PatternApplicator.cpp
index b2b372b7b1249..e13bcff2767ec 100644
--- a/mlir/lib/Rewrite/PatternApplicator.cpp
+++ b/mlir/lib/Rewrite/PatternApplicator.cpp
@@ -13,7 +13,7 @@
#include "mlir/Rewrite/PatternApplicator.h"
#include "ByteCode.h"
-#include "llvm/Support/Debug.h"
+#include "llvm/Support/DebugLog.h"
#ifndef NDEBUG
#include "llvm/ADT/ScopeExit.h"
@@ -51,9 +51,7 @@ static Operation *getDumpRootOp(Operation *op) {
return op;
}
static void logSucessfulPatternApplication(Operation *op) {
- llvm::dbgs() << "// *** IR Dump After Pattern Application ***\n";
- op->dump();
- llvm::dbgs() << "\n\n";
+ LDBG(2) << "// *** IR Dump After Pattern Application ***\n" << *op << "\n";
}
#endif
@@ -208,8 +206,8 @@ LogicalResult PatternApplicator::matchAndRewrite(
result =
bytecode->rewrite(rewriter, *pdlMatch, *mutableByteCodeState);
} else {
- LLVM_DEBUG(llvm::dbgs() << "Trying to match \""
- << bestPattern->getDebugName() << "\"\n");
+ LDBG() << "Trying to match \"" << bestPattern->getDebugName()
+ << "\"";
const auto *pattern =
static_cast<const RewritePattern *>(bestPattern);
@@ -223,9 +221,8 @@ LogicalResult PatternApplicator::matchAndRewrite(
[&] { rewriter.setListener(oldListener); });
#endif
result = pattern->matchAndRewrite(op, rewriter);
- LLVM_DEBUG(llvm::dbgs()
- << "\"" << bestPattern->getDebugName() << "\" result "
- << succeeded(result) << "\n");
+ LDBG() << " -> matchAndRewrite "
+ << (succeeded(result) ? "successful" : "failed");
}
// Process the result of the pattern application.
diff --git a/mlir/lib/Transforms/Utils/DialectConversion.cpp b/mlir/lib/Transforms/Utils/DialectConversion.cpp
index 08803e082b057..abd75558e290f 100644
--- a/mlir/lib/Transforms/Utils/DialectConversion.cpp
+++ b/mlir/lib/Transforms/Utils/DialectConversion.cpp
@@ -20,6 +20,7 @@
#include "llvm/ADT/ScopeExit.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/Support/Debug.h"
+#include "llvm/Support/DebugLog.h"
#include "llvm/Support/FormatVariadic.h"
#include "llvm/Support/SaveAndRestore.h"
#include "llvm/Support/ScopedPrinter.h"
@@ -1129,8 +1130,14 @@ struct ConversionPatternRewriterImpl : public RewriterBase::Listener {
/// verification.
SmallPtrSet<Operation *, 1> pendingRootUpdates;
+ /// A raw output stream used to prefix the debug log.
+ llvm::impl::raw_ldbg_ostream os{(Twine("[") + DEBUG_TYPE + "] ").str(),
+ llvm::dbgs(), /*HasPendingNewline=*/false,
+ /*ShouldPrintNewline=*/false};
+
/// A logger used to emit diagnostics during the conversion process.
- llvm::ScopedPrinter logger{llvm::dbgs()};
+ llvm::ScopedPrinter logger{os};
+ std::string logPrefix;
#endif
};
} // namespace detail
|
|
@llvm/pr-subscribers-mlir Author: Mehdi Amini (joker-eph) ChangesThis prefix the output with the DEBUG_TYPE. Full diff: https://github.com/llvm/llvm-project/pull/150991.diff 3 Files Affected:
diff --git a/llvm/include/llvm/Support/DebugLog.h b/llvm/include/llvm/Support/DebugLog.h
index 8fca2d5e2816b..1b4fe9d13030f 100644
--- a/llvm/include/llvm/Support/DebugLog.h
+++ b/llvm/include/llvm/Support/DebugLog.h
@@ -85,7 +85,8 @@ namespace impl {
class LLVM_ABI raw_ldbg_ostream final : public raw_ostream {
std::string Prefix;
raw_ostream &Os;
- bool HasPendingNewline = true;
+ bool HasPendingNewline;
+ bool ShouldPrintNewline;
/// Split the line on newlines and insert the prefix before each newline.
/// Forward everything to the underlying stream.
@@ -117,13 +118,17 @@ class LLVM_ABI raw_ldbg_ostream final : public raw_ostream {
}
public:
- explicit raw_ldbg_ostream(std::string Prefix, raw_ostream &Os)
- : Prefix(std::move(Prefix)), Os(Os) {
+ explicit raw_ldbg_ostream(std::string Prefix, raw_ostream &Os,
+ bool HasPendingNewline = true,
+ bool ShouldPrintNewline = true)
+ : Prefix(std::move(Prefix)), Os(Os), HasPendingNewline(HasPendingNewline),
+ ShouldPrintNewline(ShouldPrintNewline) {
SetUnbuffered();
}
~raw_ldbg_ostream() final {
flushEol();
- Os << '\n';
+ if (ShouldPrintNewline)
+ Os << '\n';
}
void flushEol() {
if (HasPendingNewline) {
diff --git a/mlir/lib/Rewrite/PatternApplicator.cpp b/mlir/lib/Rewrite/PatternApplicator.cpp
index b2b372b7b1249..e13bcff2767ec 100644
--- a/mlir/lib/Rewrite/PatternApplicator.cpp
+++ b/mlir/lib/Rewrite/PatternApplicator.cpp
@@ -13,7 +13,7 @@
#include "mlir/Rewrite/PatternApplicator.h"
#include "ByteCode.h"
-#include "llvm/Support/Debug.h"
+#include "llvm/Support/DebugLog.h"
#ifndef NDEBUG
#include "llvm/ADT/ScopeExit.h"
@@ -51,9 +51,7 @@ static Operation *getDumpRootOp(Operation *op) {
return op;
}
static void logSucessfulPatternApplication(Operation *op) {
- llvm::dbgs() << "// *** IR Dump After Pattern Application ***\n";
- op->dump();
- llvm::dbgs() << "\n\n";
+ LDBG(2) << "// *** IR Dump After Pattern Application ***\n" << *op << "\n";
}
#endif
@@ -208,8 +206,8 @@ LogicalResult PatternApplicator::matchAndRewrite(
result =
bytecode->rewrite(rewriter, *pdlMatch, *mutableByteCodeState);
} else {
- LLVM_DEBUG(llvm::dbgs() << "Trying to match \""
- << bestPattern->getDebugName() << "\"\n");
+ LDBG() << "Trying to match \"" << bestPattern->getDebugName()
+ << "\"";
const auto *pattern =
static_cast<const RewritePattern *>(bestPattern);
@@ -223,9 +221,8 @@ LogicalResult PatternApplicator::matchAndRewrite(
[&] { rewriter.setListener(oldListener); });
#endif
result = pattern->matchAndRewrite(op, rewriter);
- LLVM_DEBUG(llvm::dbgs()
- << "\"" << bestPattern->getDebugName() << "\" result "
- << succeeded(result) << "\n");
+ LDBG() << " -> matchAndRewrite "
+ << (succeeded(result) ? "successful" : "failed");
}
// Process the result of the pattern application.
diff --git a/mlir/lib/Transforms/Utils/DialectConversion.cpp b/mlir/lib/Transforms/Utils/DialectConversion.cpp
index 08803e082b057..abd75558e290f 100644
--- a/mlir/lib/Transforms/Utils/DialectConversion.cpp
+++ b/mlir/lib/Transforms/Utils/DialectConversion.cpp
@@ -20,6 +20,7 @@
#include "llvm/ADT/ScopeExit.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/Support/Debug.h"
+#include "llvm/Support/DebugLog.h"
#include "llvm/Support/FormatVariadic.h"
#include "llvm/Support/SaveAndRestore.h"
#include "llvm/Support/ScopedPrinter.h"
@@ -1129,8 +1130,14 @@ struct ConversionPatternRewriterImpl : public RewriterBase::Listener {
/// verification.
SmallPtrSet<Operation *, 1> pendingRootUpdates;
+ /// A raw output stream used to prefix the debug log.
+ llvm::impl::raw_ldbg_ostream os{(Twine("[") + DEBUG_TYPE + "] ").str(),
+ llvm::dbgs(), /*HasPendingNewline=*/false,
+ /*ShouldPrintNewline=*/false};
+
/// A logger used to emit diagnostics during the conversion process.
- llvm::ScopedPrinter logger{llvm::dbgs()};
+ llvm::ScopedPrinter logger{os};
+ std::string logPrefix;
#endif
};
} // namespace detail
|
jpienaar
reviewed
Jul 30, 2025
|
This is because the use of |
joker-eph
force-pushed
the
dialect_conversion_ldbg
branch
2 times, most recently
from
8d93fce to
3a85411
Compare
jpienaar
approved these changes
Jul 31, 2025
joker-eph
force-pushed
the
dialect_conversion_ldbg
branch
from
3a85411 to
9a9b8b7
Compare
joker-eph
force-pushed
the
dialect_conversion_ldbg
branch
from
3a85411 to
485e231
Compare
…ogging format This prefix the output with the DEBUG_TYPE. Dialect conversion is using a ScopedPrinter, we insert the raw_ldbg_ostream to consistently prefix each new line.
joker-eph
force-pushed
the
dialect_conversion_ldbg
branch
from
485e231 to
2a35d8d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This prefix the output with the DEBUG_TYPE.
Dialect conversion is using a ScopedPrinter, we insert the raw_ldbg_ostream to consistently prefix each new line.