IR printing for single function with the new pass manager.

[hoyFB]

Summary

The IR printing always prints out all functions in a module with the new pass manager, even with -filter-print-funcs specified. This is being fixed in this change. However, there are two exceptions, i.e, with user-specified wildcast switch -filter-print-funcs=* or -print-module-scope, under which IR of all functions should be printed.

Test Plan:
make check-clang
make check-llvm

[wenlei]

Thanks for fixing this. Could you use .ll IR file as test case and place it alongside with test/Other/module-pass-printer.ll or just reuse that one? We can also use opt to invoke new pass manager, so it doesn't need to be a clang test.

[hoyFB]

In D74814#1882064, @wenlei wrote:

Thanks for fixing this. Could you use .ll IR file as test case and place it alongside with test/Other/module-pass-printer.ll or just reuse that one? We can also use opt to invoke new pass manager, so it doesn't need to be a clang test.

Sounds good. I was trying to figure out how to invoke the new pass manager with OPT. Is there a command line switch to do that?

[wenlei]

Sounds good. I was trying to figure out how to invoke the new pass manager with OPT. Is there a command line switch to do that?

If you just do opt -passes=<pass_names>, it will invoke new pass manager for opt. See https://reviews.llvm.org/D66560 for example - that was for legacy PM, the equivalent for new PM would be something like opt < %s 2>&1 -passes=forceattrs ...

[hoyFB]

Updating D74814: IR printing for single function with the new pass manager.

[wenlei]

Thanks for the making the changes, it would be nice to have some consistency (the same structure) between test cases for legacy PM and new PM, e.g. EMPTY is only tested for legacy PM, but not new; multi-function filter also only tested for legacy PM, would be nice to do them for both, and unify the check-prefix, otherwise LGTM.

[hoyFB]

Updating D74814: IR printing for single function with the new pass manager.

[wenlei]

Committed on behalf of @hoyFB per request.

llvm/lib/Passes/StandardInstrumentations.cpp

if (any_isa<const Loop *>(IR)) {
     raw_string_ostream ss(LoopName);
     L->getHeader()->printAsOperand(ss, false);
     return std::make_pair(M, formatv(" (loop: {0})", ss.str()).str());
   }
 
   llvm_unreachable("Unknown IR unit");
 }
 
-void printIR(const Module *M, StringRef Banner, StringRef Extra = StringRef()) {
-  dbgs() << Banner << Extra << "\n";
-  M->print(dbgs(), nullptr, false);
-}
 void printIR(const Function *F, StringRef Banner,
              StringRef Extra = StringRef()) {
   if (!llvm::isFunctionInPrintList(F->getName()))
     return;
   dbgs() << Banner << Extra << "\n" << static_cast<const Value &>(*F);
 }
+
+void printIR(const Module *M, StringRef Banner, StringRef Extra = StringRef()) {
+  if (llvm::isFunctionInPrintList("*") || llvm::forcePrintModuleIR()) {
+    dbgs() << Banner << Extra << "\n";
+    M->print(dbgs(), nullptr, false);
+  } else {
+    for (const auto &F : M->functions()) {
+      printIR(&F, Banner, Extra);
+    }
+  }
+}
+
 void printIR(const LazyCallGraph::SCC *C, StringRef Banner,
              StringRef Extra = StringRef()) {
   bool BannerPrinted = false;
   for (const LazyCallGraph::Node &N : *C) {
     const Function &F = N.getFunction();
     if (!F.isDeclaration() && llvm::isFunctionInPrintList(F.getName())) {
       if (!BannerPrinted) {
         dbgs() << Banner << Extra << "\n";

llvm/test/Other/module-pass-printer.ll

 ; Check pass name is only printed once.
-; RUN: opt < %s 2>&1 -forceattrs -disable-output -print-after-all | FileCheck %s
-; RUN: opt < %s 2>&1 -forceattrs -disable-output -print-after-all -filter-print-funcs=foo,bar | FileCheck %s
+; Check only one function is printed
+; RUN: opt < %s 2>&1 -forceattrs -disable-output -print-after-all -filter-print-funcs=foo | FileCheck %s  -check-prefix=FOO
+; RUN: opt < %s 2>&1 -passes=forceattrs -disable-output -print-after-all -filter-print-funcs=foo | FileCheck %s  -check-prefix=FOO
+
+; Check pass name is only printed once.
+; Check both functions are printed
+; RUN: opt < %s 2>&1 -forceattrs -disable-output -print-after-all -filter-print-funcs=foo,bar | FileCheck %s -check-prefix=BOTH
+; RUN: opt < %s 2>&1 -passes=forceattrs -disable-output -print-after-all -filter-print-funcs=foo,bar | FileCheck %s -check-prefix=BOTH
 
 ; Check pass name is not printed if a module doesn't include any function specified in -filter-print-funcs.
 ; RUN: opt < %s 2>&1 -forceattrs -disable-output -print-after-all -filter-print-funcs=baz | FileCheck %s -allow-empty -check-prefix=EMPTY
+; RUN: opt < %s 2>&1 -passes=forceattrs -disable-output -print-after-all -filter-print-funcs=baz | FileCheck %s -allow-empty -check-prefix=EMPTY
+
+; Check whole module is printed with user-specified wildcast switch -filter-print-funcs=* or -print-module-scope
+; RUN: opt < %s 2>&1 -forceattrs -disable-output -print-after-all | FileCheck %s -check-prefix=ALL
+; RUN: opt < %s 2>&1 -forceattrs -disable-output  -print-after-all -filter-print-funcs=* | FileCheck %s -check-prefix=ALL
+; RUN: opt < %s 2>&1 -forceattrs -disable-output -print-after-all -filter-print-funcs=foo -print-module-scope | FileCheck %s -check-prefix=ALL
+; RUN: opt < %s 2>&1 -passes=forceattrs -disable-output -print-after-all | FileCheck %s -check-prefix=ALL
+; RUN: opt < %s 2>&1 -passes=forceattrs -disable-output -print-after-all -filter-print-funcs=* | FileCheck %s -check-prefix=ALL
+; RUN: opt < %s 2>&1 -passes=forceattrs -disable-output -print-after-all -filter-print-funcs=foo -print-module-scope | FileCheck %s -check-prefix=ALL
+
+; FOO:      IR Dump After {{Force set function attributes|ForceFunctionAttrsPass}}
+; FOO:      define void @foo
+; FOO-NOT:  define void @bar
+; FOO-NOT:  IR Dump After {{Force set function attributes|ForceFunctionAttrsPass}}
+
+; BOTH:     IR Dump After {{Force set function attributes|ForceFunctionAttrsPass}}
+; BOTH:     define void @foo
+; BOTH:     define void @bar
+; BOTH-NOT: IR Dump After {{Force set function attributes|ForceFunctionAttrsPass}}
+; BOTH-NOT: ModuleID =
+
+; EMPTY-NOT: IR Dump After {{Force set function attributes|ForceFunctionAttrsPass}}
 
-; CHECK: *** IR Dump After Force set function attributes ***
-; CHECK-NOT: *** IR Dump After Force set function attributes ***
-; EMPTY-NOT: *** IR Dump After Force set function attributes ***
+; ALL:  IR Dump After {{Force set function attributes|ForceFunctionAttrsPass}}
+; ALL:  ModuleID =
+; ALL:  define void @foo
+; ALL:  define void @bar
+; ALL-NOT: IR Dump After {{Force set function attributes|ForceFunctionAttrsPass}}
 
 define void @foo() {
   ret void
 }
 
 define void @bar() {
   ret void
 }