unittests/Transforms/Utils/Cloning.cpp

   1 //===- Cloning.cpp - Unit tests for the Cloner ----------------------------===//
   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/Transforms/Utils/Cloning.h"
  11 #include "llvm/ADT/ArrayRef.h"
  12 #include "llvm/ADT/STLExtras.h"
  13 #include "llvm/ADT/SmallPtrSet.h"
  14 #include "llvm/IR/Argument.h"
  15 #include "llvm/IR/Constant.h"
  16 #include "llvm/IR/DIBuilder.h"
  17 #include "llvm/IR/DebugInfo.h"
  18 #include "llvm/IR/Function.h"
  19 #include "llvm/IR/IRBuilder.h"
  20 #include "llvm/IR/InstIterator.h"
  21 #include "llvm/IR/Instructions.h"
  22 #include "llvm/IR/IntrinsicInst.h"
  23 #include "llvm/IR/LLVMContext.h"
  24 #include "llvm/IR/Module.h"
  25 #include "llvm/IR/Verifier.h"
  26 #include "gtest/gtest.h"
  27
  28 using namespace llvm;
  29
  30 namespace {
  31
  32 class CloneInstruction : public ::testing::Test {
  33 protected:
  34   void SetUp() override { V = nullptr; }
  35
  36   template <typename T>
  37   T *clone(T *V1) {
  38     Value *V2 = V1->clone();
  39     Orig.insert(V1);
  40     Clones.insert(V2);
  41     return cast<T>(V2);
  42   }
  43
  44   void eraseClones() {
  45     DeleteContainerPointers(Clones);
  46   }
  47
  48   void TearDown() override {
  49     eraseClones();
  50     DeleteContainerPointers(Orig);
  51     delete V;
  52   }
  53
  54   SmallPtrSet<Value *, 4> Orig;   // Erase on exit
  55   SmallPtrSet<Value *, 4> Clones; // Erase in eraseClones
  56
  57   LLVMContext context;
  58   Value *V;
  59 };
  60
  61 TEST_F(CloneInstruction, OverflowBits) {
  62   V = new Argument(Type::getInt32Ty(context));
  63
  64   BinaryOperator *Add = BinaryOperator::Create(Instruction::Add, V, V);
  65   BinaryOperator *Sub = BinaryOperator::Create(Instruction::Sub, V, V);
  66   BinaryOperator *Mul = BinaryOperator::Create(Instruction::Mul, V, V);
  67
  68   BinaryOperator *AddClone = this->clone(Add);
  69   BinaryOperator *SubClone = this->clone(Sub);
  70   BinaryOperator *MulClone = this->clone(Mul);
  71
  72   EXPECT_FALSE(AddClone->hasNoUnsignedWrap());
  73   EXPECT_FALSE(AddClone->hasNoSignedWrap());
  74   EXPECT_FALSE(SubClone->hasNoUnsignedWrap());
  75   EXPECT_FALSE(SubClone->hasNoSignedWrap());
  76   EXPECT_FALSE(MulClone->hasNoUnsignedWrap());
  77   EXPECT_FALSE(MulClone->hasNoSignedWrap());
  78
  79   eraseClones();
  80
  81   Add->setHasNoUnsignedWrap();
  82   Sub->setHasNoUnsignedWrap();
  83   Mul->setHasNoUnsignedWrap();
  84
  85   AddClone = this->clone(Add);
  86   SubClone = this->clone(Sub);
  87   MulClone = this->clone(Mul);
  88
  89   EXPECT_TRUE(AddClone->hasNoUnsignedWrap());
  90   EXPECT_FALSE(AddClone->hasNoSignedWrap());
  91   EXPECT_TRUE(SubClone->hasNoUnsignedWrap());
  92   EXPECT_FALSE(SubClone->hasNoSignedWrap());
  93   EXPECT_TRUE(MulClone->hasNoUnsignedWrap());
  94   EXPECT_FALSE(MulClone->hasNoSignedWrap());
  95
  96   eraseClones();
  97
  98   Add->setHasNoSignedWrap();
  99   Sub->setHasNoSignedWrap();
 100   Mul->setHasNoSignedWrap();
 101
 102   AddClone = this->clone(Add);
 103   SubClone = this->clone(Sub);
 104   MulClone = this->clone(Mul);
 105
 106   EXPECT_TRUE(AddClone->hasNoUnsignedWrap());
 107   EXPECT_TRUE(AddClone->hasNoSignedWrap());
 108   EXPECT_TRUE(SubClone->hasNoUnsignedWrap());
 109   EXPECT_TRUE(SubClone->hasNoSignedWrap());
 110   EXPECT_TRUE(MulClone->hasNoUnsignedWrap());
 111   EXPECT_TRUE(MulClone->hasNoSignedWrap());
 112
 113   eraseClones();
 114
 115   Add->setHasNoUnsignedWrap(false);
 116   Sub->setHasNoUnsignedWrap(false);
 117   Mul->setHasNoUnsignedWrap(false);
 118
 119   AddClone = this->clone(Add);
 120   SubClone = this->clone(Sub);
 121   MulClone = this->clone(Mul);
 122
 123   EXPECT_FALSE(AddClone->hasNoUnsignedWrap());
 124   EXPECT_TRUE(AddClone->hasNoSignedWrap());
 125   EXPECT_FALSE(SubClone->hasNoUnsignedWrap());
 126   EXPECT_TRUE(SubClone->hasNoSignedWrap());
 127   EXPECT_FALSE(MulClone->hasNoUnsignedWrap());
 128   EXPECT_TRUE(MulClone->hasNoSignedWrap());
 129 }
 130
 131 TEST_F(CloneInstruction, Inbounds) {
 132   V = new Argument(Type::getInt32PtrTy(context));
 133
 134   Constant *Z = Constant::getNullValue(Type::getInt32Ty(context));
 135   std::vector<Value *> ops;
 136   ops.push_back(Z);
 137   GetElementPtrInst *GEP =
 138       GetElementPtrInst::Create(Type::getInt32Ty(context), V, ops);
 139   EXPECT_FALSE(this->clone(GEP)->isInBounds());
 140
 141   GEP->setIsInBounds();
 142   EXPECT_TRUE(this->clone(GEP)->isInBounds());
 143 }
 144
 145 TEST_F(CloneInstruction, Exact) {
 146   V = new Argument(Type::getInt32Ty(context));
 147
 148   BinaryOperator *SDiv = BinaryOperator::Create(Instruction::SDiv, V, V);
 149   EXPECT_FALSE(this->clone(SDiv)->isExact());
 150
 151   SDiv->setIsExact(true);
 152   EXPECT_TRUE(this->clone(SDiv)->isExact());
 153 }
 154
 155 TEST_F(CloneInstruction, Attributes) {
 156   Type *ArgTy1[] = { Type::getInt32PtrTy(context) };
 157   FunctionType *FT1 =  FunctionType::get(Type::getVoidTy(context), ArgTy1, false);
 158
 159   Function *F1 = Function::Create(FT1, Function::ExternalLinkage);
 160   BasicBlock *BB = BasicBlock::Create(context, "", F1);
 161   IRBuilder<> Builder(BB);
 162   Builder.CreateRetVoid();
 163
 164   Function *F2 = Function::Create(FT1, Function::ExternalLinkage);
 165
 166   Attribute::AttrKind AK[] = { Attribute::NoCapture };
 167   AttributeSet AS = AttributeSet::get(context, 0, AK);
 168   Argument *A = F1->arg_begin();
 169   A->addAttr(AS);
 170
 171   SmallVector<ReturnInst*, 4> Returns;
 172   ValueToValueMapTy VMap;
 173   VMap[A] = UndefValue::get(A->getType());
 174
 175   CloneFunctionInto(F2, F1, VMap, false, Returns);
 176   EXPECT_FALSE(F2->arg_begin()->hasNoCaptureAttr());
 177
 178   delete F1;
 179   delete F2;
 180 }
 181
 182 TEST_F(CloneInstruction, CallingConvention) {
 183   Type *ArgTy1[] = { Type::getInt32PtrTy(context) };
 184   FunctionType *FT1 =  FunctionType::get(Type::getVoidTy(context), ArgTy1, false);
 185
 186   Function *F1 = Function::Create(FT1, Function::ExternalLinkage);
 187   F1->setCallingConv(CallingConv::Cold);
 188   BasicBlock *BB = BasicBlock::Create(context, "", F1);
 189   IRBuilder<> Builder(BB);
 190   Builder.CreateRetVoid();
 191
 192   Function *F2 = Function::Create(FT1, Function::ExternalLinkage);
 193
 194   SmallVector<ReturnInst*, 4> Returns;
 195   ValueToValueMapTy VMap;
 196   VMap[F1->arg_begin()] = F2->arg_begin();
 197
 198   CloneFunctionInto(F2, F1, VMap, false, Returns);
 199   EXPECT_EQ(CallingConv::Cold, F2->getCallingConv());
 200
 201   delete F1;
 202   delete F2;
 203 }
 204
 205 class CloneFunc : public ::testing::Test {
 206 protected:
 207   void SetUp() override {
 208     SetupModule();
 209     CreateOldFunc();
 210     CreateNewFunc();
 211     SetupFinder();
 212   }
 213
 214   void TearDown() override { delete Finder; }
 215
 216   void SetupModule() {
 217     M = new Module("", C);
 218   }
 219
 220   void CreateOldFunc() {
 221     FunctionType* FuncType = FunctionType::get(Type::getVoidTy(C), false);
 222     OldFunc = Function::Create(FuncType, GlobalValue::PrivateLinkage, "f", M);
 223     CreateOldFunctionBodyAndDI();
 224   }
 225
 226   void CreateOldFunctionBodyAndDI() {
 227     DIBuilder DBuilder(*M);
 228     IRBuilder<> IBuilder(C);
 229
 230     // Function DI
 231     DIFile File = DBuilder.createFile("filename.c", "/file/dir/");
 232     DITypeArray ParamTypes = DBuilder.getOrCreateTypeArray(None);
 233     DICompositeType FuncType = DBuilder.createSubroutineType(File, ParamTypes);
 234     DICompileUnit CU = DBuilder.createCompileUnit(dwarf::DW_LANG_C99,
 235         "filename.c", "/file/dir", "CloneFunc", false, "", 0);
 236
 237     DISubprogram Subprogram = DBuilder.createFunction(CU, "f", "f", File, 4,
 238         FuncType, true, true, 3, 0, false, OldFunc);
 239
 240     // Function body
 241     BasicBlock* Entry = BasicBlock::Create(C, "", OldFunc);
 242     IBuilder.SetInsertPoint(Entry);
 243     DebugLoc Loc = DebugLoc::get(3, 2, Subprogram);
 244     IBuilder.SetCurrentDebugLocation(Loc);
 245     AllocaInst* Alloca = IBuilder.CreateAlloca(IntegerType::getInt32Ty(C));
 246     IBuilder.SetCurrentDebugLocation(DebugLoc::get(4, 2, Subprogram));
 247     Value* AllocaContent = IBuilder.getInt32(1);
 248     Instruction* Store = IBuilder.CreateStore(AllocaContent, Alloca);
 249     IBuilder.SetCurrentDebugLocation(DebugLoc::get(5, 2, Subprogram));
 250     Instruction* Terminator = IBuilder.CreateRetVoid();
 251
 252     // Create a local variable around the alloca
 253     DIType IntType = DBuilder.createBasicType("int", 32, 0,
 254         dwarf::DW_ATE_signed);
 255     DIExpression E = DBuilder.createExpression();
 256     DIVariable Variable = DBuilder.createLocalVariable(
 257       dwarf::DW_TAG_auto_variable, Subprogram, "x", File, 5, IntType, true);
 258     auto *DL = MDLocation::get(Subprogram->getContext(), 5, 0, Subprogram);
 259     DBuilder.insertDeclare(Alloca, Variable, E, DL, Store);
 260     DBuilder.insertDbgValueIntrinsic(AllocaContent, 0, Variable, E, DL,
 261                                      Terminator);
 262     // Finalize the debug info
 263     DBuilder.finalize();
 264
 265
 266     // Create another, empty, compile unit
 267     DIBuilder DBuilder2(*M);
 268     DBuilder2.createCompileUnit(dwarf::DW_LANG_C99,
 269         "extra.c", "/file/dir", "CloneFunc", false, "", 0);
 270     DBuilder2.finalize();
 271   }
 272
 273   void CreateNewFunc() {
 274     ValueToValueMapTy VMap;
 275     NewFunc = CloneFunction(OldFunc, VMap, true, nullptr);
 276     M->getFunctionList().push_back(NewFunc);
 277   }
 278
 279   void SetupFinder() {
 280     Finder = new DebugInfoFinder();
 281     Finder->processModule(*M);
 282   }
 283
 284   LLVMContext C;
 285   Function* OldFunc;
 286   Function* NewFunc;
 287   Module* M;
 288   DebugInfoFinder* Finder;
 289 };
 290
 291 // Test that a new, distinct function was created.
 292 TEST_F(CloneFunc, NewFunctionCreated) {
 293   EXPECT_NE(OldFunc, NewFunc);
 294 }
 295
 296 // Test that a new subprogram entry was added and is pointing to the new
 297 // function, while the original subprogram still points to the old one.
 298 TEST_F(CloneFunc, Subprogram) {
 299   EXPECT_FALSE(verifyModule(*M));
 300
 301   unsigned SubprogramCount = Finder->subprogram_count();
 302   EXPECT_EQ(2U, SubprogramCount);
 303
 304   auto Iter = Finder->subprograms().begin();
 305   DISubprogram Sub1 = cast<MDSubprogram>(*Iter);
 306   Iter++;
 307   DISubprogram Sub2 = cast<MDSubprogram>(*Iter);
 308
 309   EXPECT_TRUE(
 310       (Sub1->getFunction() == OldFunc && Sub2->getFunction() == NewFunc) ||
 311       (Sub1->getFunction() == NewFunc && Sub2->getFunction() == OldFunc));
 312 }
 313
 314 // Test that the new subprogram entry was not added to the CU which doesn't
 315 // contain the old subprogram entry.
 316 TEST_F(CloneFunc, SubprogramInRightCU) {
 317   EXPECT_FALSE(verifyModule(*M));
 318
 319   EXPECT_EQ(2U, Finder->compile_unit_count());
 320
 321   auto Iter = Finder->compile_units().begin();
 322   DICompileUnit CU1 = cast<MDCompileUnit>(*Iter);
 323   Iter++;
 324   DICompileUnit CU2 = cast<MDCompileUnit>(*Iter);
 325   EXPECT_TRUE(CU1.getSubprograms().size() == 0 ||
 326               CU2.getSubprograms().size() == 0);
 327 }
 328
 329 // Test that instructions in the old function still belong to it in the
 330 // metadata, while instruction in the new function belong to the new one.
 331 TEST_F(CloneFunc, InstructionOwnership) {
 332   EXPECT_FALSE(verifyModule(*M));
 333
 334   inst_iterator OldIter = inst_begin(OldFunc);
 335   inst_iterator OldEnd = inst_end(OldFunc);
 336   inst_iterator NewIter = inst_begin(NewFunc);
 337   inst_iterator NewEnd = inst_end(NewFunc);
 338   while (OldIter != OldEnd && NewIter != NewEnd) {
 339     Instruction& OldI = *OldIter;
 340     Instruction& NewI = *NewIter;
 341     EXPECT_NE(&OldI, &NewI);
 342
 343     EXPECT_EQ(OldI.hasMetadata(), NewI.hasMetadata());
 344     if (OldI.hasMetadata()) {
 345       const DebugLoc& OldDL = OldI.getDebugLoc();
 346       const DebugLoc& NewDL = NewI.getDebugLoc();
 347
 348       // Verify that the debug location data is the same
 349       EXPECT_EQ(OldDL.getLine(), NewDL.getLine());
 350       EXPECT_EQ(OldDL.getCol(), NewDL.getCol());
 351
 352       // But that they belong to different functions
 353       auto *OldSubprogram = cast<MDSubprogram>(OldDL.getScope());
 354       auto *NewSubprogram = cast<MDSubprogram>(NewDL.getScope());
 355       EXPECT_EQ(OldFunc, OldSubprogram->getFunction());
 356       EXPECT_EQ(NewFunc, NewSubprogram->getFunction());
 357     }
 358
 359     ++OldIter;
 360     ++NewIter;
 361   }
 362   EXPECT_EQ(OldEnd, OldIter);
 363   EXPECT_EQ(NewEnd, NewIter);
 364 }
 365
 366 // Test that the arguments for debug intrinsics in the new function were
 367 // properly cloned
 368 TEST_F(CloneFunc, DebugIntrinsics) {
 369   EXPECT_FALSE(verifyModule(*M));
 370
 371   inst_iterator OldIter = inst_begin(OldFunc);
 372   inst_iterator OldEnd = inst_end(OldFunc);
 373   inst_iterator NewIter = inst_begin(NewFunc);
 374   inst_iterator NewEnd = inst_end(NewFunc);
 375   while (OldIter != OldEnd && NewIter != NewEnd) {
 376     Instruction& OldI = *OldIter;
 377     Instruction& NewI = *NewIter;
 378     if (DbgDeclareInst* OldIntrin = dyn_cast<DbgDeclareInst>(&OldI)) {
 379       DbgDeclareInst* NewIntrin = dyn_cast<DbgDeclareInst>(&NewI);
 380       EXPECT_TRUE(NewIntrin);
 381
 382       // Old address must belong to the old function
 383       EXPECT_EQ(OldFunc, cast<AllocaInst>(OldIntrin->getAddress())->
 384                          getParent()->getParent());
 385       // New address must belong to the new function
 386       EXPECT_EQ(NewFunc, cast<AllocaInst>(NewIntrin->getAddress())->
 387                          getParent()->getParent());
 388
 389       // Old variable must belong to the old function
 390       EXPECT_EQ(OldFunc,
 391                 cast<MDSubprogram>(OldIntrin->getVariable()->getScope())
 392                     ->getFunction());
 393       // New variable must belong to the New function
 394       EXPECT_EQ(NewFunc,
 395                 cast<MDSubprogram>(NewIntrin->getVariable()->getScope())
 396                     ->getFunction());
 397     } else if (DbgValueInst* OldIntrin = dyn_cast<DbgValueInst>(&OldI)) {
 398       DbgValueInst* NewIntrin = dyn_cast<DbgValueInst>(&NewI);
 399       EXPECT_TRUE(NewIntrin);
 400
 401       // Old variable must belong to the old function
 402       EXPECT_EQ(OldFunc,
 403                 cast<MDSubprogram>(OldIntrin->getVariable()->getScope())
 404                     ->getFunction());
 405       // New variable must belong to the New function
 406       EXPECT_EQ(NewFunc,
 407                 cast<MDSubprogram>(NewIntrin->getVariable()->getScope())
 408                     ->getFunction());
 409     }
 410
 411     ++OldIter;
 412     ++NewIter;
 413   }
 414 }
 415
 416 }