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/AsmParser/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();
89 static StringRef name() { return "TestModulePass"; }
94 struct TestPreservingModulePass {
95 PreservedAnalyses run(Module &M) { return PreservedAnalyses::all(); }
97 static StringRef name() { return "TestPreservingModulePass"; }
100 struct TestMinPreservingModulePass {
101 PreservedAnalyses run(Module &M, ModuleAnalysisManager *AM) {
102 PreservedAnalyses PA;
104 // Force running an analysis.
105 (void)AM->getResult<TestModuleAnalysis>(M);
107 PA.preserve<FunctionAnalysisManagerModuleProxy>();
111 static StringRef name() { return "TestMinPreservingModulePass"; }
114 struct TestFunctionPass {
115 TestFunctionPass(int &RunCount, int &AnalyzedInstrCount,
116 int &AnalyzedFunctionCount,
117 bool OnlyUseCachedResults = false)
118 : RunCount(RunCount), AnalyzedInstrCount(AnalyzedInstrCount),
119 AnalyzedFunctionCount(AnalyzedFunctionCount),
120 OnlyUseCachedResults(OnlyUseCachedResults) {}
122 PreservedAnalyses run(Function &F, FunctionAnalysisManager *AM) {
125 const ModuleAnalysisManager &MAM =
126 AM->getResult<ModuleAnalysisManagerFunctionProxy>(F).getManager();
127 if (TestModuleAnalysis::Result *TMA =
128 MAM.getCachedResult<TestModuleAnalysis>(*F.getParent()))
129 AnalyzedFunctionCount += TMA->FunctionCount;
131 if (OnlyUseCachedResults) {
132 // Hack to force the use of the cached interface.
133 if (TestFunctionAnalysis::Result *AR =
134 AM->getCachedResult<TestFunctionAnalysis>(F))
135 AnalyzedInstrCount += AR->InstructionCount;
137 // Typical path just runs the analysis as needed.
138 TestFunctionAnalysis::Result &AR = AM->getResult<TestFunctionAnalysis>(F);
139 AnalyzedInstrCount += AR.InstructionCount;
142 return PreservedAnalyses::all();
145 static StringRef name() { return "TestFunctionPass"; }
148 int &AnalyzedInstrCount;
149 int &AnalyzedFunctionCount;
150 bool OnlyUseCachedResults;
153 // A test function pass that invalidates all function analyses for a function
154 // with a specific name.
155 struct TestInvalidationFunctionPass {
156 TestInvalidationFunctionPass(StringRef FunctionName) : Name(FunctionName) {}
158 PreservedAnalyses run(Function &F) {
159 return F.getName() == Name ? PreservedAnalyses::none()
160 : PreservedAnalyses::all();
163 static StringRef name() { return "TestInvalidationFunctionPass"; }
168 std::unique_ptr<Module> parseIR(const char *IR) {
169 LLVMContext &C = getGlobalContext();
171 return parseAssemblyString(IR, Err, C);
174 class PassManagerTest : public ::testing::Test {
176 std::unique_ptr<Module> M;
180 : M(parseIR("define void @f() {\n"
186 "define void @g() {\n"
189 "define void @h() {\n"
194 TEST_F(PassManagerTest, BasicPreservedAnalyses) {
195 PreservedAnalyses PA1 = PreservedAnalyses();
196 EXPECT_FALSE(PA1.preserved<TestFunctionAnalysis>());
197 EXPECT_FALSE(PA1.preserved<TestModuleAnalysis>());
198 PreservedAnalyses PA2 = PreservedAnalyses::none();
199 EXPECT_FALSE(PA2.preserved<TestFunctionAnalysis>());
200 EXPECT_FALSE(PA2.preserved<TestModuleAnalysis>());
201 PreservedAnalyses PA3 = PreservedAnalyses::all();
202 EXPECT_TRUE(PA3.preserved<TestFunctionAnalysis>());
203 EXPECT_TRUE(PA3.preserved<TestModuleAnalysis>());
204 PreservedAnalyses PA4 = PA1;
205 EXPECT_FALSE(PA4.preserved<TestFunctionAnalysis>());
206 EXPECT_FALSE(PA4.preserved<TestModuleAnalysis>());
208 EXPECT_TRUE(PA4.preserved<TestFunctionAnalysis>());
209 EXPECT_TRUE(PA4.preserved<TestModuleAnalysis>());
210 PA4 = std::move(PA2);
211 EXPECT_FALSE(PA4.preserved<TestFunctionAnalysis>());
212 EXPECT_FALSE(PA4.preserved<TestModuleAnalysis>());
213 PA4.preserve<TestFunctionAnalysis>();
214 EXPECT_TRUE(PA4.preserved<TestFunctionAnalysis>());
215 EXPECT_FALSE(PA4.preserved<TestModuleAnalysis>());
216 PA1.preserve<TestModuleAnalysis>();
217 EXPECT_FALSE(PA1.preserved<TestFunctionAnalysis>());
218 EXPECT_TRUE(PA1.preserved<TestModuleAnalysis>());
219 PA1.preserve<TestFunctionAnalysis>();
220 EXPECT_TRUE(PA1.preserved<TestFunctionAnalysis>());
221 EXPECT_TRUE(PA1.preserved<TestModuleAnalysis>());
223 EXPECT_TRUE(PA1.preserved<TestFunctionAnalysis>());
224 EXPECT_FALSE(PA1.preserved<TestModuleAnalysis>());
227 TEST_F(PassManagerTest, Basic) {
228 FunctionAnalysisManager FAM;
229 int FunctionAnalysisRuns = 0;
230 FAM.registerPass(TestFunctionAnalysis(FunctionAnalysisRuns));
232 ModuleAnalysisManager MAM;
233 int ModuleAnalysisRuns = 0;
234 MAM.registerPass(TestModuleAnalysis(ModuleAnalysisRuns));
235 MAM.registerPass(FunctionAnalysisManagerModuleProxy(FAM));
236 FAM.registerPass(ModuleAnalysisManagerFunctionProxy(MAM));
238 ModulePassManager MPM;
240 // Count the runs over a Function.
241 int FunctionPassRunCount1 = 0;
242 int AnalyzedInstrCount1 = 0;
243 int AnalyzedFunctionCount1 = 0;
245 // Pointless scoped copy to test move assignment.
246 ModulePassManager NestedMPM;
247 FunctionPassManager FPM;
249 // Pointless scope to test move assignment.
250 FunctionPassManager NestedFPM;
251 NestedFPM.addPass(TestFunctionPass(FunctionPassRunCount1, AnalyzedInstrCount1,
252 AnalyzedFunctionCount1));
253 FPM = std::move(NestedFPM);
255 NestedMPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
256 MPM = std::move(NestedMPM);
259 // Count the runs over a module.
260 int ModulePassRunCount = 0;
261 MPM.addPass(TestModulePass(ModulePassRunCount));
263 // Count the runs over a Function in a separate manager.
264 int FunctionPassRunCount2 = 0;
265 int AnalyzedInstrCount2 = 0;
266 int AnalyzedFunctionCount2 = 0;
268 FunctionPassManager FPM;
269 FPM.addPass(TestFunctionPass(FunctionPassRunCount2, AnalyzedInstrCount2,
270 AnalyzedFunctionCount2));
271 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
274 // A third function pass manager but with only preserving intervening passes
275 // and with a function pass that invalidates exactly one analysis.
276 MPM.addPass(TestPreservingModulePass());
277 int FunctionPassRunCount3 = 0;
278 int AnalyzedInstrCount3 = 0;
279 int AnalyzedFunctionCount3 = 0;
281 FunctionPassManager FPM;
282 FPM.addPass(TestFunctionPass(FunctionPassRunCount3, AnalyzedInstrCount3,
283 AnalyzedFunctionCount3));
284 FPM.addPass(TestInvalidationFunctionPass("f"));
285 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
288 // A fourth function pass manager but with a minimal intervening passes.
289 MPM.addPass(TestMinPreservingModulePass());
290 int FunctionPassRunCount4 = 0;
291 int AnalyzedInstrCount4 = 0;
292 int AnalyzedFunctionCount4 = 0;
294 FunctionPassManager FPM;
295 FPM.addPass(TestFunctionPass(FunctionPassRunCount4, AnalyzedInstrCount4,
296 AnalyzedFunctionCount4));
297 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
300 // A fifth function pass manager but which uses only cached results.
301 int FunctionPassRunCount5 = 0;
302 int AnalyzedInstrCount5 = 0;
303 int AnalyzedFunctionCount5 = 0;
305 FunctionPassManager FPM;
306 FPM.addPass(TestInvalidationFunctionPass("f"));
307 FPM.addPass(TestFunctionPass(FunctionPassRunCount5, AnalyzedInstrCount5,
308 AnalyzedFunctionCount5,
309 /*OnlyUseCachedResults=*/true));
310 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
315 // Validate module pass counters.
316 EXPECT_EQ(1, ModulePassRunCount);
318 // Validate all function pass counter sets are the same.
319 EXPECT_EQ(3, FunctionPassRunCount1);
320 EXPECT_EQ(5, AnalyzedInstrCount1);
321 EXPECT_EQ(0, AnalyzedFunctionCount1);
322 EXPECT_EQ(3, FunctionPassRunCount2);
323 EXPECT_EQ(5, AnalyzedInstrCount2);
324 EXPECT_EQ(0, AnalyzedFunctionCount2);
325 EXPECT_EQ(3, FunctionPassRunCount3);
326 EXPECT_EQ(5, AnalyzedInstrCount3);
327 EXPECT_EQ(0, AnalyzedFunctionCount3);
328 EXPECT_EQ(3, FunctionPassRunCount4);
329 EXPECT_EQ(5, AnalyzedInstrCount4);
330 EXPECT_EQ(0, AnalyzedFunctionCount4);
331 EXPECT_EQ(3, FunctionPassRunCount5);
332 EXPECT_EQ(2, AnalyzedInstrCount5); // Only 'g' and 'h' were cached.
333 EXPECT_EQ(0, AnalyzedFunctionCount5);
335 // Validate the analysis counters:
336 // first run over 3 functions, then module pass invalidates
337 // second run over 3 functions, nothing invalidates
338 // third run over 0 functions, but 1 function invalidated
339 // fourth run over 1 function
340 EXPECT_EQ(7, FunctionAnalysisRuns);
342 EXPECT_EQ(1, ModuleAnalysisRuns);