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