[mlir] drop debug tags after TransformInterpreterPassBase

[ftynse]

Summary

The pass attaches attributes to operations for repro generation
purposes, but never removes them. This is not desirable when the pass
actually succeeds.

[bondhugula]

@ftynse You can't use -debug* flags in test case run lines. These tests will fail in release mode with assertions disabled. So you can't test your change this way.

[211/212] Running the MLIR regression tests
FAIL: MLIR :: Dialect/Transform/test-repro-dump.mlir (1 of 2062)
******************** TEST 'MLIR :: Dialect/Transform/test-repro-dump.mlir' FAILED ********************
Script:
--
: 'RUN: at line 1';   /home/uday/llvm-project-upstream/build/bin/mlir-opt /home/uday/llvm-project-upstream/mlir/test/Dialect/Transform/test-repro-dump.mlir --test-transform-dialect-interpreter              --mlir-disable-threading              --debug-only=transform-dialect-dump-repro 2>&1  | /home/uday/llvm-project-upstream/build/bin/FileCheck /home/uday/llvm-project-upstream/mlir/test/Dialect/Transform/test-repro-dump.mlir
--
Exit Code: 1

Command Output (stderr):
--
/home/uday/llvm-project-upstream/mlir/test/Dialect/Transform/test-repro-dump.mlir:15:11: error: CHECK: expected string not found in input
// CHECK: Transform Interpreter Repro
          ^
<stdin>:1:1: note: scanning from here
mlir-opt: Unknown command line argument '--debug-only=transform-dialect-dump-repro'. Try: '/home/uday/llvm-project-upstream/build/bin/mlir-opt --help'
^
<stdin>:1:56: note: possible intended match here
mlir-opt: Unknown command line argument '--debug-only=transform-dialect-dump-repro'. Try: '/home/uday/llvm-project-upstream/build/bin/mlir-opt --help'
                                                       ^

Input file: <stdin>
Check file: /home/uday/llvm-project-upstream/mlir/test/Dialect/Transform/test-repro-dump.mlir

-dump-input=help explains the following input dump.

Input was:
<<<<<<
            1: mlir-opt: Unknown command line argument '--debug-only=transform-dialect-dump-repro'. Try: '/home/uday/llvm-project-upstream/build/bin/mlir-opt --help'

[ftynse]

Ah yes, thanks for noticing, I forgot to add requires: assert, which exists exactly for the purpose of testing debug output.

mlir/lib/Dialect/Transform/Transforms/TransformInterpreterPassBase.cpp

DEBUG_WITH_TYPE(DEBUG_TYPE_DUMP_STDERR, {
     llvm::dbgs() << "===================================\n";
   });
   (void)root;
   DEBUG_WITH_TYPE(DEBUG_TYPE_DUMP_FILE, {
     saveReproToTempFile(llvm::dbgs(), target, transform, passName,
                         debugPayloadRootTag, debugTransformRootTag,
                         transformLibraryFileName, binaryName);
   });
+
+  // Remove temporary attributes if they were set.
+  if (debugPayloadRootTag.empty())
+    target->removeAttr(kTransformDialectTagAttrName);
+  if (debugTransformRootTag.empty())
+    transform->removeAttr(kTransformDialectTagAttrName);
 }
 
 /// Replaces external symbols in `block` with their (non-external) definitions
 /// from the given module.
 static LogicalResult defineDeclaredSymbols(Block &block, ModuleOp definitions) {
   MLIRContext &ctx = *definitions->getContext();
   auto consumedName =
       StringAttr::get(&ctx, transform::TransformDialect::kArgConsumedAttrName);

mlir/test/Dialect/Transform/test-repro-dump.mlir

+// RUN: mlir-opt %s --test-transform-dialect-interpreter \
+// RUN:             --mlir-disable-threading \
+// RUN:             --debug-only=transform-dialect-dump-repro 2>&1 \
+// RUN: | FileCheck %s
+
+module {
+  transform.sequence failures(propagate) {
+  ^bb0(%arg0: !transform.any_op):
+    transform.test_print_remark_at_operand %arg0, "remark" : !transform.any_op
+  }
+}
+
+// Verify that the repro string is dumped.
+
+// CHECK: Transform Interpreter Repro
+// CHECK: cat <<EOF | mlir-opt --pass-pipeline="builtin.module(test-transform-dialect-interpreter{debug-payload-root-tag=payload_root debug-transform-root-tag=transform_container})"
+
+// Verify that the IR is dumped with tags.
+
+// CHECK: module
+// CHECK-SAME: transform.target_tag = "payload_root"
+// CHECK: transform.sequence
+// CHECK-SAME: transform.target_tag = "transform_container"
+// CHECK: EOF
+
+// Verify that the actual IR after the pass doesn't have the tags.
+
+// CHECK: module
+// CHECK-NOT: transform.target_tag = "payload_root"
+// CHECK: transform.sequence
+// CHECK-NOT: transform.target_tag = "transform_container"