1 //===- llvm/unittest/IR/IRBuilderTest.cpp - IRBuilder 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/IR/IRBuilder.h"
11 #include "llvm/IR/BasicBlock.h"
12 #include "llvm/IR/DataLayout.h"
13 #include "llvm/IR/Function.h"
14 #include "llvm/IR/IntrinsicInst.h"
15 #include "llvm/IR/LLVMContext.h"
16 #include "llvm/IR/MDBuilder.h"
17 #include "llvm/IR/Module.h"
18 #include "llvm/IR/NoFolder.h"
19 #include "gtest/gtest.h"
20
21 using namespace llvm;
22
23 namespace {
24
25 class IRBuilderTest : public testing::Test {
26 protected:
SetUp()27 virtual void SetUp() {
28 M.reset(new Module("MyModule", Ctx));
29 FunctionType *FTy = FunctionType::get(Type::getVoidTy(Ctx),
30 /*isVarArg=*/false);
31 F = Function::Create(FTy, Function::ExternalLinkage, "", M.get());
32 BB = BasicBlock::Create(Ctx, "", F);
33 GV = new GlobalVariable(*M, Type::getFloatTy(Ctx), true,
34 GlobalValue::ExternalLinkage, nullptr);
35 }
36
TearDown()37 virtual void TearDown() {
38 BB = nullptr;
39 M.reset();
40 }
41
42 LLVMContext Ctx;
43 std::unique_ptr<Module> M;
44 Function *F;
45 BasicBlock *BB;
46 GlobalVariable *GV;
47 };
48
TEST_F(IRBuilderTest,Lifetime)49 TEST_F(IRBuilderTest, Lifetime) {
50 IRBuilder<> Builder(BB);
51 AllocaInst *Var1 = Builder.CreateAlloca(Builder.getInt8Ty());
52 AllocaInst *Var2 = Builder.CreateAlloca(Builder.getInt32Ty());
53 AllocaInst *Var3 = Builder.CreateAlloca(Builder.getInt8Ty(),
54 Builder.getInt32(123));
55
56 CallInst *Start1 = Builder.CreateLifetimeStart(Var1);
57 CallInst *Start2 = Builder.CreateLifetimeStart(Var2);
58 CallInst *Start3 = Builder.CreateLifetimeStart(Var3, Builder.getInt64(100));
59
60 EXPECT_EQ(Start1->getArgOperand(0), Builder.getInt64(-1));
61 EXPECT_EQ(Start2->getArgOperand(0), Builder.getInt64(-1));
62 EXPECT_EQ(Start3->getArgOperand(0), Builder.getInt64(100));
63
64 EXPECT_EQ(Start1->getArgOperand(1), Var1);
65 EXPECT_NE(Start2->getArgOperand(1), Var2);
66 EXPECT_EQ(Start3->getArgOperand(1), Var3);
67
68 Value *End1 = Builder.CreateLifetimeEnd(Var1);
69 Builder.CreateLifetimeEnd(Var2);
70 Builder.CreateLifetimeEnd(Var3);
71
72 IntrinsicInst *II_Start1 = dyn_cast<IntrinsicInst>(Start1);
73 IntrinsicInst *II_End1 = dyn_cast<IntrinsicInst>(End1);
74 ASSERT_TRUE(II_Start1 != nullptr);
75 EXPECT_EQ(II_Start1->getIntrinsicID(), Intrinsic::lifetime_start);
76 ASSERT_TRUE(II_End1 != nullptr);
77 EXPECT_EQ(II_End1->getIntrinsicID(), Intrinsic::lifetime_end);
78 }
79
TEST_F(IRBuilderTest,CreateCondBr)80 TEST_F(IRBuilderTest, CreateCondBr) {
81 IRBuilder<> Builder(BB);
82 BasicBlock *TBB = BasicBlock::Create(Ctx, "", F);
83 BasicBlock *FBB = BasicBlock::Create(Ctx, "", F);
84
85 BranchInst *BI = Builder.CreateCondBr(Builder.getTrue(), TBB, FBB);
86 TerminatorInst *TI = BB->getTerminator();
87 EXPECT_EQ(BI, TI);
88 EXPECT_EQ(2u, TI->getNumSuccessors());
89 EXPECT_EQ(TBB, TI->getSuccessor(0));
90 EXPECT_EQ(FBB, TI->getSuccessor(1));
91
92 BI->eraseFromParent();
93 MDNode *Weights = MDBuilder(Ctx).createBranchWeights(42, 13);
94 BI = Builder.CreateCondBr(Builder.getTrue(), TBB, FBB, Weights);
95 TI = BB->getTerminator();
96 EXPECT_EQ(BI, TI);
97 EXPECT_EQ(2u, TI->getNumSuccessors());
98 EXPECT_EQ(TBB, TI->getSuccessor(0));
99 EXPECT_EQ(FBB, TI->getSuccessor(1));
100 EXPECT_EQ(Weights, TI->getMetadata(LLVMContext::MD_prof));
101 }
102
TEST_F(IRBuilderTest,LandingPadName)103 TEST_F(IRBuilderTest, LandingPadName) {
104 IRBuilder<> Builder(BB);
105 LandingPadInst *LP = Builder.CreateLandingPad(Builder.getInt32Ty(),
106 Builder.getInt32(0), 0, "LP");
107 EXPECT_EQ(LP->getName(), "LP");
108 }
109
TEST_F(IRBuilderTest,DataLayout)110 TEST_F(IRBuilderTest, DataLayout) {
111 std::unique_ptr<Module> M(new Module("test", Ctx));
112 M->setDataLayout("e-n32");
113 EXPECT_TRUE(M->getDataLayout()->isLegalInteger(32));
114 M->setDataLayout("e");
115 EXPECT_FALSE(M->getDataLayout()->isLegalInteger(32));
116 }
117
TEST_F(IRBuilderTest,GetIntTy)118 TEST_F(IRBuilderTest, GetIntTy) {
119 IRBuilder<> Builder(BB);
120 IntegerType *Ty1 = Builder.getInt1Ty();
121 EXPECT_EQ(Ty1, IntegerType::get(Ctx, 1));
122
123 DataLayout* DL = new DataLayout(M.get());
124 IntegerType *IntPtrTy = Builder.getIntPtrTy(DL);
125 unsigned IntPtrBitSize = DL->getPointerSizeInBits(0);
126 EXPECT_EQ(IntPtrTy, IntegerType::get(Ctx, IntPtrBitSize));
127 delete DL;
128 }
129
TEST_F(IRBuilderTest,FastMathFlags)130 TEST_F(IRBuilderTest, FastMathFlags) {
131 IRBuilder<> Builder(BB);
132 Value *F;
133 Instruction *FDiv, *FAdd;
134
135 F = Builder.CreateLoad(GV);
136 F = Builder.CreateFAdd(F, F);
137
138 EXPECT_FALSE(Builder.getFastMathFlags().any());
139 ASSERT_TRUE(isa<Instruction>(F));
140 FAdd = cast<Instruction>(F);
141 EXPECT_FALSE(FAdd->hasNoNaNs());
142
143 FastMathFlags FMF;
144 Builder.SetFastMathFlags(FMF);
145
146 F = Builder.CreateFAdd(F, F);
147 EXPECT_FALSE(Builder.getFastMathFlags().any());
148
149 FMF.setUnsafeAlgebra();
150 Builder.SetFastMathFlags(FMF);
151
152 F = Builder.CreateFAdd(F, F);
153 EXPECT_TRUE(Builder.getFastMathFlags().any());
154 ASSERT_TRUE(isa<Instruction>(F));
155 FAdd = cast<Instruction>(F);
156 EXPECT_TRUE(FAdd->hasNoNaNs());
157
158 // Now, try it with CreateBinOp
159 F = Builder.CreateBinOp(Instruction::FAdd, F, F);
160 EXPECT_TRUE(Builder.getFastMathFlags().any());
161 ASSERT_TRUE(isa<Instruction>(F));
162 FAdd = cast<Instruction>(F);
163 EXPECT_TRUE(FAdd->hasNoNaNs());
164
165 F = Builder.CreateFDiv(F, F);
166 EXPECT_TRUE(Builder.getFastMathFlags().any());
167 EXPECT_TRUE(Builder.getFastMathFlags().UnsafeAlgebra);
168 ASSERT_TRUE(isa<Instruction>(F));
169 FDiv = cast<Instruction>(F);
170 EXPECT_TRUE(FDiv->hasAllowReciprocal());
171
172 Builder.clearFastMathFlags();
173
174 F = Builder.CreateFDiv(F, F);
175 ASSERT_TRUE(isa<Instruction>(F));
176 FDiv = cast<Instruction>(F);
177 EXPECT_FALSE(FDiv->hasAllowReciprocal());
178
179 FMF.clear();
180 FMF.setAllowReciprocal();
181 Builder.SetFastMathFlags(FMF);
182
183 F = Builder.CreateFDiv(F, F);
184 EXPECT_TRUE(Builder.getFastMathFlags().any());
185 EXPECT_TRUE(Builder.getFastMathFlags().AllowReciprocal);
186 ASSERT_TRUE(isa<Instruction>(F));
187 FDiv = cast<Instruction>(F);
188 EXPECT_TRUE(FDiv->hasAllowReciprocal());
189
190 Builder.clearFastMathFlags();
191
192 F = Builder.CreateFDiv(F, F);
193 ASSERT_TRUE(isa<Instruction>(F));
194 FDiv = cast<Instruction>(F);
195 EXPECT_FALSE(FDiv->getFastMathFlags().any());
196 FDiv->copyFastMathFlags(FAdd);
197 EXPECT_TRUE(FDiv->hasNoNaNs());
198
199 }
200
TEST_F(IRBuilderTest,WrapFlags)201 TEST_F(IRBuilderTest, WrapFlags) {
202 IRBuilder<true, NoFolder> Builder(BB);
203
204 // Test instructions.
205 GlobalVariable *G = new GlobalVariable(*M, Builder.getInt32Ty(), true,
206 GlobalValue::ExternalLinkage, nullptr);
207 Value *V = Builder.CreateLoad(G);
208 EXPECT_TRUE(
209 cast<BinaryOperator>(Builder.CreateNSWAdd(V, V))->hasNoSignedWrap());
210 EXPECT_TRUE(
211 cast<BinaryOperator>(Builder.CreateNSWMul(V, V))->hasNoSignedWrap());
212 EXPECT_TRUE(
213 cast<BinaryOperator>(Builder.CreateNSWSub(V, V))->hasNoSignedWrap());
214 EXPECT_TRUE(cast<BinaryOperator>(
215 Builder.CreateShl(V, V, "", /* NUW */ false, /* NSW */ true))
216 ->hasNoSignedWrap());
217
218 EXPECT_TRUE(
219 cast<BinaryOperator>(Builder.CreateNUWAdd(V, V))->hasNoUnsignedWrap());
220 EXPECT_TRUE(
221 cast<BinaryOperator>(Builder.CreateNUWMul(V, V))->hasNoUnsignedWrap());
222 EXPECT_TRUE(
223 cast<BinaryOperator>(Builder.CreateNUWSub(V, V))->hasNoUnsignedWrap());
224 EXPECT_TRUE(cast<BinaryOperator>(
225 Builder.CreateShl(V, V, "", /* NUW */ true, /* NSW */ false))
226 ->hasNoUnsignedWrap());
227
228 // Test operators created with constants.
229 Constant *C = Builder.getInt32(42);
230 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNSWAdd(C, C))
231 ->hasNoSignedWrap());
232 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNSWSub(C, C))
233 ->hasNoSignedWrap());
234 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNSWMul(C, C))
235 ->hasNoSignedWrap());
236 EXPECT_TRUE(cast<OverflowingBinaryOperator>(
237 Builder.CreateShl(C, C, "", /* NUW */ false, /* NSW */ true))
238 ->hasNoSignedWrap());
239
240 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNUWAdd(C, C))
241 ->hasNoUnsignedWrap());
242 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNUWSub(C, C))
243 ->hasNoUnsignedWrap());
244 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNUWMul(C, C))
245 ->hasNoUnsignedWrap());
246 EXPECT_TRUE(cast<OverflowingBinaryOperator>(
247 Builder.CreateShl(C, C, "", /* NUW */ true, /* NSW */ false))
248 ->hasNoUnsignedWrap());
249 }
250
TEST_F(IRBuilderTest,RAIIHelpersTest)251 TEST_F(IRBuilderTest, RAIIHelpersTest) {
252 IRBuilder<> Builder(BB);
253 EXPECT_FALSE(Builder.getFastMathFlags().allowReciprocal());
254 MDBuilder MDB(M->getContext());
255
256 MDNode *FPMathA = MDB.createFPMath(0.01f);
257 MDNode *FPMathB = MDB.createFPMath(0.1f);
258
259 Builder.SetDefaultFPMathTag(FPMathA);
260
261 {
262 IRBuilder<>::FastMathFlagGuard Guard(Builder);
263 FastMathFlags FMF;
264 FMF.setAllowReciprocal();
265 Builder.SetFastMathFlags(FMF);
266 Builder.SetDefaultFPMathTag(FPMathB);
267 EXPECT_TRUE(Builder.getFastMathFlags().allowReciprocal());
268 EXPECT_EQ(FPMathB, Builder.getDefaultFPMathTag());
269 }
270
271 EXPECT_FALSE(Builder.getFastMathFlags().allowReciprocal());
272 EXPECT_EQ(FPMathA, Builder.getDefaultFPMathTag());
273
274 Value *F = Builder.CreateLoad(GV);
275
276 {
277 IRBuilder<>::InsertPointGuard Guard(Builder);
278 Builder.SetInsertPoint(cast<Instruction>(F));
279 EXPECT_EQ(F, Builder.GetInsertPoint());
280 }
281
282 EXPECT_EQ(BB->end(), Builder.GetInsertPoint());
283 EXPECT_EQ(BB, Builder.GetInsertBlock());
284 }
285
286
287 }
288