[CodeGen] Port mir-strip-debug to new pass manager (#190738)

Co-authored-by: Aiden Grossman <agrossman154@yahoo.com>

Author: juanvazquez

llvm/include/llvm/CodeGen/MachineStripDebug.h

@@ -0,0 +1,32 @@
+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// This removes debug info from everything. It can be used to ensure tests can
+// be debugified without affecting the output MIR.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CODEGEN_MACHINESTRIPDEBUG_H
+#define LLVM_CODEGEN_MACHINESTRIPDEBUG_H
+
+#include "llvm/IR/Analysis.h"
+#include "llvm/IR/Module.h"
+#include "llvm/IR/PassManager.h"
+#include "llvm/Support/Compiler.h"
+
+namespace llvm {
+
+class StripDebugMachineModulePass
+    : public PassInfoMixin<StripDebugMachineModulePass> {
+public:
+  LLVM_ABI PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
+};
+
+} // namespace llvm
+
+#endif // LLVM_CODEGEN_MACHINESTRIPDEBUG_H

llvm/include/llvm/CodeGen/Passes.h

@@ -602,7 +602,8 @@ LLVM_ABI ModulePass *createDebugifyMachineModulePass();
 /// If OnlyDebugified is true then it will only strip debug info if it was
 /// added by a Debugify pass. The module will be left unchanged if the debug
 /// info was generated by another source such as clang.
-LLVM_ABI ModulePass *createStripDebugMachineModulePass(bool OnlyDebugified);
+LLVM_ABI ModulePass *
+createStripDebugMachineModuleLegacyPass(bool OnlyDebugified);
 
 /// Creates MIR Check Debug pass. \see MachineCheckDebugify.cpp
 LLVM_ABI ModulePass *createCheckDebugMachineModulePass();

llvm/include/llvm/Passes/MachinePassRegistry.def

@@ -27,6 +27,7 @@ MODULE_ANALYSIS("pass-instrumentation", PassInstrumentationAnalysis(PIC))
 MODULE_PASS("global-merge", GlobalMergePass(TM, GlobalMergeOptions()))
 MODULE_PASS("jmc-instrumenter", JMCInstrumenterPass())
 MODULE_PASS("lower-emutls", LowerEmuTLSPass())
+MODULE_PASS("mir-strip-debug", StripDebugMachineModulePass())
 MODULE_PASS("pre-isel-intrinsic-lowering", PreISelIntrinsicLoweringPass())
 MODULE_PASS("print<regusage>", PhysicalRegisterUsageInfoPrinterPass(errs()))
 MODULE_PASS("shadow-stack-gc-lowering", ShadowStackGCLoweringPass())
@@ -261,7 +262,6 @@ DUMMY_MACHINE_MODULE_PASS("static-data-annotator", StaticDataAnnotator)
 DUMMY_MACHINE_MODULE_PASS("pseudo-probe-inserter", PseudoProbeInserterPass)
 DUMMY_MACHINE_MODULE_PASS("mir-debugify", DebugifyMachineModule)
 DUMMY_MACHINE_MODULE_PASS("mir-check-debugify", CheckDebugMachineModulePass)
-DUMMY_MACHINE_MODULE_PASS("mir-strip-debug", StripDebugMachineModulePass)
 #undef DUMMY_MACHINE_MODULE_PASS
 
 #ifndef DUMMY_MACHINE_FUNCTION_PASS

llvm/lib/CodeGen/MachineStripDebug.cpp

@@ -10,10 +10,15 @@
 /// tests can be debugified without affecting the output MIR.
 //===----------------------------------------------------------------------===//
 
+#include "llvm/CodeGen/MachineStripDebug.h"
 #include "llvm/CodeGen/MachineBasicBlock.h"
 #include "llvm/CodeGen/MachineFunction.h"
+#include "llvm/CodeGen/MachineFunctionAnalysis.h"
 #include "llvm/CodeGen/MachineModuleInfo.h"
 #include "llvm/CodeGen/Passes.h"
+#include "llvm/IR/Analysis.h"
+#include "llvm/IR/Module.h"
+#include "llvm/IR/PassManager.h"
 #include "llvm/InitializePasses.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Transforms/Utils/Debugify.h"
@@ -23,60 +28,69 @@
 using namespace llvm;
 
 namespace {
+
 cl::opt<bool>
     OnlyDebugifiedDefault("mir-strip-debugify-only",
                           cl::desc("Should mir-strip-debug only strip debug "
                                    "info from debugified modules by default"),
                           cl::init(true));
 
-struct StripDebugMachineModule : public ModulePass {
-  bool runOnModule(Module &M) override {
-    if (OnlyDebugified) {
-      NamedMDNode *DebugifyMD = M.getNamedMetadata("llvm.debugify");
-      if (!DebugifyMD) {
-        LLVM_DEBUG(dbgs() << "Not stripping debug info"
-                             " (debugify metadata not found)?\n");
-        return false;
-      }
+bool stripDebugMachineModuleImpl(
+    Module &M, bool OnlyDebugified,
+    llvm::function_ref<MachineFunction *(Function &)> GetMF) {
+  if (OnlyDebugified) {
+    NamedMDNode *DebugifyMD = M.getNamedMetadata("llvm.debugify");
+    if (!DebugifyMD) {
+      LLVM_DEBUG(dbgs() << "Not stripping debug info"
+                           " (debugify metadata not found)?\n");
+      return false;
     }
+  }
 
-    MachineModuleInfo &MMI =
-        getAnalysis<MachineModuleInfoWrapperPass>().getMMI();
-
-    bool Changed = false;
-    for (Function &F : M.functions()) {
-      MachineFunction *MaybeMF = MMI.getMachineFunction(F);
-      if (!MaybeMF)
-        continue;
-      MachineFunction &MF = *MaybeMF;
-      for (MachineBasicBlock &MBB : MF) {
-        for (MachineInstr &MI : llvm::make_early_inc_range(MBB.instrs())) {
-          if (MI.isDebugInstr()) {
-            // FIXME: We should remove all of them. However, AArch64 emits an
-            //        invalid `DBG_VALUE $lr` with only one operand instead of
-            //        the usual three and has a test that depends on it's
-            //        preservation. Preserve it for now.
-            if (MI.getNumOperands() > 1) {
-              LLVM_DEBUG(dbgs() << "Removing debug instruction " << MI);
-              MBB.erase_instr(&MI);
-              Changed |= true;
-              continue;
-            }
-          }
-          if (MI.getDebugLoc()) {
-            LLVM_DEBUG(dbgs() << "Removing location " << MI);
-            MI.setDebugLoc(DebugLoc());
+  bool Changed = false;
+  for (Function &F : M.functions()) {
+    MachineFunction *MaybeMF = GetMF(F);
+    if (!MaybeMF)
+      continue;
+    MachineFunction &MF = *MaybeMF;
+    for (MachineBasicBlock &MBB : MF) {
+      for (MachineInstr &MI : llvm::make_early_inc_range(MBB.instrs())) {
+        if (MI.isDebugInstr()) {
+          // FIXME: We should remove all of them. However, AArch64 emits an
+          //        invalid `DBG_VALUE $lr` with only one operand instead of
+          //        the usual three and has a test that depends on it's
+          //        preservation. Preserve it for now.
+          if (MI.getNumOperands() > 1) {
+            LLVM_DEBUG(dbgs() << "Removing debug instruction " << MI);
+            MBB.erase_instr(&MI);
             Changed |= true;
             continue;
           }
-          LLVM_DEBUG(dbgs() << "Keeping " << MI);
         }
+        if (MI.getDebugLoc()) {
+          LLVM_DEBUG(dbgs() << "Removing location " << MI);
+          MI.setDebugLoc(DebugLoc());
+          Changed |= true;
+          continue;
+        }
+        LLVM_DEBUG(dbgs() << "Keeping " << MI);
       }
     }
+  }
+
+  Changed |= stripDebugifyMetadata(M);
 
-    Changed |= stripDebugifyMetadata(M);
+  return Changed;
+}
 
-    return Changed;
+struct StripDebugMachineModule : public ModulePass {
+  bool runOnModule(Module &M) override {
+    MachineModuleInfo &MMI =
+        getAnalysis<MachineModuleInfoWrapperPass>().getMMI();
+    return stripDebugMachineModuleImpl(
+        M, OnlyDebugified, [&MMI](Function &F) -> MachineFunction * {
+          return MMI.getMachineFunction(F);
+        });
   }
 
   StripDebugMachineModule() : StripDebugMachineModule(OnlyDebugifiedDefault) {}
@@ -103,6 +117,24 @@ INITIALIZE_PASS_BEGIN(StripDebugMachineModule, DEBUG_TYPE,
 INITIALIZE_PASS_END(StripDebugMachineModule, DEBUG_TYPE,
                     "Machine Strip Debug Module", false, false)
 
-ModulePass *llvm::createStripDebugMachineModulePass(bool OnlyDebugified) {
+ModulePass *llvm::createStripDebugMachineModuleLegacyPass(bool OnlyDebugified) {
   return new StripDebugMachineModule(OnlyDebugified);
 }
+
+PreservedAnalyses StripDebugMachineModulePass::run(Module &M,
+                                                   ModuleAnalysisManager &AM) {
+  FunctionAnalysisManager &FAM =
+      AM.getResult<FunctionAnalysisManagerModuleProxy>(M).getManager();
+  const bool Changed = stripDebugMachineModuleImpl(
+      M, OnlyDebugifiedDefault, [&FAM](Function &F) -> MachineFunction * {
+        return &FAM.getResult<MachineFunctionAnalysis>(F).getMF();
+      });
+  if (!Changed)
+    return PreservedAnalyses::all();
+
+  PreservedAnalyses PA;
+  PA.preserve<MachineModuleAnalysis>();
+  PA.preserve<FunctionAnalysisManagerModuleProxy>();
+  PA.preserveSet<CFGAnalyses>();
+  return PA;
+}

llvm/lib/CodeGen/TargetPassConfig.cpp

@@ -810,7 +810,7 @@ void TargetPassConfig::addDebugifyPass() {
 }
 
 void TargetPassConfig::addStripDebugPass() {
-  PM->add(createStripDebugMachineModulePass(/*OnlyDebugified=*/true));
+  PM->add(createStripDebugMachineModuleLegacyPass(/*OnlyDebugified=*/true));
 }
 
 void TargetPassConfig::addCheckDebugPass() {

llvm/lib/Passes/PassBuilder.cpp

@@ -134,6 +134,7 @@
 #include "llvm/CodeGen/MachineRegisterInfo.h"
 #include "llvm/CodeGen/MachineScheduler.h"
 #include "llvm/CodeGen/MachineSink.h"
+#include "llvm/CodeGen/MachineStripDebug.h"
 #include "llvm/CodeGen/MachineTraceMetrics.h"
 #include "llvm/CodeGen/MachineUniformityAnalysis.h"
 #include "llvm/CodeGen/MachineVerifier.h"

llvm/lib/Passes/PassRegistry.def

@@ -119,6 +119,7 @@ MODULE_PASS("memprof-remove-attributes", MemProfRemoveInfo())
 MODULE_PASS("memprof-module", ModuleMemProfilerPass())
 MODULE_PASS("mergefunc", MergeFunctionsPass())
 MODULE_PASS("metarenamer", MetaRenamerPass())
+MODULE_PASS("mir-strip-debug", StripDebugMachineModulePass())
 MODULE_PASS("module-inline", ModuleInlinerPass())
 MODULE_PASS("name-anon-globals", NameAnonGlobalPass())
 MODULE_PASS("no-op-module", NoOpModulePass())