1 //===- llvm/unittest/IR/IRBuilderTest.cpp - IRBuilder 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/IR/IRBuilder.h"
11 #include "llvm/ADT/OwningPtr.h"
12 #include "llvm/IR/BasicBlock.h"
13 #include "llvm/IR/DataLayout.h"
14 #include "llvm/IR/Function.h"
15 #include "llvm/IR/IntrinsicInst.h"
16 #include "llvm/IR/LLVMContext.h"
17 #include "llvm/IR/MDBuilder.h"
18 #include "llvm/IR/Module.h"
19 #include "llvm/Support/NoFolder.h"
20 #include "gtest/gtest.h"
26 class IRBuilderTest : public testing::Test {
28 virtual void SetUp() {
29 M.reset(new Module("MyModule", Ctx));
30 FunctionType *FTy = FunctionType::get(Type::getVoidTy(Ctx),
32 F = Function::Create(FTy, Function::ExternalLinkage, "", M.get());
33 BB = BasicBlock::Create(Ctx, "", F);
34 GV = new GlobalVariable(*M, Type::getFloatTy(Ctx), true,
35 GlobalValue::ExternalLinkage, 0);
38 virtual void TearDown() {
50 TEST_F(IRBuilderTest, Lifetime) {
51 IRBuilder<> Builder(BB);
52 AllocaInst *Var1 = Builder.CreateAlloca(Builder.getInt8Ty());
53 AllocaInst *Var2 = Builder.CreateAlloca(Builder.getInt32Ty());
54 AllocaInst *Var3 = Builder.CreateAlloca(Builder.getInt8Ty(),
55 Builder.getInt32(123));
57 CallInst *Start1 = Builder.CreateLifetimeStart(Var1);
58 CallInst *Start2 = Builder.CreateLifetimeStart(Var2);
59 CallInst *Start3 = Builder.CreateLifetimeStart(Var3, Builder.getInt64(100));
61 EXPECT_EQ(Start1->getArgOperand(0), Builder.getInt64(-1));
62 EXPECT_EQ(Start2->getArgOperand(0), Builder.getInt64(-1));
63 EXPECT_EQ(Start3->getArgOperand(0), Builder.getInt64(100));
65 EXPECT_EQ(Start1->getArgOperand(1), Var1);
66 EXPECT_NE(Start2->getArgOperand(1), Var2);
67 EXPECT_EQ(Start3->getArgOperand(1), Var3);
69 Value *End1 = Builder.CreateLifetimeEnd(Var1);
70 Builder.CreateLifetimeEnd(Var2);
71 Builder.CreateLifetimeEnd(Var3);
73 IntrinsicInst *II_Start1 = dyn_cast<IntrinsicInst>(Start1);
74 IntrinsicInst *II_End1 = dyn_cast<IntrinsicInst>(End1);
75 ASSERT_TRUE(II_Start1 != NULL);
76 EXPECT_EQ(II_Start1->getIntrinsicID(), Intrinsic::lifetime_start);
77 ASSERT_TRUE(II_End1 != NULL);
78 EXPECT_EQ(II_End1->getIntrinsicID(), Intrinsic::lifetime_end);
81 TEST_F(IRBuilderTest, CreateCondBr) {
82 IRBuilder<> Builder(BB);
83 BasicBlock *TBB = BasicBlock::Create(Ctx, "", F);
84 BasicBlock *FBB = BasicBlock::Create(Ctx, "", F);
86 BranchInst *BI = Builder.CreateCondBr(Builder.getTrue(), TBB, FBB);
87 TerminatorInst *TI = BB->getTerminator();
89 EXPECT_EQ(2u, TI->getNumSuccessors());
90 EXPECT_EQ(TBB, TI->getSuccessor(0));
91 EXPECT_EQ(FBB, TI->getSuccessor(1));
93 BI->eraseFromParent();
94 MDNode *Weights = MDBuilder(Ctx).createBranchWeights(42, 13);
95 BI = Builder.CreateCondBr(Builder.getTrue(), TBB, FBB, Weights);
96 TI = BB->getTerminator();
98 EXPECT_EQ(2u, TI->getNumSuccessors());
99 EXPECT_EQ(TBB, TI->getSuccessor(0));
100 EXPECT_EQ(FBB, TI->getSuccessor(1));
101 EXPECT_EQ(Weights, TI->getMetadata(LLVMContext::MD_prof));
104 TEST_F(IRBuilderTest, LandingPadName) {
105 IRBuilder<> Builder(BB);
106 LandingPadInst *LP = Builder.CreateLandingPad(Builder.getInt32Ty(),
107 Builder.getInt32(0), 0, "LP");
108 EXPECT_EQ(LP->getName(), "LP");
111 TEST_F(IRBuilderTest, GetIntTy) {
112 IRBuilder<> Builder(BB);
113 IntegerType *Ty1 = Builder.getInt1Ty();
114 EXPECT_EQ(Ty1, IntegerType::get(Ctx, 1));
116 DataLayout* DL = new DataLayout(M.get());
117 IntegerType *IntPtrTy = Builder.getIntPtrTy(DL);
118 unsigned IntPtrBitSize = DL->getPointerSizeInBits(0);
119 EXPECT_EQ(IntPtrTy, IntegerType::get(Ctx, IntPtrBitSize));
123 TEST_F(IRBuilderTest, FastMathFlags) {
124 IRBuilder<> Builder(BB);
126 Instruction *FDiv, *FAdd;
128 F = Builder.CreateLoad(GV);
129 F = Builder.CreateFAdd(F, F);
131 EXPECT_FALSE(Builder.getFastMathFlags().any());
132 ASSERT_TRUE(isa<Instruction>(F));
133 FAdd = cast<Instruction>(F);
134 EXPECT_FALSE(FAdd->hasNoNaNs());
137 Builder.SetFastMathFlags(FMF);
139 F = Builder.CreateFAdd(F, F);
140 EXPECT_FALSE(Builder.getFastMathFlags().any());
142 FMF.setUnsafeAlgebra();
143 Builder.SetFastMathFlags(FMF);
145 F = Builder.CreateFAdd(F, F);
146 EXPECT_TRUE(Builder.getFastMathFlags().any());
147 ASSERT_TRUE(isa<Instruction>(F));
148 FAdd = cast<Instruction>(F);
149 EXPECT_TRUE(FAdd->hasNoNaNs());
151 // Now, try it with CreateBinOp
152 F = Builder.CreateBinOp(Instruction::FAdd, F, F);
153 EXPECT_TRUE(Builder.getFastMathFlags().any());
154 ASSERT_TRUE(isa<Instruction>(F));
155 FAdd = cast<Instruction>(F);
156 EXPECT_TRUE(FAdd->hasNoNaNs());
158 F = Builder.CreateFDiv(F, F);
159 EXPECT_TRUE(Builder.getFastMathFlags().any());
160 EXPECT_TRUE(Builder.getFastMathFlags().UnsafeAlgebra);
161 ASSERT_TRUE(isa<Instruction>(F));
162 FDiv = cast<Instruction>(F);
163 EXPECT_TRUE(FDiv->hasAllowReciprocal());
165 Builder.clearFastMathFlags();
167 F = Builder.CreateFDiv(F, F);
168 ASSERT_TRUE(isa<Instruction>(F));
169 FDiv = cast<Instruction>(F);
170 EXPECT_FALSE(FDiv->hasAllowReciprocal());
173 FMF.setAllowReciprocal();
174 Builder.SetFastMathFlags(FMF);
176 F = Builder.CreateFDiv(F, F);
177 EXPECT_TRUE(Builder.getFastMathFlags().any());
178 EXPECT_TRUE(Builder.getFastMathFlags().AllowReciprocal);
179 ASSERT_TRUE(isa<Instruction>(F));
180 FDiv = cast<Instruction>(F);
181 EXPECT_TRUE(FDiv->hasAllowReciprocal());
183 Builder.clearFastMathFlags();
185 F = Builder.CreateFDiv(F, F);
186 ASSERT_TRUE(isa<Instruction>(F));
187 FDiv = cast<Instruction>(F);
188 EXPECT_FALSE(FDiv->getFastMathFlags().any());
189 FDiv->copyFastMathFlags(FAdd);
190 EXPECT_TRUE(FDiv->hasNoNaNs());
194 TEST_F(IRBuilderTest, WrapFlags) {
195 IRBuilder<true, NoFolder> Builder(BB);
197 // Test instructions.
198 GlobalVariable *G = new GlobalVariable(*M, Builder.getInt32Ty(), true,
199 GlobalValue::ExternalLinkage, 0);
200 Value *V = Builder.CreateLoad(G);
202 cast<BinaryOperator>(Builder.CreateNSWAdd(V, V))->hasNoSignedWrap());
204 cast<BinaryOperator>(Builder.CreateNSWMul(V, V))->hasNoSignedWrap());
206 cast<BinaryOperator>(Builder.CreateNSWSub(V, V))->hasNoSignedWrap());
207 EXPECT_TRUE(cast<BinaryOperator>(
208 Builder.CreateShl(V, V, "", /* NUW */ false, /* NSW */ true))
209 ->hasNoSignedWrap());
212 cast<BinaryOperator>(Builder.CreateNUWAdd(V, V))->hasNoUnsignedWrap());
214 cast<BinaryOperator>(Builder.CreateNUWMul(V, V))->hasNoUnsignedWrap());
216 cast<BinaryOperator>(Builder.CreateNUWSub(V, V))->hasNoUnsignedWrap());
217 EXPECT_TRUE(cast<BinaryOperator>(
218 Builder.CreateShl(V, V, "", /* NUW */ true, /* NSW */ false))
219 ->hasNoUnsignedWrap());
221 // Test operators created with constants.
222 Constant *C = Builder.getInt32(42);
223 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNSWAdd(C, C))
224 ->hasNoSignedWrap());
225 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNSWSub(C, C))
226 ->hasNoSignedWrap());
227 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNSWMul(C, C))
228 ->hasNoSignedWrap());
229 EXPECT_TRUE(cast<OverflowingBinaryOperator>(
230 Builder.CreateShl(C, C, "", /* NUW */ false, /* NSW */ true))
231 ->hasNoSignedWrap());
233 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNUWAdd(C, C))
234 ->hasNoUnsignedWrap());
235 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNUWSub(C, C))
236 ->hasNoUnsignedWrap());
237 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNUWMul(C, C))
238 ->hasNoUnsignedWrap());
239 EXPECT_TRUE(cast<OverflowingBinaryOperator>(
240 Builder.CreateShl(C, C, "", /* NUW */ true, /* NSW */ false))
241 ->hasNoUnsignedWrap());
244 TEST_F(IRBuilderTest, RAIIHelpersTest) {
245 IRBuilder<> Builder(BB);
246 EXPECT_FALSE(Builder.getFastMathFlags().allowReciprocal());
247 MDBuilder MDB(M->getContext());
249 MDNode *FPMathA = MDB.createFPMath(0.01f);
250 MDNode *FPMathB = MDB.createFPMath(0.1f);
252 Builder.SetDefaultFPMathTag(FPMathA);
255 IRBuilder<>::FastMathFlagGuard Guard(Builder);
257 FMF.setAllowReciprocal();
258 Builder.SetFastMathFlags(FMF);
259 Builder.SetDefaultFPMathTag(FPMathB);
260 EXPECT_TRUE(Builder.getFastMathFlags().allowReciprocal());
261 EXPECT_EQ(FPMathB, Builder.getDefaultFPMathTag());
264 EXPECT_FALSE(Builder.getFastMathFlags().allowReciprocal());
265 EXPECT_EQ(FPMathA, Builder.getDefaultFPMathTag());
267 Value *F = Builder.CreateLoad(GV);
270 IRBuilder<>::InsertPointGuard Guard(Builder);
271 Builder.SetInsertPoint(cast<Instruction>(F));
272 EXPECT_EQ(F, Builder.GetInsertPoint());
275 EXPECT_EQ(BB->end(), Builder.GetInsertPoint());
276 EXPECT_EQ(BB, Builder.GetInsertBlock());