[NPM] Port module-debuginfo pass to the new pass manager

[akhuang]

Summary

Port pass to NPM and update tests in DebugInfo/Generic.

[aeubanks]

a couple nits, otherwise lgtm

llvm/include/llvm/Analysis/ModuleDebugInfoPrinter.h

19

this shouldn't be needed

23

[akhuang]

clean up code

llvm/include/llvm/Analysis/ModuleDebugInfoPrinter.h

+//===- ModuleDebugInfoPrinter.h - -----------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_ANALYSIS_MODULEDEBUGINFOPRINTER_H
+#define LLVM_ANALYSIS_MODULEDEBUGINFOPRINTER_H
+
+#include "llvm/IR/DebugInfo.h"
+#include "llvm/IR/PassManager.h"
+#include "llvm/Support/raw_ostream.h"
+
+namespace llvm {
+
+class ModuleDebugInfoPrinterPass
+    : public PassInfoMixin<ModuleDebugInfoPrinterPass> {
+  DebugInfoFinder Finder;
+  raw_ostream &OS;
+
+public:
+  explicit ModuleDebugInfoPrinterPass(raw_ostream &OS);
+  PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
+};
+} // end namespace llvm
+
+#endif // LLVM_ANALYSIS_MODULEDEBUGINFOPRINTER_H

llvm/include/llvm/InitializePasses.h

 void initializeMemoryDependenceWrapperPassPass(PassRegistry&);
 void initializeMemorySSAPrinterLegacyPassPass(PassRegistry&);
 void initializeMemorySSAWrapperPassPass(PassRegistry&);
 void initializeMemorySanitizerLegacyPassPass(PassRegistry&);
 void initializeMergeFunctionsLegacyPassPass(PassRegistry&);
 void initializeMergeICmpsLegacyPassPass(PassRegistry &);
 void initializeMergedLoadStoreMotionLegacyPassPass(PassRegistry&);
 void initializeMetaRenamerPass(PassRegistry&);
-void initializeModuleDebugInfoPrinterPass(PassRegistry&);
+void initializeModuleDebugInfoLegacyPrinterPass(PassRegistry &);
 void initializeModuleMemProfilerLegacyPassPass(PassRegistry &);
 void initializeModuleSummaryIndexWrapperPassPass(PassRegistry&);
 void initializeModuloScheduleTestPass(PassRegistry&);
 void initializeMustExecutePrinterPass(PassRegistry&);
 void initializeMustBeExecutedContextPrinterPass(PassRegistry&);
 void initializeNameAnonGlobalLegacyPassPass(PassRegistry&);
 void initializeUniqueInternalLinkageNamesLegacyPassPass(PassRegistry &);
 void initializeNaryReassociateLegacyPassPass(PassRegistry&);

llvm/lib/Analysis/Analysis.cpp

