unittests/IR/IRBuilderTest.cpp

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