2019-03-16 06:15:23 +08:00
|
|
|
//===- unittests/IR/TimePassesTest.cpp - TimePassesHandler tests ----------===//
|
|
|
|
//
|
|
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#include <gtest/gtest.h>
|
|
|
|
#include <llvm/ADT/SmallString.h>
|
2019-03-23 07:11:08 +08:00
|
|
|
#include "llvm/IR/LegacyPassManager.h"
|
2019-03-16 06:15:23 +08:00
|
|
|
#include <llvm/IR/LLVMContext.h>
|
|
|
|
#include <llvm/IR/Module.h>
|
|
|
|
#include <llvm/IR/PassInstrumentation.h>
|
|
|
|
#include <llvm/IR/PassManager.h>
|
|
|
|
#include <llvm/IR/PassTimingInfo.h>
|
|
|
|
#include <llvm/Support/raw_ostream.h>
|
|
|
|
|
|
|
|
using namespace llvm;
|
|
|
|
|
2019-03-23 07:11:08 +08:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// Define dummy passes for legacy pass manager run.
|
|
|
|
|
|
|
|
namespace llvm {
|
|
|
|
|
|
|
|
void initializePass1Pass(PassRegistry &);
|
|
|
|
void initializePass2Pass(PassRegistry &);
|
|
|
|
|
|
|
|
namespace {
|
|
|
|
struct Pass1 : public ModulePass {
|
|
|
|
static char ID;
|
|
|
|
|
|
|
|
public:
|
|
|
|
Pass1() : ModulePass(ID) {}
|
|
|
|
bool runOnModule(Module &M) override { return false; }
|
|
|
|
void getAnalysisUsage(AnalysisUsage &AU) const override {
|
|
|
|
AU.setPreservesAll();
|
|
|
|
}
|
|
|
|
StringRef getPassName() const override { return "Pass1"; }
|
|
|
|
};
|
|
|
|
char Pass1::ID;
|
|
|
|
|
|
|
|
struct Pass2 : public ModulePass {
|
|
|
|
static char ID;
|
|
|
|
|
|
|
|
public:
|
|
|
|
Pass2() : ModulePass(ID) {}
|
|
|
|
bool runOnModule(Module &M) override { return false; }
|
|
|
|
void getAnalysisUsage(AnalysisUsage &AU) const override {
|
|
|
|
AU.setPreservesAll();
|
|
|
|
}
|
|
|
|
StringRef getPassName() const override { return "Pass2"; }
|
|
|
|
};
|
|
|
|
char Pass2::ID;
|
|
|
|
} // namespace
|
|
|
|
} // namespace llvm
|
|
|
|
|
|
|
|
INITIALIZE_PASS(Pass1, "Pass1", "Pass1", false, false)
|
|
|
|
INITIALIZE_PASS(Pass2, "Pass2", "Pass2", false, false)
|
|
|
|
|
2019-03-16 06:15:23 +08:00
|
|
|
namespace {
|
|
|
|
|
2019-03-23 07:11:08 +08:00
|
|
|
TEST(TimePassesTest, LegacyCustomOut) {
|
|
|
|
PassInstrumentationCallbacks PIC;
|
|
|
|
PassInstrumentation PI(&PIC);
|
|
|
|
|
|
|
|
LLVMContext Context;
|
|
|
|
Module M("TestModule", Context);
|
|
|
|
|
|
|
|
SmallString<0> TimePassesStr;
|
|
|
|
raw_svector_ostream ReportStream(TimePassesStr);
|
|
|
|
|
|
|
|
// Setup pass manager
|
|
|
|
legacy::PassManager PM1;
|
|
|
|
PM1.add(new llvm::Pass1());
|
|
|
|
PM1.add(new llvm::Pass2());
|
|
|
|
|
|
|
|
// Enable time-passes and run passes.
|
|
|
|
TimePassesIsEnabled = true;
|
|
|
|
PM1.run(M);
|
|
|
|
|
|
|
|
// Generating report.
|
|
|
|
reportAndResetTimings(&ReportStream);
|
|
|
|
|
|
|
|
// There should be Pass1 and Pass2 in the report
|
|
|
|
EXPECT_FALSE(TimePassesStr.empty());
|
|
|
|
EXPECT_TRUE(TimePassesStr.str().contains("report"));
|
|
|
|
EXPECT_TRUE(TimePassesStr.str().contains("Pass1"));
|
|
|
|
EXPECT_TRUE(TimePassesStr.str().contains("Pass2"));
|
|
|
|
|
|
|
|
// Clear and generate report again.
|
|
|
|
TimePassesStr.clear();
|
|
|
|
reportAndResetTimings(&ReportStream);
|
|
|
|
|
|
|
|
// Since we did not run any passes since last print, report should be empty.
|
|
|
|
EXPECT_TRUE(TimePassesStr.empty());
|
|
|
|
|
|
|
|
// Now run just a single pass to populate timers again.
|
|
|
|
legacy::PassManager PM2;
|
|
|
|
PM2.add(new llvm::Pass2());
|
|
|
|
PM2.run(M);
|
|
|
|
|
|
|
|
// Generate report again.
|
|
|
|
reportAndResetTimings(&ReportStream);
|
|
|
|
|
|
|
|
// There should be Pass2 in this report and no Pass1.
|
|
|
|
EXPECT_FALSE(TimePassesStr.str().empty());
|
|
|
|
EXPECT_TRUE(TimePassesStr.str().contains("report"));
|
|
|
|
EXPECT_FALSE(TimePassesStr.str().contains("Pass1"));
|
|
|
|
EXPECT_TRUE(TimePassesStr.str().contains("Pass2"));
|
|
|
|
}
|
|
|
|
|
2019-03-16 06:15:23 +08:00
|
|
|
class MyPass1 : public PassInfoMixin<MyPass1> {};
|
|
|
|
class MyPass2 : public PassInfoMixin<MyPass2> {};
|
|
|
|
|
|
|
|
TEST(TimePassesTest, CustomOut) {
|
|
|
|
PassInstrumentationCallbacks PIC;
|
|
|
|
PassInstrumentation PI(&PIC);
|
|
|
|
|
|
|
|
LLVMContext Context;
|
|
|
|
Module M("TestModule", Context);
|
|
|
|
MyPass1 Pass1;
|
|
|
|
MyPass2 Pass2;
|
|
|
|
|
|
|
|
SmallString<0> TimePassesStr;
|
|
|
|
raw_svector_ostream ReportStream(TimePassesStr);
|
|
|
|
|
|
|
|
// Setup time-passes handler and redirect output to the stream.
|
|
|
|
std::unique_ptr<TimePassesHandler> TimePasses =
|
2019-08-15 23:54:37 +08:00
|
|
|
std::make_unique<TimePassesHandler>(true);
|
2019-03-16 06:15:23 +08:00
|
|
|
TimePasses->setOutStream(ReportStream);
|
|
|
|
TimePasses->registerCallbacks(PIC);
|
|
|
|
|
2019-03-23 07:11:08 +08:00
|
|
|
// Pretending that passes are running to trigger the timers.
|
2019-03-16 06:15:23 +08:00
|
|
|
PI.runBeforePass(Pass1, M);
|
|
|
|
PI.runBeforePass(Pass2, M);
|
2020-08-21 16:52:26 +08:00
|
|
|
PI.runAfterPass(Pass2, M, PreservedAnalyses::all());
|
|
|
|
PI.runAfterPass(Pass1, M, PreservedAnalyses::all());
|
2019-03-16 06:15:23 +08:00
|
|
|
|
|
|
|
// Generating report.
|
|
|
|
TimePasses->print();
|
|
|
|
|
|
|
|
// There should be Pass1 and Pass2 in the report
|
|
|
|
EXPECT_FALSE(TimePassesStr.empty());
|
|
|
|
EXPECT_TRUE(TimePassesStr.str().contains("report"));
|
|
|
|
EXPECT_TRUE(TimePassesStr.str().contains("Pass1"));
|
|
|
|
EXPECT_TRUE(TimePassesStr.str().contains("Pass2"));
|
|
|
|
|
|
|
|
// Clear and generate report again.
|
|
|
|
TimePassesStr.clear();
|
|
|
|
TimePasses->print();
|
|
|
|
// Since we did not run any passes since last print, report should be empty.
|
|
|
|
EXPECT_TRUE(TimePassesStr.empty());
|
|
|
|
|
2019-03-23 07:11:08 +08:00
|
|
|
// Now trigger just a single pass to populate timers again.
|
2019-03-16 06:15:23 +08:00
|
|
|
PI.runBeforePass(Pass2, M);
|
2020-08-21 16:52:26 +08:00
|
|
|
PI.runAfterPass(Pass2, M, PreservedAnalyses::all());
|
2019-03-16 06:15:23 +08:00
|
|
|
|
|
|
|
// Generate report by deleting the handler.
|
|
|
|
TimePasses.reset();
|
|
|
|
|
|
|
|
// There should be Pass2 in this report and no Pass1.
|
|
|
|
EXPECT_FALSE(TimePassesStr.str().empty());
|
|
|
|
EXPECT_TRUE(TimePassesStr.str().contains("report"));
|
|
|
|
EXPECT_FALSE(TimePassesStr.str().contains("Pass1"));
|
|
|
|
EXPECT_TRUE(TimePassesStr.str().contains("Pass2"));
|
|
|
|
}
|
|
|
|
|
|
|
|
} // end anonymous namespace
|