1 //===- llvm/unittest/IR/IRBuilderTest.cpp - IRBuilder tests ---------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "llvm/IR/IRBuilder.h" 10 #include "llvm/IR/BasicBlock.h" 11 #include "llvm/IR/DIBuilder.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 "llvm/IR/Verifier.h" 20 #include "gtest/gtest.h" 21 22 using namespace llvm; 23 24 namespace { 25 26 class IRBuilderTest : public testing::Test { 27 protected: 28 void SetUp() override { 29 M.reset(new Module("MyModule", Ctx)); 30 FunctionType *FTy = FunctionType::get(Type::getVoidTy(Ctx), 31 /*isVarArg=*/false); 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, nullptr); 36 } 37 38 void TearDown() override { 39 BB = nullptr; 40 M.reset(); 41 } 42 43 LLVMContext Ctx; 44 std::unique_ptr<Module> M; 45 Function *F; 46 BasicBlock *BB; 47 GlobalVariable *GV; 48 }; 49 50 TEST_F(IRBuilderTest, Intrinsics) { 51 IRBuilder<> Builder(BB); 52 Value *V; 53 Instruction *I; 54 CallInst *Call; 55 IntrinsicInst *II; 56 57 V = Builder.CreateLoad(GV->getValueType(), GV); 58 I = cast<Instruction>(Builder.CreateFAdd(V, V)); 59 I->setHasNoInfs(true); 60 I->setHasNoNaNs(false); 61 62 Call = Builder.CreateMinNum(V, V); 63 II = cast<IntrinsicInst>(Call); 64 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::minnum); 65 66 Call = Builder.CreateMaxNum(V, V); 67 II = cast<IntrinsicInst>(Call); 68 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::maxnum); 69 70 Call = Builder.CreateMinimum(V, V); 71 II = cast<IntrinsicInst>(Call); 72 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::minimum); 73 74 Call = Builder.CreateMaximum(V, V); 75 II = cast<IntrinsicInst>(Call); 76 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::maximum); 77 78 Call = Builder.CreateIntrinsic(Intrinsic::readcyclecounter, {}, {}); 79 II = cast<IntrinsicInst>(Call); 80 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::readcyclecounter); 81 82 Call = Builder.CreateUnaryIntrinsic(Intrinsic::fabs, V); 83 II = cast<IntrinsicInst>(Call); 84 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::fabs); 85 EXPECT_FALSE(II->hasNoInfs()); 86 EXPECT_FALSE(II->hasNoNaNs()); 87 88 Call = Builder.CreateUnaryIntrinsic(Intrinsic::fabs, V, I); 89 II = cast<IntrinsicInst>(Call); 90 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::fabs); 91 EXPECT_TRUE(II->hasNoInfs()); 92 EXPECT_FALSE(II->hasNoNaNs()); 93 94 Call = Builder.CreateBinaryIntrinsic(Intrinsic::pow, V, V); 95 II = cast<IntrinsicInst>(Call); 96 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::pow); 97 EXPECT_FALSE(II->hasNoInfs()); 98 EXPECT_FALSE(II->hasNoNaNs()); 99 100 Call = Builder.CreateBinaryIntrinsic(Intrinsic::pow, V, V, I); 101 II = cast<IntrinsicInst>(Call); 102 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::pow); 103 EXPECT_TRUE(II->hasNoInfs()); 104 EXPECT_FALSE(II->hasNoNaNs()); 105 106 Call = Builder.CreateIntrinsic(Intrinsic::fma, {V->getType()}, {V, V, V}); 107 II = cast<IntrinsicInst>(Call); 108 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::fma); 109 EXPECT_FALSE(II->hasNoInfs()); 110 EXPECT_FALSE(II->hasNoNaNs()); 111 112 Call = Builder.CreateIntrinsic(Intrinsic::fma, {V->getType()}, {V, V, V}, I); 113 II = cast<IntrinsicInst>(Call); 114 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::fma); 115 EXPECT_TRUE(II->hasNoInfs()); 116 EXPECT_FALSE(II->hasNoNaNs()); 117 118 Call = Builder.CreateIntrinsic(Intrinsic::fma, {V->getType()}, {V, V, V}, I); 119 II = cast<IntrinsicInst>(Call); 120 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::fma); 121 EXPECT_TRUE(II->hasNoInfs()); 122 EXPECT_FALSE(II->hasNoNaNs()); 123 } 124 125 TEST_F(IRBuilderTest, ConstrainedFP) { 126 IRBuilder<> Builder(BB); 127 Value *V; 128 CallInst *Call; 129 IntrinsicInst *II; 130 131 V = Builder.CreateLoad(GV); 132 133 // See if we get constrained intrinsics instead of non-constrained 134 // instructions. 135 Builder.setIsFPConstrained(true); 136 137 V = Builder.CreateFAdd(V, V); 138 ASSERT_TRUE(isa<IntrinsicInst>(V)); 139 II = cast<IntrinsicInst>(V); 140 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::experimental_constrained_fadd); 141 142 V = Builder.CreateFSub(V, V); 143 ASSERT_TRUE(isa<IntrinsicInst>(V)); 144 II = cast<IntrinsicInst>(V); 145 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::experimental_constrained_fsub); 146 147 V = Builder.CreateFMul(V, V); 148 ASSERT_TRUE(isa<IntrinsicInst>(V)); 149 II = cast<IntrinsicInst>(V); 150 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::experimental_constrained_fmul); 151 152 V = Builder.CreateFDiv(V, V); 153 ASSERT_TRUE(isa<IntrinsicInst>(V)); 154 II = cast<IntrinsicInst>(V); 155 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::experimental_constrained_fdiv); 156 157 V = Builder.CreateFRem(V, V); 158 ASSERT_TRUE(isa<IntrinsicInst>(V)); 159 II = cast<IntrinsicInst>(V); 160 EXPECT_EQ(II->getIntrinsicID(), Intrinsic::experimental_constrained_frem); 161 162 // Verify the codepaths for setting and overriding the default metadata. 163 V = Builder.CreateFAdd(V, V); 164 ASSERT_TRUE(isa<ConstrainedFPIntrinsic>(V)); 165 auto *CII = cast<ConstrainedFPIntrinsic>(V); 166 ASSERT_TRUE(CII->getExceptionBehavior() == ConstrainedFPIntrinsic::ebStrict); 167 ASSERT_TRUE(CII->getRoundingMode() == ConstrainedFPIntrinsic::rmDynamic); 168 169 Builder.setDefaultConstrainedExcept(ConstrainedFPIntrinsic::ebIgnore); 170 Builder.setDefaultConstrainedRounding(ConstrainedFPIntrinsic::rmUpward); 171 V = Builder.CreateFAdd(V, V); 172 CII = cast<ConstrainedFPIntrinsic>(V); 173 ASSERT_TRUE(CII->getExceptionBehavior() == ConstrainedFPIntrinsic::ebIgnore); 174 ASSERT_TRUE(CII->getRoundingMode() == ConstrainedFPIntrinsic::rmUpward); 175 176 // Now override the defaults. 177 Call = Builder.CreateConstrainedFPBinOp( 178 Intrinsic::experimental_constrained_fadd, V, V, nullptr, "", nullptr, 179 ConstrainedFPIntrinsic::rmDownward, ConstrainedFPIntrinsic::ebMayTrap); 180 CII = cast<ConstrainedFPIntrinsic>(Call); 181 EXPECT_EQ(CII->getIntrinsicID(), Intrinsic::experimental_constrained_fadd); 182 ASSERT_TRUE(CII->getExceptionBehavior() == ConstrainedFPIntrinsic::ebMayTrap); 183 ASSERT_TRUE(CII->getRoundingMode() == ConstrainedFPIntrinsic::rmDownward); 184 185 Builder.CreateRetVoid(); 186 EXPECT_FALSE(verifyModule(*M)); 187 } 188 189 TEST_F(IRBuilderTest, Lifetime) { 190 IRBuilder<> Builder(BB); 191 AllocaInst *Var1 = Builder.CreateAlloca(Builder.getInt8Ty()); 192 AllocaInst *Var2 = Builder.CreateAlloca(Builder.getInt32Ty()); 193 AllocaInst *Var3 = Builder.CreateAlloca(Builder.getInt8Ty(), 194 Builder.getInt32(123)); 195 196 CallInst *Start1 = Builder.CreateLifetimeStart(Var1); 197 CallInst *Start2 = Builder.CreateLifetimeStart(Var2); 198 CallInst *Start3 = Builder.CreateLifetimeStart(Var3, Builder.getInt64(100)); 199 200 EXPECT_EQ(Start1->getArgOperand(0), Builder.getInt64(-1)); 201 EXPECT_EQ(Start2->getArgOperand(0), Builder.getInt64(-1)); 202 EXPECT_EQ(Start3->getArgOperand(0), Builder.getInt64(100)); 203 204 EXPECT_EQ(Start1->getArgOperand(1), Var1); 205 EXPECT_NE(Start2->getArgOperand(1), Var2); 206 EXPECT_EQ(Start3->getArgOperand(1), Var3); 207 208 Value *End1 = Builder.CreateLifetimeEnd(Var1); 209 Builder.CreateLifetimeEnd(Var2); 210 Builder.CreateLifetimeEnd(Var3); 211 212 IntrinsicInst *II_Start1 = dyn_cast<IntrinsicInst>(Start1); 213 IntrinsicInst *II_End1 = dyn_cast<IntrinsicInst>(End1); 214 ASSERT_TRUE(II_Start1 != nullptr); 215 EXPECT_EQ(II_Start1->getIntrinsicID(), Intrinsic::lifetime_start); 216 ASSERT_TRUE(II_End1 != nullptr); 217 EXPECT_EQ(II_End1->getIntrinsicID(), Intrinsic::lifetime_end); 218 } 219 220 TEST_F(IRBuilderTest, CreateCondBr) { 221 IRBuilder<> Builder(BB); 222 BasicBlock *TBB = BasicBlock::Create(Ctx, "", F); 223 BasicBlock *FBB = BasicBlock::Create(Ctx, "", F); 224 225 BranchInst *BI = Builder.CreateCondBr(Builder.getTrue(), TBB, FBB); 226 Instruction *TI = BB->getTerminator(); 227 EXPECT_EQ(BI, TI); 228 EXPECT_EQ(2u, TI->getNumSuccessors()); 229 EXPECT_EQ(TBB, TI->getSuccessor(0)); 230 EXPECT_EQ(FBB, TI->getSuccessor(1)); 231 232 BI->eraseFromParent(); 233 MDNode *Weights = MDBuilder(Ctx).createBranchWeights(42, 13); 234 BI = Builder.CreateCondBr(Builder.getTrue(), TBB, FBB, Weights); 235 TI = BB->getTerminator(); 236 EXPECT_EQ(BI, TI); 237 EXPECT_EQ(2u, TI->getNumSuccessors()); 238 EXPECT_EQ(TBB, TI->getSuccessor(0)); 239 EXPECT_EQ(FBB, TI->getSuccessor(1)); 240 EXPECT_EQ(Weights, TI->getMetadata(LLVMContext::MD_prof)); 241 } 242 243 TEST_F(IRBuilderTest, LandingPadName) { 244 IRBuilder<> Builder(BB); 245 LandingPadInst *LP = Builder.CreateLandingPad(Builder.getInt32Ty(), 0, "LP"); 246 EXPECT_EQ(LP->getName(), "LP"); 247 } 248 249 TEST_F(IRBuilderTest, DataLayout) { 250 std::unique_ptr<Module> M(new Module("test", Ctx)); 251 M->setDataLayout("e-n32"); 252 EXPECT_TRUE(M->getDataLayout().isLegalInteger(32)); 253 M->setDataLayout("e"); 254 EXPECT_FALSE(M->getDataLayout().isLegalInteger(32)); 255 } 256 257 TEST_F(IRBuilderTest, GetIntTy) { 258 IRBuilder<> Builder(BB); 259 IntegerType *Ty1 = Builder.getInt1Ty(); 260 EXPECT_EQ(Ty1, IntegerType::get(Ctx, 1)); 261 262 DataLayout* DL = new DataLayout(M.get()); 263 IntegerType *IntPtrTy = Builder.getIntPtrTy(*DL); 264 unsigned IntPtrBitSize = DL->getPointerSizeInBits(0); 265 EXPECT_EQ(IntPtrTy, IntegerType::get(Ctx, IntPtrBitSize)); 266 delete DL; 267 } 268 269 TEST_F(IRBuilderTest, UnaryOperators) { 270 IRBuilder<NoFolder> Builder(BB); 271 Value *V = Builder.CreateLoad(GV->getValueType(), GV); 272 273 // Test CreateUnOp(X) 274 Value *U = Builder.CreateUnOp(Instruction::FNeg, V); 275 ASSERT_TRUE(isa<Instruction>(U)); 276 ASSERT_TRUE(isa<FPMathOperator>(U)); 277 ASSERT_TRUE(isa<UnaryOperator>(U)); 278 ASSERT_FALSE(isa<BinaryOperator>(U)); 279 280 // Test CreateFNegFMF(X) 281 Instruction *I = cast<Instruction>(V); 282 I->setHasNoSignedZeros(true); 283 I->setHasNoNaNs(true); 284 Value *VFMF = Builder.CreateFNegFMF(V, I); 285 Instruction *IFMF = cast<Instruction>(VFMF); 286 EXPECT_TRUE(IFMF->hasNoSignedZeros()); 287 EXPECT_TRUE(IFMF->hasNoNaNs()); 288 EXPECT_FALSE(IFMF->hasAllowReassoc()); 289 } 290 291 TEST_F(IRBuilderTest, FastMathFlags) { 292 IRBuilder<> Builder(BB); 293 Value *F, *FC; 294 Instruction *FDiv, *FAdd, *FCmp, *FCall; 295 296 F = Builder.CreateLoad(GV->getValueType(), GV); 297 F = Builder.CreateFAdd(F, F); 298 299 EXPECT_FALSE(Builder.getFastMathFlags().any()); 300 ASSERT_TRUE(isa<Instruction>(F)); 301 FAdd = cast<Instruction>(F); 302 EXPECT_FALSE(FAdd->hasNoNaNs()); 303 304 FastMathFlags FMF; 305 Builder.setFastMathFlags(FMF); 306 307 // By default, no flags are set. 308 F = Builder.CreateFAdd(F, F); 309 EXPECT_FALSE(Builder.getFastMathFlags().any()); 310 ASSERT_TRUE(isa<Instruction>(F)); 311 FAdd = cast<Instruction>(F); 312 EXPECT_FALSE(FAdd->hasNoNaNs()); 313 EXPECT_FALSE(FAdd->hasNoInfs()); 314 EXPECT_FALSE(FAdd->hasNoSignedZeros()); 315 EXPECT_FALSE(FAdd->hasAllowReciprocal()); 316 EXPECT_FALSE(FAdd->hasAllowContract()); 317 EXPECT_FALSE(FAdd->hasAllowReassoc()); 318 EXPECT_FALSE(FAdd->hasApproxFunc()); 319 320 // Set all flags in the instruction. 321 FAdd->setFast(true); 322 EXPECT_TRUE(FAdd->hasNoNaNs()); 323 EXPECT_TRUE(FAdd->hasNoInfs()); 324 EXPECT_TRUE(FAdd->hasNoSignedZeros()); 325 EXPECT_TRUE(FAdd->hasAllowReciprocal()); 326 EXPECT_TRUE(FAdd->hasAllowContract()); 327 EXPECT_TRUE(FAdd->hasAllowReassoc()); 328 EXPECT_TRUE(FAdd->hasApproxFunc()); 329 330 // All flags are set in the builder. 331 FMF.setFast(); 332 Builder.setFastMathFlags(FMF); 333 334 F = Builder.CreateFAdd(F, F); 335 EXPECT_TRUE(Builder.getFastMathFlags().any()); 336 EXPECT_TRUE(Builder.getFastMathFlags().all()); 337 ASSERT_TRUE(isa<Instruction>(F)); 338 FAdd = cast<Instruction>(F); 339 EXPECT_TRUE(FAdd->hasNoNaNs()); 340 EXPECT_TRUE(FAdd->isFast()); 341 342 // Now, try it with CreateBinOp 343 F = Builder.CreateBinOp(Instruction::FAdd, F, F); 344 EXPECT_TRUE(Builder.getFastMathFlags().any()); 345 ASSERT_TRUE(isa<Instruction>(F)); 346 FAdd = cast<Instruction>(F); 347 EXPECT_TRUE(FAdd->hasNoNaNs()); 348 EXPECT_TRUE(FAdd->isFast()); 349 350 F = Builder.CreateFDiv(F, F); 351 EXPECT_TRUE(Builder.getFastMathFlags().all()); 352 ASSERT_TRUE(isa<Instruction>(F)); 353 FDiv = cast<Instruction>(F); 354 EXPECT_TRUE(FDiv->hasAllowReciprocal()); 355 356 // Clear all FMF in the builder. 357 Builder.clearFastMathFlags(); 358 359 F = Builder.CreateFDiv(F, F); 360 ASSERT_TRUE(isa<Instruction>(F)); 361 FDiv = cast<Instruction>(F); 362 EXPECT_FALSE(FDiv->hasAllowReciprocal()); 363 364 // Try individual flags. 365 FMF.clear(); 366 FMF.setAllowReciprocal(); 367 Builder.setFastMathFlags(FMF); 368 369 F = Builder.CreateFDiv(F, F); 370 EXPECT_TRUE(Builder.getFastMathFlags().any()); 371 EXPECT_TRUE(Builder.getFastMathFlags().AllowReciprocal); 372 ASSERT_TRUE(isa<Instruction>(F)); 373 FDiv = cast<Instruction>(F); 374 EXPECT_TRUE(FDiv->hasAllowReciprocal()); 375 376 Builder.clearFastMathFlags(); 377 378 FC = Builder.CreateFCmpOEQ(F, F); 379 ASSERT_TRUE(isa<Instruction>(FC)); 380 FCmp = cast<Instruction>(FC); 381 EXPECT_FALSE(FCmp->hasAllowReciprocal()); 382 383 FMF.clear(); 384 FMF.setAllowReciprocal(); 385 Builder.setFastMathFlags(FMF); 386 387 FC = Builder.CreateFCmpOEQ(F, F); 388 EXPECT_TRUE(Builder.getFastMathFlags().any()); 389 EXPECT_TRUE(Builder.getFastMathFlags().AllowReciprocal); 390 ASSERT_TRUE(isa<Instruction>(FC)); 391 FCmp = cast<Instruction>(FC); 392 EXPECT_TRUE(FCmp->hasAllowReciprocal()); 393 394 Builder.clearFastMathFlags(); 395 396 // Test FP-contract 397 FC = Builder.CreateFAdd(F, F); 398 ASSERT_TRUE(isa<Instruction>(FC)); 399 FAdd = cast<Instruction>(FC); 400 EXPECT_FALSE(FAdd->hasAllowContract()); 401 402 FMF.clear(); 403 FMF.setAllowContract(true); 404 Builder.setFastMathFlags(FMF); 405 406 FC = Builder.CreateFAdd(F, F); 407 EXPECT_TRUE(Builder.getFastMathFlags().any()); 408 EXPECT_TRUE(Builder.getFastMathFlags().AllowContract); 409 ASSERT_TRUE(isa<Instruction>(FC)); 410 FAdd = cast<Instruction>(FC); 411 EXPECT_TRUE(FAdd->hasAllowContract()); 412 413 FMF.setApproxFunc(); 414 Builder.clearFastMathFlags(); 415 Builder.setFastMathFlags(FMF); 416 // Now 'aml' and 'contract' are set. 417 F = Builder.CreateFMul(F, F); 418 FAdd = cast<Instruction>(F); 419 EXPECT_TRUE(FAdd->hasApproxFunc()); 420 EXPECT_TRUE(FAdd->hasAllowContract()); 421 EXPECT_FALSE(FAdd->hasAllowReassoc()); 422 423 FMF.setAllowReassoc(); 424 Builder.clearFastMathFlags(); 425 Builder.setFastMathFlags(FMF); 426 // Now 'aml' and 'contract' and 'reassoc' are set. 427 F = Builder.CreateFMul(F, F); 428 FAdd = cast<Instruction>(F); 429 EXPECT_TRUE(FAdd->hasApproxFunc()); 430 EXPECT_TRUE(FAdd->hasAllowContract()); 431 EXPECT_TRUE(FAdd->hasAllowReassoc()); 432 433 // Test a call with FMF. 434 auto CalleeTy = FunctionType::get(Type::getFloatTy(Ctx), 435 /*isVarArg=*/false); 436 auto Callee = 437 Function::Create(CalleeTy, Function::ExternalLinkage, "", M.get()); 438 439 FCall = Builder.CreateCall(Callee, None); 440 EXPECT_FALSE(FCall->hasNoNaNs()); 441 442 Function *V = 443 Function::Create(CalleeTy, Function::ExternalLinkage, "", M.get()); 444 FCall = Builder.CreateCall(V, None); 445 EXPECT_FALSE(FCall->hasNoNaNs()); 446 447 FMF.clear(); 448 FMF.setNoNaNs(); 449 Builder.setFastMathFlags(FMF); 450 451 FCall = Builder.CreateCall(Callee, None); 452 EXPECT_TRUE(Builder.getFastMathFlags().any()); 453 EXPECT_TRUE(Builder.getFastMathFlags().NoNaNs); 454 EXPECT_TRUE(FCall->hasNoNaNs()); 455 456 FCall = Builder.CreateCall(V, None); 457 EXPECT_TRUE(Builder.getFastMathFlags().any()); 458 EXPECT_TRUE(Builder.getFastMathFlags().NoNaNs); 459 EXPECT_TRUE(FCall->hasNoNaNs()); 460 461 Builder.clearFastMathFlags(); 462 463 // To test a copy, make sure that a '0' and a '1' change state. 464 F = Builder.CreateFDiv(F, F); 465 ASSERT_TRUE(isa<Instruction>(F)); 466 FDiv = cast<Instruction>(F); 467 EXPECT_FALSE(FDiv->getFastMathFlags().any()); 468 FDiv->setHasAllowReciprocal(true); 469 FAdd->setHasAllowReciprocal(false); 470 FAdd->setHasNoNaNs(true); 471 FDiv->copyFastMathFlags(FAdd); 472 EXPECT_TRUE(FDiv->hasNoNaNs()); 473 EXPECT_FALSE(FDiv->hasAllowReciprocal()); 474 475 } 476 477 TEST_F(IRBuilderTest, WrapFlags) { 478 IRBuilder<NoFolder> Builder(BB); 479 480 // Test instructions. 481 GlobalVariable *G = new GlobalVariable(*M, Builder.getInt32Ty(), true, 482 GlobalValue::ExternalLinkage, nullptr); 483 Value *V = Builder.CreateLoad(G->getValueType(), G); 484 EXPECT_TRUE( 485 cast<BinaryOperator>(Builder.CreateNSWAdd(V, V))->hasNoSignedWrap()); 486 EXPECT_TRUE( 487 cast<BinaryOperator>(Builder.CreateNSWMul(V, V))->hasNoSignedWrap()); 488 EXPECT_TRUE( 489 cast<BinaryOperator>(Builder.CreateNSWSub(V, V))->hasNoSignedWrap()); 490 EXPECT_TRUE(cast<BinaryOperator>( 491 Builder.CreateShl(V, V, "", /* NUW */ false, /* NSW */ true)) 492 ->hasNoSignedWrap()); 493 494 EXPECT_TRUE( 495 cast<BinaryOperator>(Builder.CreateNUWAdd(V, V))->hasNoUnsignedWrap()); 496 EXPECT_TRUE( 497 cast<BinaryOperator>(Builder.CreateNUWMul(V, V))->hasNoUnsignedWrap()); 498 EXPECT_TRUE( 499 cast<BinaryOperator>(Builder.CreateNUWSub(V, V))->hasNoUnsignedWrap()); 500 EXPECT_TRUE(cast<BinaryOperator>( 501 Builder.CreateShl(V, V, "", /* NUW */ true, /* NSW */ false)) 502 ->hasNoUnsignedWrap()); 503 504 // Test operators created with constants. 505 Constant *C = Builder.getInt32(42); 506 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNSWAdd(C, C)) 507 ->hasNoSignedWrap()); 508 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNSWSub(C, C)) 509 ->hasNoSignedWrap()); 510 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNSWMul(C, C)) 511 ->hasNoSignedWrap()); 512 EXPECT_TRUE(cast<OverflowingBinaryOperator>( 513 Builder.CreateShl(C, C, "", /* NUW */ false, /* NSW */ true)) 514 ->hasNoSignedWrap()); 515 516 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNUWAdd(C, C)) 517 ->hasNoUnsignedWrap()); 518 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNUWSub(C, C)) 519 ->hasNoUnsignedWrap()); 520 EXPECT_TRUE(cast<OverflowingBinaryOperator>(Builder.CreateNUWMul(C, C)) 521 ->hasNoUnsignedWrap()); 522 EXPECT_TRUE(cast<OverflowingBinaryOperator>( 523 Builder.CreateShl(C, C, "", /* NUW */ true, /* NSW */ false)) 524 ->hasNoUnsignedWrap()); 525 } 526 527 TEST_F(IRBuilderTest, RAIIHelpersTest) { 528 IRBuilder<> Builder(BB); 529 EXPECT_FALSE(Builder.getFastMathFlags().allowReciprocal()); 530 MDBuilder MDB(M->getContext()); 531 532 MDNode *FPMathA = MDB.createFPMath(0.01f); 533 MDNode *FPMathB = MDB.createFPMath(0.1f); 534 535 Builder.setDefaultFPMathTag(FPMathA); 536 537 { 538 IRBuilder<>::FastMathFlagGuard Guard(Builder); 539 FastMathFlags FMF; 540 FMF.setAllowReciprocal(); 541 Builder.setFastMathFlags(FMF); 542 Builder.setDefaultFPMathTag(FPMathB); 543 EXPECT_TRUE(Builder.getFastMathFlags().allowReciprocal()); 544 EXPECT_EQ(FPMathB, Builder.getDefaultFPMathTag()); 545 } 546 547 EXPECT_FALSE(Builder.getFastMathFlags().allowReciprocal()); 548 EXPECT_EQ(FPMathA, Builder.getDefaultFPMathTag()); 549 550 Value *F = Builder.CreateLoad(GV->getValueType(), GV); 551 552 { 553 IRBuilder<>::InsertPointGuard Guard(Builder); 554 Builder.SetInsertPoint(cast<Instruction>(F)); 555 EXPECT_EQ(F, &*Builder.GetInsertPoint()); 556 } 557 558 EXPECT_EQ(BB->end(), Builder.GetInsertPoint()); 559 EXPECT_EQ(BB, Builder.GetInsertBlock()); 560 } 561 562 TEST_F(IRBuilderTest, createFunction) { 563 IRBuilder<> Builder(BB); 564 DIBuilder DIB(*M); 565 auto File = DIB.createFile("error.swift", "/"); 566 auto CU = 567 DIB.createCompileUnit(dwarf::DW_LANG_Swift, File, "swiftc", true, "", 0); 568 auto Type = DIB.createSubroutineType(DIB.getOrCreateTypeArray(None)); 569 auto NoErr = DIB.createFunction( 570 CU, "noerr", "", File, 1, Type, 1, DINode::FlagZero, 571 DISubprogram::SPFlagDefinition | DISubprogram::SPFlagOptimized); 572 EXPECT_TRUE(!NoErr->getThrownTypes()); 573 auto Int = DIB.createBasicType("Int", 64, dwarf::DW_ATE_signed); 574 auto Error = DIB.getOrCreateArray({Int}); 575 auto Err = DIB.createFunction( 576 CU, "err", "", File, 1, Type, 1, DINode::FlagZero, 577 DISubprogram::SPFlagDefinition | DISubprogram::SPFlagOptimized, nullptr, 578 nullptr, Error.get()); 579 EXPECT_TRUE(Err->getThrownTypes().get() == Error.get()); 580 DIB.finalize(); 581 } 582 583 TEST_F(IRBuilderTest, DIBuilder) { 584 IRBuilder<> Builder(BB); 585 DIBuilder DIB(*M); 586 auto File = DIB.createFile("F.CBL", "/"); 587 auto CU = DIB.createCompileUnit(dwarf::DW_LANG_Cobol74, 588 DIB.createFile("F.CBL", "/"), "llvm-cobol74", 589 true, "", 0); 590 auto Type = DIB.createSubroutineType(DIB.getOrCreateTypeArray(None)); 591 auto SP = DIB.createFunction( 592 CU, "foo", "", File, 1, Type, 1, DINode::FlagZero, 593 DISubprogram::SPFlagDefinition | DISubprogram::SPFlagOptimized); 594 F->setSubprogram(SP); 595 AllocaInst *I = Builder.CreateAlloca(Builder.getInt8Ty()); 596 auto BarSP = DIB.createFunction( 597 CU, "bar", "", File, 1, Type, 1, DINode::FlagZero, 598 DISubprogram::SPFlagDefinition | DISubprogram::SPFlagOptimized); 599 auto BadScope = DIB.createLexicalBlockFile(BarSP, File, 0); 600 I->setDebugLoc(DebugLoc::get(2, 0, BadScope)); 601 DIB.finalize(); 602 EXPECT_TRUE(verifyModule(*M)); 603 } 604 605 TEST_F(IRBuilderTest, createArtificialSubprogram) { 606 IRBuilder<> Builder(BB); 607 DIBuilder DIB(*M); 608 auto File = DIB.createFile("main.c", "/"); 609 auto CU = DIB.createCompileUnit(dwarf::DW_LANG_C, File, "clang", 610 /*isOptimized=*/true, /*Flags=*/"", 611 /*Runtime Version=*/0); 612 auto Type = DIB.createSubroutineType(DIB.getOrCreateTypeArray(None)); 613 auto SP = DIB.createFunction( 614 CU, "foo", /*LinkageName=*/"", File, 615 /*LineNo=*/1, Type, /*ScopeLine=*/2, DINode::FlagZero, 616 DISubprogram::SPFlagDefinition | DISubprogram::SPFlagOptimized); 617 EXPECT_TRUE(SP->isDistinct()); 618 619 F->setSubprogram(SP); 620 AllocaInst *I = Builder.CreateAlloca(Builder.getInt8Ty()); 621 ReturnInst *R = Builder.CreateRetVoid(); 622 I->setDebugLoc(DebugLoc::get(3, 2, SP)); 623 R->setDebugLoc(DebugLoc::get(4, 2, SP)); 624 DIB.finalize(); 625 EXPECT_FALSE(verifyModule(*M)); 626 627 Function *G = Function::Create(F->getFunctionType(), 628 Function::ExternalLinkage, "", M.get()); 629 BasicBlock *GBB = BasicBlock::Create(Ctx, "", G); 630 Builder.SetInsertPoint(GBB); 631 I->removeFromParent(); 632 Builder.Insert(I); 633 Builder.CreateRetVoid(); 634 EXPECT_FALSE(verifyModule(*M)); 635 636 DISubprogram *GSP = DIBuilder::createArtificialSubprogram(F->getSubprogram()); 637 EXPECT_EQ(SP->getFile(), GSP->getFile()); 638 EXPECT_EQ(SP->getType(), GSP->getType()); 639 EXPECT_EQ(SP->getLine(), GSP->getLine()); 640 EXPECT_EQ(SP->getScopeLine(), GSP->getScopeLine()); 641 EXPECT_TRUE(GSP->isDistinct()); 642 643 G->setSubprogram(GSP); 644 EXPECT_TRUE(verifyModule(*M)); 645 646 auto *InlinedAtNode = 647 DILocation::getDistinct(Ctx, GSP->getScopeLine(), 0, GSP); 648 DebugLoc DL = I->getDebugLoc(); 649 DenseMap<const MDNode *, MDNode *> IANodes; 650 auto IA = DebugLoc::appendInlinedAt(DL, InlinedAtNode, Ctx, IANodes); 651 auto NewDL = DebugLoc::get(DL.getLine(), DL.getCol(), DL.getScope(), IA); 652 I->setDebugLoc(NewDL); 653 EXPECT_FALSE(verifyModule(*M)); 654 655 EXPECT_EQ("foo", SP->getName()); 656 EXPECT_EQ("foo", GSP->getName()); 657 EXPECT_FALSE(SP->isArtificial()); 658 EXPECT_TRUE(GSP->isArtificial()); 659 } 660 661 TEST_F(IRBuilderTest, InsertExtractElement) { 662 IRBuilder<> Builder(BB); 663 664 auto VecTy = VectorType::get(Builder.getInt64Ty(), 4); 665 auto Elt1 = Builder.getInt64(-1); 666 auto Elt2 = Builder.getInt64(-2); 667 Value *Vec = UndefValue::get(VecTy); 668 Vec = Builder.CreateInsertElement(Vec, Elt1, Builder.getInt8(1)); 669 Vec = Builder.CreateInsertElement(Vec, Elt2, 2); 670 auto X1 = Builder.CreateExtractElement(Vec, 1); 671 auto X2 = Builder.CreateExtractElement(Vec, Builder.getInt32(2)); 672 EXPECT_EQ(Elt1, X1); 673 EXPECT_EQ(Elt2, X2); 674 } 675 676 TEST_F(IRBuilderTest, CreateGlobalStringPtr) { 677 IRBuilder<> Builder(BB); 678 679 auto String1a = Builder.CreateGlobalStringPtr("TestString", "String1a"); 680 auto String1b = Builder.CreateGlobalStringPtr("TestString", "String1b", 0); 681 auto String2 = Builder.CreateGlobalStringPtr("TestString", "String2", 1); 682 auto String3 = Builder.CreateGlobalString("TestString", "String3", 2); 683 684 EXPECT_TRUE(String1a->getType()->getPointerAddressSpace() == 0); 685 EXPECT_TRUE(String1b->getType()->getPointerAddressSpace() == 0); 686 EXPECT_TRUE(String2->getType()->getPointerAddressSpace() == 1); 687 EXPECT_TRUE(String3->getType()->getPointerAddressSpace() == 2); 688 } 689 690 TEST_F(IRBuilderTest, DebugLoc) { 691 auto CalleeTy = FunctionType::get(Type::getVoidTy(Ctx), 692 /*isVarArg=*/false); 693 auto Callee = 694 Function::Create(CalleeTy, Function::ExternalLinkage, "", M.get()); 695 696 DIBuilder DIB(*M); 697 auto File = DIB.createFile("tmp.cpp", "/"); 698 auto CU = DIB.createCompileUnit(dwarf::DW_LANG_C_plus_plus_11, 699 DIB.createFile("tmp.cpp", "/"), "", true, "", 700 0); 701 auto SPType = DIB.createSubroutineType(DIB.getOrCreateTypeArray(None)); 702 auto SP = 703 DIB.createFunction(CU, "foo", "foo", File, 1, SPType, 1, DINode::FlagZero, 704 DISubprogram::SPFlagDefinition); 705 DebugLoc DL1 = DILocation::get(Ctx, 2, 0, SP); 706 DebugLoc DL2 = DILocation::get(Ctx, 3, 0, SP); 707 708 auto BB2 = BasicBlock::Create(Ctx, "bb2", F); 709 auto Br = BranchInst::Create(BB2, BB); 710 Br->setDebugLoc(DL1); 711 712 IRBuilder<> Builder(Ctx); 713 Builder.SetInsertPoint(Br); 714 EXPECT_EQ(DL1, Builder.getCurrentDebugLocation()); 715 auto Call1 = Builder.CreateCall(Callee, None); 716 EXPECT_EQ(DL1, Call1->getDebugLoc()); 717 718 Call1->setDebugLoc(DL2); 719 Builder.SetInsertPoint(Call1->getParent(), Call1->getIterator()); 720 EXPECT_EQ(DL2, Builder.getCurrentDebugLocation()); 721 auto Call2 = Builder.CreateCall(Callee, None); 722 EXPECT_EQ(DL2, Call2->getDebugLoc()); 723 724 DIB.finalize(); 725 } 726 727 TEST_F(IRBuilderTest, DIImportedEntity) { 728 IRBuilder<> Builder(BB); 729 DIBuilder DIB(*M); 730 auto F = DIB.createFile("F.CBL", "/"); 731 auto CU = DIB.createCompileUnit(dwarf::DW_LANG_Cobol74, 732 F, "llvm-cobol74", 733 true, "", 0); 734 DIB.createImportedDeclaration(CU, nullptr, F, 1); 735 DIB.createImportedDeclaration(CU, nullptr, F, 1); 736 DIB.createImportedModule(CU, (DIImportedEntity *)nullptr, F, 2); 737 DIB.createImportedModule(CU, (DIImportedEntity *)nullptr, F, 2); 738 DIB.finalize(); 739 EXPECT_TRUE(verifyModule(*M)); 740 EXPECT_TRUE(CU->getImportedEntities().size() == 2); 741 } 742 743 // 0: #define M0 V0 <-- command line definition 744 // 0: main.c <-- main file 745 // 3: #define M1 V1 <-- M1 definition in main.c 746 // 5: #include "file.h" <-- inclusion of file.h from main.c 747 // 1: #define M2 <-- M2 definition in file.h with no value 748 // 7: #undef M1 V1 <-- M1 un-definition in main.c 749 TEST_F(IRBuilderTest, DIBuilderMacro) { 750 IRBuilder<> Builder(BB); 751 DIBuilder DIB(*M); 752 auto File1 = DIB.createFile("main.c", "/"); 753 auto File2 = DIB.createFile("file.h", "/"); 754 auto CU = DIB.createCompileUnit( 755 dwarf::DW_LANG_C, DIB.createFile("main.c", "/"), "llvm-c", true, "", 0); 756 auto MDef0 = 757 DIB.createMacro(nullptr, 0, dwarf::DW_MACINFO_define, "M0", "V0"); 758 auto TMF1 = DIB.createTempMacroFile(nullptr, 0, File1); 759 auto MDef1 = DIB.createMacro(TMF1, 3, dwarf::DW_MACINFO_define, "M1", "V1"); 760 auto TMF2 = DIB.createTempMacroFile(TMF1, 5, File2); 761 auto MDef2 = DIB.createMacro(TMF2, 1, dwarf::DW_MACINFO_define, "M2"); 762 auto MUndef1 = DIB.createMacro(TMF1, 7, dwarf::DW_MACINFO_undef, "M1"); 763 764 EXPECT_EQ(dwarf::DW_MACINFO_define, MDef1->getMacinfoType()); 765 EXPECT_EQ(3u, MDef1->getLine()); 766 EXPECT_EQ("M1", MDef1->getName()); 767 EXPECT_EQ("V1", MDef1->getValue()); 768 769 EXPECT_EQ(dwarf::DW_MACINFO_undef, MUndef1->getMacinfoType()); 770 EXPECT_EQ(7u, MUndef1->getLine()); 771 EXPECT_EQ("M1", MUndef1->getName()); 772 EXPECT_EQ("", MUndef1->getValue()); 773 774 EXPECT_EQ(dwarf::DW_MACINFO_start_file, TMF2->getMacinfoType()); 775 EXPECT_EQ(5u, TMF2->getLine()); 776 EXPECT_EQ(File2, TMF2->getFile()); 777 778 DIB.finalize(); 779 780 SmallVector<Metadata *, 4> Elements; 781 Elements.push_back(MDef2); 782 auto MF2 = DIMacroFile::get(Ctx, dwarf::DW_MACINFO_start_file, 5, File2, 783 DIB.getOrCreateMacroArray(Elements)); 784 785 Elements.clear(); 786 Elements.push_back(MDef1); 787 Elements.push_back(MF2); 788 Elements.push_back(MUndef1); 789 auto MF1 = DIMacroFile::get(Ctx, dwarf::DW_MACINFO_start_file, 0, File1, 790 DIB.getOrCreateMacroArray(Elements)); 791 792 Elements.clear(); 793 Elements.push_back(MDef0); 794 Elements.push_back(MF1); 795 auto MN0 = MDTuple::get(Ctx, Elements); 796 EXPECT_EQ(MN0, CU->getRawMacros()); 797 798 Elements.clear(); 799 Elements.push_back(MDef1); 800 Elements.push_back(MF2); 801 Elements.push_back(MUndef1); 802 auto MN1 = MDTuple::get(Ctx, Elements); 803 EXPECT_EQ(MN1, MF1->getRawElements()); 804 805 Elements.clear(); 806 Elements.push_back(MDef2); 807 auto MN2 = MDTuple::get(Ctx, Elements); 808 EXPECT_EQ(MN2, MF2->getRawElements()); 809 EXPECT_TRUE(verifyModule(*M)); 810 } 811 } 812