1 //===- llvm/unittest/IR/PassManager.cpp - PassManager unit 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/PassManager.h"
11 #include "llvm/ADT/SmallVector.h"
12 #include "llvm/Analysis/CallGraphSCCPass.h"
13 #include "llvm/Analysis/LoopInfo.h"
14 #include "llvm/Analysis/LoopPass.h"
15 #include "llvm/Analysis/Verifier.h"
16 #include "llvm/Assembly/PrintModulePass.h"
17 #include "llvm/IR/BasicBlock.h"
18 #include "llvm/IR/CallingConv.h"
19 #include "llvm/IR/Constants.h"
20 #include "llvm/IR/DataLayout.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/Function.h"
23 #include "llvm/IR/GlobalVariable.h"
24 #include "llvm/IR/InlineAsm.h"
25 #include "llvm/IR/Instructions.h"
26 #include "llvm/IR/LLVMContext.h"
27 #include "llvm/IR/Module.h"
28 #include "llvm/Pass.h"
29 #include "llvm/Support/MathExtras.h"
30 #include "llvm/Support/raw_ostream.h"
31 #include "gtest/gtest.h"
36 void initializeModuleNDMPass(PassRegistry&);
37 void initializeFPassPass(PassRegistry&);
38 void initializeCGPassPass(PassRegistry&);
39 void initializeLPassPass(PassRegistry&);
40 void initializeBPassPass(PassRegistry&);
44 // NM = no modifications
45 struct ModuleNDNM: public ModulePass {
49 ModuleNDNM() : ModulePass(ID) { }
50 virtual bool runOnModule(Module &M) {
54 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
58 char ModuleNDNM::ID=0;
59 char ModuleNDNM::run=0;
61 struct ModuleNDM : public ModulePass {
65 ModuleNDM() : ModulePass(ID) {}
66 virtual bool runOnModule(Module &M) {
72 char ModuleNDM::run=0;
74 struct ModuleNDM2 : public ModulePass {
78 ModuleNDM2() : ModulePass(ID) {}
79 virtual bool runOnModule(Module &M) {
84 char ModuleNDM2::ID=0;
85 char ModuleNDM2::run=0;
87 struct ModuleDNM : public ModulePass {
91 ModuleDNM() : ModulePass(ID) {
92 initializeModuleNDMPass(*PassRegistry::getPassRegistry());
94 virtual bool runOnModule(Module &M) {
95 EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
99 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
100 AU.addRequired<ModuleNDM>();
101 AU.setPreservesAll();
104 char ModuleDNM::ID=0;
105 char ModuleDNM::run=0;
108 struct PassTestBase : public P {
111 static bool initialized;
112 static bool finalized;
115 EXPECT_TRUE(initialized);
116 EXPECT_FALSE(finalized);
117 EXPECT_EQ(0, allocated);
123 static void finishedOK(int run) {
125 EXPECT_TRUE(initialized);
126 EXPECT_TRUE(finalized);
127 EXPECT_EQ(run, runc);
129 PassTestBase() : P(ID), allocated(0) {
135 virtual void releaseMemory() {
137 EXPECT_GT(allocated, 0);
141 template<typename P> char PassTestBase<P>::ID;
142 template<typename P> int PassTestBase<P>::runc;
143 template<typename P> bool PassTestBase<P>::initialized;
144 template<typename P> bool PassTestBase<P>::finalized;
146 template<typename T, typename P>
147 struct PassTest : public PassTestBase<P> {
149 #ifndef _MSC_VER // MSVC complains that Pass is not base class.
150 using llvm::Pass::doInitialization;
151 using llvm::Pass::doFinalization;
153 virtual bool doInitialization(T &t) {
154 EXPECT_FALSE(PassTestBase<P>::initialized);
155 PassTestBase<P>::initialized = true;
158 virtual bool doFinalization(T &t) {
159 EXPECT_FALSE(PassTestBase<P>::finalized);
160 PassTestBase<P>::finalized = true;
161 EXPECT_EQ(0, PassTestBase<P>::allocated);
166 struct CGPass : public PassTest<CallGraph, CallGraphSCCPass> {
169 initializeCGPassPass(*PassRegistry::getPassRegistry());
171 virtual bool runOnSCC(CallGraphSCC &SCMM) {
172 EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
178 struct FPass : public PassTest<Module, FunctionPass> {
180 virtual bool runOnFunction(Function &F) {
182 // EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
188 struct LPass : public PassTestBase<LoopPass> {
190 static int initcount;
194 initializeLPassPass(*PassRegistry::getPassRegistry());
195 initcount = 0; fincount=0;
196 EXPECT_FALSE(initialized);
198 static void finishedOK(int run, int finalized) {
199 PassTestBase<LoopPass>::finishedOK(run);
200 EXPECT_EQ(run, initcount);
201 EXPECT_EQ(finalized, fincount);
203 using llvm::Pass::doInitialization;
204 using llvm::Pass::doFinalization;
205 virtual bool doInitialization(Loop* L, LPPassManager &LPM) {
210 virtual bool runOnLoop(Loop *L, LPPassManager &LPM) {
211 EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
215 virtual bool doFinalization() {
221 int LPass::initcount=0;
222 int LPass::fincount=0;
224 struct BPass : public PassTestBase<BasicBlockPass> {
229 static void finishedOK(int run, int N) {
230 PassTestBase<BasicBlockPass>::finishedOK(run);
231 EXPECT_EQ(inited, N);
238 virtual bool doInitialization(Module &M) {
239 EXPECT_FALSE(initialized);
243 virtual bool doInitialization(Function &F) {
247 virtual bool runOnBasicBlock(BasicBlock &BB) {
248 EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
252 virtual bool doFinalization(Function &F) {
256 virtual bool doFinalization(Module &M) {
257 EXPECT_FALSE(finalized);
259 EXPECT_EQ(0, allocated);
266 struct OnTheFlyTest: public ModulePass {
269 OnTheFlyTest() : ModulePass(ID) {
270 initializeFPassPass(*PassRegistry::getPassRegistry());
272 virtual bool runOnModule(Module &M) {
273 EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
274 for (Module::iterator I=M.begin(),E=M.end(); I != E; ++I) {
277 SCOPED_TRACE("Running on the fly function pass");
278 getAnalysis<FPass>(F);
283 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
284 AU.addRequired<FPass>();
287 char OnTheFlyTest::ID=0;
289 TEST(PassManager, RunOnce) {
290 Module M("test-once", getGlobalContext());
291 struct ModuleNDNM *mNDNM = new ModuleNDNM();
292 struct ModuleDNM *mDNM = new ModuleDNM();
293 struct ModuleNDM *mNDM = new ModuleNDM();
294 struct ModuleNDM2 *mNDM2 = new ModuleNDM2();
296 mNDM->run = mNDNM->run = mDNM->run = mNDM2->run = 0;
299 Passes.add(new DataLayout(&M));
306 // each pass must be run exactly once, since nothing invalidates them
307 EXPECT_EQ(1, mNDM->run);
308 EXPECT_EQ(1, mNDNM->run);
309 EXPECT_EQ(1, mDNM->run);
310 EXPECT_EQ(1, mNDM2->run);
313 TEST(PassManager, ReRun) {
314 Module M("test-rerun", getGlobalContext());
315 struct ModuleNDNM *mNDNM = new ModuleNDNM();
316 struct ModuleDNM *mDNM = new ModuleDNM();
317 struct ModuleNDM *mNDM = new ModuleNDM();
318 struct ModuleNDM2 *mNDM2 = new ModuleNDM2();
320 mNDM->run = mNDNM->run = mDNM->run = mNDM2->run = 0;
323 Passes.add(new DataLayout(&M));
326 Passes.add(mNDM2);// invalidates mNDM needed by mDNM
330 // Some passes must be rerun because a pass that modified the
331 // module/function was run in between
332 EXPECT_EQ(2, mNDM->run);
333 EXPECT_EQ(1, mNDNM->run);
334 EXPECT_EQ(1, mNDM2->run);
335 EXPECT_EQ(1, mDNM->run);
338 Module* makeLLVMModule();
341 void MemoryTestHelper(int run) {
342 OwningPtr<Module> M(makeLLVMModule());
345 Passes.add(new DataLayout(M.get()));
352 void MemoryTestHelper(int run, int N) {
353 Module *M = makeLLVMModule();
356 Passes.add(new DataLayout(M));
359 T::finishedOK(run, N);
363 TEST(PassManager, Memory) {
364 // SCC#1: test1->test2->test3->test1
366 // SCC#3: indirect call node
368 SCOPED_TRACE("Callgraph pass");
369 MemoryTestHelper<CGPass>(3);
373 SCOPED_TRACE("Function pass");
374 MemoryTestHelper<FPass>(4);// 4 functions
378 SCOPED_TRACE("Loop pass");
379 MemoryTestHelper<LPass>(2, 1); //2 loops, 1 function
382 SCOPED_TRACE("Basic block pass");
383 MemoryTestHelper<BPass>(7, 4); //9 basic blocks
388 TEST(PassManager, MemoryOnTheFly) {
389 Module *M = makeLLVMModule();
391 SCOPED_TRACE("Running OnTheFlyTest");
392 struct OnTheFlyTest *O = new OnTheFlyTest();
394 Passes.add(new DataLayout(M));
398 FPass::finishedOK(4);
403 Module* makeLLVMModule() {
404 // Module Construction
405 Module* mod = new Module("test-mem", getGlobalContext());
406 mod->setDataLayout("e-p:64:64:64-i1:8:8-i8:8:8-i16:16:16-i32:32:32-"
407 "i64:64:64-f32:32:32-f64:64:64-v64:64:64-v128:128:128-"
408 "a0:0:64-s0:64:64-f80:128:128");
409 mod->setTargetTriple("x86_64-unknown-linux-gnu");
412 std::vector<Type*>FuncTy_0_args;
413 FunctionType* FuncTy_0 = FunctionType::get(
414 /*Result=*/IntegerType::get(getGlobalContext(), 32),
415 /*Params=*/FuncTy_0_args,
418 std::vector<Type*>FuncTy_2_args;
419 FuncTy_2_args.push_back(IntegerType::get(getGlobalContext(), 1));
420 FunctionType* FuncTy_2 = FunctionType::get(
421 /*Result=*/Type::getVoidTy(getGlobalContext()),
422 /*Params=*/FuncTy_2_args,
426 // Function Declarations
428 Function* func_test1 = Function::Create(
430 /*Linkage=*/GlobalValue::ExternalLinkage,
431 /*Name=*/"test1", mod);
432 func_test1->setCallingConv(CallingConv::C);
433 AttributeSet func_test1_PAL;
434 func_test1->setAttributes(func_test1_PAL);
436 Function* func_test2 = Function::Create(
438 /*Linkage=*/GlobalValue::ExternalLinkage,
439 /*Name=*/"test2", mod);
440 func_test2->setCallingConv(CallingConv::C);
441 AttributeSet func_test2_PAL;
442 func_test2->setAttributes(func_test2_PAL);
444 Function* func_test3 = Function::Create(
446 /*Linkage=*/GlobalValue::ExternalLinkage,
447 /*Name=*/"test3", mod);
448 func_test3->setCallingConv(CallingConv::C);
449 AttributeSet func_test3_PAL;
450 func_test3->setAttributes(func_test3_PAL);
452 Function* func_test4 = Function::Create(
454 /*Linkage=*/GlobalValue::ExternalLinkage,
455 /*Name=*/"test4", mod);
456 func_test4->setCallingConv(CallingConv::C);
457 AttributeSet func_test4_PAL;
458 func_test4->setAttributes(func_test4_PAL);
460 // Global Variable Declarations
463 // Constant Definitions
465 // Global Variable Definitions
467 // Function Definitions
469 // Function: test1 (func_test1)
472 BasicBlock* label_entry = BasicBlock::Create(getGlobalContext(), "entry",func_test1,0);
474 // Block entry (label_entry)
475 CallInst* int32_3 = CallInst::Create(func_test2, "", label_entry);
476 int32_3->setCallingConv(CallingConv::C);
477 int32_3->setTailCall(false);AttributeSet int32_3_PAL;
478 int32_3->setAttributes(int32_3_PAL);
480 ReturnInst::Create(getGlobalContext(), int32_3, label_entry);
484 // Function: test2 (func_test2)
487 BasicBlock* label_entry_5 = BasicBlock::Create(getGlobalContext(), "entry",func_test2,0);
489 // Block entry (label_entry_5)
490 CallInst* int32_6 = CallInst::Create(func_test3, "", label_entry_5);
491 int32_6->setCallingConv(CallingConv::C);
492 int32_6->setTailCall(false);AttributeSet int32_6_PAL;
493 int32_6->setAttributes(int32_6_PAL);
495 ReturnInst::Create(getGlobalContext(), int32_6, label_entry_5);
499 // Function: test3 (func_test3)
502 BasicBlock* label_entry_8 = BasicBlock::Create(getGlobalContext(), "entry",func_test3,0);
504 // Block entry (label_entry_8)
505 CallInst* int32_9 = CallInst::Create(func_test1, "", label_entry_8);
506 int32_9->setCallingConv(CallingConv::C);
507 int32_9->setTailCall(false);AttributeSet int32_9_PAL;
508 int32_9->setAttributes(int32_9_PAL);
510 ReturnInst::Create(getGlobalContext(), int32_9, label_entry_8);
514 // Function: test4 (func_test4)
516 Function::arg_iterator args = func_test4->arg_begin();
517 Value* int1_f = args++;
518 int1_f->setName("f");
520 BasicBlock* label_entry_11 = BasicBlock::Create(getGlobalContext(), "entry",func_test4,0);
521 BasicBlock* label_bb = BasicBlock::Create(getGlobalContext(), "bb",func_test4,0);
522 BasicBlock* label_bb1 = BasicBlock::Create(getGlobalContext(), "bb1",func_test4,0);
523 BasicBlock* label_return = BasicBlock::Create(getGlobalContext(), "return",func_test4,0);
525 // Block entry (label_entry_11)
526 BranchInst::Create(label_bb, label_entry_11);
528 // Block bb (label_bb)
529 BranchInst::Create(label_bb, label_bb1, int1_f, label_bb);
531 // Block bb1 (label_bb1)
532 BranchInst::Create(label_bb1, label_return, int1_f, label_bb1);
534 // Block return (label_return)
535 ReturnInst::Create(getGlobalContext(), label_return);
544 INITIALIZE_PASS(ModuleNDM, "mndm", "mndm", false, false)
545 INITIALIZE_PASS_BEGIN(CGPass, "cgp","cgp", false, false)
546 INITIALIZE_AG_DEPENDENCY(CallGraph)
547 INITIALIZE_PASS_END(CGPass, "cgp","cgp", false, false)
548 INITIALIZE_PASS(FPass, "fp","fp", false, false)
549 INITIALIZE_PASS_BEGIN(LPass, "lp","lp", false, false)
550 INITIALIZE_PASS_DEPENDENCY(LoopInfo)
551 INITIALIZE_PASS_END(LPass, "lp","lp", false, false)
552 INITIALIZE_PASS(BPass, "bp","bp", false, false)