[Mlir-commits] [mlir] [mlir] [core]: in -mlir-print-ir-*, dump the pass options as well (PR #195198)
Jeremy Kun
llvmlistbot at llvm.org
Thu Apr 30 20:47:45 PDT 2026
https://github.com/j2kun updated https://github.com/llvm/llvm-project/pull/195198
>From 9a618de1cc56b3efbd92c813ce56f320bab70754 Mon Sep 17 00:00:00 2001
From: Jeremy Kun <jkun at google.com>
Date: Thu, 30 Apr 2026 16:42:00 -0700
Subject: [PATCH 1/3] [mlir] [core]: in -mlir-print-ir-*, dump the pass options
as well
---
mlir/lib/Pass/IRPrinting.cpp | 32 +++++++++++++++++++++-----------
mlir/test/Pass/ir-printing.mlir | 4 ++++
2 files changed, 25 insertions(+), 11 deletions(-)
diff --git a/mlir/lib/Pass/IRPrinting.cpp b/mlir/lib/Pass/IRPrinting.cpp
index c11dbc627c0be..6eab721045176 100644
--- a/mlir/lib/Pass/IRPrinting.cpp
+++ b/mlir/lib/Pass/IRPrinting.cpp
@@ -46,12 +46,18 @@ class IRPrinterInstrumentation : public PassInstrumentation {
};
} // namespace
-static void printIR(Operation *op, bool printModuleScope, raw_ostream &out,
- OpPrintingFlags flags) {
+static void printIR(Operation* op, bool printModuleScope, raw_ostream& out,
+ OpPrintingFlags flags, Pass *pass = nullptr) {
// Otherwise, check to see if we are not printing at module scope.
- if (!printModuleScope)
- return op->print(out << " //----- //\n",
- op->getBlock() ? flags.useLocalScope() : flags);
+ if (!printModuleScope) {
+ out << " //----- //\n";
+ if (pass) {
+ out << "// Pass options: ";
+ pass->printAsTextualPipeline(out);
+ out << "\n";
+ }
+ return op->print(out, op->getBlock() ? flags.useLocalScope() : flags);
+ }
// Otherwise, we are printing at module scope.
out << " ('" << op->getName() << "' operation";
@@ -59,11 +65,15 @@ static void printIR(Operation *op, bool printModuleScope, raw_ostream &out,
op->getAttrOfType<StringAttr>(SymbolTable::getSymbolAttrName()))
out << ": @" << symbolName.getValue();
out << ") //----- //\n";
+ if (pass) {
+ out << "// Pass options: ";
+ pass->printAsTextualPipeline(out);
+ out << "\n";
+ }
// Find the top-level operation.
- auto *topLevelOp = op;
- while (auto *parentOp = topLevelOp->getParentOp())
- topLevelOp = parentOp;
+ auto* topLevelOp = op;
+ while (auto* parentOp = topLevelOp->getParentOp()) topLevelOp = parentOp;
topLevelOp->print(out, flags);
}
@@ -79,7 +89,7 @@ void IRPrinterInstrumentation::runBeforePass(Pass *pass, Operation *op) {
out << "// -----// IR Dump Before " << pass->getName() << " ("
<< pass->getArgument() << ")";
printIR(op, config->shouldPrintAtModuleScope(), out,
- config->getOpPrintingFlags());
+ config->getOpPrintingFlags(), pass);
out << "\n\n";
});
}
@@ -110,7 +120,7 @@ void IRPrinterInstrumentation::runAfterPass(Pass *pass, Operation *op) {
out << "// -----// IR Dump After " << pass->getName() << " ("
<< pass->getArgument() << ")";
printIR(op, config->shouldPrintAtModuleScope(), out,
- config->getOpPrintingFlags());
+ config->getOpPrintingFlags(), pass);
out << "\n\n";
});
}
@@ -125,7 +135,7 @@ void IRPrinterInstrumentation::runAfterPassFailed(Pass *pass, Operation *op) {
out << formatv("// -----// IR Dump After {0} Failed ({1})", pass->getName(),
pass->getArgument());
printIR(op, config->shouldPrintAtModuleScope(), out,
- config->getOpPrintingFlags());
+ config->getOpPrintingFlags(), pass);
out << "\n\n";
});
}
diff --git a/mlir/test/Pass/ir-printing.mlir b/mlir/test/Pass/ir-printing.mlir
index 467d76fdaa7f6..2da605f808d7d 100644
--- a/mlir/test/Pass/ir-printing.mlir
+++ b/mlir/test/Pass/ir-printing.mlir
@@ -5,6 +5,7 @@
// RUN: mlir-opt %s -mlir-disable-threading=true -pass-pipeline='builtin.module(func.func(cse,canonicalize))' -mlir-print-ir-before=cse -mlir-print-ir-module-scope -o /dev/null 2>&1 | FileCheck -check-prefix=BEFORE_MODULE %s
// RUN: mlir-opt %s -mlir-disable-threading=true -pass-pipeline='builtin.module(func.func(cse,cse))' -mlir-print-ir-after-all -mlir-print-ir-after-change -o /dev/null 2>&1 | FileCheck -check-prefix=AFTER_ALL_CHANGE %s
// RUN: not mlir-opt %s -mlir-disable-threading=true -pass-pipeline='builtin.module(func.func(cse,test-pass-failure))' -mlir-print-ir-after-failure -o /dev/null 2>&1 | FileCheck -check-prefix=AFTER_FAILURE %s
+// RUN: mlir-opt %s -mlir-disable-threading=true -pass-pipeline='builtin.module(func.func(canonicalize{max-iterations=5}))' -mlir-print-ir-before=canonicalize -o /dev/null 2>&1 | FileCheck -check-prefix=OPTIONS %s
func.func @foo() {
%0 = arith.constant 0 : i32
@@ -65,3 +66,6 @@ func.func @bar() {
// AFTER_FAILURE-NOT: // -----// IR Dump After{{.*}}CSE
// AFTER_FAILURE: // -----// IR Dump After{{.*}}TestFailurePass Failed (test-pass-failure) //----- //
// AFTER_FAILURE: func @foo()
+
+// OPTIONS: // -----// IR Dump Before{{.*}}CanonicalizerPass (canonicalize) //----- //
+// OPTIONS-NEXT: // Pass options: canonicalize{cse-between-iterations=false{{[[:space:]]*}}max-iterations=5 max-num-rewrites=-1 region-simplify=normal test-convergence=false top-down=true}
>From 9a36bebc9e0b9d6bd7466597c12f86489339d5e8 Mon Sep 17 00:00:00 2001
From: Jeremy Kun <jkun at google.com>
Date: Thu, 30 Apr 2026 16:51:17 -0700
Subject: [PATCH 2/3] format
---
mlir/lib/Pass/IRPrinting.cpp | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/mlir/lib/Pass/IRPrinting.cpp b/mlir/lib/Pass/IRPrinting.cpp
index 6eab721045176..41c50625f0edc 100644
--- a/mlir/lib/Pass/IRPrinting.cpp
+++ b/mlir/lib/Pass/IRPrinting.cpp
@@ -46,7 +46,7 @@ class IRPrinterInstrumentation : public PassInstrumentation {
};
} // namespace
-static void printIR(Operation* op, bool printModuleScope, raw_ostream& out,
+static void printIR(Operation *op, bool printModuleScope, raw_ostream &out,
OpPrintingFlags flags, Pass *pass = nullptr) {
// Otherwise, check to see if we are not printing at module scope.
if (!printModuleScope) {
@@ -72,8 +72,9 @@ static void printIR(Operation* op, bool printModuleScope, raw_ostream& out,
}
// Find the top-level operation.
- auto* topLevelOp = op;
- while (auto* parentOp = topLevelOp->getParentOp()) topLevelOp = parentOp;
+ auto *topLevelOp = op;
+ while (auto *parentOp = topLevelOp->getParentOp())
+ topLevelOp = parentOp;
topLevelOp->print(out, flags);
}
>From d18741dd92b034e836b06dfdde13fd4730caa236 Mon Sep 17 00:00:00 2001
From: Jeremy Kun <jkun at google.com>
Date: Thu, 30 Apr 2026 20:47:31 -0700
Subject: [PATCH 3/3] relax '-next' assertions that are no longer valid
---
mlir/test/Pass/dynamic-pipeline-nested.mlir | 8 +++----
mlir/test/Pass/dynamic-pipeline.mlir | 16 ++++++-------
mlir/test/Pass/ir-printing.mlir | 26 ++++++++++-----------
mlir/test/Pass/run-reproducer.mlir | 4 ++--
4 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/mlir/test/Pass/dynamic-pipeline-nested.mlir b/mlir/test/Pass/dynamic-pipeline-nested.mlir
index ac2fdd3265b63..5f480e42b084f 100644
--- a/mlir/test/Pass/dynamic-pipeline-nested.mlir
+++ b/mlir/test/Pass/dynamic-pipeline-nested.mlir
@@ -10,7 +10,7 @@ func.func @f() {
// CHECK: IR Dump Before
// CHECK-SAME: TestDynamicPipelinePass
-// CHECK-NEXT: module @inner_mod1
+// CHECK: module @inner_mod1
module @inner_mod1 {
// We use the mlir-print-ir-after-all dumps to check the granularity of the
// scheduling: if we are nesting we expect to see to individual "Dump Before
@@ -18,11 +18,11 @@ module @inner_mod1 {
// the CSE pass to run on the `inner_mod1` module directly.
// CHECK: Dump Before CSE
-// NOTNESTED-NEXT: @inner_mod1
-// NESTED-NEXT: @foo
+// NOTNESTED: @inner_mod1
+// NESTED: @foo
module @foo {}
// Only in the nested case we have a second run of the pass here.
// NESTED: Dump Before CSE
-// NESTED-NEXT: @baz
+// NESTED: @baz
module @baz {}
}
diff --git a/mlir/test/Pass/dynamic-pipeline.mlir b/mlir/test/Pass/dynamic-pipeline.mlir
index 5e31ba476aeb0..7cae9284f44d2 100644
--- a/mlir/test/Pass/dynamic-pipeline.mlir
+++ b/mlir/test/Pass/dynamic-pipeline.mlir
@@ -10,20 +10,20 @@ func.func @f() {
// CHECK: IR Dump Before
// CHECK-SAME: TestDynamicPipelinePass
-// CHECK-NEXT: module @inner_mod1
+// CHECK: module @inner_mod1
// MOD2-ONLY: dynamic-pipeline skip op name: inner_mod1
module @inner_mod1 {
// MOD1: Dump Before CSE
-// MOD1-NEXT: @foo
+// MOD1: @foo
// MOD1: Dump Before Canonicalizer
-// MOD1-NEXT: @foo
+// MOD1: @foo
func.func @foo() {
return
}
// MOD1: Dump Before CSE
-// MOD1-NEXT: @baz
+// MOD1: @baz
// MOD1: Dump Before Canonicalizer
-// MOD1-NEXT: @baz
+// MOD1: @baz
func.func @baz() {
return
}
@@ -31,13 +31,13 @@ module @inner_mod1 {
// CHECK: IR Dump Before
// CHECK-SAME: TestDynamicPipelinePass
-// CHECK-NEXT: module @inner_mod2
+// CHECK: module @inner_mod2
// MOD1-ONLY: dynamic-pipeline skip op name: inner_mod2
module @inner_mod2 {
// MOD2: Dump Before CSE
-// MOD2-NEXT: @foo
+// MOD2: @foo
// MOD2: Dump Before Canonicalizer
-// MOD2-NEXT: @foo
+// MOD2: @foo
func.func @foo() {
return
}
diff --git a/mlir/test/Pass/ir-printing.mlir b/mlir/test/Pass/ir-printing.mlir
index 2da605f808d7d..44f7b3ebc2905 100644
--- a/mlir/test/Pass/ir-printing.mlir
+++ b/mlir/test/Pass/ir-printing.mlir
@@ -17,38 +17,38 @@ func.func @bar() {
}
// BEFORE: // -----// IR Dump Before{{.*}}CSEPass (cse) //----- //
-// BEFORE-NEXT: func @foo()
+// BEFORE: func @foo()
// BEFORE: // -----// IR Dump Before{{.*}}CSEPass (cse) //----- //
-// BEFORE-NEXT: func @bar()
+// BEFORE: func @bar()
// BEFORE-NOT: // -----// IR Dump Before{{.*}}CanonicalizerPass (canonicalize) //----- //
// BEFORE-NOT: // -----// IR Dump After
// BEFORE_ALL: // -----// IR Dump Before{{.*}}CSEPass (cse) //----- //
-// BEFORE_ALL-NEXT: func @foo()
+// BEFORE_ALL: func @foo()
// BEFORE_ALL: // -----// IR Dump Before{{.*}}CanonicalizerPass (canonicalize) //----- //
-// BEFORE_ALL-NEXT: func @foo()
+// BEFORE_ALL: func @foo()
// BEFORE_ALL: // -----// IR Dump Before{{.*}}CSEPass (cse) //----- //
-// BEFORE_ALL-NEXT: func @bar()
+// BEFORE_ALL: func @bar()
// BEFORE_ALL: // -----// IR Dump Before{{.*}}CanonicalizerPass (canonicalize) //----- //
-// BEFORE_ALL-NEXT: func @bar()
+// BEFORE_ALL: func @bar()
// BEFORE_ALL-NOT: // -----// IR Dump After
// AFTER-NOT: // -----// IR Dump Before
// AFTER: // -----// IR Dump After{{.*}}CSEPass (cse) //----- //
-// AFTER-NEXT: func @foo()
+// AFTER: func @foo()
// AFTER: // -----// IR Dump After{{.*}}CSEPass (cse) //----- //
-// AFTER-NEXT: func @bar()
+// AFTER: func @bar()
// AFTER-NOT: // -----// IR Dump After{{.*}}CanonicalizerPass (canonicalize) //----- //
// AFTER_ALL-NOT: // -----// IR Dump Before
// AFTER_ALL: // -----// IR Dump After{{.*}}CSEPass (cse) //----- //
-// AFTER_ALL-NEXT: func @foo()
+// AFTER_ALL: func @foo()
// AFTER_ALL: // -----// IR Dump After{{.*}}CanonicalizerPass (canonicalize) //----- //
-// AFTER_ALL-NEXT: func @foo()
+// AFTER_ALL: func @foo()
// AFTER_ALL: // -----// IR Dump After{{.*}}CSEPass (cse) //----- //
-// AFTER_ALL-NEXT: func @bar()
+// AFTER_ALL: func @bar()
// AFTER_ALL: // -----// IR Dump After{{.*}}CanonicalizerPass (canonicalize) //----- //
-// AFTER_ALL-NEXT: func @bar()
+// AFTER_ALL: func @bar()
// BEFORE_MODULE: // -----// IR Dump Before{{.*}}CSEPass (cse) ('func.func' operation: @foo) //----- //
// BEFORE_MODULE: func @foo()
@@ -58,7 +58,7 @@ func.func @bar() {
// BEFORE_MODULE: func @bar()
// AFTER_ALL_CHANGE: // -----// IR Dump After{{.*}}CSEPass (cse) //----- //
-// AFTER_ALL_CHANGE-NEXT: func @foo()
+// AFTER_ALL_CHANGE: func @foo()
// AFTER_ALL_CHANGE-NOT: // -----// IR Dump After{{.*}}CSEPass (cse) //----- //
// We expect that only 'foo' changed during CSE, and the second run of CSE did
// nothing.
diff --git a/mlir/test/Pass/run-reproducer.mlir b/mlir/test/Pass/run-reproducer.mlir
index 68f634d2038fc..4ff8ad9c0baeb 100644
--- a/mlir/test/Pass/run-reproducer.mlir
+++ b/mlir/test/Pass/run-reproducer.mlir
@@ -27,8 +27,8 @@ func.func @bar() {
#-}
// BEFORE: // -----// IR Dump Before{{.*}}CSEPass (cse) //----- //
-// BEFORE-NEXT: func @foo()
+// BEFORE: func @foo()
// BEFORE: // -----// IR Dump Before{{.*}}CSEPass (cse) //----- //
-// BEFORE-NEXT: func @bar()
+// BEFORE: func @bar()
// BEFORE-NOT: // -----// IR Dump Before{{.*}}CanonicalizerPass (canonicalize) //----- //
// BEFORE-NOT: // -----// IR Dump After
More information about the Mlir-commits
mailing list