void llvm::initializeAnalysis(PassRegistry &Registry) {
   initializeLazyValueInfoWrapperPassPass(Registry);
   initializeLazyValueInfoPrinterPass(Registry);
   initializeLegacyDivergenceAnalysisPass(Registry);
   initializeLintLegacyPassPass(Registry);
   initializeLoopInfoWrapperPassPass(Registry);
   initializeMemDepPrinterPass(Registry);
   initializeMemDerefPrinterPass(Registry);
   initializeMemoryDependenceWrapperPassPass(Registry);
-  initializeModuleDebugInfoPrinterPass(Registry);
+  initializeModuleDebugInfoLegacyPrinterPass(Registry);
   initializeModuleSummaryIndexWrapperPassPass(Registry);
   initializeMustExecutePrinterPass(Registry);
   initializeMustBeExecutedContextPrinterPass(Registry);
   initializeObjCARCAAWrapperPassPass(Registry);
   initializeOptimizationRemarkEmitterWrapperPassPass(Registry);
   initializePhiValuesWrapperPassPass(Registry);
   initializePostDominatorTreeWrapperPassPass(Registry);
   initializeRegionInfoPassPass(Registry);

llvm/lib/Analysis/ModuleDebugInfoPrinter.cpp

 //===-- ModuleDebugInfoPrinter.cpp - Prints module debug info metadata ----===//
 //
 // 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 pass decodes the debug info metadata in a module and prints in a
 // (sufficiently-prepared-) human-readable form.
 //
 // For example, run this pass from opt along with the -analyze option, and
 // it'll print to standard output.
 //
 //===----------------------------------------------------------------------===//
 
+#include "llvm/Analysis/ModuleDebugInfoPrinter.h"
 #include "llvm/ADT/Statistic.h"
 #include "llvm/Analysis/Passes.h"
 #include "llvm/IR/DebugInfo.h"
+#include "llvm/IR/PassManager.h"
 #include "llvm/InitializePasses.h"
 #include "llvm/Pass.h"
 #include "llvm/Support/ErrorHandling.h"
 #include "llvm/Support/raw_ostream.h"
 using namespace llvm;
 
 namespace {
-  class ModuleDebugInfoPrinter : public ModulePass {
-    DebugInfoFinder Finder;
-  public:
-    static char ID; // Pass identification, replacement for typeid
-    ModuleDebugInfoPrinter() : ModulePass(ID) {
-      initializeModuleDebugInfoPrinterPass(*PassRegistry::getPassRegistry());
-    }
+class ModuleDebugInfoLegacyPrinter : public ModulePass {
+
+  ModuleDebugInfoLegacyPrinter() : ModulePass(ID) {
+    initializeModuleDebugInfoLegacyPrinterPass(
+        *PassRegistry::getPassRegistry());
 
-    bool runOnModule(Module &M) override;
 
-    void getAnalysisUsage(AnalysisUsage &AU) const override {
-      AU.setPreservesAll();
-    }
-    void print(raw_ostream &O, const Module *M) const override;
-  };
 }
 
-char ModuleDebugInfoPrinter::ID = 0;
-INITIALIZE_PASS(ModuleDebugInfoPrinter, "module-debuginfo",
+char ModuleDebugInfoLegacyPrinter::ID = 0;
+INITIALIZE_PASS(ModuleDebugInfoLegacyPrinter, "module-debuginfo",
                 "Decodes module-level debug info", false, true)
 
 ModulePass *llvm::createModuleDebugInfoPrinterPass() {
-  return new ModuleDebugInfoPrinter();
+  return new ModuleDebugInfoLegacyPrinter();
 }
 
-bool ModuleDebugInfoPrinter::runOnModule(Module &M) {
+bool ModuleDebugInfoLegacyPrinter::runOnModule(Module &M) {
   Finder.processModule(M);
   return false;
 }
 
 static void printFile(raw_ostream &O, StringRef Filename, StringRef Directory,
                       unsigned Line = 0) {
   if (Filename.empty())
     return;
 
   O << " from ";
   if (!Directory.empty())
     O << Directory << "/";
   O << Filename;
   if (Line)
     O << ":" << Line;
 }
 
-void ModuleDebugInfoPrinter::print(raw_ostream &O, const Module *M) const {
+static void printModuleDebugInfo(raw_ostream &O, const Module *M,
+                                 const DebugInfoFinder &Finder) {
   // Printing the nodes directly isn't particularly helpful (since they
   // reference other nodes that won't be printed, particularly for the
   // filenames), so just print a few useful things.
   for (DICompileUnit *CU : Finder.compile_units()) {
     O << "Compile unit: ";
     auto Lang = dwarf::LanguageString(CU->getSourceLanguage());
     if (!Lang.empty())
       O << Lang;
for (const DIType *T : Finder.types()) {
     }
     if (auto *CT = dyn_cast<DICompositeType>(T)) {
       if (auto *S = CT->getRawIdentifier())
         O << " (identifier: '" << S->getString() << "')";
     }
     O << '\n';
   }
 }
+
+void ModuleDebugInfoLegacyPrinter::print(raw_ostream &O,
+                                         const Module *M) const {
+  printModuleDebugInfo(O, M, Finder);
+}
+
+ModuleDebugInfoPrinterPass::ModuleDebugInfoPrinterPass(raw_ostream &OS)
+    : OS(OS) {}
+
+PreservedAnalyses ModuleDebugInfoPrinterPass::run(Module &M,
+                                                  ModuleAnalysisManager &AM) {
+  Finder.processModule(M);
+  printModuleDebugInfo(OS, &M, Finder);
+  return PreservedAnalyses::all();
+}

llvm/lib/Passes/PassBuilder.cpp

 #include "llvm/Analysis/LazyValueInfo.h"
 #include "llvm/Analysis/Lint.h"
 #include "llvm/Analysis/LoopAccessAnalysis.h"
 #include "llvm/Analysis/LoopCacheAnalysis.h"
 #include "llvm/Analysis/LoopInfo.h"
 #include "llvm/Analysis/LoopNestAnalysis.h"
 #include "llvm/Analysis/MemoryDependenceAnalysis.h"
 #include "llvm/Analysis/MemorySSA.h"
+#include "llvm/Analysis/ModuleDebugInfoPrinter.h"
 #include "llvm/Analysis/ModuleSummaryAnalysis.h"
 #include "llvm/Analysis/ObjCARCAliasAnalysis.h"
 #include "llvm/Analysis/OptimizationRemarkEmitter.h"
 #include "llvm/Analysis/PhiValues.h"
 #include "llvm/Analysis/PostDominators.h"
 #include "llvm/Analysis/ProfileSummaryInfo.h"
 #include "llvm/Analysis/RegionInfo.h"
 #include "llvm/Analysis/ScalarEvolution.h"

llvm/lib/Passes/PassRegistry.def

 MODULE_PASS("pgo-instr-gen", PGOInstrumentationGen())
 MODULE_PASS("pgo-instr-use", PGOInstrumentationUse())
 MODULE_PASS("print-profile-summary", ProfileSummaryPrinterPass(dbgs()))
 MODULE_PASS("print-callgraph", CallGraphPrinterPass(dbgs()))
 MODULE_PASS("print", PrintModulePass(dbgs()))
 MODULE_PASS("print-lcg", LazyCallGraphPrinterPass(dbgs()))
 MODULE_PASS("print-lcg-dot", LazyCallGraphDOTPrinterPass(dbgs()))
 MODULE_PASS("print-stack-safety", StackSafetyGlobalPrinterPass(dbgs()))
+MODULE_PASS("print<module-debuginfo>", ModuleDebugInfoPrinterPass(dbgs()))
 MODULE_PASS("rewrite-statepoints-for-gc", RewriteStatepointsForGC())
 MODULE_PASS("rewrite-symbols", RewriteSymbolPass())
 MODULE_PASS("rpo-function-attrs", ReversePostOrderFunctionAttrsPass())
 MODULE_PASS("sample-profile", SampleProfileLoaderPass())
 MODULE_PASS("scc-oz-module-inliner",
   buildInlinerPipeline(OptimizationLevel::Oz, ThinLTOPhase::None, DebugLogging))
 MODULE_PASS("loop-extract-single", LoopExtractorPass(1))
 MODULE_PASS("oz-module-optimizer",

llvm/test/DebugInfo/Generic/debuginfofinder-forward-declaration.ll

-; RUN: opt -analyze -module-debuginfo < %s | FileCheck %s
+; RUN: opt -analyze -module-debuginfo -enable-new-pm=0 < %s | FileCheck %s
+; RUN: opt -passes='print<module-debuginfo>' -disable-output 2>&1 < %s \
+; RUN:   | FileCheck %s
 
 ; This module is generated from the following c-code:
 ;
 ; > union X;
 ; >
 ; > struct Y {
 ; >     union X *x;
 ; > };

llvm/test/DebugInfo/Generic/debuginfofinder-imported-global-variable.ll

-; RUN: opt -analyze -module-debuginfo < %s | FileCheck %s
+; RUN: opt -analyze -module-debuginfo -enable-new-pm=0 < %s | FileCheck %s
+; RUN: opt -passes='print<module-debuginfo>' -disable-output 2>&1 < %s \
+; RUN:   | FileCheck %s
 
 ; This is to track DebugInfoFinder's ability to find the debug info metadata,
-; in particular, properly visit different kinds of DIImportedEntit'ies.
+; in particular, properly visit different kinds of DIImportedEntities.
 
 ; Derived from the following C++ snippet
 ;
 ; namespace s {
 ;   int i;
 ; }
 ;
 ; using s::i;
 ;
 ; compiled with `clang -O1 -g3 -emit-llvm -S`
 
-; CHECK: Printing analysis 'Decodes module-level debug info':
 ; CHECK: Compile unit: DW_LANG_C_plus_plus from /somewhere/source.cpp
 ; CHECK: Global variable: i from /somewhere/source.cpp:2 ('_ZN1s1iE')
 ; CHECK: Type: int DW_ATE_signed
 
 @_ZN1s1iE = local_unnamed_addr global i32 0, align 4, !dbg !0
 
 !llvm.dbg.cu = !{!5}
 !llvm.module.flags = !{!10, !11, !12, !13}

llvm/test/DebugInfo/Generic/debuginfofinder-inlined-cu.ll

-; RUN: opt -analyze -module-debuginfo < %s | FileCheck %s
+; RUN: opt -analyze -module-debuginfo -enable-new-pm=0 < %s | FileCheck %s
+; RUN: opt -passes='print<module-debuginfo>' -disable-output 2>&1 < %s \
+; RUN:   | FileCheck %s
 
 ; Verify that both compile units, even though one compile units's functions
 ; were entirely inlined into the other.
 ;CHECK: Compile unit: DW_LANG_C99 from /tmp/test1.c
 ;CHECK: Compile unit: DW_LANG_C99 from /tmp/test2.c
 ;CHECK: Subprogram: f from /tmp/test1.c:1
 ;CHECK: Subprogram: g from /tmp/test2.c:1
 

llvm/test/DebugInfo/Generic/debuginfofinder-multiple-cu.ll

-; RUN: opt -analyze -module-debuginfo < %s | FileCheck %s
+; RUN: opt -analyze -module-debuginfo -enable-new-pm=0 < %s | FileCheck %s
+; RUN: opt -passes='print<module-debuginfo>' -disable-output 2>&1 < %s \
+; RUN:   | FileCheck %s
 
 ; Produced from linking:
 ;   /tmp/test1.c containing f()
 ;   /tmp/test2.c containing g()
 
 ; Verify that both compile units and both their contained functions are
 ; listed by DebugInfoFinder:
 ;CHECK: Compile unit: DW_LANG_C99 from /tmp/test1.c