[mlir-ir-printing] Prefix the dump message with the split marker(// -----)

[rriddle]

Summary

This allows for better interaction with tools (such as mlir-lsp-server), as it separates the IR into separate modules for consecutive dumps.

[benvanik]

<3

mlir/lib/Pass/IRPrinting.cpp

private:
   DenseMap<Pass *, OperationFingerPrint> beforePassFingerPrints;
 };
 } // end anonymous namespace
 
 static void printIR(Operation *op, bool printModuleScope, raw_ostream &out,
                     OpPrintingFlags flags) {
   // Otherwise, check to see if we are not printing at module scope.
   if (!printModuleScope)
-    return op->print(out << "\n",
+    return op->print(out << " //----- //\n",
                      op->getBlock() ? flags.useLocalScope() : flags);
 
   // Otherwise, we are printing at module scope.
   out << " ('" << op->getName() << "' operation";
   if (auto symbolName =
           op->getAttrOfType<StringAttr>(SymbolTable::getSymbolAttrName()))
     out << ": @" << symbolName.getValue();
-  out << ")\n";
+  out << ") //----- //\n";
 
   // Find the top-level operation.
   auto *topLevelOp = op;
   while (auto *parentOp = topLevelOp->getParentOp())
     topLevelOp = parentOp;
   topLevelOp->print(out, flags);
 }
 
 /// Instrumentation hooks.
 void IRPrinterInstrumentation::runBeforePass(Pass *pass, Operation *op) {
   if (isa<OpToOpPassAdaptor>(pass))
     return;
   // If the config asked to detect changes, record the current fingerprint.
   if (config->shouldPrintAfterOnlyOnChange())
     beforePassFingerPrints.try_emplace(pass, op);
 
   config->printBeforeIfEnabled(pass, op, [&](raw_ostream &out) {
-    out << formatv("// *** IR Dump Before {0} ***", pass->getName());
+    out << "// -----// IR Dump Before " << pass->getName();
     printIR(op, config->shouldPrintAtModuleScope(), out,
             config->getOpPrintingFlags());
     out << "\n\n";
   });
 }
 
 void IRPrinterInstrumentation::runAfterPass(Pass *pass, Operation *op) {
   if (isa<OpToOpPassAdaptor>(pass))
if (config->shouldPrintAfterOnlyOnChange()) {
     if (fingerPrintIt->second == OperationFingerPrint(op)) {
       beforePassFingerPrints.erase(fingerPrintIt);
       return;
     }
     beforePassFingerPrints.erase(fingerPrintIt);
   }
 
   config->printAfterIfEnabled(pass, op, [&](raw_ostream &out) {
-    out << formatv("// *** IR Dump After {0} ***", pass->getName());
+    out << "// -----// IR Dump After " << pass->getName();
     printIR(op, config->shouldPrintAtModuleScope(), out,
             config->getOpPrintingFlags());
     out << "\n\n";
   });
 }
 
 void IRPrinterInstrumentation::runAfterPassFailed(Pass *pass, Operation *op) {
   if (isa<OpToOpPassAdaptor>(pass))
     return;
   if (config->shouldPrintAfterOnlyOnChange())
     beforePassFingerPrints.erase(pass);
 
   config->printAfterIfEnabled(pass, op, [&](raw_ostream &out) {
-    out << formatv("// *** IR Dump After {0} Failed ***", pass->getName());
+    out << formatv("// -----// IR Dump After {0} Failed", pass->getName());
     printIR(op, config->shouldPrintAtModuleScope(), out,
             OpPrintingFlags().printGenericOpForm());
     out << "\n\n";
   });
 }
 
 //===----------------------------------------------------------------------===//
 // IRPrinterConfig

mlir/test/Pass/ir-printing.mlir

func @foo() {
   %0 = constant 0 : i32
   return
 }
 
 func @bar() {
   return
 }
 
-// BEFORE: *** IR Dump Before{{.*}}CSE ***
+// BEFORE: // -----// IR Dump Before{{.*}}CSE //----- //
 // BEFORE-NEXT: func @foo()
-// BEFORE: *** IR Dump Before{{.*}}CSE ***
+// BEFORE: // -----// IR Dump Before{{.*}}CSE //----- //
 // BEFORE-NEXT: func @bar()
-// BEFORE-NOT: *** IR Dump Before{{.*}}Canonicalizer ***
-// BEFORE-NOT: *** IR Dump After
+// BEFORE-NOT: // -----// IR Dump Before{{.*}}Canonicalizer //----- //
+// BEFORE-NOT: // -----// IR Dump After
 
-// BEFORE_ALL: *** IR Dump Before{{.*}}CSE ***
+// BEFORE_ALL: // -----// IR Dump Before{{.*}}CSE //----- //
 // BEFORE_ALL-NEXT: func @foo()
-// BEFORE_ALL: *** IR Dump Before{{.*}}Canonicalizer ***
+// BEFORE_ALL: // -----// IR Dump Before{{.*}}Canonicalizer //----- //
 // BEFORE_ALL-NEXT: func @foo()
-// BEFORE_ALL: *** IR Dump Before{{.*}}CSE ***
+// BEFORE_ALL: // -----// IR Dump Before{{.*}}CSE //----- //
 // BEFORE_ALL-NEXT: func @bar()
-// BEFORE_ALL: *** IR Dump Before{{.*}}Canonicalizer ***
+// BEFORE_ALL: // -----// IR Dump Before{{.*}}Canonicalizer //----- //
 // BEFORE_ALL-NEXT: func @bar()
-// BEFORE_ALL-NOT: *** IR Dump After
+// BEFORE_ALL-NOT: // -----// IR Dump After
 
-// AFTER-NOT: *** IR Dump Before
-// AFTER: *** IR Dump After{{.*}}CSE ***
+// AFTER-NOT: // -----// IR Dump Before
+// AFTER: // -----// IR Dump After{{.*}}CSE //----- //
 // AFTER-NEXT: func @foo()
-// AFTER: *** IR Dump After{{.*}}CSE ***
+// AFTER: // -----// IR Dump After{{.*}}CSE //----- //
 // AFTER-NEXT: func @bar()
-// AFTER-NOT: *** IR Dump After{{.*}}Canonicalizer ***
+// AFTER-NOT: // -----// IR Dump After{{.*}}Canonicalizer //----- //
 
-// AFTER_ALL-NOT: *** IR Dump Before
-// AFTER_ALL: *** IR Dump After{{.*}}CSE ***
+// AFTER_ALL-NOT: // -----// IR Dump Before
+// AFTER_ALL: // -----// IR Dump After{{.*}}CSE //----- //
 // AFTER_ALL-NEXT: func @foo()
-// AFTER_ALL: *** IR Dump After{{.*}}Canonicalizer ***
+// AFTER_ALL: // -----// IR Dump After{{.*}}Canonicalizer //----- //
 // AFTER_ALL-NEXT: func @foo()
-// AFTER_ALL: *** IR Dump After{{.*}}CSE ***
+// AFTER_ALL: // -----// IR Dump After{{.*}}CSE //----- //
 // AFTER_ALL-NEXT: func @bar()
-// AFTER_ALL: *** IR Dump After{{.*}}Canonicalizer ***
+// AFTER_ALL: // -----// IR Dump After{{.*}}Canonicalizer //----- //
 // AFTER_ALL-NEXT: func @bar()
 
-// BEFORE_MODULE: *** IR Dump Before{{.*}}CSE *** ('func' operation: @foo)
+// BEFORE_MODULE: // -----// IR Dump Before{{.*}}CSE ('func' operation: @foo) //----- //
 // BEFORE_MODULE: func @foo()
 // BEFORE_MODULE: func @bar()
-// BEFORE_MODULE: *** IR Dump Before{{.*}}CSE *** ('func' operation: @bar)
+// BEFORE_MODULE: // -----// IR Dump Before{{.*}}CSE ('func' operation: @bar) //----- //
 // BEFORE_MODULE: func @foo()
 // BEFORE_MODULE: func @bar()
 
-// AFTER_ALL_CHANGE: *** IR Dump After{{.*}}CSE ***
+// AFTER_ALL_CHANGE: // -----// IR Dump After{{.*}}CSE //----- //
 // AFTER_ALL_CHANGE-NEXT: func @foo()
-// AFTER_ALL_CHANGE-NOT: *** IR Dump After{{.*}}CSE ***
+// AFTER_ALL_CHANGE-NOT: // -----// IR Dump After{{.*}}CSE //----- //
 // We expect that only 'foo' changed during CSE, and the second run of CSE did
 // nothing.
 
-// AFTER_FAILURE-NOT: *** IR Dump After{{.*}}CSE
-// AFTER_FAILURE: *** IR Dump After{{.*}}TestFailurePass Failed ***
+// AFTER_FAILURE-NOT: // -----// IR Dump After{{.*}}CSE
+// AFTER_FAILURE: // -----// IR Dump After{{.*}}TestFailurePass Failed //----- //

mlir/test/Pass/run-reproducer.mlir

 // configuration: -mlir-disable-threading=true -pass-pipeline='func(cse,canonicalize)' -print-ir-before=cse
 
 // Test of the reproducer run option. The first line has to be the
 // configuration (matching what is produced by reproducer).
 
 // RUN: mlir-opt %s -run-reproducer 2>&1 | FileCheck -check-prefix=BEFORE %s
 
 func @foo() {
   %0 = constant 0 : i32
   return
 }
 
 func @bar() {
   return
 }
 
-// BEFORE: *** IR Dump Before{{.*}}CSE ***
+// BEFORE: // -----// IR Dump Before{{.*}}CSE //----- //
 // BEFORE-NEXT: func @foo()
-// BEFORE: *** IR Dump Before{{.*}}CSE ***
+// BEFORE: // -----// IR Dump Before{{.*}}CSE //----- //
 // BEFORE-NEXT: func @bar()
-// BEFORE-NOT: *** IR Dump Before{{.*}}Canonicalizer ***
-// BEFORE-NOT: *** IR Dump After
+// BEFORE-NOT: // -----// IR Dump Before{{.*}}Canonicalizer //----- //
+// BEFORE-NOT: // -----// IR Dump After