1 //===- llvm/unittest/IR/PassManager.cpp - PassManager tests ---------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Assembly/Parser.h"
11 #include "llvm/IR/Function.h"
12 #include "llvm/IR/LLVMContext.h"
13 #include "llvm/IR/Module.h"
14 #include "llvm/IR/PassManager.h"
15 #include "llvm/Support/SourceMgr.h"
16 #include "gtest/gtest.h"
22 class TestFunctionAnalysis {
25 Result(int Count) : InstructionCount(Count) {}
29 /// \brief Returns an opaque, unique ID for this pass type.
30 static void *ID() { return (void *)&PassID; }
32 TestFunctionAnalysis(int &Runs) : Runs(Runs) {}
34 /// \brief Run the analysis pass over the function and return a result.
35 Result run(Function *F, FunctionAnalysisManager *AM) {
38 for (Function::iterator BBI = F->begin(), BBE = F->end(); BBI != BBE; ++BBI)
39 for (BasicBlock::iterator II = BBI->begin(), IE = BBI->end(); II != IE;
46 /// \brief Private static data to provide unique ID.
52 char TestFunctionAnalysis::PassID;
54 class TestModuleAnalysis {
57 Result(int Count) : FunctionCount(Count) {}
61 static void *ID() { return (void * )&PassID; }
63 TestModuleAnalysis(int &Runs) : Runs(Runs) {}
65 Result run(Module *M, ModuleAnalysisManager *AM) {
68 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
79 char TestModuleAnalysis::PassID;
81 struct TestModulePass {
82 TestModulePass(int &RunCount) : RunCount(RunCount) {}
84 PreservedAnalyses run(Module *M) {
86 return PreservedAnalyses::none();
92 struct TestPreservingModulePass {
93 PreservedAnalyses run(Module *M) {
94 return PreservedAnalyses::all();
98 struct TestMinPreservingModulePass {
99 PreservedAnalyses run(Module *M, ModuleAnalysisManager *AM) {
100 PreservedAnalyses PA;
102 // Force running an analysis.
103 (void)AM->getResult<TestModuleAnalysis>(M);
105 PA.preserve<FunctionAnalysisManagerModuleProxy>();
110 struct TestFunctionPass {
111 TestFunctionPass(int &RunCount, int &AnalyzedInstrCount,
112 int &AnalyzedFunctionCount,
113 bool OnlyUseCachedResults = false)
114 : RunCount(RunCount), AnalyzedInstrCount(AnalyzedInstrCount),
115 AnalyzedFunctionCount(AnalyzedFunctionCount),
116 OnlyUseCachedResults(OnlyUseCachedResults) {}
118 PreservedAnalyses run(Function *F, FunctionAnalysisManager *AM) {
121 const ModuleAnalysisManager &MAM =
122 AM->getResult<ModuleAnalysisManagerFunctionProxy>(F).getManager();
123 if (const TestModuleAnalysis::Result *TMA =
124 MAM.getCachedResult<TestModuleAnalysis>(F->getParent()))
125 AnalyzedFunctionCount += TMA->FunctionCount;
127 if (OnlyUseCachedResults) {
128 // Hack to force the use of the cached interface.
129 if (const TestFunctionAnalysis::Result *AR =
130 AM->getCachedResult<TestFunctionAnalysis>(F))
131 AnalyzedInstrCount += AR->InstructionCount;
133 // Typical path just runs the analysis as needed.
134 const TestFunctionAnalysis::Result &AR = AM->getResult<TestFunctionAnalysis>(F);
135 AnalyzedInstrCount += AR.InstructionCount;
138 return PreservedAnalyses::all();
142 int &AnalyzedInstrCount;
143 int &AnalyzedFunctionCount;
144 bool OnlyUseCachedResults;
147 // A test function pass that invalidates all function analyses for a function
148 // with a specific name.
149 struct TestInvalidationFunctionPass {
150 TestInvalidationFunctionPass(StringRef FunctionName) : Name(FunctionName) {}
152 PreservedAnalyses run(Function *F) {
153 return F->getName() == Name ? PreservedAnalyses::none()
154 : PreservedAnalyses::all();
160 Module *parseIR(const char *IR) {
161 LLVMContext &C = getGlobalContext();
163 return ParseAssemblyString(IR, 0, Err, C);
166 class PassManagerTest : public ::testing::Test {
172 : M(parseIR("define void @f() {\n"
178 "define void @g() {\n"
181 "define void @h() {\n"
186 TEST_F(PassManagerTest, Basic) {
187 FunctionAnalysisManager FAM;
188 int FunctionAnalysisRuns = 0;
189 FAM.registerPass(TestFunctionAnalysis(FunctionAnalysisRuns));
191 ModuleAnalysisManager MAM;
192 int ModuleAnalysisRuns = 0;
193 MAM.registerPass(TestModuleAnalysis(ModuleAnalysisRuns));
194 MAM.registerPass(FunctionAnalysisManagerModuleProxy(FAM));
195 FAM.registerPass(ModuleAnalysisManagerFunctionProxy(MAM));
197 ModulePassManager MPM;
199 // Count the runs over a Function.
200 FunctionPassManager FPM1;
201 int FunctionPassRunCount1 = 0;
202 int AnalyzedInstrCount1 = 0;
203 int AnalyzedFunctionCount1 = 0;
204 FPM1.addPass(TestFunctionPass(FunctionPassRunCount1, AnalyzedInstrCount1,
205 AnalyzedFunctionCount1));
206 MPM.addPass(createModuleToFunctionPassAdaptor(FPM1));
208 // Count the runs over a module.
209 int ModulePassRunCount = 0;
210 MPM.addPass(TestModulePass(ModulePassRunCount));
212 // Count the runs over a Function in a separate manager.
213 FunctionPassManager FPM2;
214 int FunctionPassRunCount2 = 0;
215 int AnalyzedInstrCount2 = 0;
216 int AnalyzedFunctionCount2 = 0;
217 FPM2.addPass(TestFunctionPass(FunctionPassRunCount2, AnalyzedInstrCount2,
218 AnalyzedFunctionCount2));
219 MPM.addPass(createModuleToFunctionPassAdaptor(FPM2));
221 // A third function pass manager but with only preserving intervening passes
222 // and with a function pass that invalidates exactly one analysis.
223 MPM.addPass(TestPreservingModulePass());
224 FunctionPassManager FPM3;
225 int FunctionPassRunCount3 = 0;
226 int AnalyzedInstrCount3 = 0;
227 int AnalyzedFunctionCount3 = 0;
228 FPM3.addPass(TestFunctionPass(FunctionPassRunCount3, AnalyzedInstrCount3,
229 AnalyzedFunctionCount3));
230 FPM3.addPass(TestInvalidationFunctionPass("f"));
231 MPM.addPass(createModuleToFunctionPassAdaptor(FPM3));
233 // A fourth function pass manager but with a minimal intervening passes.
234 MPM.addPass(TestMinPreservingModulePass());
235 FunctionPassManager FPM4;
236 int FunctionPassRunCount4 = 0;
237 int AnalyzedInstrCount4 = 0;
238 int AnalyzedFunctionCount4 = 0;
239 FPM4.addPass(TestFunctionPass(FunctionPassRunCount4, AnalyzedInstrCount4,
240 AnalyzedFunctionCount4));
241 MPM.addPass(createModuleToFunctionPassAdaptor(FPM4));
243 // A fifth function pass manager but which uses only cached results.
244 FunctionPassManager FPM5;
245 int FunctionPassRunCount5 = 0;
246 int AnalyzedInstrCount5 = 0;
247 int AnalyzedFunctionCount5 = 0;
248 FPM5.addPass(TestInvalidationFunctionPass("f"));
249 FPM5.addPass(TestFunctionPass(FunctionPassRunCount5, AnalyzedInstrCount5,
250 AnalyzedFunctionCount5,
251 /*OnlyUseCachedResults=*/true));
252 MPM.addPass(createModuleToFunctionPassAdaptor(FPM5));
254 MPM.run(M.get(), &MAM);
256 // Validate module pass counters.
257 EXPECT_EQ(1, ModulePassRunCount);
259 // Validate all function pass counter sets are the same.
260 EXPECT_EQ(3, FunctionPassRunCount1);
261 EXPECT_EQ(5, AnalyzedInstrCount1);
262 EXPECT_EQ(0, AnalyzedFunctionCount1);
263 EXPECT_EQ(3, FunctionPassRunCount2);
264 EXPECT_EQ(5, AnalyzedInstrCount2);
265 EXPECT_EQ(0, AnalyzedFunctionCount2);
266 EXPECT_EQ(3, FunctionPassRunCount3);
267 EXPECT_EQ(5, AnalyzedInstrCount3);
268 EXPECT_EQ(0, AnalyzedFunctionCount3);
269 EXPECT_EQ(3, FunctionPassRunCount4);
270 EXPECT_EQ(5, AnalyzedInstrCount4);
271 EXPECT_EQ(0, AnalyzedFunctionCount4);
272 EXPECT_EQ(3, FunctionPassRunCount5);
273 EXPECT_EQ(2, AnalyzedInstrCount5); // Only 'g' and 'h' were cached.
274 EXPECT_EQ(0, AnalyzedFunctionCount5);
276 // Validate the analysis counters:
277 // first run over 3 functions, then module pass invalidates
278 // second run over 3 functions, nothing invalidates
279 // third run over 0 functions, but 1 function invalidated
280 // fourth run over 1 function
281 EXPECT_EQ(7, FunctionAnalysisRuns);
283 EXPECT_EQ(1, ModuleAnalysisRuns);