unittests/IR/PassManagerTest.cpp

   1 //===- llvm/unittest/IR/PassManager.cpp - PassManager tests ---------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  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"
  17
  18 using namespace llvm;
  19
  20 namespace {
  21
  22 class TestFunctionAnalysis {
  23 public:
  24   struct Result {
  25     Result(int Count) : InstructionCount(Count) {}
  26     int InstructionCount;
  27   };
  28
  29   /// \brief Returns an opaque, unique ID for this pass type.
  30   static void *ID() { return (void *)&PassID; }
  31
  32   TestFunctionAnalysis(int &Runs) : Runs(Runs) {}
  33
  34   /// \brief Run the analysis pass over the function and return a result.
  35   Result run(Function *F, FunctionAnalysisManager *AM) {
  36     ++Runs;
  37     int Count = 0;
  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;
  40            ++II)
  41         ++Count;
  42     return Result(Count);
  43   }
  44
  45 private:
  46   /// \brief Private static data to provide unique ID.
  47   static char PassID;
  48
  49   int &Runs;
  50 };
  51
  52 char TestFunctionAnalysis::PassID;
  53
  54 class TestModuleAnalysis {
  55 public:
  56   struct Result {
  57     Result(int Count) : FunctionCount(Count) {}
  58     int FunctionCount;
  59   };
  60
  61   static void *ID() { return (void *)&PassID; }
  62
  63   TestModuleAnalysis(int &Runs) : Runs(Runs) {}
  64
  65   Result run(Module *M, ModuleAnalysisManager *AM) {
  66     ++Runs;
  67     int Count = 0;
  68     for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
  69       ++Count;
  70     return Result(Count);
  71   }
  72
  73 private:
  74   static char PassID;
  75
  76   int &Runs;
  77 };
  78
  79 char TestModuleAnalysis::PassID;
  80
  81 struct TestModulePass {
  82   TestModulePass(int &RunCount) : RunCount(RunCount) {}
  83
  84   PreservedAnalyses run(Module *M) {
  85     ++RunCount;
  86     return PreservedAnalyses::none();
  87   }
  88
  89   static StringRef name() { return "TestModulePass"; }
  90
  91   int &RunCount;
  92 };
  93
  94 struct TestPreservingModulePass {
  95   PreservedAnalyses run(Module *M) { return PreservedAnalyses::all(); }
  96
  97   static StringRef name() { return "TestPreservingModulePass"; }
  98 };
  99
 100 struct TestMinPreservingModulePass {
 101   PreservedAnalyses run(Module *M, ModuleAnalysisManager *AM) {
 102     PreservedAnalyses PA;
 103
 104     // Force running an analysis.
 105     (void)AM->getResult<TestModuleAnalysis>(M);
 106
 107     PA.preserve<FunctionAnalysisManagerModuleProxy>();
 108     return PA;
 109   }
 110
 111   static StringRef name() { return "TestMinPreservingModulePass"; }
 112 };
 113
 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) {}
 121
 122   PreservedAnalyses run(Function *F, FunctionAnalysisManager *AM) {
 123     ++RunCount;
 124
 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;
 130
 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;
 136     } else {
 137       // Typical path just runs the analysis as needed.
 138       TestFunctionAnalysis::Result &AR = AM->getResult<TestFunctionAnalysis>(F);
 139       AnalyzedInstrCount += AR.InstructionCount;
 140     }
 141
 142     return PreservedAnalyses::all();
 143   }
 144
 145   static StringRef name() { return "TestFunctionPass"; }
 146
 147   int &RunCount;
 148   int &AnalyzedInstrCount;
 149   int &AnalyzedFunctionCount;
 150   bool OnlyUseCachedResults;
 151 };
 152
 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) {}
 157
 158   PreservedAnalyses run(Function *F) {
 159     return F->getName() == Name ? PreservedAnalyses::none()
 160                                 : PreservedAnalyses::all();
 161   }
 162
 163   static StringRef name() { return "TestInvalidationFunctionPass"; }
 164
 165   StringRef Name;
 166 };
 167
 168 Module *parseIR(const char *IR) {
 169   LLVMContext &C = getGlobalContext();
 170   SMDiagnostic Err;
 171   return ParseAssemblyString(IR, 0, Err, C);
 172 }
 173
 174 class PassManagerTest : public ::testing::Test {
 175 protected:
 176   std::unique_ptr<Module> M;
 177
 178 public:
 179   PassManagerTest()
 180       : M(parseIR("define void @f() {\n"
 181                   "entry:\n"
 182                   "  call void @g()\n"
 183                   "  call void @h()\n"
 184                   "  ret void\n"
 185                   "}\n"
 186                   "define void @g() {\n"
 187                   "  ret void\n"
 188                   "}\n"
 189                   "define void @h() {\n"
 190                   "  ret void\n"
 191                   "}\n")) {}
 192 };
 193
 194 TEST_F(PassManagerTest, Basic) {
 195   FunctionAnalysisManager FAM;
 196   int FunctionAnalysisRuns = 0;
 197   FAM.registerPass(TestFunctionAnalysis(FunctionAnalysisRuns));
 198
 199   ModuleAnalysisManager MAM;
 200   int ModuleAnalysisRuns = 0;
 201   MAM.registerPass(TestModuleAnalysis(ModuleAnalysisRuns));
 202   MAM.registerPass(FunctionAnalysisManagerModuleProxy(FAM));
 203   FAM.registerPass(ModuleAnalysisManagerFunctionProxy(MAM));
 204
 205   ModulePassManager MPM;
 206
 207   // Count the runs over a Function.
 208   int FunctionPassRunCount1 = 0;
 209   int AnalyzedInstrCount1 = 0;
 210   int AnalyzedFunctionCount1 = 0;
 211   {
 212     FunctionPassManager FPM;
 213     FPM.addPass(TestFunctionPass(FunctionPassRunCount1, AnalyzedInstrCount1,
 214                                  AnalyzedFunctionCount1));
 215     MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
 216   }
 217
 218   // Count the runs over a module.
 219   int ModulePassRunCount = 0;
 220   MPM.addPass(TestModulePass(ModulePassRunCount));
 221
 222   // Count the runs over a Function in a separate manager.
 223   int FunctionPassRunCount2 = 0;
 224   int AnalyzedInstrCount2 = 0;
 225   int AnalyzedFunctionCount2 = 0;
 226   {
 227     FunctionPassManager FPM;
 228     FPM.addPass(TestFunctionPass(FunctionPassRunCount2, AnalyzedInstrCount2,
 229                                  AnalyzedFunctionCount2));
 230     MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
 231   }
 232
 233   // A third function pass manager but with only preserving intervening passes
 234   // and with a function pass that invalidates exactly one analysis.
 235   MPM.addPass(TestPreservingModulePass());
 236   int FunctionPassRunCount3 = 0;
 237   int AnalyzedInstrCount3 = 0;
 238   int AnalyzedFunctionCount3 = 0;
 239   {
 240     FunctionPassManager FPM;
 241     FPM.addPass(TestFunctionPass(FunctionPassRunCount3, AnalyzedInstrCount3,
 242                                  AnalyzedFunctionCount3));
 243     FPM.addPass(TestInvalidationFunctionPass("f"));
 244     MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
 245   }
 246
 247   // A fourth function pass manager but with a minimal intervening passes.
 248   MPM.addPass(TestMinPreservingModulePass());
 249   int FunctionPassRunCount4 = 0;
 250   int AnalyzedInstrCount4 = 0;
 251   int AnalyzedFunctionCount4 = 0;
 252   {
 253     FunctionPassManager FPM;
 254     FPM.addPass(TestFunctionPass(FunctionPassRunCount4, AnalyzedInstrCount4,
 255                                  AnalyzedFunctionCount4));
 256     MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
 257   }
 258
 259   // A fifth function pass manager but which uses only cached results.
 260   int FunctionPassRunCount5 = 0;
 261   int AnalyzedInstrCount5 = 0;
 262   int AnalyzedFunctionCount5 = 0;
 263   {
 264     FunctionPassManager FPM;
 265     FPM.addPass(TestInvalidationFunctionPass("f"));
 266     FPM.addPass(TestFunctionPass(FunctionPassRunCount5, AnalyzedInstrCount5,
 267                                  AnalyzedFunctionCount5,
 268                                  /*OnlyUseCachedResults=*/true));
 269     MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
 270   }
 271
 272   MPM.run(M.get(), &MAM);
 273
 274   // Validate module pass counters.
 275   EXPECT_EQ(1, ModulePassRunCount);
 276
 277   // Validate all function pass counter sets are the same.
 278   EXPECT_EQ(3, FunctionPassRunCount1);
 279   EXPECT_EQ(5, AnalyzedInstrCount1);
 280   EXPECT_EQ(0, AnalyzedFunctionCount1);
 281   EXPECT_EQ(3, FunctionPassRunCount2);
 282   EXPECT_EQ(5, AnalyzedInstrCount2);
 283   EXPECT_EQ(0, AnalyzedFunctionCount2);
 284   EXPECT_EQ(3, FunctionPassRunCount3);
 285   EXPECT_EQ(5, AnalyzedInstrCount3);
 286   EXPECT_EQ(0, AnalyzedFunctionCount3);
 287   EXPECT_EQ(3, FunctionPassRunCount4);
 288   EXPECT_EQ(5, AnalyzedInstrCount4);
 289   EXPECT_EQ(0, AnalyzedFunctionCount4);
 290   EXPECT_EQ(3, FunctionPassRunCount5);
 291   EXPECT_EQ(2, AnalyzedInstrCount5); // Only 'g' and 'h' were cached.
 292   EXPECT_EQ(0, AnalyzedFunctionCount5);
 293
 294   // Validate the analysis counters:
 295   //   first run over 3 functions, then module pass invalidates
 296   //   second run over 3 functions, nothing invalidates
 297   //   third run over 0 functions, but 1 function invalidated
 298   //   fourth run over 1 function
 299   EXPECT_EQ(7, FunctionAnalysisRuns);
 300
 301   EXPECT_EQ(1, ModuleAnalysisRuns);
 302 }
 303 }