[mlir] Allow statistics to be printed to a custom stream#190937
Open
malbecki wants to merge 1 commit into
Open
[mlir] Allow statistics to be printed to a custom stream#190937malbecki wants to merge 1 commit into
malbecki wants to merge 1 commit into
Conversation
Add a dumpStatistics method to PassManager to allow compilers to print pass statistics without going through the --info-output-file CLI option. This allows compilers that do not parse CLI options to still be able to print statistics to custom stream.
|
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be notified. If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers. If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
Member
|
@llvm/pr-subscribers-mlir-core Author: Mateusz Albecki (malbecki) ChangesAdd a dumpStatistics method to PassManager to allow compilers to print pass statistics without going through the --info-output-file CLI option. This allows compilers that do not parse CLI options to still be able to print statistics to custom stream. Full diff: https://github.com/llvm/llvm-project/pull/190937.diff 3 Files Affected:
diff --git a/mlir/include/mlir/Pass/PassManager.h b/mlir/include/mlir/Pass/PassManager.h
index 6e59b0f32ac6f..16f12d2dc16eb 100644
--- a/mlir/include/mlir/Pass/PassManager.h
+++ b/mlir/include/mlir/Pass/PassManager.h
@@ -463,6 +463,8 @@ class PassManager : public OpPassManager {
void
enableStatistics(PassDisplayMode displayMode = PassDisplayMode::Pipeline);
+ void dumpStatistics(raw_ostream &os, PassDisplayMode displayMode);
+
private:
/// Dump the statistics of the passes within this pass manager.
void dumpStatistics();
diff --git a/mlir/lib/Pass/PassStatistics.cpp b/mlir/lib/Pass/PassStatistics.cpp
index 01191aa824440..3d271129ebfe6 100644
--- a/mlir/lib/Pass/PassStatistics.cpp
+++ b/mlir/lib/Pass/PassStatistics.cpp
@@ -138,27 +138,26 @@ static void printResultsAsPipeline(raw_ostream &os, OpPassManager &pm) {
#endif
}
-static void printStatistics(OpPassManager &pm, PassDisplayMode displayMode) {
- auto os = llvm::CreateInfoOutputFile();
-
+static void printStatistics(OpPassManager &pm, raw_ostream &os,
+ PassDisplayMode displayMode) {
// Print the stats header.
- *os << "===" << std::string(73, '-') << "===\n";
+ os << "===" << std::string(73, '-') << "===\n";
// Figure out how many spaces for the description name.
unsigned padding = (80 - kPassStatsDescription.size()) / 2;
- os->indent(padding) << kPassStatsDescription << '\n';
- *os << "===" << std::string(73, '-') << "===\n";
+ os.indent(padding) << kPassStatsDescription << '\n';
+ os << "===" << std::string(73, '-') << "===\n";
// Defer to a specialized printer for each display mode.
switch (displayMode) {
case PassDisplayMode::List:
- printResultsAsList(*os, pm);
+ printResultsAsList(os, pm);
break;
case PassDisplayMode::Pipeline:
- printResultsAsPipeline(*os, pm);
+ printResultsAsPipeline(os, pm);
break;
}
- *os << "\n";
- os->flush();
+ os << "\n";
+ os.flush();
}
//===----------------------------------------------------------------------===//
@@ -242,8 +241,13 @@ static void prepareStatistics(OpPassManager &pm) {
/// Dump the statistics of the passes within this pass manager.
void PassManager::dumpStatistics() {
+ auto os = llvm::CreateInfoOutputFile();
+ dumpStatistics(*os, passStatisticsMode.value());
+}
+
+void PassManager::dumpStatistics(raw_ostream &os, PassDisplayMode displayMode) {
prepareStatistics(*this);
- printStatistics(*this, *passStatisticsMode);
+ printStatistics(*this, os, displayMode);
}
/// Dump the statistics for each pass after running.
diff --git a/mlir/unittests/Pass/PassManagerTest.cpp b/mlir/unittests/Pass/PassManagerTest.cpp
index 3f5db8ebcbb6d..ea6ecc1759ad8 100644
--- a/mlir/unittests/Pass/PassManagerTest.cpp
+++ b/mlir/unittests/Pass/PassManagerTest.cpp
@@ -380,4 +380,48 @@ TEST(PassManagerTest, PassInitialization) {
EXPECT_TRUE(succeeded(pm.run(module.get())));
}
+struct IncrementStatisticsPass
+ : public PassWrapper<IncrementStatisticsPass, OperationPass<ModuleOp>> {
+ MLIR_DEFINE_EXPLICIT_INTERNAL_INLINE_TYPE_ID(IncrementStatisticsPass)
+
+ IncrementStatisticsPass() {};
+ IncrementStatisticsPass(const IncrementStatisticsPass &other) {}
+
+ void runOnOperation() override {
+ testStat1++;
+ testStat2 += 5;
+ testStat3 = 10;
+ }
+
+ std::unique_ptr<mlir::Pass> clonePass() const override {
+ return std::make_unique<IncrementStatisticsPass>();
+ }
+
+private:
+ Pass::Statistic testStat1{this, "test-stat-1", "Test1"};
+ Pass::Statistic testStat2{this, "test-stat-2", "Test2"};
+ Pass::Statistic testStat3{this, "test-stat-3", "Test3"};
+};
+
+TEST(PassManagerTest, StatisticsPrint) {
+ MLIRContext context;
+ context.allowUnregisteredDialects();
+
+ OwningOpRef<ModuleOp> module(ModuleOp::create(UnknownLoc::get(&context)));
+
+ auto pm = PassManager::on<ModuleOp>(&context);
+ pm.addPass(std::make_unique<IncrementStatisticsPass>());
+ LogicalResult result = pm.run(module.get());
+ EXPECT_TRUE(succeeded(result));
+
+ std::string statistics;
+ llvm::raw_string_ostream os(statistics);
+
+ pm.dumpStatistics(os, PassDisplayMode::List);
+
+ EXPECT_NE(statistics.find("1 test-stat-1"), std::string::npos);
+ EXPECT_NE(statistics.find("5 test-stat-2"), std::string::npos);
+ EXPECT_NE(statistics.find("10 test-stat-3"), std::string::npos);
+}
+
} // namespace
|
Member
|
@llvm/pr-subscribers-mlir Author: Mateusz Albecki (malbecki) ChangesAdd a dumpStatistics method to PassManager to allow compilers to print pass statistics without going through the --info-output-file CLI option. This allows compilers that do not parse CLI options to still be able to print statistics to custom stream. Full diff: https://github.com/llvm/llvm-project/pull/190937.diff 3 Files Affected:
diff --git a/mlir/include/mlir/Pass/PassManager.h b/mlir/include/mlir/Pass/PassManager.h
index 6e59b0f32ac6f..16f12d2dc16eb 100644
--- a/mlir/include/mlir/Pass/PassManager.h
+++ b/mlir/include/mlir/Pass/PassManager.h
@@ -463,6 +463,8 @@ class PassManager : public OpPassManager {
void
enableStatistics(PassDisplayMode displayMode = PassDisplayMode::Pipeline);
+ void dumpStatistics(raw_ostream &os, PassDisplayMode displayMode);
+
private:
/// Dump the statistics of the passes within this pass manager.
void dumpStatistics();
diff --git a/mlir/lib/Pass/PassStatistics.cpp b/mlir/lib/Pass/PassStatistics.cpp
index 01191aa824440..3d271129ebfe6 100644
--- a/mlir/lib/Pass/PassStatistics.cpp
+++ b/mlir/lib/Pass/PassStatistics.cpp
@@ -138,27 +138,26 @@ static void printResultsAsPipeline(raw_ostream &os, OpPassManager &pm) {
#endif
}
-static void printStatistics(OpPassManager &pm, PassDisplayMode displayMode) {
- auto os = llvm::CreateInfoOutputFile();
-
+static void printStatistics(OpPassManager &pm, raw_ostream &os,
+ PassDisplayMode displayMode) {
// Print the stats header.
- *os << "===" << std::string(73, '-') << "===\n";
+ os << "===" << std::string(73, '-') << "===\n";
// Figure out how many spaces for the description name.
unsigned padding = (80 - kPassStatsDescription.size()) / 2;
- os->indent(padding) << kPassStatsDescription << '\n';
- *os << "===" << std::string(73, '-') << "===\n";
+ os.indent(padding) << kPassStatsDescription << '\n';
+ os << "===" << std::string(73, '-') << "===\n";
// Defer to a specialized printer for each display mode.
switch (displayMode) {
case PassDisplayMode::List:
- printResultsAsList(*os, pm);
+ printResultsAsList(os, pm);
break;
case PassDisplayMode::Pipeline:
- printResultsAsPipeline(*os, pm);
+ printResultsAsPipeline(os, pm);
break;
}
- *os << "\n";
- os->flush();
+ os << "\n";
+ os.flush();
}
//===----------------------------------------------------------------------===//
@@ -242,8 +241,13 @@ static void prepareStatistics(OpPassManager &pm) {
/// Dump the statistics of the passes within this pass manager.
void PassManager::dumpStatistics() {
+ auto os = llvm::CreateInfoOutputFile();
+ dumpStatistics(*os, passStatisticsMode.value());
+}
+
+void PassManager::dumpStatistics(raw_ostream &os, PassDisplayMode displayMode) {
prepareStatistics(*this);
- printStatistics(*this, *passStatisticsMode);
+ printStatistics(*this, os, displayMode);
}
/// Dump the statistics for each pass after running.
diff --git a/mlir/unittests/Pass/PassManagerTest.cpp b/mlir/unittests/Pass/PassManagerTest.cpp
index 3f5db8ebcbb6d..ea6ecc1759ad8 100644
--- a/mlir/unittests/Pass/PassManagerTest.cpp
+++ b/mlir/unittests/Pass/PassManagerTest.cpp
@@ -380,4 +380,48 @@ TEST(PassManagerTest, PassInitialization) {
EXPECT_TRUE(succeeded(pm.run(module.get())));
}
+struct IncrementStatisticsPass
+ : public PassWrapper<IncrementStatisticsPass, OperationPass<ModuleOp>> {
+ MLIR_DEFINE_EXPLICIT_INTERNAL_INLINE_TYPE_ID(IncrementStatisticsPass)
+
+ IncrementStatisticsPass() {};
+ IncrementStatisticsPass(const IncrementStatisticsPass &other) {}
+
+ void runOnOperation() override {
+ testStat1++;
+ testStat2 += 5;
+ testStat3 = 10;
+ }
+
+ std::unique_ptr<mlir::Pass> clonePass() const override {
+ return std::make_unique<IncrementStatisticsPass>();
+ }
+
+private:
+ Pass::Statistic testStat1{this, "test-stat-1", "Test1"};
+ Pass::Statistic testStat2{this, "test-stat-2", "Test2"};
+ Pass::Statistic testStat3{this, "test-stat-3", "Test3"};
+};
+
+TEST(PassManagerTest, StatisticsPrint) {
+ MLIRContext context;
+ context.allowUnregisteredDialects();
+
+ OwningOpRef<ModuleOp> module(ModuleOp::create(UnknownLoc::get(&context)));
+
+ auto pm = PassManager::on<ModuleOp>(&context);
+ pm.addPass(std::make_unique<IncrementStatisticsPass>());
+ LogicalResult result = pm.run(module.get());
+ EXPECT_TRUE(succeeded(result));
+
+ std::string statistics;
+ llvm::raw_string_ostream os(statistics);
+
+ pm.dumpStatistics(os, PassDisplayMode::List);
+
+ EXPECT_NE(statistics.find("1 test-stat-1"), std::string::npos);
+ EXPECT_NE(statistics.find("5 test-stat-2"), std::string::npos);
+ EXPECT_NE(statistics.find("10 test-stat-3"), std::string::npos);
+}
+
} // namespace
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a dumpStatistics method to PassManager to allow compilers to print pass statistics without going through the --info-output-file CLI option. This allows compilers that do not parse CLI options to still be able to print statistics to custom stream.