Drop handleInitalMIR

Author: paperchalice

llvm/include/llvm/Passes/StandardInstrumentations.h

@@ -212,8 +212,6 @@ template <typename IRUnitT> class ChangeReporter {
 
   // Called on the first IR processed.
   virtual void handleInitialIR(Any IR) = 0;
-  // Called on the first MIR processed.
-  virtual void handleInitialMIR(const MachineFunction *IR) = 0;
   // Called before and after a pass to get the representation of the IR.
   virtual void generateIRRepresentation(Any IR, StringRef PassID,
                                         IRUnitT &Output) = 0;
@@ -234,8 +232,6 @@ template <typename IRUnitT> class ChangeReporter {
   std::vector<IRUnitT> BeforeStack;
   // Is this the first IR seen?
   bool InitialIR = true;
-  // Is this the first MIR seen?
-  StringSet<> HandledMIR;
 
   // Run in verbose mode, printing everything?
   const bool VerboseMode;
@@ -250,8 +246,6 @@ class TextChangeReporter : public ChangeReporter<IRUnitT> {
 
   // Print a module dump of the first IR that is changed.
   void handleInitialIR(Any IR) override;
-  // Print a module dump of the first MIR that is changed.
-  void handleInitialMIR(const MachineFunction *IR) override;
   // Report that the IR was omitted because it did not change.
   void omitAfter(StringRef PassID, std::string &Name) override;
   // Report that the pass was invalidated.
@@ -298,8 +292,6 @@ class IRChangedTester : public IRChangedPrinter {
 
   // Check initial IR
   void handleInitialIR(Any IR) override;
-  // Check initial MIR
-  void handleInitialMIR(const MachineFunction *IR) override;
   // Do nothing.
   void omitAfter(StringRef PassID, std::string &Name) override;
   // Do nothing.
@@ -533,8 +525,6 @@ class DotCfgChangeReporter : public ChangeReporter<IRDataT<DCData>> {
 
   // Called on the first IR processed.
   void handleInitialIR(Any IR) override;
-  // Called on the first MIR processed.
-  void handleInitialMIR(const MachineFunction *IR) override;
   // Called before and after a pass to get the representation of the IR.
   void generateIRRepresentation(Any IR, StringRef PassID,
                                 IRDataT<DCData> &Output) override;

llvm/lib/Passes/StandardInstrumentations.cpp

@@ -19,6 +19,8 @@
 #include "llvm/Analysis/CallGraphSCCPass.h"
 #include "llvm/Analysis/LazyCallGraph.h"
 #include "llvm/Analysis/LoopInfo.h"
+#include "llvm/CodeGen/FreeMachineFunction.h"
+#include "llvm/CodeGen/MIRPrinter.h"
 #include "llvm/CodeGen/MachineFunction.h"
 #include "llvm/CodeGen/MachineModuleInfo.h"
 #include "llvm/IR/Constants.h"
@@ -378,16 +380,13 @@ template <typename T>
 void ChangeReporter<T>::saveIRBeforePass(Any IR, StringRef PassID,
                                          StringRef PassName) {
   // Is this the initial IR?
-  if (InitialIR) {
-    InitialIR = false;
-    if (VerboseMode)
-      handleInitialIR(IR);
-  }
-
-  if (const auto *MF = unwrapIR<MachineFunction>(IR)) {
-    if (VerboseMode && !HandledMIR.contains(MF->getName()) && !MF->empty()) {
-      handleInitialMIR(MF);
-      HandledMIR.insert(MF->getName());
+  // TODO: When Module to MachineFunction adaptor is available
+  // set InitialIR to true when PassID is the adaptor.
+  if (InitialIR && PassID != PrintMIRPreparePass::name()) {
+    if (const auto *MF = unwrapIR<MachineFunction>(IR); !MF || !MF->empty()) {
+      InitialIR = false;
+      if (VerboseMode)
+        handleInitialIR(IR);
     }
   }
 
@@ -438,6 +437,10 @@ template <typename T>
 void ChangeReporter<T>::handleInvalidatedPass(StringRef PassID) {
   assert(!BeforeStack.empty() && "Unexpected empty stack encountered.");
 
+  // Prepare to process the next MIR.
+  if (PassID == FreeMachineFunctionPass::name())
+    InitialIR = true;
+
   // Always flag it as invalidated as we cannot determine when
   // a pass for a filtered function is invalidated since we do not
   // get the IR in the call.  Also, the output is just alternate
@@ -469,6 +472,13 @@ TextChangeReporter<T>::TextChangeReporter(bool Verbose)
     : ChangeReporter<T>(Verbose), Out(dbgs()) {}
 
 template <typename T> void TextChangeReporter<T>::handleInitialIR(Any IR) {
+  // MIR is special, not all MIRs are available at the beginning.
+  if (const auto *MF = unwrapIR<MachineFunction>(IR)) {
+    Out << "*** MIR Dump At Start ***\n";
+    MF->print(Out);
+    return;
+  }
+
   // Always print the module.
   // Unwrap and print directly to avoid filtering problems in general routines.
   auto *M = unwrapModule(IR, /*Force=*/true);
@@ -477,11 +487,6 @@ template <typename T> void TextChangeReporter<T>::handleInitialIR(Any IR) {
   M->print(Out, nullptr);
 }
 
-template <typename T>
-void TextChangeReporter<T>::handleInitialMIR(const MachineFunction *IR) {
-  // For simplicity, don't print the initial MIR.
-}
-
 template <typename T>
 void TextChangeReporter<T>::omitAfter(StringRef PassID, std::string &Name) {
   Out << formatv("*** IR Dump After {0} on {1} omitted because no change ***\n",
@@ -580,12 +585,6 @@ void IRChangedTester::handleInitialIR(Any IR) {
   handleIR(S, "Initial IR");
 }
 
-void IRChangedTester::handleInitialMIR(const MachineFunction *IR) {
-  std::string S;
-  generateIRRepresentation(IR, "Initial MIR", S);
-  handleIR(S, "Initial MIR");
-}
-
 void IRChangedTester::omitAfter(StringRef PassID, std::string &Name) {}
 void IRChangedTester::handleInvalidated(StringRef PassID) {}
 void IRChangedTester::handleFiltered(StringRef PassID, std::string &Name) {}
@@ -2257,7 +2256,7 @@ std::string DotCfgChangeReporter::genHTML(StringRef Text, StringRef DotFile,
 
 void DotCfgChangeReporter::handleInitialIR(Any IR) {
   assert(HTML && "Expected outstream to be set");
-  *HTML << "<button type=\"button\" class=\"collapsible\">0. "
+  *HTML << "<button type=\"button\" class=\"collapsible\">" << N << ". "
         << "Initial IR (by function)</button>\n"
         << "<div class=\"content\">\n"
         << "  <p>\n";
@@ -2279,30 +2278,6 @@ void DotCfgChangeReporter::handleInitialIR(Any IR) {
   ++N;
 }
 
-void DotCfgChangeReporter::handleInitialMIR(const MachineFunction *IR) {
-  assert(HTML && "Expected outstream to be set");
-  *HTML << "<button type=\"button\" class=\"collapsible\">" << N << ". "
-        << "Initial MIR (by machine function)</button>\n"
-        << "<div class=\"content\">\n"
-        << "  <p>\n";
-  // Create representation of IR
-  IRDataT<DCData> Data;
-  IRComparer<DCData>::analyzeIR(llvm::Any(IR), Data);
-  // Now compare it against itself, which will have everything the
-  // same and will generate the files.
-  IRComparer<DCData>(Data, Data)
-      .compare(getModuleForComparison(IR),
-               [&](bool InModule, unsigned Minor,
-                   const FuncDataT<DCData> &Before,
-                   const FuncDataT<DCData> &After) -> void {
-                 handleFunctionCompare("", " ", "Initial MIR", "", InModule,
-                                       Minor, Before, After);
-               });
-  *HTML << "  </p>\n"
-        << "</div><br/>\n";
-  ++N;
-}
-
 void DotCfgChangeReporter::generateIRRepresentation(Any IR, StringRef PassID,
                                                     IRDataT<DCData> &Data) {
   IRComparer<DCData>::analyzeIR(IR, Data);

llvm/test/Other/ChangePrinters/DotCfg/print-changed-dot-cfg.mir

@@ -2,7 +2,7 @@
 # Simple functionality check.
 # RUN: rm -rf %t && mkdir -p %t
 # RUN: llc -filetype=null -print-changed=dot-cfg -passes=no-op-machine-function -dot-cfg-dir=%t %s
-# RUN: ls %t/*.pdf %t/passes.html | count 5
+# RUN: ls %t/*.pdf %t/passes.html | count 3
 
 ---
 name:            g