Index: llvm/include/llvm/Passes/StandardInstrumentations.h =================================================================== --- llvm/include/llvm/Passes/StandardInstrumentations.h +++ llvm/include/llvm/Passes/StandardInstrumentations.h @@ -25,6 +25,7 @@ namespace llvm { +class Function; class Module; /// Instrumentation to print IR before/after passes. @@ -73,6 +74,98 @@ bool DebugLogging; }; +// Base class for classes that report changes to the IR. +// It presents an interface for such classes and provides callbacks +// on various events as the new pass manager transforms the IR. +// It also provides filtering of information based on hidden options +// specifying which functions are interesting. +// Callbacks are made for the following events/queries: +// 1. The initial IR processed. +// 2. To get the representation of the IR (of type \p T). +// 3. When a pass does not change the IR. +// 4. When a pass changes the IR (given both before and after representations +// of type \p T). +// 5. When an IR is invalidated. +// 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 class ChangePrinter { +protected: + ChangePrinter( + std::function HandleInitialIRFunc, + std::function + GenerateIRRepresentationFunc, + std::function OmitAfterFunc, + std::function + HandleAfterFunc, + std::function HandleInvalidatedFunc, + std::function + HandleFilteredFunc, + std::function + HandleIgnoredFunc, + std::function SameFunc) + : HandleInitialIR(HandleInitialIRFunc), + GenerateIRRepresentation(GenerateIRRepresentationFunc), + OmitAfter(OmitAfterFunc), HandleAfter(HandleAfterFunc), + HandleInvalidated(HandleInvalidatedFunc), + HandleFiltered(HandleFilteredFunc), HandleIgnored(HandleIgnoredFunc), + Same(SameFunc), InitialIR(true) {} + +public: + // Not virtual as classes are expected to be referenced as derived classes. + ~ChangePrinter() { + assert(BeforeStack.empty() && "Problem with Change Printer stack."); + } + + // Determine if this pass/IR is interesting and if so, save the IR + // otherwise it is left on the stack without data + void saveIRBeforePass(Any IR, StringRef PassID); + // Compare the IR from before the pass after the pass. + void handleIRAfterPass(Any IR, StringRef PassID); + // Handle the situation where a pass is invalidated. + void handleInvalidatedPass(StringRef PassID); + +private: + // callback on the first IR processed + std::function HandleInitialIR; + // callback before and after a pass to get the representation of the IR + std::function + GenerateIRRepresentation; + // callback when the pass is not iteresting + std::function OmitAfter; + // callback when interesting IR has changed + std::function + HandleAfter; + // callback when an interesting pass is invalidated + std::function HandleInvalidated; + // callback when the IR or pass is not interesting + std::function HandleFiltered; + // callback when an ignored pass is encountered + std::function HandleIgnored; + // callback to compare the before and after representations of the IR + std::function Same; + + // stack of IRs before passes + std::vector BeforeStack; + // Is this the first IR seen? + bool InitialIR; +}; + +// 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 { +public: + IRChangePrinter(); + void registerCallbacks(PassInstrumentationCallbacks &PIC); + +protected: + raw_ostream &Out; +}; + /// This class provides an interface to register all the standard pass /// instrumentations and manages their state (if any). class StandardInstrumentations { @@ -80,6 +173,7 @@ PrintPassInstrumentation PrintPass; TimePassesHandler TimePasses; OptNoneInstrumentation OptNone; + IRChangePrinter PrintChangedIR; public: StandardInstrumentations(bool DebugLogging) : PrintPass(DebugLogging) {} Index: llvm/lib/IR/LegacyPassManager.cpp =================================================================== --- llvm/lib/IR/LegacyPassManager.cpp +++ llvm/lib/IR/LegacyPassManager.cpp @@ -86,14 +86,14 @@ static cl::opt PrintModuleScope("print-module-scope", cl::desc("When printing IR for print-[before|after]{-all} " - "always print a module IR"), + "and change reporters always print a module IR"), cl::init(false), cl::Hidden); static cl::list PrintFuncsList("filter-print-funcs", cl::value_desc("function names"), cl::desc("Only print IR for functions whose name " "match this for all print-[before|after][-all] " - "options"), + "and change reporter options"), cl::CommaSeparated, cl::Hidden); /// This is a helper to determine whether to print IR before or Index: llvm/lib/Passes/StandardInstrumentations.cpp =================================================================== --- llvm/lib/Passes/StandardInstrumentations.cpp +++ 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 #include using namespace llvm; @@ -43,6 +44,34 @@ cl::desc("Print all pass management debugging information. " "`-debug-pass-manager` must also be specified")); +// A hidden option that prints out the IR after passes, similar to +// -print-after-all except that it only prints the IR after passes that +// change the IR. Those passes that do not make changes to the IR are +// reported as not making any changes. In addition, the initial IR is +// also reported. Other hidden options affect the output from this +// option. -filter-passes will limit the output to the named passes +// that actually change the IR and other passes are reported as filtered out. +// The specified passes will either be reported as making no changes (with +// no IR reported) or the changed IR will be reported. Also, the +// -filter-print-funcs and -print-module-scope options will do similar +// filtering based on function name, reporting changed IRs as functions(or +// modules if -print-module-scope is specified) for a particular function +// or indicating that the IR has been filtered out. The extra options +// can be combined, allowing only changed IRs for certain passes on certain +// functions to be reported in different formats, with the rest being +// reported as filtered out. +static cl::opt PrintChanged("print-changed", + cl::desc("Print changed IRs"), + cl::init(false), cl::Hidden); +// A hidden option that supports the -print-changed option. See +// the description for -print-changed for an explanation of the use +// of this option. Note that this option has no effect without -print-changed. +static cl::list + PrintPassesList("filter-passes", cl::value_desc("pass names"), + cl::desc("Only consider IR changes for passes whose names " + "match for the print-changed option"), + cl::CommaSeparated, cl::Hidden); + namespace { /// Extracting Module out of \p IR unit. Also fills a textual description @@ -99,7 +128,8 @@ } void printIR(raw_ostream &OS, const Module *M, StringRef Banner, - StringRef Extra = StringRef(), bool Brief = false) { + StringRef Extra = StringRef(), bool Brief = false, + bool ShouldPreserveUseListOrder = false) { if (Brief) { OS << M->getName() << '\n'; return; @@ -107,7 +137,7 @@ if (llvm::isFunctionInPrintList("*") || llvm::forcePrintModuleIR()) { OS << Banner << Extra << "\n"; - M->print(OS, nullptr, false); + M->print(OS, nullptr, ShouldPreserveUseListOrder); } else { for (const auto &F : M->functions()) { printIR(OS, &F, Banner, Extra); @@ -151,17 +181,19 @@ /// Generic IR-printing helper that unpacks a pointer to IRUnit wrapped into /// llvm::Any and does actual print job. void unwrapAndPrint(raw_ostream &OS, Any IR, StringRef Banner, - bool ForceModule = false, bool Brief = false) { + bool ForceModule = false, bool Brief = false, + bool ShouldPreserveUseListOrder = false) { if (ForceModule) { if (auto UnwrappedModule = unwrapModule(IR)) - printIR(OS, UnwrappedModule->first, Banner, UnwrappedModule->second); + printIR(OS, UnwrappedModule->first, Banner, UnwrappedModule->second, + Brief, ShouldPreserveUseListOrder); return; } if (any_isa(IR)) { const Module *M = any_cast(IR); assert(M && "module should be valid for printing"); - printIR(OS, M, Banner, "", Brief); + printIR(OS, M, Banner, "", Brief, ShouldPreserveUseListOrder); return; } @@ -189,8 +221,200 @@ llvm_unreachable("Unknown wrapped IR type"); } +// Return true when this is a pass for which changes should be ignored +inline bool isIgnored(StringRef PassID) { + return isSpecialPass(PassID, + {"PassManager", "PassAdaptor", "AnalysisManagerProxy"}); +} + +// Return true when this is a defined function for which printing +// of changes is desired. +inline bool isInterestingFunction(const Function &F) { + return llvm::isFunctionInPrintList(F.getName()); +} + +// Return true when this is a pass for which printing of changes is desired. +inline bool isInterestingPass(StringRef PassID) { + if (isIgnored(PassID)) + return false; + + static std::unordered_set PrintPassNames(PrintPassesList.begin(), + PrintPassesList.end()); + return PrintPassNames.empty() || PrintPassNames.count(PassID.str()); +} + +// Return true when this is a pass on IR for which printing +// of changes is desired. +bool isInteresting(Any IR, StringRef PassID) { + if (!isInterestingPass(PassID)) + return false; + if (any_isa(IR)) + return isInterestingFunction(*any_cast(IR)); + return true; +} + } // namespace +template +void ChangePrinter::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. + BeforeStack.emplace_back(); + + if (!isInteresting(IR, PassID)) + return; + // Is this the initial IR? + if (InitialIR) { + InitialIR = false; + HandleInitialIR(IR); + } + + // Save the IR representation on the stack. + auto &Data = BeforeStack.back(); + GenerateIRRepresentation(IR, PassID, Data); +} + +template +void ChangePrinter::handleIRAfterPass(Any IR, StringRef PassID) { + assert(!BeforeStack.empty() && "Unexpected empty stack encountered."); + std::string Name; + + // unwrapModule has inconsistent handling of names for function IRs. + if (any_isa(IR)) { + const Function *F = any_cast(IR); + Name = formatv(" (function: {0})", F->getName()).str(); + } else { + if (auto UM = unwrapModule(IR)) + Name = UM->second; + } + if (Name == "") + Name = " (module)"; + + if (isIgnored(PassID)) + HandleIgnored(PassID, Name); + else if (!isInteresting(IR, PassID)) + HandleFiltered(PassID, Name); + else { + // Get the before rep from the stack + IRUnitT &Before = BeforeStack.back(); + // Create the after rep + IRUnitT After; + GenerateIRRepresentation(IR, PassID, After); + + // was there a change in IR? + if (Same(Before, After)) + OmitAfter(PassID, Name); + else + HandleAfter(PassID, Name, Before, After, IR); + } + BeforeStack.pop_back(); +} + +template +void ChangePrinter::handleInvalidatedPass(StringRef PassID) { + assert(!BeforeStack.empty() && "Unexpected empty stack encountered."); + + // Always flag it as invalidated as we cannot determine when + // a pass for a filtered function is invalidated since we do not + // get the IR in the callback. Also, the output is just alternate + // forms of the banner anyway. + HandleInvalidated(PassID); + BeforeStack.pop_back(); +} + +void handleInitialIR(Any IR, raw_ostream &Out) { + StringRef Banner("*** IR Dump At Start: ***"); + unwrapAndPrint(Out, IR, Banner, true, + /*Brief*/ false, /*ShouldPreserveUseListOrder*/ true); +} + +void generateOutput(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(), + /*Brief*/ false, /*ShouldPreserveUseListOrder*/ true); + OS.str(); +} + +void omitAfter(StringRef PassID, std::string &Name, raw_ostream &Out) { + Out << formatv("*** IR Dump After {0}{1} omitted because no change ***\n", + PassID, Name); +} + +void handleAfter(const StringRef After, std::string &Name, raw_ostream &Out) { + assert(After.find("*** IR Dump") == 0 && "Unexpected banner format."); + StringRef Banner = After.take_until([](char C) -> bool { return C == '\n'; }); + Out << Banner; + + // LazyCallGraph::SCC already has "(scc:..." in banner so only add + // in the name if it isn't already there. + if (Name.substr(0, 6).compare(" (scc:") != 0 && !llvm::forcePrintModuleIR()) + Out << Name; + + Out << After.substr(Banner.size()); +} + +void handleInvalidated(StringRef PassID, raw_ostream &Out) { + Out << formatv("*** IR Pass {0} invalidated ***\n", PassID); +} + +void handleFiltered(StringRef PassID, std::string &Name, raw_ostream &Out) { + SmallString<20> Banner = + formatv("*** IR Dump After {0}{1} filtered out ***\n", PassID, Name); + Out << Banner; +} + +void handleIgnored(StringRef PassID, std::string &Name, raw_ostream &Out) { + Out << formatv("*** IR Pass {0}{1} ignored ***\n", PassID, Name); +} + +bool sameIR(const std::string &S1, const std::string &S2) { + return S1.compare(S2) == 0; +} + +IRChangePrinter::IRChangePrinter() + : ChangePrinter( + [this](Any IR) -> void { ::handleInitialIR(IR, Out); }, + ::generateOutput, + [this](StringRef PassID, std::string &Name) -> void { + ::omitAfter(PassID, Name, Out); + }, + [this](StringRef PassID, std::string &Name, const std::string &Before, + const std::string &After, + Any IR) -> void { ::handleAfter(After, Name, Out); }, + [this](StringRef PassID) -> void { + ::handleInvalidated(PassID, Out); + }, + [this](StringRef PassID, std::string &Name) -> void { + ::handleFiltered(PassID, Name, Out); + }, + [this](StringRef PassID, std::string &Name) -> void { + ::handleIgnored(PassID, Name, Out); + }, + ::sameIR), + Out(dbgs()) {} + +void IRChangePrinter::registerCallbacks(PassInstrumentationCallbacks &PIC) { + if (!PrintChanged) + return; + + PIC.registerBeforePassCallback([this](StringRef P, Any IR) { + saveIRBeforePass(IR, P); + return true; + }); + + PIC.registerAfterPassCallback( + [this](StringRef P, Any IR, const PreservedAnalyses &) { + handleIRAfterPass(IR, P); + }); + PIC.registerAfterPassInvalidatedCallback( + [this](StringRef P, const PreservedAnalyses &) { + handleInvalidatedPass(P); + }); +} + PrintIRInstrumentation::~PrintIRInstrumentation() { assert(ModuleDescStack.empty() && "ModuleDescStack is not empty at exit"); } @@ -344,4 +568,5 @@ PrintPass.registerCallbacks(PIC); TimePasses.registerCallbacks(PIC); OptNone.registerCallbacks(PIC); + PrintChangedIR.registerCallbacks(PIC); } Index: llvm/test/Other/change-printer.ll =================================================================== --- /dev/null +++ llvm/test/Other/change-printer.ll @@ -0,0 +1,109 @@ +; Simple checks of -print-changed functionality +; +; Note that (mostly) only the banners are checked. +; +; Simple functionality check. +; RUN: opt -S -print-changed -passes=instsimplify 2>&1 -o /dev/null < %s | FileCheck %s --check-prefix=CHECK_SIMPLE +; +; Check that only the passes that change the IR are printed and that the +; others (including g) are filtered out. +; RUN: opt -S -print-changed -passes=instsimplify -filter-print-funcs=f 2>&1 -o /dev/null < %s | FileCheck %s --check-prefix=CHECK_FUNC_FILTER +; +; Check that the reporting of IRs respects -print-module-scope +; RUN: opt -S -print-changed -passes=instsimplify -print-module-scope 2>&1 -o /dev/null < %s | FileCheck %s --check-prefix=CHECK_PRINT_MOD_SCOPE +; +; Check that the reporting of IRs respects -print-module-scope +; RUN: opt -S -print-changed -passes=instsimplify -filter-print-funcs=f -print-module-scope 2>&1 -o /dev/null < %s | FileCheck %s --check-prefix=CHECK_FUNC_FILTER_MOD_SCOPE +; +; Check that reporting of multiple functions happens +; RUN: opt -S -print-changed -passes=instsimplify -filter-print-funcs="f,g" 2>&1 -o /dev/null < %s | FileCheck %s --check-prefix=CHECK_FILTER_MULT_FUNC +; +; Check that the reporting of IRs respects -filter-passes +; RUN: opt -S -print-changed -passes="instsimplify,no-op-function" -filter-passes="NoOpFunctionPass" 2>&1 -o /dev/null < %s | FileCheck %s --check-prefix=CHECK_FILTER_PASSES +; +; Check that the reporting of IRs respects -filter-passes with multiple passes +; RUN: opt -S -print-changed -passes="instsimplify,no-op-function" -filter-passes="NoOpFunctionPass,InstSimplifyPass" 2>&1 -o /dev/null < %s | FileCheck %s --check-prefix=CHECK_FILTER_MULT_PASSES +; +; Check that the reporting of IRs respects both -filter-passes and -filter-print-funcs +; RUN: opt -S -print-changed -passes="instsimplify,no-op-function" -filter-passes="NoOpFunctionPass,InstSimplifyPass" -filter-print-funcs=f 2>&1 -o /dev/null < %s | FileCheck %s --check-prefix=CHECK_FILTER_FUNC_PASSES +; +; Check that the reporting of IRs respects -filter-passes, -filter-print-funcs and -print-module-scope +; RUN: opt -S -print-changed -passes="instsimplify,no-op-function" -filter-passes="NoOpFunctionPass,InstSimplifyPass" -filter-print-funcs=f -print-module-scope 2>&1 -o /dev/null < %s | FileCheck %s --check-prefix=CHECK_FILTER_FUNC_PASSES_MOD_SCOPE +; +; Check that repeated passes that change the IR are printed and that the +; others (including g) are filtered out. Note that the second time +; instsimplify is run on f, it does not change the IR +; RUN: opt -S -print-changed -passes="instsimplify,instsimplify" -filter-print-funcs=f 2>&1 -o /dev/null < %s | FileCheck %s --check-prefix=CHECK_MULT_PASSES_FILTER_FUNC + +define i32 @g() { +entry: + %a = add i32 2, 3 + ret i32 %a +} + +define i32 @f() { +entry: + %a = add i32 2, 3 + ret i32 %a +} + +; CHECK_SIMPLE: *** IR Dump At Start: *** +; CHECK_SIMPLE: ; ModuleID = '' +; CHECK_SIMPLE: *** IR Dump After VerifierPass (module) omitted because no change *** +; CHECK_SIMPLE: *** IR Dump After InstSimplifyPass *** (function: g) +; CHECK_SIMPLE: *** IR Pass PassManager (function: g) ignored *** +; CHECK_SIMPLE: *** IR Dump After InstSimplifyPass *** (function: f) +; CHECK_SIMPLE: *** IR Pass PassManager (function: f) ignored *** +; CHECK_SIMPLE: *** IR Pass ModuleToFunctionPassAdaptor{{ ?}}> (module) ignored *** +; CHECK_SIMPLE: *** IR Dump After VerifierPass (module) omitted because no change *** +; CHECK_SIMPLE: *** IR Dump After PrintModulePass (module) omitted because no change *** + +; CHECK_FUNC_FILTER: *** IR Dump At Start: *** +; CHECK_FUNC_FILTER: *** IR Dump After InstSimplifyPass (function: g) filtered out *** +; CHECK_FUNC_FILTER: *** IR Dump After InstSimplifyPass *** (function: f) + +; CHECK_PRINT_MOD_SCOPE: *** IR Dump At Start: *** +; CHECK_PRINT_MOD_SCOPE: *** IR Dump After InstSimplifyPass *** (function: g) +; CHECK_PRINT_MOD_SCOPE: ModuleID = '' +; CHECK_PRINT_MOD_SCOPE: *** IR Dump After InstSimplifyPass *** (function: f) +; CHECK_PRINT_MOD_SCOPE: ModuleID = '' + +; CHECK_FUNC_FILTER_MOD_SCOPE: *** IR Dump At Start: *** +; CHECK_FUNC_FILTER_MOD_SCOPE: *** IR Dump After InstSimplifyPass (function: g) filtered out *** +; CHECK_FUNC_FILTER_MOD_SCOPE: *** IR Dump After InstSimplifyPass *** (function: f) +; CHECK_FUNC_FILTER_MOD_SCOPE: ModuleID = '' + +; CHECK_FILTER_MULT_FUNC: *** IR Dump At Start: *** +; CHECK_FILTER_MULT_FUNC: *** IR Dump After InstSimplifyPass *** (function: g) +; CHECK_FILTER_MULT_FUNC: *** IR Dump After InstSimplifyPass *** (function: f) + +; CHECK_FILTER_PASSES: *** IR Dump After InstSimplifyPass (function: g) filtered out *** +; CHECK_FILTER_PASSES: *** IR Dump At Start: *** (function: g) +; CHECK_FILTER_PASSES: *** IR Dump After NoOpFunctionPass (function: g) omitted because no change *** +; CHECK_FILTER_PASSES: *** IR Dump After InstSimplifyPass (function: f) filtered out *** +; CHECK_FILTER_PASSES: *** IR Dump After NoOpFunctionPass (function: f) omitted because no change *** + +; CHECK_FILTER_MULT_PASSES: *** IR Dump At Start: *** (function: g) +; CHECK_FILTER_MULT_PASSES: *** IR Dump After InstSimplifyPass *** (function: g) +; CHECK_FILTER_MULT_PASSES: *** IR Dump After NoOpFunctionPass (function: g) omitted because no change *** +; CHECK_FILTER_MULT_PASSES: *** IR Dump After InstSimplifyPass *** (function: f) +; CHECK_FILTER_MULT_PASSES: *** IR Dump After NoOpFunctionPass (function: f) omitted because no change *** + +; CHECK_FILTER_FUNC_PASSES: *** IR Dump After InstSimplifyPass (function: g) filtered out *** +; CHECK_FILTER_FUNC_PASSES: *** IR Dump After NoOpFunctionPass (function: g) filtered out *** +; CHECK_FILTER_FUNC_PASSES: *** IR Dump At Start: *** (function: f) +; CHECK_FILTER_FUNC_PASSES: *** IR Dump After InstSimplifyPass *** (function: f) +; CHECK_FILTER_FUNC_PASSES: *** IR Dump After NoOpFunctionPass (function: f) omitted because no change *** + +; CHECK_FILTER_FUNC_PASSES_MOD_SCOPE: *** IR Dump After InstSimplifyPass (function: g) filtered out *** +; CHECK_FILTER_FUNC_PASSES_MOD_SCOPE: *** IR Dump After NoOpFunctionPass (function: g) filtered out *** +; CHECK_FILTER_FUNC_PASSES_MOD_SCOPE: *** IR Dump At Start: *** (function: f) +; CHECK_FILTER_FUNC_PASSES_MOD_SCOPE: *** IR Dump After InstSimplifyPass *** (function: f) +; CHECK_FILTER_FUNC_PASSES_MOD_SCOPE: ModuleID = '' +; CHECK_FILTER_FUNC_PASSES_MOD_SCOPE: *** IR Dump After NoOpFunctionPass (function: f) omitted because no change *** + +; CHECK_MULT_PASSES_FILTER_FUNC: *** IR Dump At Start: *** +; CHECK_MULT_PASSES_FILTER_FUNC: *** IR Dump After InstSimplifyPass (function: g) filtered out *** +; CHECK_MULT_PASSES_FILTER_FUNC: *** IR Dump After InstSimplifyPass (function: g) filtered out *** +; CHECK_MULT_PASSES_FILTER_FUNC: *** IR Dump After InstSimplifyPass *** (function: f) +; CHECK_MULT_PASSES_FILTER_FUNC: *** IR Dump After InstSimplifyPass (function: f) omitted because no change ***