commit 7b9aa284500d1cef0711965ca5b45efd43ce9742
author Benoit Jacob <jacob.benoit.1@gmail.com> Wed Jan 08 13:27:30 2025 -0500
committer GitHub <noreply@github.com> Wed Jan 08 18:27:30 2025 +0000
tree 063ba0367a4932036b07d7596619bdd7c3397c20
parent be75a3001ce43f046b60f49f8d74650b93d239c4

When dumping intermediates, dump how to reproduce the `.optimized.ll` (#19633)

This is similar to the upstream `--print-pipeline-passes`, which we
don't implement but is still there as a command-line flag. In our case,
I think it's more useful to integrate it into our existing
dump-intermediates feature. This would need to be done for each target;
this PR only does it for ROCMTarget for now.

Sample output at the start of the dumped `.optimized.ll` file:
```
; To reproduce the .optimized.ll from the .linked.ll, run:
; opt --passes=' [...] elided 4 kilobytes of text [...] '
```

Signed-off-by: Benoit Jacob <jacob.benoit.1@gmail.com>

compiler/plugins/target/ROCM/ROCMTarget.cpp

diff --git a/compiler/plugins/target/ROCM/ROCMTarget.cpp b/compiler/plugins/target/ROCM/ROCMTarget.cpp
index 8558f0b..49e8256 100644
--- a/compiler/plugins/target/ROCM/ROCMTarget.cpp
+++ b/compiler/plugins/target/ROCM/ROCMTarget.cpp
@@ -175,9 +175,10 @@
 
 static void dumpModuleToPath(StringRef path, StringRef baseName,
                              StringRef suffix, StringRef extension,
-                             llvm::Module &module) {
+                             llvm::Module &module, StringRef header = {}) {
   llvm::SmallVector<char, 0> data;
   llvm::raw_svector_ostream ostream(data);
+  ostream << header;
   module.print(ostream, nullptr);
   dumpDataToPath(path, baseName, suffix, extension,
                  StringRef(data.data(), data.size()));
@@ -295,7 +296,8 @@
   static void optimizeModule(llvm::Module &module,
                              llvm::TargetMachine &targetMachine,
                              ArrayRef<std::string> passPlugins,
-                             bool slpVectorization) {
+                             bool slpVectorization,
+                             std::string &outPassesString) {
     llvm::LoopAnalysisManager lam;
     llvm::FunctionAnalysisManager fam;
     llvm::CGSCCAnalysisManager cgam;
@@ -336,7 +338,11 @@
     mpm.addPass(llvm::VerifierPass());
     mpm.addPass(pb.buildPerModuleDefaultPipeline(ol));
     mpm.addPass(llvm::VerifierPass());
-
+    llvm::raw_string_ostream os(outPassesString);
+    mpm.printPipeline(os, [&pic](StringRef className) {
+      auto passName = pic.getPassNameForClassName(className);
+      return passName.empty() ? className : passName;
+    });
     mpm.run(module, mam);
   }
 
@@ -566,12 +572,19 @@
       }
 
       // Run LLVM optimization passes.
+      std::string passesString;
       optimizeModule(*llvmModule, *targetMachine, options.passPlugins,
-                     options.slpVectorization);
+                     options.slpVectorization, passesString);
       if (!serializationOptions.dumpIntermediatesPath.empty()) {
+        std::string header = llvm::formatv(R"TXT(
+; To reproduce the .optimized.ll from the .linked.ll, run:
+; opt --passes='{}'
+
+)TXT",
+                                           passesString);
         dumpModuleToPath(serializationOptions.dumpIntermediatesPath,
                          serializationOptions.dumpBaseName, variantOp.getName(),
-                         ".optimized.ll", *llvmModule);
+                         ".optimized.ll", *llvmModule, header);
       }
 
       if (failed(validateFinalizedModule(variantOp, *llvmModule))) {