[mlir] Catch the case using ir print without disabling multithread

[Lewuathe]

Summary

-mlir-print-ir-module-scope option cannot be used without disabling multithread for pass manager. For the usability, we can throw a validation error in mlir-opt instead of assertion failure.

Issue: https://github.com/llvm/llvm-project/issues/61578

[Lewuathe]

Add new line.

[rriddle]

mlir/lib/Pass/PassManagerOptions.cpp

147–148

The error message doesn't really match the check, "IR printing" is much more general than just module scope.

[Lewuathe]

Refine error message

[Lewuathe]

Fix test failure.

[mehdi_amini]

LGTM modulo one comment

mlir/lib/Pass/PassManagerOptions.cpp

147–148

I suspect we should print the error through the context so it is emitted as diagnostic instead of using directly llvm::errs().

[mehdi_amini]

[rriddle]

This LGTM!

mlir/include/mlir/Pass/PassManager.h

 
 /// Register a set of useful command-line options that can be used to configure
 /// a pass manager. The values of these options can be applied via the
 /// 'applyPassManagerCLOptions' method below.
 void registerPassManagerCLOptions();
 
 /// Apply any values provided to the pass manager options that were registered
 /// with 'registerPassManagerOptions'.
-void applyPassManagerCLOptions(PassManager &pm);
+LogicalResult applyPassManagerCLOptions(PassManager &pm);
 
 /// Apply any values provided to the timing manager options that were registered
 /// with `registerDefaultTimingManagerOptions`. This is a handy helper function
 /// if you do not want to bother creating your own timing manager and passing it
 /// to the pass manager.
 void applyDefaultTimingPassManagerCLOptions(PassManager &pm);
 
 } // namespace mlir
 
 #endif // MLIR_PASS_PASSMANAGER_H

mlir/lib/Pass/PassManagerOptions.cpp

pm.enableIRPrinting(shouldPrintBeforePass, shouldPrintAfterPass,
                       llvm::errs());
 }
 
 void mlir::registerPassManagerCLOptions() {
   // Make sure that the options struct has been constructed.
   *options;
 }
 
-void mlir::applyPassManagerCLOptions(PassManager &pm) {
+LogicalResult mlir::applyPassManagerCLOptions(PassManager &pm) {
   if (!options.isConstructed())
-    return;
+    return failure();
 
   // Generate a reproducer on crash/failure.
   if (options->reproducerFile.getNumOccurrences())
     pm.enableCrashReproducerGeneration(options->reproducerFile,
                                        options->localReproducer);
 
   // Enable statistics dumping.
   if (options->passStatistics)
     pm.enableStatistics(options->passStatisticsDisplayMode);
 
+  if (options->printModuleScope && pm.getContext()->isMultithreadingEnabled()) {
+    emitError(UnknownLoc::get(pm.getContext()))
+        << "IR print for module scope can't be setup on a pass-manager "
+           "without disabling multi-threading first.\n";
+    return failure();
+  }
+
   // Add the IR printing instrumentation.
   options->addPrinterInstrumentation(pm);
+  return success();
 }
 
 void mlir::applyDefaultTimingPassManagerCLOptions(PassManager &pm) {
   // Create a temporary timing manager for the PM to own, apply its CL options,
   // and pass it to the PM.
   auto tm = std::make_unique<DefaultTimingManager>();
   applyDefaultTimingManagerCLOptions(*tm);
   pm.enableTiming(std::move(tm));
 }

mlir/lib/Tools/mlir-opt/MlirOptMain.cpp

performActions(raw_ostream &os,
   context->enableMultithreading(wasThreadingEnabled);
   if (!op)
     return failure();
   parserTiming.stop();
 
   // Prepare the pass manager, applying command-line and reproducer options.
   PassManager pm(op.get()->getName(), PassManager::Nesting::Implicit);
   pm.enableVerifier(config.shouldVerifyPasses());
-  applyPassManagerCLOptions(pm);
+  if (failed(applyPassManagerCLOptions(pm)))
+    return failure();
   pm.enableTiming(timing);
   if (failed(reproOptions.apply(pm)) || failed(config.setupPassPipeline(pm)))
     return failure();
 
   // Run the pipeline.
   if (failed(pm.run(*op)))
     return failure();
 

mlir/test/Pass/invalid-pass.mlir

 // RUN: not mlir-opt %s -pass-pipeline='builtin.module(builtin.module(test-module-pass{test-option=a}))' 2>&1 | FileCheck %s
+// RUN: not mlir-opt %s -mlir-print-ir-module-scope -mlir-print-ir-before=cse 2>&1 | FileCheck -check-prefix=PRINT_MODULE_IR_WITH_MULTITHREAD %s
 
 // CHECK: <Pass-Options-Parser>: no such option test-option
 // CHECK: failed to add `test-module-pass` with options `test-option=a`
 // CHECK: failed to add `builtin.module` with options `` to inner pipeline
 module {}
+
+// PRINT_MODULE_IR_WITH_MULTITHREAD: IR print for module scope can't be setup on a pass-manager without disabling multi-threading first.