[NewPM][PassInstrument] Add PrintPass callback to StandardInstrumentations
Problem:
Right now, our "Running pass" is not accurate when passes are wrapped in adaptor because adaptor is never skipped and a pass could be skipped. The other problem is that "Running pass" for a adaptor is before any "Running pass" of passes/analyses it depends on. (for example, FunctionToLoopPassAdaptor). So the order of printing is not the actual order.
Solution:
Doing things like PassManager::Debuglogging is very intrusive because we need to specify Debuglogging whenever adaptor is created. (Actually, right now we're not specifying Debuglogging for some sub-PassManagers. Check PassBuilder)
This patch move debug logging for pass as a PassInstrument callback. We could be sure that all running passes are logged and in the correct order.
This could also be used to implement hierarchy pass logging in legacy PM. We could also move logging of pass manager to this if we want.
The test fixes looks messy. It includes changes:
- Remove PassInstrumentationAnalysis
- Remove PassAdaptor
- If a PassAdaptor is for a real pass, the pass is added
- Pass reorder (to the correct order), related to PassAdaptor
- Add missing passes (due to Debuglogging not passed down)
Reviewed By: asbirlea, aeubanks
Differential Revision: https://reviews.llvm.org/D84774
diff --git a/llvm/lib/Analysis/CGSCCPassManager.cpp b/llvm/lib/Analysis/CGSCCPassManager.cpp
index fd3166f..a862de6 100644
--- a/llvm/lib/Analysis/CGSCCPassManager.cpp
+++ b/llvm/lib/Analysis/CGSCCPassManager.cpp
@@ -78,9 +78,6 @@
if (!PI.runBeforePass(*Pass, *C))
continue;
- if (DebugLogging)
- dbgs() << "Running pass: " << Pass->name() << " on " << *C << "\n";
-
PreservedAnalyses PassPA;
{
TimeTraceScope TimeScope(Pass->name());
diff --git a/llvm/lib/IR/PassInstrumentation.cpp b/llvm/lib/IR/PassInstrumentation.cpp
index 49cc6ec..d3867de 100644
--- a/llvm/lib/IR/PassInstrumentation.cpp
+++ b/llvm/lib/IR/PassInstrumentation.cpp
@@ -12,10 +12,19 @@
//===----------------------------------------------------------------------===//
#include "llvm/IR/PassInstrumentation.h"
+#include "llvm/ADT/STLExtras.h"
#include "llvm/IR/PassManager.h"
namespace llvm {
AnalysisKey PassInstrumentationAnalysis::Key;
+bool isSpecialPass(StringRef PassID, const std::vector<StringRef> &Specials) {
+ size_t Pos = PassID.find('<');
+ if (Pos == StringRef::npos)
+ return false;
+ StringRef Prefix = PassID.substr(0, Pos);
+ return any_of(Specials, [Prefix](StringRef S) { return Prefix.endswith(S); });
+}
+
} // namespace llvm
diff --git a/llvm/lib/IR/PassTimingInfo.cpp b/llvm/lib/IR/PassTimingInfo.cpp
index b3cb4ae..fb551dd 100644
--- a/llvm/lib/IR/PassTimingInfo.cpp
+++ b/llvm/lib/IR/PassTimingInfo.cpp
@@ -231,17 +231,9 @@
MyTimer->stopTimer();
}
-static bool matchPassManager(StringRef PassID) {
- size_t prefix_pos = PassID.find('<');
- if (prefix_pos == StringRef::npos)
- return false;
- StringRef Prefix = PassID.substr(0, prefix_pos);
- return Prefix.endswith("PassManager") || Prefix.endswith("PassAdaptor") ||
- Prefix.endswith("AnalysisManagerProxy");
-}
-
void TimePassesHandler::runBeforePass(StringRef PassID) {
- if (matchPassManager(PassID))
+ if (isSpecialPass(PassID,
+ {"PassManager", "PassAdaptor", "AnalysisManagerProxy"}))
return;
startTimer(PassID);
@@ -251,7 +243,8 @@
}
void TimePassesHandler::runAfterPass(StringRef PassID) {
- if (matchPassManager(PassID))
+ if (isSpecialPass(PassID,
+ {"PassManager", "PassAdaptor", "AnalysisManagerProxy"}))
return;
stopTimer(PassID);
diff --git a/llvm/lib/Passes/StandardInstrumentations.cpp b/llvm/lib/Passes/StandardInstrumentations.cpp
index 2f802c9..d4a6784 100644
--- a/llvm/lib/Passes/StandardInstrumentations.cpp
+++ b/llvm/lib/Passes/StandardInstrumentations.cpp
@@ -26,6 +26,7 @@
#include "llvm/Support/Debug.h"
#include "llvm/Support/FormatVariadic.h"
#include "llvm/Support/raw_ostream.h"
+#include <vector>
using namespace llvm;
@@ -35,6 +36,13 @@
cl::desc("Enable skipping optional passes optnone functions "
"under new pass manager"));
+// FIXME: Change `-debug-pass-manager` from boolean to enum type. Similar to
+// `-debug-pass` in legacy PM.
+static cl::opt<bool>
+ DebugPMVerbose("debug-pass-manager-verbose", cl::Hidden, cl::init(false),
+ cl::desc("Print all pass management debugging information. "
+ "`-debug-pass-manager` must also be specified"));
+
namespace {
/// Extracting Module out of \p IR unit. Also fills a textual description
@@ -78,14 +86,25 @@
llvm_unreachable("Unknown IR unit");
}
-void printIR(const Function *F, StringRef Banner,
- StringRef Extra = StringRef()) {
+void printIR(const Function *F, StringRef Banner, StringRef Extra = StringRef(),
+ bool Brief = false) {
+ if (Brief) {
+ dbgs() << F->getName() << '\n';
+ return;
+ }
+
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()) {
+void printIR(const Module *M, StringRef Banner, StringRef Extra = StringRef(),
+ bool Brief = false) {
+ if (Brief) {
+ dbgs() << M->getName() << '\n';
+ return;
+ }
+
if (llvm::isFunctionInPrintList("*") || llvm::forcePrintModuleIR()) {
dbgs() << Banner << Extra << "\n";
M->print(dbgs(), nullptr, false);
@@ -97,7 +116,12 @@
}
void printIR(const LazyCallGraph::SCC *C, StringRef Banner,
- StringRef Extra = StringRef()) {
+ StringRef Extra = StringRef(), bool Brief = false) {
+ if (Brief) {
+ dbgs() << *C << '\n';
+ return;
+ }
+
bool BannerPrinted = false;
for (const LazyCallGraph::Node &N : *C) {
const Function &F = N.getFunction();
@@ -110,7 +134,13 @@
}
}
}
-void printIR(const Loop *L, StringRef Banner) {
+
+void printIR(const Loop *L, StringRef Banner, bool Brief = false) {
+ if (Brief) {
+ dbgs() << *L;
+ return;
+ }
+
const Function *F = L->getHeader()->getParent();
if (!llvm::isFunctionInPrintList(F->getName()))
return;
@@ -119,7 +149,8 @@
/// Generic IR-printing helper that unpacks a pointer to IRUnit wrapped into
/// llvm::Any and does actual print job.
-void unwrapAndPrint(Any IR, StringRef Banner, bool ForceModule = false) {
+void unwrapAndPrint(Any IR, StringRef Banner, bool ForceModule = false,
+ bool Brief = false) {
if (ForceModule) {
if (auto UnwrappedModule = unwrapModule(IR))
printIR(UnwrappedModule->first, Banner, UnwrappedModule->second);
@@ -129,14 +160,14 @@
if (any_isa<const Module *>(IR)) {
const Module *M = any_cast<const Module *>(IR);
assert(M && "module should be valid for printing");
- printIR(M, Banner);
+ printIR(M, Banner, "", Brief);
return;
}
if (any_isa<const Function *>(IR)) {
const Function *F = any_cast<const Function *>(IR);
assert(F && "function should be valid for printing");
- printIR(F, Banner);
+ printIR(F, Banner, "", Brief);
return;
}
@@ -144,14 +175,14 @@
const LazyCallGraph::SCC *C = any_cast<const LazyCallGraph::SCC *>(IR);
assert(C && "scc should be valid for printing");
std::string Extra = std::string(formatv(" (scc: {0})", C->getName()));
- printIR(C, Banner, Extra);
+ printIR(C, Banner, Extra, Brief);
return;
}
if (any_isa<const Loop *>(IR)) {
const Loop *L = any_cast<const Loop *>(IR);
assert(L && "Loop should be valid for printing");
- printIR(L, Banner);
+ printIR(L, Banner, Brief);
return;
}
llvm_unreachable("Unknown wrapped IR type");
@@ -274,9 +305,34 @@
return true;
}
+void PrintPassInstrumentation::registerCallbacks(
+ PassInstrumentationCallbacks &PIC) {
+ if (!DebugLogging)
+ return;
+
+ std::vector<StringRef> SpecialPasses = {"PassManager"};
+ if (!DebugPMVerbose)
+ SpecialPasses.emplace_back("PassAdaptor");
+
+ PIC.registerBeforeNonSkippedPassCallback(
+ [SpecialPasses](StringRef PassID, Any IR) {
+ if (isSpecialPass(PassID, SpecialPasses))
+ return;
+
+ dbgs() << "Running pass: " << PassID << " on ";
+ unwrapAndPrint(IR, "", false, true);
+ });
+
+ PIC.registerBeforeAnalysisCallback([](StringRef PassID, Any IR) {
+ dbgs() << "Running analysis: " << PassID << " on ";
+ unwrapAndPrint(IR, "", false, true);
+ });
+}
+
void StandardInstrumentations::registerCallbacks(
PassInstrumentationCallbacks &PIC) {
PrintIR.registerCallbacks(PIC);
+ PrintPass.registerCallbacks(PIC);
TimePasses.registerCallbacks(PIC);
OptNone.registerCallbacks(PIC);
}
diff --git a/llvm/lib/Transforms/Scalar/LoopPassManager.cpp b/llvm/lib/Transforms/Scalar/LoopPassManager.cpp
index 98889a9..91de571 100644
--- a/llvm/lib/Transforms/Scalar/LoopPassManager.cpp
+++ b/llvm/lib/Transforms/Scalar/LoopPassManager.cpp
@@ -39,9 +39,6 @@
if (!PI.runBeforePass<Loop>(*Pass, L))
continue;
- if (DebugLogging)
- dbgs() << "Running pass: " << Pass->name() << " on " << L;
-
PreservedAnalyses PassPA;
{
TimeTraceScope TimeScope(Pass->name(), L.getName());