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