rename to PatternLoggingListener

Author: j2kun

mlir/include/mlir/IR/PatternMatch.h

@@ -475,8 +475,10 @@ class RewriterBase : public OpBuilder {
     RewriterBase::Listener *rewriteListener;
   };
 
-  struct CatalogingListener : public RewriterBase::ForwardingListener {
-    CatalogingListener(OpBuilder::Listener *listener, StringRef patternName)
+  /// A listener that logs notification events to llvm::dbgs() before
+  /// forwarding to the base listener.
+  struct PatternLoggingListener : public RewriterBase::ForwardingListener {
+    PatternLoggingListener(OpBuilder::Listener *listener, StringRef patternName)
         : RewriterBase::ForwardingListener(listener), patternName(patternName) {
     }
 

mlir/lib/IR/CMakeLists.txt

@@ -18,7 +18,6 @@ add_mlir_library(MLIRIR
   BuiltinDialectBytecode.cpp
   BuiltinTypes.cpp
   BuiltinTypeInterfaces.cpp
-  CatalogingListener.cpp
   Diagnostics.cpp
   Dialect.cpp
   DialectResourceBlobManager.cpp
@@ -30,6 +29,7 @@ add_mlir_library(MLIRIR
   ODSSupport.cpp
   Operation.cpp
   OperationSupport.cpp
+  PatternLoggingListener.cpp
   PatternMatch.cpp
   Region.cpp
   RegionKindInterface.cpp

mlir/lib/IR/CatalogingListener.cpp renamed to mlir/lib/IR/PatternLoggingListener.cpp

@@ -1,28 +1,28 @@
 #include "mlir/IR/PatternMatch.h"
 #include "llvm/Support/Debug.h"
 
-#define DEBUG_TYPE "generate-pattern-catalog"
+#define DEBUG_TYPE "pattern-logging-listener"
 
 using namespace mlir;
 
-static constexpr StringLiteral catalogPrefix = "CatalogingListener: ";
+static constexpr StringLiteral catalogPrefix = "PatternLoggingListener: ";
 
-void RewriterBase::CatalogingListener::notifyOperationInserted(
+void RewriterBase::PatternLoggingListener::notifyOperationInserted(
     Operation *op, InsertPoint previous) {
   LLVM_DEBUG(llvm::dbgs() << catalogPrefix << patternName
                           << " | notifyOperationInserted"
                           << " | " << op->getName() << "\n");
   ForwardingListener::notifyOperationInserted(op, previous);
 }
 
-void RewriterBase::CatalogingListener::notifyOperationModified(Operation *op) {
+void RewriterBase::PatternLoggingListener::notifyOperationModified(Operation *op) {
   LLVM_DEBUG(llvm::dbgs() << catalogPrefix << patternName
                           << " | notifyOperationModified"
                           << " | " << op->getName() << "\n");
   ForwardingListener::notifyOperationModified(op);
 }
 
-void RewriterBase::CatalogingListener::notifyOperationReplaced(
+void RewriterBase::PatternLoggingListener::notifyOperationReplaced(
     Operation *op, Operation *newOp) {
   LLVM_DEBUG(llvm::dbgs() << catalogPrefix << patternName
                           << " | notifyOperationReplaced (with op)"
@@ -31,22 +31,22 @@ void RewriterBase::CatalogingListener::notifyOperationReplaced(
   ForwardingListener::notifyOperationReplaced(op, newOp);
 }
 
-void RewriterBase::CatalogingListener::notifyOperationReplaced(
+void RewriterBase::PatternLoggingListener::notifyOperationReplaced(
     Operation *op, ValueRange replacement) {
   LLVM_DEBUG(llvm::dbgs() << catalogPrefix << patternName
                           << " | notifyOperationReplaced (with values)"
                           << " | " << op->getName() << "\n");
   ForwardingListener::notifyOperationReplaced(op, replacement);
 }
 
-void RewriterBase::CatalogingListener::notifyOperationErased(Operation *op) {
+void RewriterBase::PatternLoggingListener::notifyOperationErased(Operation *op) {
   LLVM_DEBUG(llvm::dbgs() << catalogPrefix << patternName
                           << " | notifyOperationErased"
                           << " | " << op->getName() << "\n");
   ForwardingListener::notifyOperationErased(op);
 }
 
-void RewriterBase::CatalogingListener::notifyPatternBegin(
+void RewriterBase::PatternLoggingListener::notifyPatternBegin(
     const Pattern &pattern, Operation *op) {
   LLVM_DEBUG(llvm::dbgs() << catalogPrefix << patternName
                           << " | notifyPatternBegin"

mlir/lib/Rewrite/PatternApplicator.cpp

@@ -15,6 +15,10 @@
 #include "ByteCode.h"
 #include "llvm/Support/Debug.h"
 
+#ifndef NDEBUG
+#include "llvm/ADT/ScopeExit.h"
+#endif
+
 #define DEBUG_TYPE "pattern-application"
 
 using namespace mlir;
@@ -212,11 +216,11 @@ LogicalResult PatternApplicator::matchAndRewrite(
 #ifndef NDEBUG
             OpBuilder::Listener *oldListener = rewriter.getListener();
             auto catalogingListener =
-                std::make_unique<RewriterBase::CatalogingListener>(
+                std::make_unique<RewriterBase::PatternLoggingListener>(
                     oldListener, pattern->getDebugName());
             rewriter.setListener(catalogingListener.get());
-            llvm::make_scope_exit([&] {
-          rewriter.setListener(oldListener); };
+            auto resetListenerCallback = llvm::make_scope_exit(
+                [&] { rewriter.setListener(oldListener); });
 #endif
             result = pattern->matchAndRewrite(op, rewriter);
             LLVM_DEBUG(llvm::dbgs()

mlir/test/lit.cfg.py

@@ -306,7 +306,7 @@ def find_real_python_interpreter():
         [
             ToolSubst(
                 "mlir-opt",
-                "mlir-opt --debug-only=generate-pattern-catalog --mlir-disable-threading",
+                "mlir-opt --debug-only=pattern-logging-listener --mlir-disable-threading",
                 unresolved="fatal",
             ),
             ToolSubst("FileCheck", "FileCheck --dump-input=always", unresolved="fatal"),