[llvm] 621efa6 - [NFC intended] Refactor the code for printChanged for reuse and to facilitate subsequent reporters of changes to the IR in the new pass manager.
Jamie Schmeiser via llvm-commits
llvm-commits at lists.llvm.org
Fri Nov 20 06:51:09 PST 2020
Author: Jamie Schmeiser
Date: 2020-11-20T09:43:06-05:00
New Revision: 621efa6a5a964d72ad3f1d34776aad476ae2a2e3
URL: https://github.com/llvm/llvm-project/commit/621efa6a5a964d72ad3f1d34776aad476ae2a2e3
DIFF: https://github.com/llvm/llvm-project/commit/621efa6a5a964d72ad3f1d34776aad476ae2a2e3.diff
LOG: [NFC intended] Refactor the code for printChanged for reuse and to facilitate subsequent reporters of changes to the IR in the new pass manager.
Summary:
[NFC intended] Refactor the code for printChanged for reuse and to facilitate
subsequent reporters of changes to the IR in the new pass manager.
Create abstract template base classes for common functionality and give
classes more appropriate names. The base classes handle all of the
determination of when a function or pass is "interesting" and should be
reported or filtered out. They have pure virtual functions which are called
when a change by a pass has been recognized so the derived class need only
provide the overrides to present the information about the changing IR.
There are at least 2 more change reporters to come (which were presented
in my tutorial at the 2020 llvm developer's meeting) that derive from
these classes.
Respond to review comments: move function out of line, remove inline keyword,
remove unneeded qualifiers, simplify comparison.
Author: Jamie Schmeiser <schmeise at ca.ibm.com>
Reviewed By: aeubanks (Arthur Eubanks), madhur13490 (Madhur Amilkanthwar)
Differential Revision: https://reviews.llvm.org/D87000
Added:
Modified:
llvm/include/llvm/Passes/StandardInstrumentations.h
llvm/lib/Passes/StandardInstrumentations.cpp
Removed:
################################################################################
diff --git a/llvm/include/llvm/Passes/StandardInstrumentations.h b/llvm/include/llvm/Passes/StandardInstrumentations.h
index b811ede5a9f3..d4acd9c9b1c4 100644
--- a/llvm/include/llvm/Passes/StandardInstrumentations.h
+++ b/llvm/include/llvm/Passes/StandardInstrumentations.h
@@ -146,12 +146,12 @@ class PreservedCFGCheckerInstrumentation {
// 6. When a pass is run on an IR that is not interesting (based on options).
// 7. When a pass is ignored (pass manager or adapter pass).
// 8. To compare two IR representations (of type \p T).
-template <typename IRUnitT> class ChangePrinter {
+template <typename IRUnitT> class ChangeReporter {
protected:
- ChangePrinter() {}
+ ChangeReporter() {}
public:
- virtual ~ChangePrinter();
+ virtual ~ChangeReporter();
// Determine if this pass/IR is interesting and if so, save the IR
// otherwise it is left on the stack without data.
@@ -162,6 +162,20 @@ template <typename IRUnitT> class ChangePrinter {
void handleInvalidatedPass(StringRef PassID);
protected:
+ // Register required callbacks.
+ void registerRequiredCallbacks(PassInstrumentationCallbacks &PIC);
+
+ // Return true when this is a defined function for which printing
+ // of changes is desired.
+ bool isInterestingFunction(const Function &F);
+
+ // Return true when this is a pass for which printing of changes is desired.
+ bool isInterestingPass(StringRef PassID);
+
+ // Return true when this is a pass on IR for which printing
+ // of changes is desired.
+ bool isInteresting(Any IR, StringRef PassID);
+
// Called on the first IR processed.
virtual void handleInitialIR(Any IR) = 0;
// Called before and after a pass to get the representation of the IR.
@@ -188,38 +202,49 @@ template <typename IRUnitT> class ChangePrinter {
bool InitialIR = true;
};
+// An abstract template base class that handles printing banners and
+// reporting when things have not changed or are filtered out.
+template <typename IRUnitT>
+class TextChangeReporter : public ChangeReporter<IRUnitT> {
+protected:
+ TextChangeReporter();
+
+ // Print a module dump of the first IR that is changed.
+ void handleInitialIR(Any 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.
+ void handleInvalidated(StringRef PassID) override;
+ // Report that the IR was filtered out.
+ void handleFiltered(StringRef PassID, std::string &Name) override;
+ // Report that the pass was ignored.
+ void handleIgnored(StringRef PassID, std::string &Name) override;
+ // Make substitutions in \p S suitable for reporting changes
+ // after the pass and then print it.
+
+ raw_ostream &Out;
+};
+
// A change printer based on the string representation of the IR as created
// by unwrapAndPrint. The string representation is stored in a std::string
// to preserve it as the IR changes in each pass. Note that the banner is
// included in this representation but it is massaged before reporting.
-class IRChangePrinter : public ChangePrinter<std::string> {
+class IRChangedPrinter : public TextChangeReporter<std::string> {
public:
- IRChangePrinter();
- ~IRChangePrinter() override;
+ IRChangedPrinter() {}
+ ~IRChangedPrinter() override;
void registerCallbacks(PassInstrumentationCallbacks &PIC);
protected:
- // Called on the first IR processed.
- void handleInitialIR(Any IR) override;
// Called before and after a pass to get the representation of the IR.
void generateIRRepresentation(Any IR, StringRef PassID,
std::string &Output) override;
- // Called when the pass is not iteresting.
- void omitAfter(StringRef PassID, std::string &Name) override;
// Called when an interesting IR has changed.
void handleAfter(StringRef PassID, std::string &Name,
const std::string &Before, const std::string &After,
Any) override;
- // Called when an interesting pass is invalidated.
- void handleInvalidated(StringRef PassID) override;
- // Called when the IR or pass is not interesting.
- void handleFiltered(StringRef PassID, std::string &Name) override;
- // Called when an ignored pass is encountered.
- void handleIgnored(StringRef PassID, std::string &Name) override;
// Called to compare the before and after representations of the IR.
bool same(const std::string &Before, const std::string &After) override;
-
- raw_ostream &Out;
};
class VerifyInstrumentation {
@@ -239,7 +264,7 @@ class StandardInstrumentations {
OptNoneInstrumentation OptNone;
OptBisectInstrumentation OptBisect;
PreservedCFGCheckerInstrumentation PreservedCFGChecker;
- IRChangePrinter PrintChangedIR;
+ IRChangedPrinter PrintChangedIR;
VerifyInstrumentation Verify;
bool VerifyEach;
@@ -253,6 +278,10 @@ class StandardInstrumentations {
TimePassesHandler &getTimePasses() { return TimePasses; }
};
+
+extern template class ChangeReporter<std::string>;
+extern template class TextChangeReporter<std::string>;
+
} // namespace llvm
#endif
diff --git a/llvm/lib/Passes/StandardInstrumentations.cpp b/llvm/lib/Passes/StandardInstrumentations.cpp
index fe1a7af50f9e..445b9d289ad5 100644
--- a/llvm/lib/Passes/StandardInstrumentations.cpp
+++ b/llvm/lib/Passes/StandardInstrumentations.cpp
@@ -241,14 +241,20 @@ bool isIgnored(StringRef PassID) {
{"PassManager", "PassAdaptor", "AnalysisManagerProxy"});
}
-// Return true when this is a defined function for which printing
-// of changes is desired.
-bool isInterestingFunction(const Function &F) {
+} // namespace
+
+template <typename IRUnitT>
+ChangeReporter<IRUnitT>::~ChangeReporter<IRUnitT>() {
+ assert(BeforeStack.empty() && "Problem with Change Printer stack.");
+}
+
+template <typename IRUnitT>
+bool ChangeReporter<IRUnitT>::isInterestingFunction(const Function &F) {
return llvm::isFunctionInPrintList(F.getName());
}
-// Return true when this is a pass for which printing of changes is desired.
-bool isInterestingPass(StringRef PassID) {
+template <typename IRUnitT>
+bool ChangeReporter<IRUnitT>::isInterestingPass(StringRef PassID) {
if (isIgnored(PassID))
return false;
@@ -259,7 +265,8 @@ bool isInterestingPass(StringRef PassID) {
// Return true when this is a pass on IR for which printing
// of changes is desired.
-bool isInteresting(Any IR, StringRef PassID) {
+template <typename IRUnitT>
+bool ChangeReporter<IRUnitT>::isInteresting(Any IR, StringRef PassID) {
if (!isInterestingPass(PassID))
return false;
if (any_isa<const Function *>(IR))
@@ -267,10 +274,8 @@ bool isInteresting(Any IR, StringRef PassID) {
return true;
}
-} // namespace
-
template <typename IRUnitT>
-void ChangePrinter<IRUnitT>::saveIRBeforePass(Any IR, StringRef PassID) {
+void ChangeReporter<IRUnitT>::saveIRBeforePass(Any IR, StringRef PassID) {
// Always need to place something on the stack because invalidated passes
// are not given the IR so it cannot be determined whether the pass was for
// something that was filtered out.
@@ -290,7 +295,7 @@ void ChangePrinter<IRUnitT>::saveIRBeforePass(Any IR, StringRef PassID) {
}
template <typename IRUnitT>
-void ChangePrinter<IRUnitT>::handleIRAfterPass(Any IR, StringRef PassID) {
+void ChangeReporter<IRUnitT>::handleIRAfterPass(Any IR, StringRef PassID) {
assert(!BeforeStack.empty() && "Unexpected empty stack encountered.");
std::string Name;
@@ -302,7 +307,7 @@ void ChangePrinter<IRUnitT>::handleIRAfterPass(Any IR, StringRef PassID) {
if (auto UM = unwrapModule(IR))
Name = UM->second;
}
- if (Name.empty())
+ if (Name == "")
Name = " (module)";
if (isIgnored(PassID))
@@ -326,7 +331,7 @@ void ChangePrinter<IRUnitT>::handleIRAfterPass(Any IR, StringRef PassID) {
}
template <typename IRUnitT>
-void ChangePrinter<IRUnitT>::handleInvalidatedPass(StringRef PassID) {
+void ChangeReporter<IRUnitT>::handleInvalidatedPass(StringRef PassID) {
assert(!BeforeStack.empty() && "Unexpected empty stack encountered.");
// Always flag it as invalidated as we cannot determine when
@@ -337,18 +342,9 @@ void ChangePrinter<IRUnitT>::handleInvalidatedPass(StringRef PassID) {
BeforeStack.pop_back();
}
-template <typename IRUnitT> ChangePrinter<IRUnitT>::~ChangePrinter<IRUnitT>() {
- assert(BeforeStack.empty() && "Problem with Change Printer stack.");
-}
-
-IRChangePrinter::IRChangePrinter() : Out(dbgs()) {}
-
-IRChangePrinter::~IRChangePrinter() {}
-
-void IRChangePrinter::registerCallbacks(PassInstrumentationCallbacks &PIC) {
- if (!PrintChanged)
- return;
-
+template <typename IRUnitT>
+void ChangeReporter<IRUnitT>::registerRequiredCallbacks(
+ PassInstrumentationCallbacks &PIC) {
PIC.registerBeforeNonSkippedPassCallback(
[this](StringRef P, Any IR) { saveIRBeforePass(IR, P); });
@@ -362,7 +358,12 @@ void IRChangePrinter::registerCallbacks(PassInstrumentationCallbacks &PIC) {
});
}
-void IRChangePrinter::handleInitialIR(Any IR) {
+template <typename IRUnitT>
+TextChangeReporter<IRUnitT>::TextChangeReporter()
+ : ChangeReporter<IRUnitT>(), Out(dbgs()) {}
+
+template <typename IRUnitT>
+void TextChangeReporter<IRUnitT>::handleInitialIR(Any IR) {
// Always print the module.
// Unwrap and print directly to avoid filtering problems in general routines.
auto UnwrappedModule = unwrapModule(IR, /*Force=*/true);
@@ -372,24 +373,53 @@ void IRChangePrinter::handleInitialIR(Any IR) {
/*ShouldPreserveUseListOrder=*/true);
}
-void IRChangePrinter::generateIRRepresentation(Any IR, StringRef PassID,
- std::string &Output) {
+template <typename IRUnitT>
+void TextChangeReporter<IRUnitT>::omitAfter(StringRef PassID,
+ std::string &Name) {
+ Out << formatv("*** IR Dump After {0}{1} omitted because no change ***\n",
+ PassID, Name);
+}
+
+template <typename IRUnitT>
+void TextChangeReporter<IRUnitT>::handleInvalidated(StringRef PassID) {
+ Out << formatv("*** IR Pass {0} invalidated ***\n", PassID);
+}
+
+template <typename IRUnitT>
+void TextChangeReporter<IRUnitT>::handleFiltered(StringRef PassID,
+ std::string &Name) {
+ SmallString<20> Banner =
+ formatv("*** IR Dump After {0}{1} filtered out ***\n", PassID, Name);
+ Out << Banner;
+}
+
+template <typename IRUnitT>
+void TextChangeReporter<IRUnitT>::handleIgnored(StringRef PassID,
+ std::string &Name) {
+ Out << formatv("*** IR Pass {0}{1} ignored ***\n", PassID, Name);
+}
+
+IRChangedPrinter::~IRChangedPrinter() {}
+
+void IRChangedPrinter::registerCallbacks(PassInstrumentationCallbacks &PIC) {
+ if (PrintChanged)
+ TextChangeReporter<std::string>::registerRequiredCallbacks(PIC);
+}
+
+void IRChangedPrinter::generateIRRepresentation(Any IR, StringRef PassID,
+ std::string &Output) {
raw_string_ostream OS(Output);
// use the after banner for all cases so it will match
SmallString<20> Banner = formatv("*** IR Dump After {0} ***", PassID);
- unwrapAndPrint(OS, IR, Banner, llvm::forcePrintModuleIR(),
+ unwrapAndPrint(OS, IR, Banner, forcePrintModuleIR(),
/*Brief=*/false, /*ShouldPreserveUseListOrder=*/true);
- OS.str();
-}
-void IRChangePrinter::omitAfter(StringRef PassID, std::string &Name) {
- Out << formatv("*** IR Dump After {0}{1} omitted because no change ***\n",
- PassID, Name);
+ OS.str();
}
-void IRChangePrinter::handleAfter(StringRef PassID, std::string &Name,
- const std::string &Before,
- const std::string &After, Any) {
+void IRChangedPrinter::handleAfter(StringRef PassID, std::string &Name,
+ const std::string &Before,
+ const std::string &After, Any) {
assert(After.find("*** IR Dump") == 0 && "Unexpected banner format.");
StringRef AfterRef = After;
StringRef Banner =
@@ -417,23 +447,8 @@ void IRChangePrinter::handleAfter(StringRef PassID, std::string &Name,
Out << After.substr(Banner.size());
}
-void IRChangePrinter::handleInvalidated(StringRef PassID) {
- Out << formatv("*** IR Pass {0} invalidated ***\n", PassID);
-}
-
-void IRChangePrinter::handleFiltered(StringRef PassID, std::string &Name) {
- SmallString<20> Banner =
- formatv("*** IR Dump After {0}{1} filtered out ***\n", PassID, Name);
- Out << Banner;
-}
-
-void IRChangePrinter::handleIgnored(StringRef PassID, std::string &Name) {
- Out << formatv("*** IR Pass {0}{1} ignored ***\n", PassID, Name);
-}
-
-bool IRChangePrinter::same(const std::string &Before,
- const std::string &After) {
- return Before == After;
+bool IRChangedPrinter::same(const std::string &S1, const std::string &S2) {
+ return S1 == S2;
}
PrintIRInstrumentation::~PrintIRInstrumentation() {
@@ -829,3 +844,10 @@ void StandardInstrumentations::registerCallbacks(
if (VerifyEach)
Verify.registerCallbacks(PIC);
}
+
+namespace llvm {
+
+template class ChangeReporter<std::string>;
+template class TextChangeReporter<std::string>;
+
+} // namespace llvm
More information about the llvm-commits
mailing list