1 //===- llvm/unittest/VMCore/PassManager.cpp - Constants 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/Module.h"
11 #include "llvm/LLVMContext.h"
12 #include "llvm/PassManager.h"
13 #include "llvm/Analysis/LoopInfo.h"
14 #include "llvm/Pass.h"
15 #include "llvm/Analysis/LoopPass.h"
16 #include "llvm/CallGraphSCCPass.h"
17 #include "llvm/DataLayout.h"
18 #include "llvm/Support/raw_ostream.h"
19 #include "llvm/DerivedTypes.h"
20 #include "llvm/Constants.h"
21 #include "llvm/GlobalVariable.h"
22 #include "llvm/Function.h"
23 #include "llvm/CallingConv.h"
24 #include "llvm/BasicBlock.h"
25 #include "llvm/Instructions.h"
26 #include "llvm/InlineAsm.h"
27 #include "llvm/Support/MathExtras.h"
28 #include "llvm/Support/raw_ostream.h"
29 #include "llvm/PassManager.h"
30 #include "llvm/ADT/SmallVector.h"
31 #include "llvm/Analysis/Verifier.h"
32 #include "llvm/Assembly/PrintModulePass.h"
33 #include "gtest/gtest.h"
38 void initializeModuleNDMPass(PassRegistry&);
39 void initializeFPassPass(PassRegistry&);
40 void initializeCGPassPass(PassRegistry&);
41 void initializeLPassPass(PassRegistry&);
42 void initializeBPassPass(PassRegistry&);
46 // NM = no modifications
47 struct ModuleNDNM: public ModulePass {
51 ModuleNDNM() : ModulePass(ID) { }
52 virtual bool runOnModule(Module &M) {
56 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
60 char ModuleNDNM::ID=0;
61 char ModuleNDNM::run=0;
63 struct ModuleNDM : public ModulePass {
67 ModuleNDM() : ModulePass(ID) {}
68 virtual bool runOnModule(Module &M) {
74 char ModuleNDM::run=0;
76 struct ModuleNDM2 : public ModulePass {
80 ModuleNDM2() : ModulePass(ID) {}
81 virtual bool runOnModule(Module &M) {
86 char ModuleNDM2::ID=0;
87 char ModuleNDM2::run=0;
89 struct ModuleDNM : public ModulePass {
93 ModuleDNM() : ModulePass(ID) {
94 initializeModuleNDMPass(*PassRegistry::getPassRegistry());
96 virtual bool runOnModule(Module &M) {
97 EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
101 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
102 AU.addRequired<ModuleNDM>();
103 AU.setPreservesAll();
106 char ModuleDNM::ID=0;
107 char ModuleDNM::run=0;
110 struct PassTestBase : public P {
113 static bool initialized;
114 static bool finalized;
117 EXPECT_TRUE(initialized);
118 EXPECT_FALSE(finalized);
119 EXPECT_EQ(0, allocated);
125 static void finishedOK(int run) {
127 EXPECT_TRUE(initialized);
128 EXPECT_TRUE(finalized);
129 EXPECT_EQ(run, runc);
131 PassTestBase() : P(ID), allocated(0) {
137 virtual void releaseMemory() {
139 EXPECT_GT(allocated, 0);
143 template<typename P> char PassTestBase<P>::ID;
144 template<typename P> int PassTestBase<P>::runc;
145 template<typename P> bool PassTestBase<P>::initialized;
146 template<typename P> bool PassTestBase<P>::finalized;
148 template<typename T, typename P>
149 struct PassTest : public PassTestBase<P> {
151 #ifndef _MSC_VER // MSVC complains that Pass is not base class.
152 using llvm::Pass::doInitialization;
153 using llvm::Pass::doFinalization;
155 virtual bool doInitialization(T &t) {
156 EXPECT_FALSE(PassTestBase<P>::initialized);
157 PassTestBase<P>::initialized = true;
160 virtual bool doFinalization(T &t) {
161 EXPECT_FALSE(PassTestBase<P>::finalized);
162 PassTestBase<P>::finalized = true;
163 EXPECT_EQ(0, PassTestBase<P>::allocated);
168 struct CGPass : public PassTest<CallGraph, CallGraphSCCPass> {
171 initializeCGPassPass(*PassRegistry::getPassRegistry());
173 virtual bool runOnSCC(CallGraphSCC &SCMM) {
174 EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
180 struct FPass : public PassTest<Module, FunctionPass> {
182 virtual bool runOnFunction(Function &F) {
184 // EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
190 struct LPass : public PassTestBase<LoopPass> {
192 static int initcount;
196 initializeLPassPass(*PassRegistry::getPassRegistry());
197 initcount = 0; fincount=0;
198 EXPECT_FALSE(initialized);
200 static void finishedOK(int run, int finalized) {
201 PassTestBase<LoopPass>::finishedOK(run);
202 EXPECT_EQ(run, initcount);
203 EXPECT_EQ(finalized, fincount);
205 using llvm::Pass::doInitialization;
206 using llvm::Pass::doFinalization;
207 virtual bool doInitialization(Loop* L, LPPassManager &LPM) {
212 virtual bool runOnLoop(Loop *L, LPPassManager &LPM) {
213 EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
217 virtual bool doFinalization() {
223 int LPass::initcount=0;
224 int LPass::fincount=0;
226 struct BPass : public PassTestBase<BasicBlockPass> {
231 static void finishedOK(int run, int N) {
232 PassTestBase<BasicBlockPass>::finishedOK(run);
233 EXPECT_EQ(inited, N);
240 virtual bool doInitialization(Module &M) {
241 EXPECT_FALSE(initialized);
245 virtual bool doInitialization(Function &F) {
249 virtual bool runOnBasicBlock(BasicBlock &BB) {
250 EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
254 virtual bool doFinalization(Function &F) {
258 virtual bool doFinalization(Module &M) {
259 EXPECT_FALSE(finalized);
261 EXPECT_EQ(0, allocated);
268 struct OnTheFlyTest: public ModulePass {
271 OnTheFlyTest() : ModulePass(ID) {
272 initializeFPassPass(*PassRegistry::getPassRegistry());
274 virtual bool runOnModule(Module &M) {
275 EXPECT_TRUE(getAnalysisIfAvailable<DataLayout>());
276 for (Module::iterator I=M.begin(),E=M.end(); I != E; ++I) {
279 SCOPED_TRACE("Running on the fly function pass");
280 getAnalysis<FPass>(F);
285 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
286 AU.addRequired<FPass>();
289 char OnTheFlyTest::ID=0;
291 TEST(PassManager, RunOnce) {
292 Module M("test-once", getGlobalContext());
293 struct ModuleNDNM *mNDNM = new ModuleNDNM();
294 struct ModuleDNM *mDNM = new ModuleDNM();
295 struct ModuleNDM *mNDM = new ModuleNDM();
296 struct ModuleNDM2 *mNDM2 = new ModuleNDM2();
298 mNDM->run = mNDNM->run = mDNM->run = mNDM2->run = 0;
301 Passes.add(new DataLayout(&M));
308 // each pass must be run exactly once, since nothing invalidates them
309 EXPECT_EQ(1, mNDM->run);
310 EXPECT_EQ(1, mNDNM->run);
311 EXPECT_EQ(1, mDNM->run);
312 EXPECT_EQ(1, mNDM2->run);
315 TEST(PassManager, ReRun) {
316 Module M("test-rerun", getGlobalContext());
317 struct ModuleNDNM *mNDNM = new ModuleNDNM();
318 struct ModuleDNM *mDNM = new ModuleDNM();
319 struct ModuleNDM *mNDM = new ModuleNDM();
320 struct ModuleNDM2 *mNDM2 = new ModuleNDM2();
322 mNDM->run = mNDNM->run = mDNM->run = mNDM2->run = 0;
325 Passes.add(new DataLayout(&M));
328 Passes.add(mNDM2);// invalidates mNDM needed by mDNM
332 // Some passes must be rerun because a pass that modified the
333 // module/function was run in between
334 EXPECT_EQ(2, mNDM->run);
335 EXPECT_EQ(1, mNDNM->run);
336 EXPECT_EQ(1, mNDM2->run);
337 EXPECT_EQ(1, mDNM->run);
340 Module* makeLLVMModule();
343 void MemoryTestHelper(int run) {
344 OwningPtr<Module> M(makeLLVMModule());
347 Passes.add(new DataLayout(M.get()));
354 void MemoryTestHelper(int run, int N) {
355 Module *M = makeLLVMModule();
358 Passes.add(new DataLayout(M));
361 T::finishedOK(run, N);
365 TEST(PassManager, Memory) {
366 // SCC#1: test1->test2->test3->test1
368 // SCC#3: indirect call node
370 SCOPED_TRACE("Callgraph pass");
371 MemoryTestHelper<CGPass>(3);
375 SCOPED_TRACE("Function pass");
376 MemoryTestHelper<FPass>(4);// 4 functions
380 SCOPED_TRACE("Loop pass");
381 MemoryTestHelper<LPass>(2, 1); //2 loops, 1 function
384 SCOPED_TRACE("Basic block pass");
385 MemoryTestHelper<BPass>(7, 4); //9 basic blocks
390 TEST(PassManager, MemoryOnTheFly) {
391 Module *M = makeLLVMModule();
393 SCOPED_TRACE("Running OnTheFlyTest");
394 struct OnTheFlyTest *O = new OnTheFlyTest();
396 Passes.add(new DataLayout(M));
400 FPass::finishedOK(4);
405 Module* makeLLVMModule() {
406 // Module Construction
407 Module* mod = new Module("test-mem", getGlobalContext());
408 mod->setDataLayout("e-p:64:64:64-i1:8:8-i8:8:8-i16:16:16-i32:32:32-"
409 "i64:64:64-f32:32:32-f64:64:64-v64:64:64-v128:128:128-"
410 "a0:0:64-s0:64:64-f80:128:128");
411 mod->setTargetTriple("x86_64-unknown-linux-gnu");
414 std::vector<Type*>FuncTy_0_args;
415 FunctionType* FuncTy_0 = FunctionType::get(
416 /*Result=*/IntegerType::get(getGlobalContext(), 32),
417 /*Params=*/FuncTy_0_args,
420 std::vector<Type*>FuncTy_2_args;
421 FuncTy_2_args.push_back(IntegerType::get(getGlobalContext(), 1));
422 FunctionType* FuncTy_2 = FunctionType::get(
423 /*Result=*/Type::getVoidTy(getGlobalContext()),
424 /*Params=*/FuncTy_2_args,
428 // Function Declarations
430 Function* func_test1 = Function::Create(
432 /*Linkage=*/GlobalValue::ExternalLinkage,
433 /*Name=*/"test1", mod);
434 func_test1->setCallingConv(CallingConv::C);
435 AttrListPtr func_test1_PAL;
436 func_test1->setAttributes(func_test1_PAL);
438 Function* func_test2 = Function::Create(
440 /*Linkage=*/GlobalValue::ExternalLinkage,
441 /*Name=*/"test2", mod);
442 func_test2->setCallingConv(CallingConv::C);
443 AttrListPtr func_test2_PAL;
444 func_test2->setAttributes(func_test2_PAL);
446 Function* func_test3 = Function::Create(
448 /*Linkage=*/GlobalValue::ExternalLinkage,
449 /*Name=*/"test3", mod);
450 func_test3->setCallingConv(CallingConv::C);
451 AttrListPtr func_test3_PAL;
452 func_test3->setAttributes(func_test3_PAL);
454 Function* func_test4 = Function::Create(
456 /*Linkage=*/GlobalValue::ExternalLinkage,
457 /*Name=*/"test4", mod);
458 func_test4->setCallingConv(CallingConv::C);
459 AttrListPtr func_test4_PAL;
460 func_test4->setAttributes(func_test4_PAL);
462 // Global Variable Declarations
465 // Constant Definitions
467 // Global Variable Definitions
469 // Function Definitions
471 // Function: test1 (func_test1)
474 BasicBlock* label_entry = BasicBlock::Create(getGlobalContext(), "entry",func_test1,0);
476 // Block entry (label_entry)
477 CallInst* int32_3 = CallInst::Create(func_test2, "", label_entry);
478 int32_3->setCallingConv(CallingConv::C);
479 int32_3->setTailCall(false);AttrListPtr int32_3_PAL;
480 int32_3->setAttributes(int32_3_PAL);
482 ReturnInst::Create(getGlobalContext(), int32_3, label_entry);
486 // Function: test2 (func_test2)
489 BasicBlock* label_entry_5 = BasicBlock::Create(getGlobalContext(), "entry",func_test2,0);
491 // Block entry (label_entry_5)
492 CallInst* int32_6 = CallInst::Create(func_test3, "", label_entry_5);
493 int32_6->setCallingConv(CallingConv::C);
494 int32_6->setTailCall(false);AttrListPtr int32_6_PAL;
495 int32_6->setAttributes(int32_6_PAL);
497 ReturnInst::Create(getGlobalContext(), int32_6, label_entry_5);
501 // Function: test3 (func_test3)
504 BasicBlock* label_entry_8 = BasicBlock::Create(getGlobalContext(), "entry",func_test3,0);
506 // Block entry (label_entry_8)
507 CallInst* int32_9 = CallInst::Create(func_test1, "", label_entry_8);
508 int32_9->setCallingConv(CallingConv::C);
509 int32_9->setTailCall(false);AttrListPtr int32_9_PAL;
510 int32_9->setAttributes(int32_9_PAL);
512 ReturnInst::Create(getGlobalContext(), int32_9, label_entry_8);
516 // Function: test4 (func_test4)
518 Function::arg_iterator args = func_test4->arg_begin();
519 Value* int1_f = args++;
520 int1_f->setName("f");
522 BasicBlock* label_entry_11 = BasicBlock::Create(getGlobalContext(), "entry",func_test4,0);
523 BasicBlock* label_bb = BasicBlock::Create(getGlobalContext(), "bb",func_test4,0);
524 BasicBlock* label_bb1 = BasicBlock::Create(getGlobalContext(), "bb1",func_test4,0);
525 BasicBlock* label_return = BasicBlock::Create(getGlobalContext(), "return",func_test4,0);
527 // Block entry (label_entry_11)
528 BranchInst::Create(label_bb, label_entry_11);
530 // Block bb (label_bb)
531 BranchInst::Create(label_bb, label_bb1, int1_f, label_bb);
533 // Block bb1 (label_bb1)
534 BranchInst::Create(label_bb1, label_return, int1_f, label_bb1);
536 // Block return (label_return)
537 ReturnInst::Create(getGlobalContext(), label_return);
546 INITIALIZE_PASS(ModuleNDM, "mndm", "mndm", false, false)
547 INITIALIZE_PASS_BEGIN(CGPass, "cgp","cgp", false, false)
548 INITIALIZE_AG_DEPENDENCY(CallGraph)
549 INITIALIZE_PASS_END(CGPass, "cgp","cgp", false, false)
550 INITIALIZE_PASS(FPass, "fp","fp", false, false)
551 INITIALIZE_PASS_BEGIN(LPass, "lp","lp", false, false)
552 INITIALIZE_PASS_DEPENDENCY(LoopInfo)
553 INITIALIZE_PASS_END(LPass, "lp","lp", false, false)
554 INITIALIZE_PASS(BPass, "bp","bp", false, false)