xref: /llvm-project/llvm/unittests/IR/IRBuilderTest.cpp (revision afadf061e7f09144c32f9e720b6e333a8dd8643d) 
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/DIBuilder.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/IR/NoFolder.h"
20 #include "llvm/IR/Verifier.h"
21 #include "gtest/gtest.h"
22 
23 using namespace llvm;
24 
25 namespace {
26 
27 class IRBuilderTest : public testing::Test {
28 protected:
29   void SetUp() override {
30     M.reset(new Module("MyModule", Ctx));
31     FunctionType *FTy = FunctionType::get(Type::getVoidTy(Ctx),
32                                           /*isVarArg=*/false);
33     F = Function::Create(FTy, Function::ExternalLinkage, "", M.get());
34     BB = BasicBlock::Create(Ctx, "", F);
35     GV = new GlobalVariable(*M, Type::getFloatTy(Ctx), true,
36                             GlobalValue::ExternalLinkage, nullptr);
37   }
38 
39   void TearDown() override {
40     BB = nullptr;
41     M.reset();
42   }
43 
44   LLVMContext Ctx;
45   std::unique_ptr<Module> M;
46   Function *F;
47   BasicBlock *BB;
48   GlobalVariable *GV;
49 };
50 
51 TEST_F(IRBuilderTest, Lifetime) {
52   IRBuilder<> Builder(BB);
53   AllocaInst *Var1 = Builder.CreateAlloca(Builder.getInt8Ty());
54   AllocaInst *Var2 = Builder.CreateAlloca(Builder.getInt32Ty());
55   AllocaInst *Var3 = Builder.CreateAlloca(Builder.getInt8Ty(),
56                                           Builder.getInt32(123));
57 
58   CallInst *Start1 = Builder.CreateLifetimeStart(Var1);
59   CallInst *Start2 = Builder.CreateLifetimeStart(Var2);
60   CallInst *Start3 = Builder.CreateLifetimeStart(Var3, Builder.getInt64(100));
61 
62   EXPECT_EQ(Start1->getArgOperand(0), Builder.getInt64(-1));
63   EXPECT_EQ(Start2->getArgOperand(0), Builder.getInt64(-1));
64   EXPECT_EQ(Start3->getArgOperand(0), Builder.getInt64(100));
65 
66   EXPECT_EQ(Start1->getArgOperand(1), Var1);
67   EXPECT_NE(Start2->getArgOperand(1), Var2);
68   EXPECT_EQ(Start3->getArgOperand(1), Var3);
69 
70   Value *End1 = Builder.CreateLifetimeEnd(Var1);
71   Builder.CreateLifetimeEnd(Var2);
72   Builder.CreateLifetimeEnd(Var3);
73 
74   IntrinsicInst *II_Start1 = dyn_cast<IntrinsicInst>(Start1);
75   IntrinsicInst *II_End1 = dyn_cast<IntrinsicInst>(End1);
76   ASSERT_TRUE(II_Start1 != nullptr);
77   EXPECT_EQ(II_Start1->getIntrinsicID(), Intrinsic::lifetime_start);
78   ASSERT_TRUE(II_End1 != nullptr);
79   EXPECT_EQ(II_End1->getIntrinsicID(), Intrinsic::lifetime_end);
80 }
81 
82 TEST_F(IRBuilderTest, CreateCondBr) {
83   IRBuilder<> Builder(BB);
84   BasicBlock *TBB = BasicBlock::Create(Ctx, "", F);
85   BasicBlock *FBB = BasicBlock::Create(Ctx, "", F);
86 
87   BranchInst *BI = Builder.CreateCondBr(Builder.getTrue(), TBB, FBB);
88   TerminatorInst *TI = BB->getTerminator();
89   EXPECT_EQ(BI, TI);
90   EXPECT_EQ(2u, TI->getNumSuccessors());
91   EXPECT_EQ(TBB, TI->getSuccessor(0));
92   EXPECT_EQ(FBB, TI->getSuccessor(1));
93 
94   BI->eraseFromParent();
95   MDNode *Weights = MDBuilder(Ctx).createBranchWeights(42, 13);
96   BI = Builder.CreateCondBr(Builder.getTrue(), TBB, FBB, Weights);
97   TI = BB->getTerminator();
98   EXPECT_EQ(BI, TI);
99   EXPECT_EQ(2u, TI->getNumSuccessors());
100   EXPECT_EQ(TBB, TI->getSuccessor(0));
101   EXPECT_EQ(FBB, TI->getSuccessor(1));
102   EXPECT_EQ(Weights, TI->getMetadata(LLVMContext::MD_prof));
103 }
104 
105 TEST_F(IRBuilderTest, LandingPadName) {
106   IRBuilder<> Builder(BB);
107   LandingPadInst *LP = Builder.CreateLandingPad(Builder.getInt32Ty(), 0, "LP");
108   EXPECT_EQ(LP->getName(), "LP");
109 }
110 
111 TEST_F(IRBuilderTest, DataLayout) {
112   std::unique_ptr<Module> M(new Module("test", Ctx));
113   M->setDataLayout("e-n32");
114   EXPECT_TRUE(M->getDataLayout().isLegalInteger(32));
115   M->setDataLayout("e");
116   EXPECT_FALSE(M->getDataLayout().isLegalInteger(32));
117 }
118 
119 TEST_F(IRBuilderTest, GetIntTy) {
120   IRBuilder<> Builder(BB);
121   IntegerType *Ty1 = Builder.getInt1Ty();
122   EXPECT_EQ(Ty1, IntegerType::get(Ctx, 1));
123 
124   DataLayout* DL = new DataLayout(M.get());
125   IntegerType *IntPtrTy = Builder.getIntPtrTy(*DL);
126   unsigned IntPtrBitSize =  DL->getPointerSizeInBits(0);
127   EXPECT_EQ(IntPtrTy, IntegerType::get(Ctx, IntPtrBitSize));
128   delete DL;
129 }
130 
131 TEST_F(IRBuilderTest, FastMathFlags) {
132   IRBuilder<> Builder(BB);
133   Value *F;
134   Instruction *FDiv, *FAdd;
135 
136   F = Builder.CreateLoad(GV);
137   F = Builder.CreateFAdd(F, F);
138 
139   EXPECT_FALSE(Builder.getFastMathFlags().any());
140   ASSERT_TRUE(isa<Instruction>(F));
141   FAdd = cast<Instruction>(F);
142   EXPECT_FALSE(FAdd->hasNoNaNs());
143 
144   FastMathFlags FMF;
145   Builder.SetFastMathFlags(FMF);
146 
147   F = Builder.CreateFAdd(F, F);
148   EXPECT_FALSE(Builder.getFastMathFlags().any());
149 
150   FMF.setUnsafeAlgebra();
151   Builder.SetFastMathFlags(FMF);
152 
153   F = Builder.CreateFAdd(F, F);
154   EXPECT_TRUE(Builder.getFastMathFlags().any());
155   ASSERT_TRUE(isa<Instruction>(F));
156   FAdd = cast<Instruction>(F);
157   EXPECT_TRUE(FAdd->hasNoNaNs());
158 
159   // Now, try it with CreateBinOp
160   F = Builder.CreateBinOp(Instruction::FAdd, F, F);
161   EXPECT_TRUE(Builder.getFastMathFlags().any());
162   ASSERT_TRUE(isa<Instruction>(F));
163   FAdd = cast<Instruction>(F);
164   EXPECT_TRUE(FAdd->hasNoNaNs());
165 
166   F = Builder.CreateFDiv(F, F);
167   EXPECT_TRUE(Builder.getFastMathFlags().any());
168   EXPECT_TRUE(Builder.getFastMathFlags().UnsafeAlgebra);
169   ASSERT_TRUE(isa<Instruction>(F));
170   FDiv = cast<Instruction>(F);
171   EXPECT_TRUE(FDiv->hasAllowReciprocal());
172 
173   Builder.clearFastMathFlags();
174 
175   F = Builder.CreateFDiv(F, F);
176   ASSERT_TRUE(isa<Instruction>(F));
177   FDiv = cast<Instruction>(F);
178   EXPECT_FALSE(FDiv->hasAllowReciprocal());
179 
180   FMF.clear();
181   FMF.setAllowReciprocal();
182   Builder.SetFastMathFlags(FMF);
183 
184   F = Builder.CreateFDiv(F, F);
185   EXPECT_TRUE(Builder.getFastMathFlags().any());
186   EXPECT_TRUE(Builder.getFastMathFlags().AllowReciprocal);
187   ASSERT_TRUE(isa<Instruction>(F));
188   FDiv = cast<Instruction>(F);
189   EXPECT_TRUE(FDiv->hasAllowReciprocal());
190 
191   Builder.clearFastMathFlags();
192 
193   // To test a copy, make sure that a '0' and a '1' change state.
194   F = Builder.CreateFDiv(F, F);
195   ASSERT_TRUE(isa<Instruction>(F));
196   FDiv = cast<Instruction>(F);
197   EXPECT_FALSE(FDiv->getFastMathFlags().any());
198   FDiv->setHasAllowReciprocal(true);
199   FAdd->setHasAllowReciprocal(false);
200   FDiv->copyFastMathFlags(FAdd);
201   EXPECT_TRUE(FDiv->hasNoNaNs());
202   EXPECT_FALSE(FDiv->hasAllowReciprocal());
203 
204 }
205 
206 TEST_F(IRBuilderTest, WrapFlags) {
207   IRBuilder<true, NoFolder> Builder(BB);
208 
209   // Test instructions.
210   GlobalVariable *G = new GlobalVariable(*M, Builder.getInt32Ty(), true,
211                                          GlobalValue::ExternalLinkage, nullptr);
212   Value *V = Builder.CreateLoad(G);
213   EXPECT_TRUE(
214       cast<BinaryOperator>(Builder.CreateNSWAdd(V, V))->hasNoSignedWrap());
215   EXPECT_TRUE(
216       cast<BinaryOperator>(Builder.CreateNSWMul(V, V))->hasNoSignedWrap());
217   EXPECT_TRUE(
218       cast<BinaryOperator>(Builder.CreateNSWSub(V, V))->hasNoSignedWrap());
219   EXPECT_TRUE(cast<BinaryOperator>(
220                   Builder.CreateShl(V, V, "", /* NUW */ false, /* NSW */ true))
221                   ->hasNoSignedWrap());
222 
223   EXPECT_TRUE(
224       cast<BinaryOperator>(Builder.CreateNUWAdd(V, V))->hasNoUnsignedWrap());
225   EXPECT_TRUE(
226       cast<BinaryOperator>(Builder.CreateNUWMul(V, V))->hasNoUnsignedWrap());
227   EXPECT_TRUE(
228       cast<BinaryOperator>(Builder.CreateNUWSub(V, V))->hasNoUnsignedWrap());
229   EXPECT_TRUE(cast<BinaryOperator>(
230                   Builder.CreateShl(V, V, "", /* NUW */ true, /* NSW */ false))
231                   ->hasNoUnsignedWrap());
232 
233   // Test operators created with constants.
234   Constant *C = Builder.getInt32(42);
235   EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNSWAdd(C, C))
236                   ->hasNoSignedWrap());
237   EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNSWSub(C, C))
238                   ->hasNoSignedWrap());
239   EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNSWMul(C, C))
240                   ->hasNoSignedWrap());
241   EXPECT_TRUE(cast<OverflowingBinaryOperator>(
242                   Builder.CreateShl(C, C, "", /* NUW */ false, /* NSW */ true))
243                   ->hasNoSignedWrap());
244 
245   EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNUWAdd(C, C))
246                   ->hasNoUnsignedWrap());
247   EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNUWSub(C, C))
248                   ->hasNoUnsignedWrap());
249   EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNUWMul(C, C))
250                   ->hasNoUnsignedWrap());
251   EXPECT_TRUE(cast<OverflowingBinaryOperator>(
252                   Builder.CreateShl(C, C, "", /* NUW */ true, /* NSW */ false))
253                   ->hasNoUnsignedWrap());
254 }
255 
256 TEST_F(IRBuilderTest, RAIIHelpersTest) {
257   IRBuilder<> Builder(BB);
258   EXPECT_FALSE(Builder.getFastMathFlags().allowReciprocal());
259   MDBuilder MDB(M->getContext());
260 
261   MDNode *FPMathA = MDB.createFPMath(0.01f);
262   MDNode *FPMathB = MDB.createFPMath(0.1f);
263 
264   Builder.SetDefaultFPMathTag(FPMathA);
265 
266   {
267     IRBuilder<>::FastMathFlagGuard Guard(Builder);
268     FastMathFlags FMF;
269     FMF.setAllowReciprocal();
270     Builder.SetFastMathFlags(FMF);
271     Builder.SetDefaultFPMathTag(FPMathB);
272     EXPECT_TRUE(Builder.getFastMathFlags().allowReciprocal());
273     EXPECT_EQ(FPMathB, Builder.getDefaultFPMathTag());
274   }
275 
276   EXPECT_FALSE(Builder.getFastMathFlags().allowReciprocal());
277   EXPECT_EQ(FPMathA, Builder.getDefaultFPMathTag());
278 
279   Value *F = Builder.CreateLoad(GV);
280 
281   {
282     IRBuilder<>::InsertPointGuard Guard(Builder);
283     Builder.SetInsertPoint(cast<Instruction>(F));
284     EXPECT_EQ(F, Builder.GetInsertPoint());
285   }
286 
287   EXPECT_EQ(BB->end(), Builder.GetInsertPoint());
288   EXPECT_EQ(BB, Builder.GetInsertBlock());
289 }
290 
291 TEST_F(IRBuilderTest, DIBuilder) {
292   IRBuilder<> Builder(BB);
293   DIBuilder DIB(*M);
294   auto File = DIB.createFile("F.CBL", "/");
295   auto CU = DIB.createCompileUnit(dwarf::DW_LANG_Cobol74, "F.CBL", "/",
296                                   "llvm-cobol74", true, "", 0);
297   auto Type = DIB.createSubroutineType(File, DIB.getOrCreateTypeArray(None));
298   DIB.createFunction(CU, "foo", "", File, 1, Type, false, true, 1, 0, true, F);
299   AllocaInst *I = Builder.CreateAlloca(Builder.getInt8Ty());
300   auto BarSP = DIB.createFunction(CU, "bar", "", File, 1, Type, false, true, 1,
301                                   0, true, nullptr);
302   auto BadScope = DIB.createLexicalBlockFile(BarSP, File, 0);
303   I->setDebugLoc(DebugLoc::get(2, 0, BadScope));
304   DIB.finalize();
305   EXPECT_TRUE(verifyModule(*M));
306 }
307 
308 TEST_F(IRBuilderTest, InsertExtractElement) {
309   IRBuilder<> Builder(BB);
310 
311   auto VecTy = VectorType::get(Builder.getInt64Ty(), 4);
312   auto Elt1 = Builder.getInt64(-1);
313   auto Elt2 = Builder.getInt64(-2);
314   Value *Vec = UndefValue::get(VecTy);
315   Vec = Builder.CreateInsertElement(Vec, Elt1, Builder.getInt8(1));
316   Vec = Builder.CreateInsertElement(Vec, Elt2, 2);
317   auto X1 = Builder.CreateExtractElement(Vec, 1);
318   auto X2 = Builder.CreateExtractElement(Vec, Builder.getInt32(2));
319   EXPECT_EQ(Elt1, X1);
320   EXPECT_EQ(Elt2, X2);
321 }
322 
323 TEST_F(IRBuilderTest, CreateGlobalStringPtr) {
324   IRBuilder<> Builder(BB);
325 
326   auto String1a = Builder.CreateGlobalStringPtr("TestString", "String1a");
327   auto String1b = Builder.CreateGlobalStringPtr("TestString", "String1b", 0);
328   auto String2 = Builder.CreateGlobalStringPtr("TestString", "String2", 1);
329   auto String3 = Builder.CreateGlobalString("TestString", "String3", 2);
330 
331   EXPECT_TRUE(String1a->getType()->getPointerAddressSpace() == 0);
332   EXPECT_TRUE(String1b->getType()->getPointerAddressSpace() == 0);
333   EXPECT_TRUE(String2->getType()->getPointerAddressSpace() == 1);
334   EXPECT_TRUE(String3->getType()->getPointerAddressSpace() == 2);
335 }
336 
337 TEST_F(IRBuilderTest, DebugLoc) {
338   auto CalleeTy = FunctionType::get(Type::getVoidTy(Ctx),
339                                     /*isVarArg=*/false);
340   auto Callee =
341       Function::Create(CalleeTy, Function::ExternalLinkage, "", M.get());
342 
343   DIBuilder DIB(*M);
344   auto File = DIB.createFile("tmp.cpp", "/");
345   auto CU = DIB.createCompileUnit(dwarf::DW_LANG_C_plus_plus_11, "tmp.cpp", "/",
346                                   "", true, "", 0);
347   auto SPType = DIB.createSubroutineType(File, DIB.getOrCreateTypeArray(None));
348   auto SP =
349       DIB.createFunction(CU, "foo", "foo", File, 1, SPType, false, true, 1);
350   DebugLoc DL1 = DILocation::get(Ctx, 2, 0, SP);
351   DebugLoc DL2 = DILocation::get(Ctx, 3, 0, SP);
352 
353   auto BB2 = BasicBlock::Create(Ctx, "bb2", F);
354   auto Br = BranchInst::Create(BB2, BB);
355   Br->setDebugLoc(DL1);
356 
357   IRBuilder<> Builder(Ctx);
358   Builder.SetInsertPoint(Br);
359   EXPECT_EQ(DL1, Builder.getCurrentDebugLocation());
360   auto Call1 = Builder.CreateCall(Callee, None);
361   EXPECT_EQ(DL1, Call1->getDebugLoc());
362 
363   Call1->setDebugLoc(DL2);
364   Builder.SetInsertPoint(Call1->getParent(), Call1);
365   EXPECT_EQ(DL2, Builder.getCurrentDebugLocation());
366   auto Call2 = Builder.CreateCall(Callee, None);
367   EXPECT_EQ(DL2, Call2->getDebugLoc());
368 
369   DIB.finalize();
370 }
371 }
372