unittests/VMCore/PassManagerTest.cpp

   1 //===- llvm/unittest/VMCore/PassManager.cpp - Constants unit 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/PassManager.h"
  11 #include "llvm/ADT/SmallVector.h"
  12 #include "llvm/Analysis/LoopInfo.h"
  13 #include "llvm/Analysis/LoopPass.h"
  14 #include "llvm/Analysis/Verifier.h"
  15 #include "llvm/Assembly/PrintModulePass.h"
  16 #include "llvm/BasicBlock.h"
  17 #include "llvm/CallGraphSCCPass.h"
  18 #include "llvm/CallingConv.h"
  19 #include "llvm/Constants.h"
  20 #include "llvm/DataLayout.h"
  21 #include "llvm/DerivedTypes.h"
  22 #include "llvm/Function.h"
  23 #include "llvm/GlobalVariable.h"
  24 #include "llvm/InlineAsm.h"
  25 #include "llvm/Instructions.h"
  26 #include "llvm/LLVMContext.h"
  27 #include "llvm/Module.h"
  28 #include "llvm/Pass.h"
  29 #include "llvm/Support/MathExtras.h"
  30 #include "llvm/Support/raw_ostream.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 #include "gtest/gtest.h"
  33
  34 using namespace llvm;
  35
  36 namespace llvm {
  37   void initializeModuleNDMPass(PassRegistry&);
  38   void initializeFPassPass(PassRegistry&);
  39   void initializeCGPassPass(PassRegistry&);
  40   void initializeLPassPass(PassRegistry&);
  41   void initializeBPassPass(PassRegistry&);
  42
  43   namespace {
  44     // ND = no deps
  45     // NM = no modifications
  46     struct ModuleNDNM: public ModulePass {
  47     public:
  48       static char run;
  49       static char ID;
  50       ModuleNDNM() : ModulePass(ID) { }
  51       virtual bool runOnModule(Module &M) {
  52         run++;
  53         return false;
  54       }
  55       virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  56         AU.setPreservesAll();
  57       }
  58     };
  59     char ModuleNDNM::ID=0;
  60     char ModuleNDNM::run=0;
  61
  62     struct ModuleNDM : public ModulePass {
  63     public:
  64       static char run;
  65       static char ID;
  66       ModuleNDM() : ModulePass(ID) {}
  67       virtual bool runOnModule(Module &M) {
  68         run++;
  69         return true;
  70       }
  71     };
  72     char ModuleNDM::ID=0;
  73     char ModuleNDM::run=0;
  74
  75     struct ModuleNDM2 : public ModulePass {
  76     public:
  77       static char run;
  78       static char ID;
  79       ModuleNDM2() : ModulePass(ID) {}
  80       virtual bool runOnModule(Module &M) {
  81         run++;
  82         return true;
  83       }
  84     };
  85     char ModuleNDM2::ID=0;
  86     char ModuleNDM2::run=0;
  87
  88     struct ModuleDNM : public ModulePass {
  89     public:
  90       static char run;
  91       static char ID;
  92       ModuleDNM() : ModulePass(ID) {
  93         initializeModuleNDMPass(*PassRegistry::getPassRegistry());
  94       }
  95       virtual bool runOnModule(Module &M) {
  96         EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
  97         run++;
  98         return false;
  99       }
 100       virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 101         AU.addRequired<ModuleNDM>();
 102         AU.setPreservesAll();
 103       }
 104     };
 105     char ModuleDNM::ID=0;
 106     char ModuleDNM::run=0;
 107
 108     template<typename P>
 109     struct PassTestBase : public P {
 110     protected:
 111       static int runc;
 112       static bool initialized;
 113       static bool finalized;
 114       int allocated;
 115       void run() {
 116         EXPECT_TRUE(initialized);
 117         EXPECT_FALSE(finalized);
 118         EXPECT_EQ(0, allocated);
 119         allocated++;
 120         runc++;
 121       }
 122     public:
 123       static char ID;
 124       static void finishedOK(int run) {
 125         EXPECT_GT(runc, 0);
 126         EXPECT_TRUE(initialized);
 127         EXPECT_TRUE(finalized);
 128         EXPECT_EQ(run, runc);
 129       }
 130       PassTestBase() : P(ID), allocated(0) {
 131         initialized = false;
 132         finalized = false;
 133         runc = 0;
 134       }
 135
 136       virtual void releaseMemory() {
 137         EXPECT_GT(runc, 0);
 138         EXPECT_GT(allocated, 0);
 139         allocated--;
 140       }
 141     };
 142     template<typename P> char PassTestBase<P>::ID;
 143     template<typename P> int PassTestBase<P>::runc;
 144     template<typename P> bool PassTestBase<P>::initialized;
 145     template<typename P> bool PassTestBase<P>::finalized;
 146
 147     template<typename T, typename P>
 148     struct PassTest : public PassTestBase<P> {
 149     public:
 150 #ifndef _MSC_VER // MSVC complains that Pass is not base class.
 151       using llvm::Pass::doInitialization;
 152       using llvm::Pass::doFinalization;
 153 #endif
 154       virtual bool doInitialization(T &t) {
 155         EXPECT_FALSE(PassTestBase<P>::initialized);
 156         PassTestBase<P>::initialized = true;
 157         return false;
 158       }
 159       virtual bool doFinalization(T &t) {
 160         EXPECT_FALSE(PassTestBase<P>::finalized);
 161         PassTestBase<P>::finalized = true;
 162         EXPECT_EQ(0, PassTestBase<P>::allocated);
 163         return false;
 164       }
 165     };
 166
 167     struct CGPass : public PassTest<CallGraph, CallGraphSCCPass> {
 168     public:
 169       CGPass() {
 170         initializeCGPassPass(*PassRegistry::getPassRegistry());
 171       }
 172       virtual bool runOnSCC(CallGraphSCC &SCMM) {
 173         EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
 174         run();
 175         return false;
 176       }
 177     };
 178
 179     struct FPass : public PassTest<Module, FunctionPass> {
 180     public:
 181       virtual bool runOnFunction(Function &F) {
 182         // FIXME: PR4112
 183         // EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
 184         run();
 185         return false;
 186       }
 187     };
 188
 189     struct LPass : public PassTestBase<LoopPass> {
 190     private:
 191       static int initcount;
 192       static int fincount;
 193     public:
 194       LPass() {
 195         initializeLPassPass(*PassRegistry::getPassRegistry());
 196         initcount = 0; fincount=0;
 197         EXPECT_FALSE(initialized);
 198       }
 199       static void finishedOK(int run, int finalized) {
 200         PassTestBase<LoopPass>::finishedOK(run);
 201         EXPECT_EQ(run, initcount);
 202         EXPECT_EQ(finalized, fincount);
 203       }
 204       using llvm::Pass::doInitialization;
 205       using llvm::Pass::doFinalization;
 206       virtual bool doInitialization(Loop* L, LPPassManager &LPM) {
 207         initialized = true;
 208         initcount++;
 209         return false;
 210       }
 211       virtual bool runOnLoop(Loop *L, LPPassManager &LPM) {
 212         EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
 213         run();
 214         return false;
 215       }
 216       virtual bool doFinalization() {
 217         fincount++;
 218         finalized = true;
 219         return false;
 220       }
 221     };
 222     int LPass::initcount=0;
 223     int LPass::fincount=0;
 224
 225     struct BPass : public PassTestBase<BasicBlockPass> {
 226     private:
 227       static int inited;
 228       static int fin;
 229     public:
 230       static void finishedOK(int run, int N) {
 231         PassTestBase<BasicBlockPass>::finishedOK(run);
 232         EXPECT_EQ(inited, N);
 233         EXPECT_EQ(fin, N);
 234       }
 235       BPass() {
 236         inited = 0;
 237         fin = 0;
 238       }
 239       virtual bool doInitialization(Module &M) {
 240         EXPECT_FALSE(initialized);
 241         initialized = true;
 242         return false;
 243       }
 244       virtual bool doInitialization(Function &F) {
 245         inited++;
 246         return false;
 247       }
 248       virtual bool runOnBasicBlock(BasicBlock &BB) {
 249         EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
 250         run();
 251         return false;
 252       }
 253       virtual bool doFinalization(Function &F) {
 254         fin++;
 255         return false;
 256       }
 257       virtual bool doFinalization(Module &M) {
 258         EXPECT_FALSE(finalized);
 259         finalized = true;
 260         EXPECT_EQ(0, allocated);
 261         return false;
 262       }
 263     };
 264     int BPass::inited=0;
 265     int BPass::fin=0;
 266
 267     struct OnTheFlyTest: public ModulePass {
 268     public:
 269       static char ID;
 270       OnTheFlyTest() : ModulePass(ID) {
 271         initializeFPassPass(*PassRegistry::getPassRegistry());
 272       }
 273       virtual bool runOnModule(Module &M) {
 274         EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
 275         for (Module::iterator I=M.begin(),E=M.end(); I != E; ++I) {
 276           Function &F = *I;
 277           {
 278             SCOPED_TRACE("Running on the fly function pass");
 279             getAnalysis<FPass>(F);
 280           }
 281         }
 282         return false;
 283       }
 284       virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 285         AU.addRequired<FPass>();
 286       }
 287     };
 288     char OnTheFlyTest::ID=0;
 289
 290     TEST(PassManager, RunOnce) {
 291       Module M("test-once", getGlobalContext());
 292       struct ModuleNDNM *mNDNM = new ModuleNDNM();
 293       struct ModuleDNM *mDNM = new ModuleDNM();
 294       struct ModuleNDM *mNDM = new ModuleNDM();
 295       struct ModuleNDM2 *mNDM2 = new ModuleNDM2();
 296
 297       mNDM->run = mNDNM->run = mDNM->run = mNDM2->run = 0;
 298
 299       PassManager Passes;
 300       Passes.add(new DataLayout(&M));
 301       Passes.add(mNDM2);
 302       Passes.add(mNDM);
 303       Passes.add(mNDNM);
 304       Passes.add(mDNM);
 305
 306       Passes.run(M);
 307       // each pass must be run exactly once, since nothing invalidates them
 308       EXPECT_EQ(1, mNDM->run);
 309       EXPECT_EQ(1, mNDNM->run);
 310       EXPECT_EQ(1, mDNM->run);
 311       EXPECT_EQ(1, mNDM2->run);
 312     }
 313
 314     TEST(PassManager, ReRun) {
 315       Module M("test-rerun", getGlobalContext());
 316       struct ModuleNDNM *mNDNM = new ModuleNDNM();
 317       struct ModuleDNM *mDNM = new ModuleDNM();
 318       struct ModuleNDM *mNDM = new ModuleNDM();
 319       struct ModuleNDM2 *mNDM2 = new ModuleNDM2();
 320
 321       mNDM->run = mNDNM->run = mDNM->run = mNDM2->run = 0;
 322
 323       PassManager Passes;
 324       Passes.add(new DataLayout(&M));
 325       Passes.add(mNDM);
 326       Passes.add(mNDNM);
 327       Passes.add(mNDM2);// invalidates mNDM needed by mDNM
 328       Passes.add(mDNM);
 329
 330       Passes.run(M);
 331       // Some passes must be rerun because a pass that modified the
 332       // module/function was run in between
 333       EXPECT_EQ(2, mNDM->run);
 334       EXPECT_EQ(1, mNDNM->run);
 335       EXPECT_EQ(1, mNDM2->run);
 336       EXPECT_EQ(1, mDNM->run);
 337     }
 338
 339     Module* makeLLVMModule();
 340
 341     template<typename T>
 342     void MemoryTestHelper(int run) {
 343       OwningPtr<Module> M(makeLLVMModule());
 344       T *P = new T();
 345       PassManager Passes;
 346       Passes.add(new DataLayout(M.get()));
 347       Passes.add(P);
 348       Passes.run(*M);
 349       T::finishedOK(run);
 350     }
 351
 352     template<typename T>
 353     void MemoryTestHelper(int run, int N) {
 354       Module *M = makeLLVMModule();
 355       T *P = new T();
 356       PassManager Passes;
 357       Passes.add(new DataLayout(M));
 358       Passes.add(P);
 359       Passes.run(*M);
 360       T::finishedOK(run, N);
 361       delete M;
 362     }
 363
 364     TEST(PassManager, Memory) {
 365       // SCC#1: test1->test2->test3->test1
 366       // SCC#2: test4
 367       // SCC#3: indirect call node
 368       {
 369         SCOPED_TRACE("Callgraph pass");
 370         MemoryTestHelper<CGPass>(3);
 371       }
 372
 373       {
 374         SCOPED_TRACE("Function pass");
 375         MemoryTestHelper<FPass>(4);// 4 functions
 376       }
 377
 378       {
 379         SCOPED_TRACE("Loop pass");
 380         MemoryTestHelper<LPass>(2, 1); //2 loops, 1 function
 381       }
 382       {
 383         SCOPED_TRACE("Basic block pass");
 384         MemoryTestHelper<BPass>(7, 4); //9 basic blocks
 385       }
 386
 387     }
 388
 389     TEST(PassManager, MemoryOnTheFly) {
 390       Module *M = makeLLVMModule();
 391       {
 392         SCOPED_TRACE("Running OnTheFlyTest");
 393         struct OnTheFlyTest *O = new OnTheFlyTest();
 394         PassManager Passes;
 395         Passes.add(new DataLayout(M));
 396         Passes.add(O);
 397         Passes.run(*M);
 398
 399         FPass::finishedOK(4);
 400       }
 401       delete M;
 402     }
 403
 404     Module* makeLLVMModule() {
 405       // Module Construction
 406       Module* mod = new Module("test-mem", getGlobalContext());
 407       mod->setDataLayout("e-p:64:64:64-i1:8:8-i8:8:8-i16:16:16-i32:32:32-"
 408                          "i64:64:64-f32:32:32-f64:64:64-v64:64:64-v128:128:128-"
 409                          "a0:0:64-s0:64:64-f80:128:128");
 410       mod->setTargetTriple("x86_64-unknown-linux-gnu");
 411
 412       // Type Definitions
 413       std::vector<Type*>FuncTy_0_args;
 414       FunctionType* FuncTy_0 = FunctionType::get(
 415         /*Result=*/IntegerType::get(getGlobalContext(), 32),
 416         /*Params=*/FuncTy_0_args,
 417         /*isVarArg=*/false);
 418
 419       std::vector<Type*>FuncTy_2_args;
 420       FuncTy_2_args.push_back(IntegerType::get(getGlobalContext(), 1));
 421       FunctionType* FuncTy_2 = FunctionType::get(
 422         /*Result=*/Type::getVoidTy(getGlobalContext()),
 423         /*Params=*/FuncTy_2_args,
 424         /*isVarArg=*/false);
 425
 426
 427       // Function Declarations
 428
 429       Function* func_test1 = Function::Create(
 430         /*Type=*/FuncTy_0,
 431         /*Linkage=*/GlobalValue::ExternalLinkage,
 432         /*Name=*/"test1", mod);
 433       func_test1->setCallingConv(CallingConv::C);
 434       AttributeSet func_test1_PAL;
 435       func_test1->setAttributes(func_test1_PAL);
 436
 437       Function* func_test2 = Function::Create(
 438         /*Type=*/FuncTy_0,
 439         /*Linkage=*/GlobalValue::ExternalLinkage,
 440         /*Name=*/"test2", mod);
 441       func_test2->setCallingConv(CallingConv::C);
 442       AttributeSet func_test2_PAL;
 443       func_test2->setAttributes(func_test2_PAL);
 444
 445       Function* func_test3 = Function::Create(
 446         /*Type=*/FuncTy_0,
 447         /*Linkage=*/GlobalValue::ExternalLinkage,
 448         /*Name=*/"test3", mod);
 449       func_test3->setCallingConv(CallingConv::C);
 450       AttributeSet func_test3_PAL;
 451       func_test3->setAttributes(func_test3_PAL);
 452
 453       Function* func_test4 = Function::Create(
 454         /*Type=*/FuncTy_2,
 455         /*Linkage=*/GlobalValue::ExternalLinkage,
 456         /*Name=*/"test4", mod);
 457       func_test4->setCallingConv(CallingConv::C);
 458       AttributeSet func_test4_PAL;
 459       func_test4->setAttributes(func_test4_PAL);
 460
 461       // Global Variable Declarations
 462
 463
 464       // Constant Definitions
 465
 466       // Global Variable Definitions
 467
 468       // Function Definitions
 469
 470       // Function: test1 (func_test1)
 471       {
 472
 473         BasicBlock* label_entry = BasicBlock::Create(getGlobalContext(), "entry",func_test1,0);
 474
 475         // Block entry (label_entry)
 476         CallInst* int32_3 = CallInst::Create(func_test2, "", label_entry);
 477         int32_3->setCallingConv(CallingConv::C);
 478         int32_3->setTailCall(false);AttributeSet int32_3_PAL;
 479         int32_3->setAttributes(int32_3_PAL);
 480
 481         ReturnInst::Create(getGlobalContext(), int32_3, label_entry);
 482
 483       }
 484
 485       // Function: test2 (func_test2)
 486       {
 487
 488         BasicBlock* label_entry_5 = BasicBlock::Create(getGlobalContext(), "entry",func_test2,0);
 489
 490         // Block entry (label_entry_5)
 491         CallInst* int32_6 = CallInst::Create(func_test3, "", label_entry_5);
 492         int32_6->setCallingConv(CallingConv::C);
 493         int32_6->setTailCall(false);AttributeSet int32_6_PAL;
 494         int32_6->setAttributes(int32_6_PAL);
 495
 496         ReturnInst::Create(getGlobalContext(), int32_6, label_entry_5);
 497
 498       }
 499
 500       // Function: test3 (func_test3)
 501       {
 502
 503         BasicBlock* label_entry_8 = BasicBlock::Create(getGlobalContext(), "entry",func_test3,0);
 504
 505         // Block entry (label_entry_8)
 506         CallInst* int32_9 = CallInst::Create(func_test1, "", label_entry_8);
 507         int32_9->setCallingConv(CallingConv::C);
 508         int32_9->setTailCall(false);AttributeSet int32_9_PAL;
 509         int32_9->setAttributes(int32_9_PAL);
 510
 511         ReturnInst::Create(getGlobalContext(), int32_9, label_entry_8);
 512
 513       }
 514
 515       // Function: test4 (func_test4)
 516       {
 517         Function::arg_iterator args = func_test4->arg_begin();
 518         Value* int1_f = args++;
 519         int1_f->setName("f");
 520
 521         BasicBlock* label_entry_11 = BasicBlock::Create(getGlobalContext(), "entry",func_test4,0);
 522         BasicBlock* label_bb = BasicBlock::Create(getGlobalContext(), "bb",func_test4,0);
 523         BasicBlock* label_bb1 = BasicBlock::Create(getGlobalContext(), "bb1",func_test4,0);
 524         BasicBlock* label_return = BasicBlock::Create(getGlobalContext(), "return",func_test4,0);
 525
 526         // Block entry (label_entry_11)
 527         BranchInst::Create(label_bb, label_entry_11);
 528
 529         // Block bb (label_bb)
 530         BranchInst::Create(label_bb, label_bb1, int1_f, label_bb);
 531
 532         // Block bb1 (label_bb1)
 533         BranchInst::Create(label_bb1, label_return, int1_f, label_bb1);
 534
 535         // Block return (label_return)
 536         ReturnInst::Create(getGlobalContext(), label_return);
 537
 538       }
 539       return mod;
 540     }
 541
 542   }
 543 }
 544
 545 INITIALIZE_PASS(ModuleNDM, "mndm", "mndm", false, false)
 546 INITIALIZE_PASS_BEGIN(CGPass, "cgp","cgp", false, false)
 547 INITIALIZE_AG_DEPENDENCY(CallGraph)
 548 INITIALIZE_PASS_END(CGPass, "cgp","cgp", false, false)
 549 INITIALIZE_PASS(FPass, "fp","fp", false, false)
 550 INITIALIZE_PASS_BEGIN(LPass, "lp","lp", false, false)
 551 INITIALIZE_PASS_DEPENDENCY(LoopInfo)
 552 INITIALIZE_PASS_END(LPass, "lp","lp", false, false)
 553 INITIALIZE_PASS(BPass, "bp","bp", false, false)