1 //===- unittests/IR/MetadataTest.cpp - Metadata unit 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/Metadata.h" 11 #include "llvm/ADT/STLExtras.h" 12 #include "llvm/IR/Constants.h" 13 #include "llvm/IR/DebugInfo.h" 14 #include "llvm/IR/DebugInfoMetadata.h" 15 #include "llvm/IR/Function.h" 16 #include "llvm/IR/Instructions.h" 17 #include "llvm/IR/LLVMContext.h" 18 #include "llvm/IR/Module.h" 19 #include "llvm/IR/ModuleSlotTracker.h" 20 #include "llvm/IR/Type.h" 21 #include "llvm/IR/Verifier.h" 22 #include "llvm/Support/raw_ostream.h" 23 #include "gtest/gtest.h" 24 using namespace llvm; 25 26 namespace { 27 28 TEST(ContextAndReplaceableUsesTest, FromContext) { 29 LLVMContext Context; 30 ContextAndReplaceableUses CRU(Context); 31 EXPECT_EQ(&Context, &CRU.getContext()); 32 EXPECT_FALSE(CRU.hasReplaceableUses()); 33 EXPECT_FALSE(CRU.getReplaceableUses()); 34 } 35 36 TEST(ContextAndReplaceableUsesTest, FromReplaceableUses) { 37 LLVMContext Context; 38 ContextAndReplaceableUses CRU(make_unique<ReplaceableMetadataImpl>(Context)); 39 EXPECT_EQ(&Context, &CRU.getContext()); 40 EXPECT_TRUE(CRU.hasReplaceableUses()); 41 EXPECT_TRUE(CRU.getReplaceableUses()); 42 } 43 44 TEST(ContextAndReplaceableUsesTest, makeReplaceable) { 45 LLVMContext Context; 46 ContextAndReplaceableUses CRU(Context); 47 CRU.makeReplaceable(make_unique<ReplaceableMetadataImpl>(Context)); 48 EXPECT_EQ(&Context, &CRU.getContext()); 49 EXPECT_TRUE(CRU.hasReplaceableUses()); 50 EXPECT_TRUE(CRU.getReplaceableUses()); 51 } 52 53 TEST(ContextAndReplaceableUsesTest, takeReplaceableUses) { 54 LLVMContext Context; 55 auto ReplaceableUses = make_unique<ReplaceableMetadataImpl>(Context); 56 auto *Ptr = ReplaceableUses.get(); 57 ContextAndReplaceableUses CRU(std::move(ReplaceableUses)); 58 ReplaceableUses = CRU.takeReplaceableUses(); 59 EXPECT_EQ(&Context, &CRU.getContext()); 60 EXPECT_FALSE(CRU.hasReplaceableUses()); 61 EXPECT_FALSE(CRU.getReplaceableUses()); 62 EXPECT_EQ(Ptr, ReplaceableUses.get()); 63 } 64 65 class MetadataTest : public testing::Test { 66 public: 67 MetadataTest() : M("test", Context), Counter(0) {} 68 69 protected: 70 LLVMContext Context; 71 Module M; 72 int Counter; 73 74 MDNode *getNode() { return MDNode::get(Context, None); } 75 MDNode *getNode(Metadata *MD) { return MDNode::get(Context, MD); } 76 MDNode *getNode(Metadata *MD1, Metadata *MD2) { 77 Metadata *MDs[] = {MD1, MD2}; 78 return MDNode::get(Context, MDs); 79 } 80 81 MDTuple *getTuple() { return MDTuple::getDistinct(Context, None); } 82 DISubroutineType *getSubroutineType() { 83 return DISubroutineType::getDistinct(Context, DINode::FlagZero, 0, 84 getNode(nullptr)); 85 } 86 DISubprogram *getSubprogram() { 87 return DISubprogram::getDistinct(Context, nullptr, "", "", nullptr, 0, 88 nullptr, false, false, 0, nullptr, 0, 0, 0, 89 DINode::FlagZero, false, nullptr); 90 } 91 DIFile *getFile() { 92 return DIFile::getDistinct(Context, "file.c", "/path/to/dir"); 93 } 94 DICompileUnit *getUnit() { 95 return DICompileUnit::getDistinct( 96 Context, 1, getFile(), "clang", false, "-g", 2, "", 97 DICompileUnit::FullDebug, getTuple(), getTuple(), getTuple(), 98 getTuple(), getTuple(), 0, true, false, false); 99 } 100 DIType *getBasicType(StringRef Name) { 101 return DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type, Name); 102 } 103 DIType *getDerivedType() { 104 return DIDerivedType::getDistinct( 105 Context, dwarf::DW_TAG_pointer_type, "", nullptr, 0, nullptr, 106 getBasicType("basictype"), 1, 2, 0, None, DINode::FlagZero); 107 } 108 Constant *getConstant() { 109 return ConstantInt::get(Type::getInt32Ty(Context), Counter++); 110 } 111 ConstantAsMetadata *getConstantAsMetadata() { 112 return ConstantAsMetadata::get(getConstant()); 113 } 114 DIType *getCompositeType() { 115 return DICompositeType::getDistinct( 116 Context, dwarf::DW_TAG_structure_type, "", nullptr, 0, nullptr, nullptr, 117 32, 32, 0, DINode::FlagZero, nullptr, 0, nullptr, nullptr, ""); 118 } 119 Function *getFunction(StringRef Name) { 120 return cast<Function>(M.getOrInsertFunction( 121 Name, FunctionType::get(Type::getVoidTy(Context), None, false))); 122 } 123 }; 124 typedef MetadataTest MDStringTest; 125 126 // Test that construction of MDString with different value produces different 127 // MDString objects, even with the same string pointer and nulls in the string. 128 TEST_F(MDStringTest, CreateDifferent) { 129 char x[3] = { 'f', 0, 'A' }; 130 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3)); 131 x[2] = 'B'; 132 MDString *s2 = MDString::get(Context, StringRef(&x[0], 3)); 133 EXPECT_NE(s1, s2); 134 } 135 136 // Test that creation of MDStrings with the same string contents produces the 137 // same MDString object, even with different pointers. 138 TEST_F(MDStringTest, CreateSame) { 139 char x[4] = { 'a', 'b', 'c', 'X' }; 140 char y[4] = { 'a', 'b', 'c', 'Y' }; 141 142 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3)); 143 MDString *s2 = MDString::get(Context, StringRef(&y[0], 3)); 144 EXPECT_EQ(s1, s2); 145 } 146 147 // Test that MDString prints out the string we fed it. 148 TEST_F(MDStringTest, PrintingSimple) { 149 char *str = new char[13]; 150 strncpy(str, "testing 1 2 3", 13); 151 MDString *s = MDString::get(Context, StringRef(str, 13)); 152 strncpy(str, "aaaaaaaaaaaaa", 13); 153 delete[] str; 154 155 std::string Str; 156 raw_string_ostream oss(Str); 157 s->print(oss); 158 EXPECT_STREQ("!\"testing 1 2 3\"", oss.str().c_str()); 159 } 160 161 // Test printing of MDString with non-printable characters. 162 TEST_F(MDStringTest, PrintingComplex) { 163 char str[5] = {0, '\n', '"', '\\', (char)-1}; 164 MDString *s = MDString::get(Context, StringRef(str+0, 5)); 165 std::string Str; 166 raw_string_ostream oss(Str); 167 s->print(oss); 168 EXPECT_STREQ("!\"\\00\\0A\\22\\5C\\FF\"", oss.str().c_str()); 169 } 170 171 typedef MetadataTest MDNodeTest; 172 173 // Test the two constructors, and containing other Constants. 174 TEST_F(MDNodeTest, Simple) { 175 char x[3] = { 'a', 'b', 'c' }; 176 char y[3] = { '1', '2', '3' }; 177 178 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3)); 179 MDString *s2 = MDString::get(Context, StringRef(&y[0], 3)); 180 ConstantAsMetadata *CI = 181 ConstantAsMetadata::get(ConstantInt::get(Context, APInt(8, 0))); 182 183 std::vector<Metadata *> V; 184 V.push_back(s1); 185 V.push_back(CI); 186 V.push_back(s2); 187 188 MDNode *n1 = MDNode::get(Context, V); 189 Metadata *const c1 = n1; 190 MDNode *n2 = MDNode::get(Context, c1); 191 Metadata *const c2 = n2; 192 MDNode *n3 = MDNode::get(Context, V); 193 MDNode *n4 = MDNode::getIfExists(Context, V); 194 MDNode *n5 = MDNode::getIfExists(Context, c1); 195 MDNode *n6 = MDNode::getIfExists(Context, c2); 196 EXPECT_NE(n1, n2); 197 EXPECT_EQ(n1, n3); 198 EXPECT_EQ(n4, n1); 199 EXPECT_EQ(n5, n2); 200 EXPECT_EQ(n6, (Metadata *)nullptr); 201 202 EXPECT_EQ(3u, n1->getNumOperands()); 203 EXPECT_EQ(s1, n1->getOperand(0)); 204 EXPECT_EQ(CI, n1->getOperand(1)); 205 EXPECT_EQ(s2, n1->getOperand(2)); 206 207 EXPECT_EQ(1u, n2->getNumOperands()); 208 EXPECT_EQ(n1, n2->getOperand(0)); 209 } 210 211 TEST_F(MDNodeTest, Delete) { 212 Constant *C = ConstantInt::get(Type::getInt32Ty(Context), 1); 213 Instruction *I = new BitCastInst(C, Type::getInt32Ty(Context)); 214 215 Metadata *const V = LocalAsMetadata::get(I); 216 MDNode *n = MDNode::get(Context, V); 217 TrackingMDRef wvh(n); 218 219 EXPECT_EQ(n, wvh); 220 221 I->deleteValue(); 222 } 223 224 TEST_F(MDNodeTest, SelfReference) { 225 // !0 = !{!0} 226 // !1 = !{!0} 227 { 228 auto Temp = MDNode::getTemporary(Context, None); 229 Metadata *Args[] = {Temp.get()}; 230 MDNode *Self = MDNode::get(Context, Args); 231 Self->replaceOperandWith(0, Self); 232 ASSERT_EQ(Self, Self->getOperand(0)); 233 234 // Self-references should be distinct, so MDNode::get() should grab a 235 // uniqued node that references Self, not Self. 236 Args[0] = Self; 237 MDNode *Ref1 = MDNode::get(Context, Args); 238 MDNode *Ref2 = MDNode::get(Context, Args); 239 EXPECT_NE(Self, Ref1); 240 EXPECT_EQ(Ref1, Ref2); 241 } 242 243 // !0 = !{!0, !{}} 244 // !1 = !{!0, !{}} 245 { 246 auto Temp = MDNode::getTemporary(Context, None); 247 Metadata *Args[] = {Temp.get(), MDNode::get(Context, None)}; 248 MDNode *Self = MDNode::get(Context, Args); 249 Self->replaceOperandWith(0, Self); 250 ASSERT_EQ(Self, Self->getOperand(0)); 251 252 // Self-references should be distinct, so MDNode::get() should grab a 253 // uniqued node that references Self, not Self itself. 254 Args[0] = Self; 255 MDNode *Ref1 = MDNode::get(Context, Args); 256 MDNode *Ref2 = MDNode::get(Context, Args); 257 EXPECT_NE(Self, Ref1); 258 EXPECT_EQ(Ref1, Ref2); 259 } 260 } 261 262 TEST_F(MDNodeTest, Print) { 263 Constant *C = ConstantInt::get(Type::getInt32Ty(Context), 7); 264 MDString *S = MDString::get(Context, "foo"); 265 MDNode *N0 = getNode(); 266 MDNode *N1 = getNode(N0); 267 MDNode *N2 = getNode(N0, N1); 268 269 Metadata *Args[] = {ConstantAsMetadata::get(C), S, nullptr, N0, N1, N2}; 270 MDNode *N = MDNode::get(Context, Args); 271 272 std::string Expected; 273 { 274 raw_string_ostream OS(Expected); 275 OS << "<" << (void *)N << "> = !{"; 276 C->printAsOperand(OS); 277 OS << ", "; 278 S->printAsOperand(OS); 279 OS << ", null"; 280 MDNode *Nodes[] = {N0, N1, N2}; 281 for (auto *Node : Nodes) 282 OS << ", <" << (void *)Node << ">"; 283 OS << "}"; 284 } 285 286 std::string Actual; 287 { 288 raw_string_ostream OS(Actual); 289 N->print(OS); 290 } 291 292 EXPECT_EQ(Expected, Actual); 293 } 294 295 #define EXPECT_PRINTER_EQ(EXPECTED, PRINT) \ 296 do { \ 297 std::string Actual_; \ 298 raw_string_ostream OS(Actual_); \ 299 PRINT; \ 300 OS.flush(); \ 301 std::string Expected_(EXPECTED); \ 302 EXPECT_EQ(Expected_, Actual_); \ 303 } while (false) 304 305 TEST_F(MDNodeTest, PrintTemporary) { 306 MDNode *Arg = getNode(); 307 TempMDNode Temp = MDNode::getTemporary(Context, Arg); 308 MDNode *N = getNode(Temp.get()); 309 Module M("test", Context); 310 NamedMDNode *NMD = M.getOrInsertNamedMetadata("named"); 311 NMD->addOperand(N); 312 313 EXPECT_PRINTER_EQ("!0 = !{!1}", N->print(OS, &M)); 314 EXPECT_PRINTER_EQ("!1 = <temporary!> !{!2}", Temp->print(OS, &M)); 315 EXPECT_PRINTER_EQ("!2 = !{}", Arg->print(OS, &M)); 316 317 // Cleanup. 318 Temp->replaceAllUsesWith(Arg); 319 } 320 321 TEST_F(MDNodeTest, PrintFromModule) { 322 Constant *C = ConstantInt::get(Type::getInt32Ty(Context), 7); 323 MDString *S = MDString::get(Context, "foo"); 324 MDNode *N0 = getNode(); 325 MDNode *N1 = getNode(N0); 326 MDNode *N2 = getNode(N0, N1); 327 328 Metadata *Args[] = {ConstantAsMetadata::get(C), S, nullptr, N0, N1, N2}; 329 MDNode *N = MDNode::get(Context, Args); 330 Module M("test", Context); 331 NamedMDNode *NMD = M.getOrInsertNamedMetadata("named"); 332 NMD->addOperand(N); 333 334 std::string Expected; 335 { 336 raw_string_ostream OS(Expected); 337 OS << "!0 = !{"; 338 C->printAsOperand(OS); 339 OS << ", "; 340 S->printAsOperand(OS); 341 OS << ", null, !1, !2, !3}"; 342 } 343 344 EXPECT_PRINTER_EQ(Expected, N->print(OS, &M)); 345 } 346 347 TEST_F(MDNodeTest, PrintFromFunction) { 348 Module M("test", Context); 349 auto *FTy = FunctionType::get(Type::getVoidTy(Context), false); 350 auto *F0 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F0", &M); 351 auto *F1 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F1", &M); 352 auto *BB0 = BasicBlock::Create(Context, "entry", F0); 353 auto *BB1 = BasicBlock::Create(Context, "entry", F1); 354 auto *R0 = ReturnInst::Create(Context, BB0); 355 auto *R1 = ReturnInst::Create(Context, BB1); 356 auto *N0 = MDNode::getDistinct(Context, None); 357 auto *N1 = MDNode::getDistinct(Context, None); 358 R0->setMetadata("md", N0); 359 R1->setMetadata("md", N1); 360 361 EXPECT_PRINTER_EQ("!0 = distinct !{}", N0->print(OS, &M)); 362 EXPECT_PRINTER_EQ("!1 = distinct !{}", N1->print(OS, &M)); 363 364 ModuleSlotTracker MST(&M); 365 EXPECT_PRINTER_EQ("!0 = distinct !{}", N0->print(OS, MST)); 366 EXPECT_PRINTER_EQ("!1 = distinct !{}", N1->print(OS, MST)); 367 } 368 369 TEST_F(MDNodeTest, PrintFromMetadataAsValue) { 370 Module M("test", Context); 371 372 auto *Intrinsic = 373 Function::Create(FunctionType::get(Type::getVoidTy(Context), 374 Type::getMetadataTy(Context), false), 375 GlobalValue::ExternalLinkage, "llvm.intrinsic", &M); 376 377 auto *FTy = FunctionType::get(Type::getVoidTy(Context), false); 378 auto *F0 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F0", &M); 379 auto *F1 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F1", &M); 380 auto *BB0 = BasicBlock::Create(Context, "entry", F0); 381 auto *BB1 = BasicBlock::Create(Context, "entry", F1); 382 auto *N0 = MDNode::getDistinct(Context, None); 383 auto *N1 = MDNode::getDistinct(Context, None); 384 auto *MAV0 = MetadataAsValue::get(Context, N0); 385 auto *MAV1 = MetadataAsValue::get(Context, N1); 386 CallInst::Create(Intrinsic, MAV0, "", BB0); 387 CallInst::Create(Intrinsic, MAV1, "", BB1); 388 389 EXPECT_PRINTER_EQ("!0 = distinct !{}", MAV0->print(OS)); 390 EXPECT_PRINTER_EQ("!1 = distinct !{}", MAV1->print(OS)); 391 EXPECT_PRINTER_EQ("!0", MAV0->printAsOperand(OS, false)); 392 EXPECT_PRINTER_EQ("!1", MAV1->printAsOperand(OS, false)); 393 EXPECT_PRINTER_EQ("metadata !0", MAV0->printAsOperand(OS, true)); 394 EXPECT_PRINTER_EQ("metadata !1", MAV1->printAsOperand(OS, true)); 395 396 ModuleSlotTracker MST(&M); 397 EXPECT_PRINTER_EQ("!0 = distinct !{}", MAV0->print(OS, MST)); 398 EXPECT_PRINTER_EQ("!1 = distinct !{}", MAV1->print(OS, MST)); 399 EXPECT_PRINTER_EQ("!0", MAV0->printAsOperand(OS, false, MST)); 400 EXPECT_PRINTER_EQ("!1", MAV1->printAsOperand(OS, false, MST)); 401 EXPECT_PRINTER_EQ("metadata !0", MAV0->printAsOperand(OS, true, MST)); 402 EXPECT_PRINTER_EQ("metadata !1", MAV1->printAsOperand(OS, true, MST)); 403 } 404 #undef EXPECT_PRINTER_EQ 405 406 TEST_F(MDNodeTest, NullOperand) { 407 // metadata !{} 408 MDNode *Empty = MDNode::get(Context, None); 409 410 // metadata !{metadata !{}} 411 Metadata *Ops[] = {Empty}; 412 MDNode *N = MDNode::get(Context, Ops); 413 ASSERT_EQ(Empty, N->getOperand(0)); 414 415 // metadata !{metadata !{}} => metadata !{null} 416 N->replaceOperandWith(0, nullptr); 417 ASSERT_EQ(nullptr, N->getOperand(0)); 418 419 // metadata !{null} 420 Ops[0] = nullptr; 421 MDNode *NullOp = MDNode::get(Context, Ops); 422 ASSERT_EQ(nullptr, NullOp->getOperand(0)); 423 EXPECT_EQ(N, NullOp); 424 } 425 426 TEST_F(MDNodeTest, DistinctOnUniquingCollision) { 427 // !{} 428 MDNode *Empty = MDNode::get(Context, None); 429 ASSERT_TRUE(Empty->isResolved()); 430 EXPECT_FALSE(Empty->isDistinct()); 431 432 // !{!{}} 433 Metadata *Wrapped1Ops[] = {Empty}; 434 MDNode *Wrapped1 = MDNode::get(Context, Wrapped1Ops); 435 ASSERT_EQ(Empty, Wrapped1->getOperand(0)); 436 ASSERT_TRUE(Wrapped1->isResolved()); 437 EXPECT_FALSE(Wrapped1->isDistinct()); 438 439 // !{!{!{}}} 440 Metadata *Wrapped2Ops[] = {Wrapped1}; 441 MDNode *Wrapped2 = MDNode::get(Context, Wrapped2Ops); 442 ASSERT_EQ(Wrapped1, Wrapped2->getOperand(0)); 443 ASSERT_TRUE(Wrapped2->isResolved()); 444 EXPECT_FALSE(Wrapped2->isDistinct()); 445 446 // !{!{!{}}} => !{!{}} 447 Wrapped2->replaceOperandWith(0, Empty); 448 ASSERT_EQ(Empty, Wrapped2->getOperand(0)); 449 EXPECT_TRUE(Wrapped2->isDistinct()); 450 EXPECT_FALSE(Wrapped1->isDistinct()); 451 } 452 453 TEST_F(MDNodeTest, UniquedOnDeletedOperand) { 454 // temp !{} 455 TempMDTuple T = MDTuple::getTemporary(Context, None); 456 457 // !{temp !{}} 458 Metadata *Ops[] = {T.get()}; 459 MDTuple *N = MDTuple::get(Context, Ops); 460 461 // !{temp !{}} => !{null} 462 T.reset(); 463 ASSERT_TRUE(N->isUniqued()); 464 Metadata *NullOps[] = {nullptr}; 465 ASSERT_EQ(N, MDTuple::get(Context, NullOps)); 466 } 467 468 TEST_F(MDNodeTest, DistinctOnDeletedValueOperand) { 469 // i1* @GV 470 Type *Ty = Type::getInt1PtrTy(Context); 471 std::unique_ptr<GlobalVariable> GV( 472 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 473 ConstantAsMetadata *Op = ConstantAsMetadata::get(GV.get()); 474 475 // !{i1* @GV} 476 Metadata *Ops[] = {Op}; 477 MDTuple *N = MDTuple::get(Context, Ops); 478 479 // !{i1* @GV} => !{null} 480 GV.reset(); 481 ASSERT_TRUE(N->isDistinct()); 482 ASSERT_EQ(nullptr, N->getOperand(0)); 483 Metadata *NullOps[] = {nullptr}; 484 ASSERT_NE(N, MDTuple::get(Context, NullOps)); 485 } 486 487 TEST_F(MDNodeTest, getDistinct) { 488 // !{} 489 MDNode *Empty = MDNode::get(Context, None); 490 ASSERT_TRUE(Empty->isResolved()); 491 ASSERT_FALSE(Empty->isDistinct()); 492 ASSERT_EQ(Empty, MDNode::get(Context, None)); 493 494 // distinct !{} 495 MDNode *Distinct1 = MDNode::getDistinct(Context, None); 496 MDNode *Distinct2 = MDNode::getDistinct(Context, None); 497 EXPECT_TRUE(Distinct1->isResolved()); 498 EXPECT_TRUE(Distinct2->isDistinct()); 499 EXPECT_NE(Empty, Distinct1); 500 EXPECT_NE(Empty, Distinct2); 501 EXPECT_NE(Distinct1, Distinct2); 502 503 // !{} 504 ASSERT_EQ(Empty, MDNode::get(Context, None)); 505 } 506 507 TEST_F(MDNodeTest, isUniqued) { 508 MDNode *U = MDTuple::get(Context, None); 509 MDNode *D = MDTuple::getDistinct(Context, None); 510 auto T = MDTuple::getTemporary(Context, None); 511 EXPECT_TRUE(U->isUniqued()); 512 EXPECT_FALSE(D->isUniqued()); 513 EXPECT_FALSE(T->isUniqued()); 514 } 515 516 TEST_F(MDNodeTest, isDistinct) { 517 MDNode *U = MDTuple::get(Context, None); 518 MDNode *D = MDTuple::getDistinct(Context, None); 519 auto T = MDTuple::getTemporary(Context, None); 520 EXPECT_FALSE(U->isDistinct()); 521 EXPECT_TRUE(D->isDistinct()); 522 EXPECT_FALSE(T->isDistinct()); 523 } 524 525 TEST_F(MDNodeTest, isTemporary) { 526 MDNode *U = MDTuple::get(Context, None); 527 MDNode *D = MDTuple::getDistinct(Context, None); 528 auto T = MDTuple::getTemporary(Context, None); 529 EXPECT_FALSE(U->isTemporary()); 530 EXPECT_FALSE(D->isTemporary()); 531 EXPECT_TRUE(T->isTemporary()); 532 } 533 534 TEST_F(MDNodeTest, getDistinctWithUnresolvedOperands) { 535 // temporary !{} 536 auto Temp = MDTuple::getTemporary(Context, None); 537 ASSERT_FALSE(Temp->isResolved()); 538 539 // distinct !{temporary !{}} 540 Metadata *Ops[] = {Temp.get()}; 541 MDNode *Distinct = MDNode::getDistinct(Context, Ops); 542 EXPECT_TRUE(Distinct->isResolved()); 543 EXPECT_EQ(Temp.get(), Distinct->getOperand(0)); 544 545 // temporary !{} => !{} 546 MDNode *Empty = MDNode::get(Context, None); 547 Temp->replaceAllUsesWith(Empty); 548 EXPECT_EQ(Empty, Distinct->getOperand(0)); 549 } 550 551 TEST_F(MDNodeTest, handleChangedOperandRecursion) { 552 // !0 = !{} 553 MDNode *N0 = MDNode::get(Context, None); 554 555 // !1 = !{!3, null} 556 auto Temp3 = MDTuple::getTemporary(Context, None); 557 Metadata *Ops1[] = {Temp3.get(), nullptr}; 558 MDNode *N1 = MDNode::get(Context, Ops1); 559 560 // !2 = !{!3, !0} 561 Metadata *Ops2[] = {Temp3.get(), N0}; 562 MDNode *N2 = MDNode::get(Context, Ops2); 563 564 // !3 = !{!2} 565 Metadata *Ops3[] = {N2}; 566 MDNode *N3 = MDNode::get(Context, Ops3); 567 Temp3->replaceAllUsesWith(N3); 568 569 // !4 = !{!1} 570 Metadata *Ops4[] = {N1}; 571 MDNode *N4 = MDNode::get(Context, Ops4); 572 573 // Confirm that the cycle prevented RAUW from getting dropped. 574 EXPECT_TRUE(N0->isResolved()); 575 EXPECT_FALSE(N1->isResolved()); 576 EXPECT_FALSE(N2->isResolved()); 577 EXPECT_FALSE(N3->isResolved()); 578 EXPECT_FALSE(N4->isResolved()); 579 580 // Create a couple of distinct nodes to observe what's going on. 581 // 582 // !5 = distinct !{!2} 583 // !6 = distinct !{!3} 584 Metadata *Ops5[] = {N2}; 585 MDNode *N5 = MDNode::getDistinct(Context, Ops5); 586 Metadata *Ops6[] = {N3}; 587 MDNode *N6 = MDNode::getDistinct(Context, Ops6); 588 589 // Mutate !2 to look like !1, causing a uniquing collision (and an RAUW). 590 // This will ripple up, with !3 colliding with !4, and RAUWing. Since !2 591 // references !3, this can cause a re-entry of handleChangedOperand() when !3 592 // is not ready for it. 593 // 594 // !2->replaceOperandWith(1, nullptr) 595 // !2: !{!3, !0} => !{!3, null} 596 // !2->replaceAllUsesWith(!1) 597 // !3: !{!2] => !{!1} 598 // !3->replaceAllUsesWith(!4) 599 N2->replaceOperandWith(1, nullptr); 600 601 // If all has gone well, N2 and N3 will have been RAUW'ed and deleted from 602 // under us. Just check that the other nodes are sane. 603 // 604 // !1 = !{!4, null} 605 // !4 = !{!1} 606 // !5 = distinct !{!1} 607 // !6 = distinct !{!4} 608 EXPECT_EQ(N4, N1->getOperand(0)); 609 EXPECT_EQ(N1, N4->getOperand(0)); 610 EXPECT_EQ(N1, N5->getOperand(0)); 611 EXPECT_EQ(N4, N6->getOperand(0)); 612 } 613 614 TEST_F(MDNodeTest, replaceResolvedOperand) { 615 // Check code for replacing one resolved operand with another. If doing this 616 // directly (via replaceOperandWith()) becomes illegal, change the operand to 617 // a global value that gets RAUW'ed. 618 // 619 // Use a temporary node to keep N from being resolved. 620 auto Temp = MDTuple::getTemporary(Context, None); 621 Metadata *Ops[] = {nullptr, Temp.get()}; 622 623 MDNode *Empty = MDTuple::get(Context, ArrayRef<Metadata *>()); 624 MDNode *N = MDTuple::get(Context, Ops); 625 EXPECT_EQ(nullptr, N->getOperand(0)); 626 ASSERT_FALSE(N->isResolved()); 627 628 // Check code for replacing resolved nodes. 629 N->replaceOperandWith(0, Empty); 630 EXPECT_EQ(Empty, N->getOperand(0)); 631 632 // Check code for adding another unresolved operand. 633 N->replaceOperandWith(0, Temp.get()); 634 EXPECT_EQ(Temp.get(), N->getOperand(0)); 635 636 // Remove the references to Temp; required for teardown. 637 Temp->replaceAllUsesWith(nullptr); 638 } 639 640 TEST_F(MDNodeTest, replaceWithUniqued) { 641 auto *Empty = MDTuple::get(Context, None); 642 MDTuple *FirstUniqued; 643 { 644 Metadata *Ops[] = {Empty}; 645 auto Temp = MDTuple::getTemporary(Context, Ops); 646 EXPECT_TRUE(Temp->isTemporary()); 647 648 // Don't expect a collision. 649 auto *Current = Temp.get(); 650 FirstUniqued = MDNode::replaceWithUniqued(std::move(Temp)); 651 EXPECT_TRUE(FirstUniqued->isUniqued()); 652 EXPECT_TRUE(FirstUniqued->isResolved()); 653 EXPECT_EQ(Current, FirstUniqued); 654 } 655 { 656 Metadata *Ops[] = {Empty}; 657 auto Temp = MDTuple::getTemporary(Context, Ops); 658 EXPECT_TRUE(Temp->isTemporary()); 659 660 // Should collide with Uniqued above this time. 661 auto *Uniqued = MDNode::replaceWithUniqued(std::move(Temp)); 662 EXPECT_TRUE(Uniqued->isUniqued()); 663 EXPECT_TRUE(Uniqued->isResolved()); 664 EXPECT_EQ(FirstUniqued, Uniqued); 665 } 666 { 667 auto Unresolved = MDTuple::getTemporary(Context, None); 668 Metadata *Ops[] = {Unresolved.get()}; 669 auto Temp = MDTuple::getTemporary(Context, Ops); 670 EXPECT_TRUE(Temp->isTemporary()); 671 672 // Shouldn't be resolved. 673 auto *Uniqued = MDNode::replaceWithUniqued(std::move(Temp)); 674 EXPECT_TRUE(Uniqued->isUniqued()); 675 EXPECT_FALSE(Uniqued->isResolved()); 676 677 // Should be a different node. 678 EXPECT_NE(FirstUniqued, Uniqued); 679 680 // Should resolve when we update its node (note: be careful to avoid a 681 // collision with any other nodes above). 682 Uniqued->replaceOperandWith(0, nullptr); 683 EXPECT_TRUE(Uniqued->isResolved()); 684 } 685 } 686 687 TEST_F(MDNodeTest, replaceWithUniquedResolvingOperand) { 688 // temp !{} 689 MDTuple *Op = MDTuple::getTemporary(Context, None).release(); 690 EXPECT_FALSE(Op->isResolved()); 691 692 // temp !{temp !{}} 693 Metadata *Ops[] = {Op}; 694 MDTuple *N = MDTuple::getTemporary(Context, Ops).release(); 695 EXPECT_FALSE(N->isResolved()); 696 697 // temp !{temp !{}} => !{temp !{}} 698 ASSERT_EQ(N, MDNode::replaceWithUniqued(TempMDTuple(N))); 699 EXPECT_FALSE(N->isResolved()); 700 701 // !{temp !{}} => !{!{}} 702 ASSERT_EQ(Op, MDNode::replaceWithUniqued(TempMDTuple(Op))); 703 EXPECT_TRUE(Op->isResolved()); 704 EXPECT_TRUE(N->isResolved()); 705 } 706 707 TEST_F(MDNodeTest, replaceWithUniquedDeletedOperand) { 708 // i1* @GV 709 Type *Ty = Type::getInt1PtrTy(Context); 710 std::unique_ptr<GlobalVariable> GV( 711 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 712 ConstantAsMetadata *Op = ConstantAsMetadata::get(GV.get()); 713 714 // temp !{i1* @GV} 715 Metadata *Ops[] = {Op}; 716 MDTuple *N = MDTuple::getTemporary(Context, Ops).release(); 717 718 // temp !{i1* @GV} => !{i1* @GV} 719 ASSERT_EQ(N, MDNode::replaceWithUniqued(TempMDTuple(N))); 720 ASSERT_TRUE(N->isUniqued()); 721 722 // !{i1* @GV} => !{null} 723 GV.reset(); 724 ASSERT_TRUE(N->isDistinct()); 725 ASSERT_EQ(nullptr, N->getOperand(0)); 726 Metadata *NullOps[] = {nullptr}; 727 ASSERT_NE(N, MDTuple::get(Context, NullOps)); 728 } 729 730 TEST_F(MDNodeTest, replaceWithUniquedChangedOperand) { 731 // i1* @GV 732 Type *Ty = Type::getInt1PtrTy(Context); 733 std::unique_ptr<GlobalVariable> GV( 734 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 735 ConstantAsMetadata *Op = ConstantAsMetadata::get(GV.get()); 736 737 // temp !{i1* @GV} 738 Metadata *Ops[] = {Op}; 739 MDTuple *N = MDTuple::getTemporary(Context, Ops).release(); 740 741 // temp !{i1* @GV} => !{i1* @GV} 742 ASSERT_EQ(N, MDNode::replaceWithUniqued(TempMDTuple(N))); 743 ASSERT_TRUE(N->isUniqued()); 744 745 // !{i1* @GV} => !{i1* @GV2} 746 std::unique_ptr<GlobalVariable> GV2( 747 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 748 GV->replaceAllUsesWith(GV2.get()); 749 ASSERT_TRUE(N->isUniqued()); 750 Metadata *NullOps[] = {ConstantAsMetadata::get(GV2.get())}; 751 ASSERT_EQ(N, MDTuple::get(Context, NullOps)); 752 } 753 754 TEST_F(MDNodeTest, replaceWithDistinct) { 755 { 756 auto *Empty = MDTuple::get(Context, None); 757 Metadata *Ops[] = {Empty}; 758 auto Temp = MDTuple::getTemporary(Context, Ops); 759 EXPECT_TRUE(Temp->isTemporary()); 760 761 // Don't expect a collision. 762 auto *Current = Temp.get(); 763 auto *Distinct = MDNode::replaceWithDistinct(std::move(Temp)); 764 EXPECT_TRUE(Distinct->isDistinct()); 765 EXPECT_TRUE(Distinct->isResolved()); 766 EXPECT_EQ(Current, Distinct); 767 } 768 { 769 auto Unresolved = MDTuple::getTemporary(Context, None); 770 Metadata *Ops[] = {Unresolved.get()}; 771 auto Temp = MDTuple::getTemporary(Context, Ops); 772 EXPECT_TRUE(Temp->isTemporary()); 773 774 // Don't expect a collision. 775 auto *Current = Temp.get(); 776 auto *Distinct = MDNode::replaceWithDistinct(std::move(Temp)); 777 EXPECT_TRUE(Distinct->isDistinct()); 778 EXPECT_TRUE(Distinct->isResolved()); 779 EXPECT_EQ(Current, Distinct); 780 781 // Cleanup; required for teardown. 782 Unresolved->replaceAllUsesWith(nullptr); 783 } 784 } 785 786 TEST_F(MDNodeTest, replaceWithPermanent) { 787 Metadata *Ops[] = {nullptr}; 788 auto Temp = MDTuple::getTemporary(Context, Ops); 789 auto *T = Temp.get(); 790 791 // U is a normal, uniqued node that references T. 792 auto *U = MDTuple::get(Context, T); 793 EXPECT_TRUE(U->isUniqued()); 794 795 // Make Temp self-referencing. 796 Temp->replaceOperandWith(0, T); 797 798 // Try to uniquify Temp. This should, despite the name in the API, give a 799 // 'distinct' node, since self-references aren't allowed to be uniqued. 800 // 801 // Since it's distinct, N should have the same address as when it was a 802 // temporary (i.e., be equal to T not U). 803 auto *N = MDNode::replaceWithPermanent(std::move(Temp)); 804 EXPECT_EQ(N, T); 805 EXPECT_TRUE(N->isDistinct()); 806 807 // U should be the canonical unique node with N as the argument. 808 EXPECT_EQ(U, MDTuple::get(Context, N)); 809 EXPECT_TRUE(U->isUniqued()); 810 811 // This temporary should collide with U when replaced, but it should still be 812 // uniqued. 813 EXPECT_EQ(U, MDNode::replaceWithPermanent(MDTuple::getTemporary(Context, N))); 814 EXPECT_TRUE(U->isUniqued()); 815 816 // This temporary should become a new uniqued node. 817 auto Temp2 = MDTuple::getTemporary(Context, U); 818 auto *V = Temp2.get(); 819 EXPECT_EQ(V, MDNode::replaceWithPermanent(std::move(Temp2))); 820 EXPECT_TRUE(V->isUniqued()); 821 EXPECT_EQ(U, V->getOperand(0)); 822 } 823 824 TEST_F(MDNodeTest, deleteTemporaryWithTrackingRef) { 825 TrackingMDRef Ref; 826 EXPECT_EQ(nullptr, Ref.get()); 827 { 828 auto Temp = MDTuple::getTemporary(Context, None); 829 Ref.reset(Temp.get()); 830 EXPECT_EQ(Temp.get(), Ref.get()); 831 } 832 EXPECT_EQ(nullptr, Ref.get()); 833 } 834 835 typedef MetadataTest DILocationTest; 836 837 TEST_F(DILocationTest, Overflow) { 838 DISubprogram *N = getSubprogram(); 839 { 840 DILocation *L = DILocation::get(Context, 2, 7, N); 841 EXPECT_EQ(2u, L->getLine()); 842 EXPECT_EQ(7u, L->getColumn()); 843 } 844 unsigned U16 = 1u << 16; 845 { 846 DILocation *L = DILocation::get(Context, UINT32_MAX, U16 - 1, N); 847 EXPECT_EQ(UINT32_MAX, L->getLine()); 848 EXPECT_EQ(U16 - 1, L->getColumn()); 849 } 850 { 851 DILocation *L = DILocation::get(Context, UINT32_MAX, U16, N); 852 EXPECT_EQ(UINT32_MAX, L->getLine()); 853 EXPECT_EQ(0u, L->getColumn()); 854 } 855 { 856 DILocation *L = DILocation::get(Context, UINT32_MAX, U16 + 1, N); 857 EXPECT_EQ(UINT32_MAX, L->getLine()); 858 EXPECT_EQ(0u, L->getColumn()); 859 } 860 } 861 862 TEST_F(DILocationTest, getDistinct) { 863 MDNode *N = getSubprogram(); 864 DILocation *L0 = DILocation::getDistinct(Context, 2, 7, N); 865 EXPECT_TRUE(L0->isDistinct()); 866 DILocation *L1 = DILocation::get(Context, 2, 7, N); 867 EXPECT_FALSE(L1->isDistinct()); 868 EXPECT_EQ(L1, DILocation::get(Context, 2, 7, N)); 869 } 870 871 TEST_F(DILocationTest, getTemporary) { 872 MDNode *N = MDNode::get(Context, None); 873 auto L = DILocation::getTemporary(Context, 2, 7, N); 874 EXPECT_TRUE(L->isTemporary()); 875 EXPECT_FALSE(L->isResolved()); 876 } 877 878 TEST_F(DILocationTest, cloneTemporary) { 879 MDNode *N = MDNode::get(Context, None); 880 auto L = DILocation::getTemporary(Context, 2, 7, N); 881 EXPECT_TRUE(L->isTemporary()); 882 auto L2 = L->clone(); 883 EXPECT_TRUE(L2->isTemporary()); 884 } 885 886 typedef MetadataTest GenericDINodeTest; 887 888 TEST_F(GenericDINodeTest, get) { 889 StringRef Header = "header"; 890 auto *Empty = MDNode::get(Context, None); 891 Metadata *Ops1[] = {Empty}; 892 auto *N = GenericDINode::get(Context, 15, Header, Ops1); 893 EXPECT_EQ(15u, N->getTag()); 894 EXPECT_EQ(2u, N->getNumOperands()); 895 EXPECT_EQ(Header, N->getHeader()); 896 EXPECT_EQ(MDString::get(Context, Header), N->getOperand(0)); 897 EXPECT_EQ(1u, N->getNumDwarfOperands()); 898 EXPECT_EQ(Empty, N->getDwarfOperand(0)); 899 EXPECT_EQ(Empty, N->getOperand(1)); 900 ASSERT_TRUE(N->isUniqued()); 901 902 EXPECT_EQ(N, GenericDINode::get(Context, 15, Header, Ops1)); 903 904 N->replaceOperandWith(1, nullptr); 905 EXPECT_EQ(15u, N->getTag()); 906 EXPECT_EQ(Header, N->getHeader()); 907 EXPECT_EQ(nullptr, N->getDwarfOperand(0)); 908 ASSERT_TRUE(N->isUniqued()); 909 910 Metadata *Ops2[] = {nullptr}; 911 EXPECT_EQ(N, GenericDINode::get(Context, 15, Header, Ops2)); 912 913 N->replaceDwarfOperandWith(0, Empty); 914 EXPECT_EQ(15u, N->getTag()); 915 EXPECT_EQ(Header, N->getHeader()); 916 EXPECT_EQ(Empty, N->getDwarfOperand(0)); 917 ASSERT_TRUE(N->isUniqued()); 918 EXPECT_EQ(N, GenericDINode::get(Context, 15, Header, Ops1)); 919 920 TempGenericDINode Temp = N->clone(); 921 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 922 } 923 924 TEST_F(GenericDINodeTest, getEmptyHeader) { 925 // Canonicalize !"" to null. 926 auto *N = GenericDINode::get(Context, 15, StringRef(), None); 927 EXPECT_EQ(StringRef(), N->getHeader()); 928 EXPECT_EQ(nullptr, N->getOperand(0)); 929 } 930 931 typedef MetadataTest DISubrangeTest; 932 933 TEST_F(DISubrangeTest, get) { 934 auto *N = DISubrange::get(Context, 5, 7); 935 auto Count = N->getCount(); 936 EXPECT_EQ(dwarf::DW_TAG_subrange_type, N->getTag()); 937 ASSERT_TRUE(Count); 938 ASSERT_TRUE(Count.is<ConstantInt*>()); 939 EXPECT_EQ(5, Count.get<ConstantInt*>()->getSExtValue()); 940 EXPECT_EQ(7, N->getLowerBound()); 941 EXPECT_EQ(N, DISubrange::get(Context, 5, 7)); 942 EXPECT_EQ(DISubrange::get(Context, 5, 0), DISubrange::get(Context, 5)); 943 944 TempDISubrange Temp = N->clone(); 945 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 946 } 947 948 TEST_F(DISubrangeTest, getEmptyArray) { 949 auto *N = DISubrange::get(Context, -1, 0); 950 auto Count = N->getCount(); 951 EXPECT_EQ(dwarf::DW_TAG_subrange_type, N->getTag()); 952 ASSERT_TRUE(Count); 953 ASSERT_TRUE(Count.is<ConstantInt*>()); 954 EXPECT_EQ(-1, Count.get<ConstantInt*>()->getSExtValue()); 955 EXPECT_EQ(0, N->getLowerBound()); 956 EXPECT_EQ(N, DISubrange::get(Context, -1, 0)); 957 } 958 959 TEST_F(DISubrangeTest, getVariableCount) { 960 DILocalScope *Scope = getSubprogram(); 961 DIFile *File = getFile(); 962 DIType *Type = getDerivedType(); 963 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7); 964 auto *VlaExpr = DILocalVariable::get(Context, Scope, "vla_expr", File, 8, 965 Type, 2, Flags, 8); 966 967 auto *N = DISubrange::get(Context, VlaExpr, 0); 968 auto Count = N->getCount(); 969 ASSERT_TRUE(Count); 970 ASSERT_TRUE(Count.is<DIVariable*>()); 971 EXPECT_EQ(VlaExpr, Count.get<DIVariable*>()); 972 ASSERT_TRUE(isa<DIVariable>(N->getRawCountNode())); 973 EXPECT_EQ(0, N->getLowerBound()); 974 EXPECT_EQ("vla_expr", Count.get<DIVariable*>()->getName()); 975 EXPECT_EQ(N, DISubrange::get(Context, VlaExpr, 0)); 976 } 977 978 typedef MetadataTest DIEnumeratorTest; 979 980 TEST_F(DIEnumeratorTest, get) { 981 auto *N = DIEnumerator::get(Context, 7, false, "name"); 982 EXPECT_EQ(dwarf::DW_TAG_enumerator, N->getTag()); 983 EXPECT_EQ(7, N->getValue()); 984 EXPECT_FALSE(N->isUnsigned()); 985 EXPECT_EQ("name", N->getName()); 986 EXPECT_EQ(N, DIEnumerator::get(Context, 7, false, "name")); 987 988 EXPECT_NE(N, DIEnumerator::get(Context, 7, true, "name")); 989 EXPECT_NE(N, DIEnumerator::get(Context, 8, false, "name")); 990 EXPECT_NE(N, DIEnumerator::get(Context, 7, false, "nam")); 991 992 TempDIEnumerator Temp = N->clone(); 993 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 994 } 995 996 typedef MetadataTest DIBasicTypeTest; 997 998 TEST_F(DIBasicTypeTest, get) { 999 auto *N = 1000 DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 26, 7); 1001 EXPECT_EQ(dwarf::DW_TAG_base_type, N->getTag()); 1002 EXPECT_EQ("special", N->getName()); 1003 EXPECT_EQ(33u, N->getSizeInBits()); 1004 EXPECT_EQ(26u, N->getAlignInBits()); 1005 EXPECT_EQ(7u, N->getEncoding()); 1006 EXPECT_EQ(0u, N->getLine()); 1007 EXPECT_EQ(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 1008 26, 7)); 1009 1010 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type, 1011 "special", 33, 26, 7)); 1012 EXPECT_NE(N, 1013 DIBasicType::get(Context, dwarf::DW_TAG_base_type, "s", 33, 26, 7)); 1014 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 32, 1015 26, 7)); 1016 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 1017 25, 7)); 1018 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 1019 26, 6)); 1020 1021 TempDIBasicType Temp = N->clone(); 1022 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1023 } 1024 1025 TEST_F(DIBasicTypeTest, getWithLargeValues) { 1026 auto *N = DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 1027 UINT64_MAX, UINT32_MAX - 1, 7); 1028 EXPECT_EQ(UINT64_MAX, N->getSizeInBits()); 1029 EXPECT_EQ(UINT32_MAX - 1, N->getAlignInBits()); 1030 } 1031 1032 TEST_F(DIBasicTypeTest, getUnspecified) { 1033 auto *N = 1034 DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type, "unspecified"); 1035 EXPECT_EQ(dwarf::DW_TAG_unspecified_type, N->getTag()); 1036 EXPECT_EQ("unspecified", N->getName()); 1037 EXPECT_EQ(0u, N->getSizeInBits()); 1038 EXPECT_EQ(0u, N->getAlignInBits()); 1039 EXPECT_EQ(0u, N->getEncoding()); 1040 EXPECT_EQ(0u, N->getLine()); 1041 } 1042 1043 typedef MetadataTest DITypeTest; 1044 1045 TEST_F(DITypeTest, clone) { 1046 // Check that DIType has a specialized clone that returns TempDIType. 1047 DIType *N = DIBasicType::get(Context, dwarf::DW_TAG_base_type, "int", 32, 32, 1048 dwarf::DW_ATE_signed); 1049 1050 TempDIType Temp = N->clone(); 1051 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1052 } 1053 1054 TEST_F(DITypeTest, setFlags) { 1055 // void (void) 1056 Metadata *TypesOps[] = {nullptr}; 1057 Metadata *Types = MDTuple::get(Context, TypesOps); 1058 1059 DIType *D = 1060 DISubroutineType::getDistinct(Context, DINode::FlagZero, 0, Types); 1061 EXPECT_EQ(DINode::FlagZero, D->getFlags()); 1062 D->setFlags(DINode::FlagRValueReference); 1063 EXPECT_EQ(DINode::FlagRValueReference, D->getFlags()); 1064 D->setFlags(DINode::FlagZero); 1065 EXPECT_EQ(DINode::FlagZero, D->getFlags()); 1066 1067 TempDIType T = 1068 DISubroutineType::getTemporary(Context, DINode::FlagZero, 0, Types); 1069 EXPECT_EQ(DINode::FlagZero, T->getFlags()); 1070 T->setFlags(DINode::FlagRValueReference); 1071 EXPECT_EQ(DINode::FlagRValueReference, T->getFlags()); 1072 T->setFlags(DINode::FlagZero); 1073 EXPECT_EQ(DINode::FlagZero, T->getFlags()); 1074 } 1075 1076 typedef MetadataTest DIDerivedTypeTest; 1077 1078 TEST_F(DIDerivedTypeTest, get) { 1079 DIFile *File = getFile(); 1080 DIScope *Scope = getSubprogram(); 1081 DIType *BaseType = getBasicType("basic"); 1082 MDTuple *ExtraData = getTuple(); 1083 unsigned DWARFAddressSpace = 8; 1084 DINode::DIFlags Flags5 = static_cast<DINode::DIFlags>(5); 1085 DINode::DIFlags Flags4 = static_cast<DINode::DIFlags>(4); 1086 1087 auto *N = 1088 DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "something", File, 1089 1, Scope, BaseType, 2, 3, 4, DWARFAddressSpace, Flags5, 1090 ExtraData); 1091 EXPECT_EQ(dwarf::DW_TAG_pointer_type, N->getTag()); 1092 EXPECT_EQ("something", N->getName()); 1093 EXPECT_EQ(File, N->getFile()); 1094 EXPECT_EQ(1u, N->getLine()); 1095 EXPECT_EQ(Scope, N->getScope()); 1096 EXPECT_EQ(BaseType, N->getBaseType()); 1097 EXPECT_EQ(2u, N->getSizeInBits()); 1098 EXPECT_EQ(3u, N->getAlignInBits()); 1099 EXPECT_EQ(4u, N->getOffsetInBits()); 1100 EXPECT_EQ(DWARFAddressSpace, N->getDWARFAddressSpace().getValue()); 1101 EXPECT_EQ(5u, N->getFlags()); 1102 EXPECT_EQ(ExtraData, N->getExtraData()); 1103 EXPECT_EQ(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1104 "something", File, 1, Scope, BaseType, 2, 3, 1105 4, DWARFAddressSpace, Flags5, ExtraData)); 1106 1107 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_reference_type, 1108 "something", File, 1, Scope, BaseType, 2, 3, 1109 4, DWARFAddressSpace, Flags5, ExtraData)); 1110 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "else", 1111 File, 1, Scope, BaseType, 2, 3, 1112 4, DWARFAddressSpace, Flags5, ExtraData)); 1113 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1114 "something", getFile(), 1, Scope, BaseType, 2, 1115 3, 4, DWARFAddressSpace, Flags5, ExtraData)); 1116 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1117 "something", File, 2, Scope, BaseType, 2, 3, 1118 4, DWARFAddressSpace, Flags5, ExtraData)); 1119 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1120 "something", File, 1, getSubprogram(), 1121 BaseType, 2, 3, 4, DWARFAddressSpace, Flags5, 1122 ExtraData)); 1123 EXPECT_NE(N, DIDerivedType::get( 1124 Context, dwarf::DW_TAG_pointer_type, "something", File, 1, 1125 Scope, getBasicType("basic2"), 2, 3, 4, DWARFAddressSpace, 1126 Flags5, ExtraData)); 1127 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1128 "something", File, 1, Scope, BaseType, 3, 3, 1129 4, DWARFAddressSpace, Flags5, ExtraData)); 1130 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1131 "something", File, 1, Scope, BaseType, 2, 2, 1132 4, DWARFAddressSpace, Flags5, ExtraData)); 1133 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1134 "something", File, 1, Scope, BaseType, 2, 3, 1135 5, DWARFAddressSpace, Flags5, ExtraData)); 1136 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1137 "something", File, 1, Scope, BaseType, 2, 3, 1138 4, DWARFAddressSpace + 1, Flags5, ExtraData)); 1139 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1140 "something", File, 1, Scope, BaseType, 2, 3, 1141 4, DWARFAddressSpace, Flags4, ExtraData)); 1142 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1143 "something", File, 1, Scope, BaseType, 2, 3, 1144 4, DWARFAddressSpace, Flags5, getTuple())); 1145 1146 TempDIDerivedType Temp = N->clone(); 1147 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1148 } 1149 1150 TEST_F(DIDerivedTypeTest, getWithLargeValues) { 1151 DIFile *File = getFile(); 1152 DIScope *Scope = getSubprogram(); 1153 DIType *BaseType = getBasicType("basic"); 1154 MDTuple *ExtraData = getTuple(); 1155 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1156 1157 auto *N = DIDerivedType::get( 1158 Context, dwarf::DW_TAG_pointer_type, "something", File, 1, Scope, 1159 BaseType, UINT64_MAX, UINT32_MAX - 1, UINT64_MAX - 2, UINT32_MAX - 3, 1160 Flags, ExtraData); 1161 EXPECT_EQ(UINT64_MAX, N->getSizeInBits()); 1162 EXPECT_EQ(UINT32_MAX - 1, N->getAlignInBits()); 1163 EXPECT_EQ(UINT64_MAX - 2, N->getOffsetInBits()); 1164 EXPECT_EQ(UINT32_MAX - 3, N->getDWARFAddressSpace().getValue()); 1165 } 1166 1167 typedef MetadataTest DICompositeTypeTest; 1168 1169 TEST_F(DICompositeTypeTest, get) { 1170 unsigned Tag = dwarf::DW_TAG_structure_type; 1171 StringRef Name = "some name"; 1172 DIFile *File = getFile(); 1173 unsigned Line = 1; 1174 DIScope *Scope = getSubprogram(); 1175 DIType *BaseType = getCompositeType(); 1176 uint64_t SizeInBits = 2; 1177 uint32_t AlignInBits = 3; 1178 uint64_t OffsetInBits = 4; 1179 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1180 MDTuple *Elements = getTuple(); 1181 unsigned RuntimeLang = 6; 1182 DIType *VTableHolder = getCompositeType(); 1183 MDTuple *TemplateParams = getTuple(); 1184 StringRef Identifier = "some id"; 1185 1186 auto *N = DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1187 BaseType, SizeInBits, AlignInBits, 1188 OffsetInBits, Flags, Elements, RuntimeLang, 1189 VTableHolder, TemplateParams, Identifier); 1190 EXPECT_EQ(Tag, N->getTag()); 1191 EXPECT_EQ(Name, N->getName()); 1192 EXPECT_EQ(File, N->getFile()); 1193 EXPECT_EQ(Line, N->getLine()); 1194 EXPECT_EQ(Scope, N->getScope()); 1195 EXPECT_EQ(BaseType, N->getBaseType()); 1196 EXPECT_EQ(SizeInBits, N->getSizeInBits()); 1197 EXPECT_EQ(AlignInBits, N->getAlignInBits()); 1198 EXPECT_EQ(OffsetInBits, N->getOffsetInBits()); 1199 EXPECT_EQ(Flags, N->getFlags()); 1200 EXPECT_EQ(Elements, N->getElements().get()); 1201 EXPECT_EQ(RuntimeLang, N->getRuntimeLang()); 1202 EXPECT_EQ(VTableHolder, N->getVTableHolder()); 1203 EXPECT_EQ(TemplateParams, N->getTemplateParams().get()); 1204 EXPECT_EQ(Identifier, N->getIdentifier()); 1205 1206 EXPECT_EQ(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1207 BaseType, SizeInBits, AlignInBits, 1208 OffsetInBits, Flags, Elements, RuntimeLang, 1209 VTableHolder, TemplateParams, Identifier)); 1210 1211 EXPECT_NE(N, DICompositeType::get(Context, Tag + 1, Name, File, Line, Scope, 1212 BaseType, SizeInBits, AlignInBits, 1213 OffsetInBits, Flags, Elements, RuntimeLang, 1214 VTableHolder, TemplateParams, Identifier)); 1215 EXPECT_NE(N, DICompositeType::get(Context, Tag, "abc", File, Line, Scope, 1216 BaseType, SizeInBits, AlignInBits, 1217 OffsetInBits, Flags, Elements, RuntimeLang, 1218 VTableHolder, TemplateParams, Identifier)); 1219 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, getFile(), Line, Scope, 1220 BaseType, SizeInBits, AlignInBits, 1221 OffsetInBits, Flags, Elements, RuntimeLang, 1222 VTableHolder, TemplateParams, Identifier)); 1223 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line + 1, Scope, 1224 BaseType, SizeInBits, AlignInBits, 1225 OffsetInBits, Flags, Elements, RuntimeLang, 1226 VTableHolder, TemplateParams, Identifier)); 1227 EXPECT_NE(N, DICompositeType::get( 1228 Context, Tag, Name, File, Line, getSubprogram(), BaseType, 1229 SizeInBits, AlignInBits, OffsetInBits, Flags, Elements, 1230 RuntimeLang, VTableHolder, TemplateParams, Identifier)); 1231 EXPECT_NE(N, DICompositeType::get( 1232 Context, Tag, Name, File, Line, Scope, getBasicType("other"), 1233 SizeInBits, AlignInBits, OffsetInBits, Flags, Elements, 1234 RuntimeLang, VTableHolder, TemplateParams, Identifier)); 1235 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1236 BaseType, SizeInBits + 1, AlignInBits, 1237 OffsetInBits, Flags, Elements, RuntimeLang, 1238 VTableHolder, TemplateParams, Identifier)); 1239 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1240 BaseType, SizeInBits, AlignInBits + 1, 1241 OffsetInBits, Flags, Elements, RuntimeLang, 1242 VTableHolder, TemplateParams, Identifier)); 1243 EXPECT_NE(N, DICompositeType::get( 1244 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1245 AlignInBits, OffsetInBits + 1, Flags, Elements, RuntimeLang, 1246 VTableHolder, TemplateParams, Identifier)); 1247 DINode::DIFlags FlagsPOne = static_cast<DINode::DIFlags>(Flags + 1); 1248 EXPECT_NE(N, DICompositeType::get( 1249 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1250 AlignInBits, OffsetInBits, FlagsPOne, Elements, RuntimeLang, 1251 VTableHolder, TemplateParams, Identifier)); 1252 EXPECT_NE(N, DICompositeType::get( 1253 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1254 AlignInBits, OffsetInBits, Flags, getTuple(), RuntimeLang, 1255 VTableHolder, TemplateParams, Identifier)); 1256 EXPECT_NE(N, DICompositeType::get( 1257 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1258 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang + 1, 1259 VTableHolder, TemplateParams, Identifier)); 1260 EXPECT_NE(N, DICompositeType::get( 1261 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1262 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang, 1263 getCompositeType(), TemplateParams, Identifier)); 1264 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1265 BaseType, SizeInBits, AlignInBits, 1266 OffsetInBits, Flags, Elements, RuntimeLang, 1267 VTableHolder, getTuple(), Identifier)); 1268 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1269 BaseType, SizeInBits, AlignInBits, 1270 OffsetInBits, Flags, Elements, RuntimeLang, 1271 VTableHolder, TemplateParams, "other")); 1272 1273 // Be sure that missing identifiers get null pointers. 1274 EXPECT_FALSE(DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1275 BaseType, SizeInBits, AlignInBits, 1276 OffsetInBits, Flags, Elements, RuntimeLang, 1277 VTableHolder, TemplateParams, "") 1278 ->getRawIdentifier()); 1279 EXPECT_FALSE(DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1280 BaseType, SizeInBits, AlignInBits, 1281 OffsetInBits, Flags, Elements, RuntimeLang, 1282 VTableHolder, TemplateParams) 1283 ->getRawIdentifier()); 1284 1285 TempDICompositeType Temp = N->clone(); 1286 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1287 } 1288 1289 TEST_F(DICompositeTypeTest, getWithLargeValues) { 1290 unsigned Tag = dwarf::DW_TAG_structure_type; 1291 StringRef Name = "some name"; 1292 DIFile *File = getFile(); 1293 unsigned Line = 1; 1294 DIScope *Scope = getSubprogram(); 1295 DIType *BaseType = getCompositeType(); 1296 uint64_t SizeInBits = UINT64_MAX; 1297 uint32_t AlignInBits = UINT32_MAX - 1; 1298 uint64_t OffsetInBits = UINT64_MAX - 2; 1299 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1300 MDTuple *Elements = getTuple(); 1301 unsigned RuntimeLang = 6; 1302 DIType *VTableHolder = getCompositeType(); 1303 MDTuple *TemplateParams = getTuple(); 1304 StringRef Identifier = "some id"; 1305 1306 auto *N = DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1307 BaseType, SizeInBits, AlignInBits, 1308 OffsetInBits, Flags, Elements, RuntimeLang, 1309 VTableHolder, TemplateParams, Identifier); 1310 EXPECT_EQ(SizeInBits, N->getSizeInBits()); 1311 EXPECT_EQ(AlignInBits, N->getAlignInBits()); 1312 EXPECT_EQ(OffsetInBits, N->getOffsetInBits()); 1313 } 1314 1315 TEST_F(DICompositeTypeTest, replaceOperands) { 1316 unsigned Tag = dwarf::DW_TAG_structure_type; 1317 StringRef Name = "some name"; 1318 DIFile *File = getFile(); 1319 unsigned Line = 1; 1320 DIScope *Scope = getSubprogram(); 1321 DIType *BaseType = getCompositeType(); 1322 uint64_t SizeInBits = 2; 1323 uint32_t AlignInBits = 3; 1324 uint64_t OffsetInBits = 4; 1325 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1326 unsigned RuntimeLang = 6; 1327 StringRef Identifier = "some id"; 1328 1329 auto *N = DICompositeType::get( 1330 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, 1331 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier); 1332 1333 auto *Elements = MDTuple::getDistinct(Context, None); 1334 EXPECT_EQ(nullptr, N->getElements().get()); 1335 N->replaceElements(Elements); 1336 EXPECT_EQ(Elements, N->getElements().get()); 1337 N->replaceElements(nullptr); 1338 EXPECT_EQ(nullptr, N->getElements().get()); 1339 1340 DIType *VTableHolder = getCompositeType(); 1341 EXPECT_EQ(nullptr, N->getVTableHolder()); 1342 N->replaceVTableHolder(VTableHolder); 1343 EXPECT_EQ(VTableHolder, N->getVTableHolder()); 1344 // As an extension, the containing type can be anything. This is 1345 // used by Rust to associate vtables with their concrete type. 1346 DIType *BasicType = getBasicType("basic"); 1347 N->replaceVTableHolder(BasicType); 1348 EXPECT_EQ(BasicType, N->getVTableHolder()); 1349 N->replaceVTableHolder(nullptr); 1350 EXPECT_EQ(nullptr, N->getVTableHolder()); 1351 1352 auto *TemplateParams = MDTuple::getDistinct(Context, None); 1353 EXPECT_EQ(nullptr, N->getTemplateParams().get()); 1354 N->replaceTemplateParams(TemplateParams); 1355 EXPECT_EQ(TemplateParams, N->getTemplateParams().get()); 1356 N->replaceTemplateParams(nullptr); 1357 EXPECT_EQ(nullptr, N->getTemplateParams().get()); 1358 } 1359 1360 TEST_F(DICompositeTypeTest, variant_part) { 1361 unsigned Tag = dwarf::DW_TAG_variant_part; 1362 StringRef Name = "some name"; 1363 DIFile *File = getFile(); 1364 unsigned Line = 1; 1365 DIScope *Scope = getSubprogram(); 1366 DIType *BaseType = getCompositeType(); 1367 uint64_t SizeInBits = 2; 1368 uint32_t AlignInBits = 3; 1369 uint64_t OffsetInBits = 4; 1370 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1371 unsigned RuntimeLang = 6; 1372 StringRef Identifier = "some id"; 1373 DIDerivedType *Discriminator = cast<DIDerivedType>(getDerivedType()); 1374 DIDerivedType *Discriminator2 = cast<DIDerivedType>(getDerivedType()); 1375 1376 EXPECT_NE(Discriminator, Discriminator2); 1377 1378 auto *N = DICompositeType::get( 1379 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, 1380 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier, 1381 Discriminator); 1382 1383 // Test the hashing. 1384 auto *Same = DICompositeType::get( 1385 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, 1386 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier, 1387 Discriminator); 1388 auto *Other = DICompositeType::get( 1389 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, 1390 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier, 1391 Discriminator2); 1392 auto *NoDisc = DICompositeType::get( 1393 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, 1394 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier, 1395 nullptr); 1396 1397 EXPECT_EQ(N, Same); 1398 EXPECT_NE(Same, Other); 1399 EXPECT_NE(Same, NoDisc); 1400 EXPECT_NE(Other, NoDisc); 1401 1402 EXPECT_EQ(N->getDiscriminator(), Discriminator); 1403 } 1404 1405 typedef MetadataTest DISubroutineTypeTest; 1406 1407 TEST_F(DISubroutineTypeTest, get) { 1408 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(1); 1409 DINode::DIFlags FlagsPOne = static_cast<DINode::DIFlags>(Flags + 1); 1410 MDTuple *TypeArray = getTuple(); 1411 1412 auto *N = DISubroutineType::get(Context, Flags, 0, TypeArray); 1413 EXPECT_EQ(dwarf::DW_TAG_subroutine_type, N->getTag()); 1414 EXPECT_EQ(Flags, N->getFlags()); 1415 EXPECT_EQ(TypeArray, N->getTypeArray().get()); 1416 EXPECT_EQ(N, DISubroutineType::get(Context, Flags, 0, TypeArray)); 1417 1418 EXPECT_NE(N, DISubroutineType::get(Context, FlagsPOne, 0, TypeArray)); 1419 EXPECT_NE(N, DISubroutineType::get(Context, Flags, 0, getTuple())); 1420 1421 // Test the hashing of calling conventions. 1422 auto *Fast = DISubroutineType::get( 1423 Context, Flags, dwarf::DW_CC_BORLAND_msfastcall, TypeArray); 1424 auto *Std = DISubroutineType::get(Context, Flags, 1425 dwarf::DW_CC_BORLAND_stdcall, TypeArray); 1426 EXPECT_EQ(Fast, 1427 DISubroutineType::get(Context, Flags, 1428 dwarf::DW_CC_BORLAND_msfastcall, TypeArray)); 1429 EXPECT_EQ(Std, DISubroutineType::get( 1430 Context, Flags, dwarf::DW_CC_BORLAND_stdcall, TypeArray)); 1431 1432 EXPECT_NE(N, Fast); 1433 EXPECT_NE(N, Std); 1434 EXPECT_NE(Fast, Std); 1435 1436 TempDISubroutineType Temp = N->clone(); 1437 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1438 1439 // Test always-empty operands. 1440 EXPECT_EQ(nullptr, N->getScope()); 1441 EXPECT_EQ(nullptr, N->getFile()); 1442 EXPECT_EQ("", N->getName()); 1443 } 1444 1445 typedef MetadataTest DIFileTest; 1446 1447 TEST_F(DIFileTest, get) { 1448 StringRef Filename = "file"; 1449 StringRef Directory = "dir"; 1450 DIFile::ChecksumKind CSKind = DIFile::ChecksumKind::CSK_MD5; 1451 StringRef ChecksumString = "000102030405060708090a0b0c0d0e0f"; 1452 DIFile::ChecksumInfo<StringRef> Checksum(CSKind, ChecksumString); 1453 StringRef Source = "source"; 1454 auto *N = DIFile::get(Context, Filename, Directory, Checksum, Source); 1455 1456 EXPECT_EQ(dwarf::DW_TAG_file_type, N->getTag()); 1457 EXPECT_EQ(Filename, N->getFilename()); 1458 EXPECT_EQ(Directory, N->getDirectory()); 1459 EXPECT_EQ(Checksum, N->getChecksum()); 1460 EXPECT_EQ(Source, N->getSource()); 1461 EXPECT_EQ(N, DIFile::get(Context, Filename, Directory, Checksum, Source)); 1462 1463 EXPECT_NE(N, DIFile::get(Context, "other", Directory, Checksum, Source)); 1464 EXPECT_NE(N, DIFile::get(Context, Filename, "other", Checksum, Source)); 1465 DIFile::ChecksumInfo<StringRef> OtherChecksum(DIFile::ChecksumKind::CSK_SHA1, ChecksumString); 1466 EXPECT_NE( 1467 N, DIFile::get(Context, Filename, Directory, OtherChecksum)); 1468 StringRef OtherSource = "other"; 1469 EXPECT_NE(N, DIFile::get(Context, Filename, Directory, Checksum, OtherSource)); 1470 EXPECT_NE(N, DIFile::get(Context, Filename, Directory, Checksum)); 1471 EXPECT_NE(N, DIFile::get(Context, Filename, Directory)); 1472 1473 TempDIFile Temp = N->clone(); 1474 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1475 } 1476 1477 TEST_F(DIFileTest, ScopeGetFile) { 1478 // Ensure that DIScope::getFile() returns itself. 1479 DIScope *N = DIFile::get(Context, "file", "dir"); 1480 EXPECT_EQ(N, N->getFile()); 1481 } 1482 1483 typedef MetadataTest DICompileUnitTest; 1484 1485 TEST_F(DICompileUnitTest, get) { 1486 unsigned SourceLanguage = 1; 1487 DIFile *File = getFile(); 1488 StringRef Producer = "some producer"; 1489 bool IsOptimized = false; 1490 StringRef Flags = "flag after flag"; 1491 unsigned RuntimeVersion = 2; 1492 StringRef SplitDebugFilename = "another/file"; 1493 auto EmissionKind = DICompileUnit::FullDebug; 1494 MDTuple *EnumTypes = getTuple(); 1495 MDTuple *RetainedTypes = getTuple(); 1496 MDTuple *GlobalVariables = getTuple(); 1497 MDTuple *ImportedEntities = getTuple(); 1498 uint64_t DWOId = 0x10000000c0ffee; 1499 MDTuple *Macros = getTuple(); 1500 auto *N = DICompileUnit::getDistinct( 1501 Context, SourceLanguage, File, Producer, IsOptimized, Flags, 1502 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes, 1503 RetainedTypes, GlobalVariables, ImportedEntities, Macros, DWOId, true, 1504 false, false); 1505 1506 EXPECT_EQ(dwarf::DW_TAG_compile_unit, N->getTag()); 1507 EXPECT_EQ(SourceLanguage, N->getSourceLanguage()); 1508 EXPECT_EQ(File, N->getFile()); 1509 EXPECT_EQ(Producer, N->getProducer()); 1510 EXPECT_EQ(IsOptimized, N->isOptimized()); 1511 EXPECT_EQ(Flags, N->getFlags()); 1512 EXPECT_EQ(RuntimeVersion, N->getRuntimeVersion()); 1513 EXPECT_EQ(SplitDebugFilename, N->getSplitDebugFilename()); 1514 EXPECT_EQ(EmissionKind, N->getEmissionKind()); 1515 EXPECT_EQ(EnumTypes, N->getEnumTypes().get()); 1516 EXPECT_EQ(RetainedTypes, N->getRetainedTypes().get()); 1517 EXPECT_EQ(GlobalVariables, N->getGlobalVariables().get()); 1518 EXPECT_EQ(ImportedEntities, N->getImportedEntities().get()); 1519 EXPECT_EQ(Macros, N->getMacros().get()); 1520 EXPECT_EQ(DWOId, N->getDWOId()); 1521 1522 TempDICompileUnit Temp = N->clone(); 1523 EXPECT_EQ(dwarf::DW_TAG_compile_unit, Temp->getTag()); 1524 EXPECT_EQ(SourceLanguage, Temp->getSourceLanguage()); 1525 EXPECT_EQ(File, Temp->getFile()); 1526 EXPECT_EQ(Producer, Temp->getProducer()); 1527 EXPECT_EQ(IsOptimized, Temp->isOptimized()); 1528 EXPECT_EQ(Flags, Temp->getFlags()); 1529 EXPECT_EQ(RuntimeVersion, Temp->getRuntimeVersion()); 1530 EXPECT_EQ(SplitDebugFilename, Temp->getSplitDebugFilename()); 1531 EXPECT_EQ(EmissionKind, Temp->getEmissionKind()); 1532 EXPECT_EQ(EnumTypes, Temp->getEnumTypes().get()); 1533 EXPECT_EQ(RetainedTypes, Temp->getRetainedTypes().get()); 1534 EXPECT_EQ(GlobalVariables, Temp->getGlobalVariables().get()); 1535 EXPECT_EQ(ImportedEntities, Temp->getImportedEntities().get()); 1536 EXPECT_EQ(Macros, Temp->getMacros().get()); 1537 EXPECT_EQ(DWOId, Temp->getDWOId()); 1538 1539 auto *TempAddress = Temp.get(); 1540 auto *Clone = MDNode::replaceWithPermanent(std::move(Temp)); 1541 EXPECT_TRUE(Clone->isDistinct()); 1542 EXPECT_EQ(TempAddress, Clone); 1543 } 1544 1545 TEST_F(DICompileUnitTest, replaceArrays) { 1546 unsigned SourceLanguage = 1; 1547 DIFile *File = getFile(); 1548 StringRef Producer = "some producer"; 1549 bool IsOptimized = false; 1550 StringRef Flags = "flag after flag"; 1551 unsigned RuntimeVersion = 2; 1552 StringRef SplitDebugFilename = "another/file"; 1553 auto EmissionKind = DICompileUnit::FullDebug; 1554 MDTuple *EnumTypes = MDTuple::getDistinct(Context, None); 1555 MDTuple *RetainedTypes = MDTuple::getDistinct(Context, None); 1556 MDTuple *ImportedEntities = MDTuple::getDistinct(Context, None); 1557 uint64_t DWOId = 0xc0ffee; 1558 auto *N = DICompileUnit::getDistinct( 1559 Context, SourceLanguage, File, Producer, IsOptimized, Flags, 1560 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes, 1561 RetainedTypes, nullptr, ImportedEntities, nullptr, DWOId, true, false, 1562 false); 1563 1564 auto *GlobalVariables = MDTuple::getDistinct(Context, None); 1565 EXPECT_EQ(nullptr, N->getGlobalVariables().get()); 1566 N->replaceGlobalVariables(GlobalVariables); 1567 EXPECT_EQ(GlobalVariables, N->getGlobalVariables().get()); 1568 N->replaceGlobalVariables(nullptr); 1569 EXPECT_EQ(nullptr, N->getGlobalVariables().get()); 1570 1571 auto *Macros = MDTuple::getDistinct(Context, None); 1572 EXPECT_EQ(nullptr, N->getMacros().get()); 1573 N->replaceMacros(Macros); 1574 EXPECT_EQ(Macros, N->getMacros().get()); 1575 N->replaceMacros(nullptr); 1576 EXPECT_EQ(nullptr, N->getMacros().get()); 1577 } 1578 1579 typedef MetadataTest DISubprogramTest; 1580 1581 TEST_F(DISubprogramTest, get) { 1582 DIScope *Scope = getCompositeType(); 1583 StringRef Name = "name"; 1584 StringRef LinkageName = "linkage"; 1585 DIFile *File = getFile(); 1586 unsigned Line = 2; 1587 DISubroutineType *Type = getSubroutineType(); 1588 bool IsLocalToUnit = false; 1589 bool IsDefinition = true; 1590 unsigned ScopeLine = 3; 1591 DIType *ContainingType = getCompositeType(); 1592 unsigned Virtuality = 2; 1593 unsigned VirtualIndex = 5; 1594 int ThisAdjustment = -3; 1595 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(6); 1596 bool IsOptimized = false; 1597 MDTuple *TemplateParams = getTuple(); 1598 DISubprogram *Declaration = getSubprogram(); 1599 MDTuple *RetainedNodes = getTuple(); 1600 MDTuple *ThrownTypes = getTuple(); 1601 DICompileUnit *Unit = getUnit(); 1602 1603 auto *N = DISubprogram::get( 1604 Context, Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, 1605 IsDefinition, ScopeLine, ContainingType, Virtuality, VirtualIndex, 1606 ThisAdjustment, Flags, IsOptimized, Unit, TemplateParams, Declaration, 1607 RetainedNodes, ThrownTypes); 1608 1609 EXPECT_EQ(dwarf::DW_TAG_subprogram, N->getTag()); 1610 EXPECT_EQ(Scope, N->getScope()); 1611 EXPECT_EQ(Name, N->getName()); 1612 EXPECT_EQ(LinkageName, N->getLinkageName()); 1613 EXPECT_EQ(File, N->getFile()); 1614 EXPECT_EQ(Line, N->getLine()); 1615 EXPECT_EQ(Type, N->getType()); 1616 EXPECT_EQ(IsLocalToUnit, N->isLocalToUnit()); 1617 EXPECT_EQ(IsDefinition, N->isDefinition()); 1618 EXPECT_EQ(ScopeLine, N->getScopeLine()); 1619 EXPECT_EQ(ContainingType, N->getContainingType()); 1620 EXPECT_EQ(Virtuality, N->getVirtuality()); 1621 EXPECT_EQ(VirtualIndex, N->getVirtualIndex()); 1622 EXPECT_EQ(ThisAdjustment, N->getThisAdjustment()); 1623 EXPECT_EQ(Flags, N->getFlags()); 1624 EXPECT_EQ(IsOptimized, N->isOptimized()); 1625 EXPECT_EQ(Unit, N->getUnit()); 1626 EXPECT_EQ(TemplateParams, N->getTemplateParams().get()); 1627 EXPECT_EQ(Declaration, N->getDeclaration()); 1628 EXPECT_EQ(RetainedNodes, N->getRetainedNodes().get()); 1629 EXPECT_EQ(ThrownTypes, N->getThrownTypes().get()); 1630 EXPECT_EQ(N, DISubprogram::get( 1631 Context, Scope, Name, LinkageName, File, Line, Type, 1632 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, 1633 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1634 Unit, TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1635 1636 EXPECT_NE(N, DISubprogram::get( 1637 Context, getCompositeType(), Name, LinkageName, File, Line, 1638 Type, IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, 1639 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1640 Unit, TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1641 EXPECT_NE(N, DISubprogram::get( 1642 Context, Scope, "other", LinkageName, File, Line, Type, 1643 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, 1644 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1645 Unit, TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1646 EXPECT_NE(N, DISubprogram::get( 1647 Context, Scope, Name, "other", File, Line, Type, 1648 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, 1649 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1650 Unit, TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1651 EXPECT_NE(N, DISubprogram::get( 1652 Context, Scope, Name, LinkageName, getFile(), Line, Type, 1653 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, 1654 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1655 Unit, TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1656 EXPECT_NE(N, DISubprogram::get( 1657 Context, Scope, Name, LinkageName, File, Line + 1, Type, 1658 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, 1659 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1660 Unit, TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1661 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1662 getSubroutineType(), IsLocalToUnit, 1663 IsDefinition, ScopeLine, ContainingType, 1664 Virtuality, VirtualIndex, ThisAdjustment, 1665 Flags, IsOptimized, Unit, TemplateParams, 1666 Declaration, RetainedNodes, ThrownTypes)); 1667 EXPECT_NE(N, DISubprogram::get( 1668 Context, Scope, Name, LinkageName, File, Line, Type, 1669 !IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, 1670 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1671 Unit, TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1672 EXPECT_NE(N, DISubprogram::get( 1673 Context, Scope, Name, LinkageName, File, Line, Type, 1674 IsLocalToUnit, !IsDefinition, ScopeLine, ContainingType, 1675 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1676 Unit, TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1677 EXPECT_NE(N, DISubprogram::get( 1678 Context, Scope, Name, LinkageName, File, Line, Type, 1679 IsLocalToUnit, IsDefinition, ScopeLine + 1, ContainingType, 1680 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1681 Unit, TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1682 EXPECT_NE(N, DISubprogram::get( 1683 Context, Scope, Name, LinkageName, File, Line, Type, 1684 IsLocalToUnit, IsDefinition, ScopeLine, getCompositeType(), 1685 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1686 Unit, TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1687 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1688 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1689 ContainingType, Virtuality + 1, VirtualIndex, 1690 ThisAdjustment, Flags, IsOptimized, Unit, 1691 TemplateParams, Declaration, RetainedNodes, 1692 ThrownTypes)); 1693 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1694 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1695 ContainingType, Virtuality, VirtualIndex + 1, 1696 ThisAdjustment, Flags, IsOptimized, Unit, 1697 TemplateParams, Declaration, RetainedNodes, 1698 ThrownTypes)); 1699 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1700 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1701 ContainingType, Virtuality, VirtualIndex, 1702 ThisAdjustment, Flags, !IsOptimized, Unit, 1703 TemplateParams, Declaration, RetainedNodes, 1704 ThrownTypes)); 1705 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1706 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1707 ContainingType, Virtuality, VirtualIndex, 1708 ThisAdjustment, Flags, IsOptimized, nullptr, 1709 TemplateParams, Declaration, RetainedNodes, 1710 ThrownTypes)); 1711 EXPECT_NE(N, DISubprogram::get( 1712 Context, Scope, Name, LinkageName, File, Line, Type, 1713 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, 1714 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1715 Unit, getTuple(), Declaration, RetainedNodes, ThrownTypes)); 1716 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1717 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1718 ContainingType, Virtuality, VirtualIndex, 1719 ThisAdjustment, Flags, IsOptimized, Unit, 1720 TemplateParams, getSubprogram(), RetainedNodes, 1721 ThrownTypes)); 1722 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1723 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1724 ContainingType, Virtuality, VirtualIndex, 1725 ThisAdjustment, Flags, IsOptimized, Unit, 1726 TemplateParams, Declaration, getTuple())); 1727 EXPECT_NE(N, DISubprogram::get( 1728 Context, Scope, Name, LinkageName, File, Line, Type, 1729 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, 1730 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1731 Unit, TemplateParams, Declaration, RetainedNodes, getTuple())); 1732 1733 TempDISubprogram Temp = N->clone(); 1734 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1735 } 1736 1737 typedef MetadataTest DILexicalBlockTest; 1738 1739 TEST_F(DILexicalBlockTest, get) { 1740 DILocalScope *Scope = getSubprogram(); 1741 DIFile *File = getFile(); 1742 unsigned Line = 5; 1743 unsigned Column = 8; 1744 1745 auto *N = DILexicalBlock::get(Context, Scope, File, Line, Column); 1746 1747 EXPECT_EQ(dwarf::DW_TAG_lexical_block, N->getTag()); 1748 EXPECT_EQ(Scope, N->getScope()); 1749 EXPECT_EQ(File, N->getFile()); 1750 EXPECT_EQ(Line, N->getLine()); 1751 EXPECT_EQ(Column, N->getColumn()); 1752 EXPECT_EQ(N, DILexicalBlock::get(Context, Scope, File, Line, Column)); 1753 1754 EXPECT_NE(N, 1755 DILexicalBlock::get(Context, getSubprogram(), File, Line, Column)); 1756 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, getFile(), Line, Column)); 1757 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, File, Line + 1, Column)); 1758 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, File, Line, Column + 1)); 1759 1760 TempDILexicalBlock Temp = N->clone(); 1761 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1762 } 1763 1764 TEST_F(DILexicalBlockTest, Overflow) { 1765 DISubprogram *SP = getSubprogram(); 1766 DIFile *F = getFile(); 1767 { 1768 auto *LB = DILexicalBlock::get(Context, SP, F, 2, 7); 1769 EXPECT_EQ(2u, LB->getLine()); 1770 EXPECT_EQ(7u, LB->getColumn()); 1771 } 1772 unsigned U16 = 1u << 16; 1773 { 1774 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16 - 1); 1775 EXPECT_EQ(UINT32_MAX, LB->getLine()); 1776 EXPECT_EQ(U16 - 1, LB->getColumn()); 1777 } 1778 { 1779 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16); 1780 EXPECT_EQ(UINT32_MAX, LB->getLine()); 1781 EXPECT_EQ(0u, LB->getColumn()); 1782 } 1783 { 1784 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16 + 1); 1785 EXPECT_EQ(UINT32_MAX, LB->getLine()); 1786 EXPECT_EQ(0u, LB->getColumn()); 1787 } 1788 } 1789 1790 typedef MetadataTest DILexicalBlockFileTest; 1791 1792 TEST_F(DILexicalBlockFileTest, get) { 1793 DILocalScope *Scope = getSubprogram(); 1794 DIFile *File = getFile(); 1795 unsigned Discriminator = 5; 1796 1797 auto *N = DILexicalBlockFile::get(Context, Scope, File, Discriminator); 1798 1799 EXPECT_EQ(dwarf::DW_TAG_lexical_block, N->getTag()); 1800 EXPECT_EQ(Scope, N->getScope()); 1801 EXPECT_EQ(File, N->getFile()); 1802 EXPECT_EQ(Discriminator, N->getDiscriminator()); 1803 EXPECT_EQ(N, DILexicalBlockFile::get(Context, Scope, File, Discriminator)); 1804 1805 EXPECT_NE(N, DILexicalBlockFile::get(Context, getSubprogram(), File, 1806 Discriminator)); 1807 EXPECT_NE(N, 1808 DILexicalBlockFile::get(Context, Scope, getFile(), Discriminator)); 1809 EXPECT_NE(N, 1810 DILexicalBlockFile::get(Context, Scope, File, Discriminator + 1)); 1811 1812 TempDILexicalBlockFile Temp = N->clone(); 1813 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1814 } 1815 1816 typedef MetadataTest DINamespaceTest; 1817 1818 TEST_F(DINamespaceTest, get) { 1819 DIScope *Scope = getFile(); 1820 StringRef Name = "namespace"; 1821 bool ExportSymbols = true; 1822 1823 auto *N = DINamespace::get(Context, Scope, Name, ExportSymbols); 1824 1825 EXPECT_EQ(dwarf::DW_TAG_namespace, N->getTag()); 1826 EXPECT_EQ(Scope, N->getScope()); 1827 EXPECT_EQ(Name, N->getName()); 1828 EXPECT_EQ(N, DINamespace::get(Context, Scope, Name, ExportSymbols)); 1829 EXPECT_NE(N, DINamespace::get(Context, getFile(), Name, ExportSymbols)); 1830 EXPECT_NE(N, DINamespace::get(Context, Scope, "other", ExportSymbols)); 1831 EXPECT_NE(N, DINamespace::get(Context, Scope, Name, !ExportSymbols)); 1832 1833 TempDINamespace Temp = N->clone(); 1834 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1835 } 1836 1837 typedef MetadataTest DIModuleTest; 1838 1839 TEST_F(DIModuleTest, get) { 1840 DIScope *Scope = getFile(); 1841 StringRef Name = "module"; 1842 StringRef ConfigMacro = "-DNDEBUG"; 1843 StringRef Includes = "-I."; 1844 StringRef Sysroot = "/"; 1845 1846 auto *N = DIModule::get(Context, Scope, Name, ConfigMacro, Includes, Sysroot); 1847 1848 EXPECT_EQ(dwarf::DW_TAG_module, N->getTag()); 1849 EXPECT_EQ(Scope, N->getScope()); 1850 EXPECT_EQ(Name, N->getName()); 1851 EXPECT_EQ(ConfigMacro, N->getConfigurationMacros()); 1852 EXPECT_EQ(Includes, N->getIncludePath()); 1853 EXPECT_EQ(Sysroot, N->getISysRoot()); 1854 EXPECT_EQ(N, DIModule::get(Context, Scope, Name, 1855 ConfigMacro, Includes, Sysroot)); 1856 EXPECT_NE(N, DIModule::get(Context, getFile(), Name, 1857 ConfigMacro, Includes, Sysroot)); 1858 EXPECT_NE(N, DIModule::get(Context, Scope, "other", 1859 ConfigMacro, Includes, Sysroot)); 1860 EXPECT_NE(N, DIModule::get(Context, Scope, Name, 1861 "other", Includes, Sysroot)); 1862 EXPECT_NE(N, DIModule::get(Context, Scope, Name, 1863 ConfigMacro, "other", Sysroot)); 1864 EXPECT_NE(N, DIModule::get(Context, Scope, Name, 1865 ConfigMacro, Includes, "other")); 1866 1867 TempDIModule Temp = N->clone(); 1868 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1869 } 1870 1871 typedef MetadataTest DITemplateTypeParameterTest; 1872 1873 TEST_F(DITemplateTypeParameterTest, get) { 1874 StringRef Name = "template"; 1875 DIType *Type = getBasicType("basic"); 1876 1877 auto *N = DITemplateTypeParameter::get(Context, Name, Type); 1878 1879 EXPECT_EQ(dwarf::DW_TAG_template_type_parameter, N->getTag()); 1880 EXPECT_EQ(Name, N->getName()); 1881 EXPECT_EQ(Type, N->getType()); 1882 EXPECT_EQ(N, DITemplateTypeParameter::get(Context, Name, Type)); 1883 1884 EXPECT_NE(N, DITemplateTypeParameter::get(Context, "other", Type)); 1885 EXPECT_NE(N, 1886 DITemplateTypeParameter::get(Context, Name, getBasicType("other"))); 1887 1888 TempDITemplateTypeParameter Temp = N->clone(); 1889 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1890 } 1891 1892 typedef MetadataTest DITemplateValueParameterTest; 1893 1894 TEST_F(DITemplateValueParameterTest, get) { 1895 unsigned Tag = dwarf::DW_TAG_template_value_parameter; 1896 StringRef Name = "template"; 1897 DIType *Type = getBasicType("basic"); 1898 Metadata *Value = getConstantAsMetadata(); 1899 1900 auto *N = DITemplateValueParameter::get(Context, Tag, Name, Type, Value); 1901 EXPECT_EQ(Tag, N->getTag()); 1902 EXPECT_EQ(Name, N->getName()); 1903 EXPECT_EQ(Type, N->getType()); 1904 EXPECT_EQ(Value, N->getValue()); 1905 EXPECT_EQ(N, DITemplateValueParameter::get(Context, Tag, Name, Type, Value)); 1906 1907 EXPECT_NE(N, DITemplateValueParameter::get( 1908 Context, dwarf::DW_TAG_GNU_template_template_param, Name, 1909 Type, Value)); 1910 EXPECT_NE(N, 1911 DITemplateValueParameter::get(Context, Tag, "other", Type, Value)); 1912 EXPECT_NE(N, DITemplateValueParameter::get(Context, Tag, Name, 1913 getBasicType("other"), Value)); 1914 EXPECT_NE(N, DITemplateValueParameter::get(Context, Tag, Name, Type, 1915 getConstantAsMetadata())); 1916 1917 TempDITemplateValueParameter Temp = N->clone(); 1918 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1919 } 1920 1921 typedef MetadataTest DIGlobalVariableTest; 1922 1923 TEST_F(DIGlobalVariableTest, get) { 1924 DIScope *Scope = getSubprogram(); 1925 StringRef Name = "name"; 1926 StringRef LinkageName = "linkage"; 1927 DIFile *File = getFile(); 1928 unsigned Line = 5; 1929 DIType *Type = getDerivedType(); 1930 bool IsLocalToUnit = false; 1931 bool IsDefinition = true; 1932 DIDerivedType *StaticDataMemberDeclaration = 1933 cast<DIDerivedType>(getDerivedType()); 1934 uint32_t AlignInBits = 8; 1935 1936 auto *N = DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, Line, 1937 Type, IsLocalToUnit, IsDefinition, 1938 StaticDataMemberDeclaration, AlignInBits); 1939 EXPECT_EQ(dwarf::DW_TAG_variable, N->getTag()); 1940 EXPECT_EQ(Scope, N->getScope()); 1941 EXPECT_EQ(Name, N->getName()); 1942 EXPECT_EQ(LinkageName, N->getLinkageName()); 1943 EXPECT_EQ(File, N->getFile()); 1944 EXPECT_EQ(Line, N->getLine()); 1945 EXPECT_EQ(Type, N->getType()); 1946 EXPECT_EQ(IsLocalToUnit, N->isLocalToUnit()); 1947 EXPECT_EQ(IsDefinition, N->isDefinition()); 1948 EXPECT_EQ(StaticDataMemberDeclaration, N->getStaticDataMemberDeclaration()); 1949 EXPECT_EQ(AlignInBits, N->getAlignInBits()); 1950 EXPECT_EQ(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 1951 Line, Type, IsLocalToUnit, IsDefinition, 1952 StaticDataMemberDeclaration, AlignInBits)); 1953 1954 EXPECT_NE(N, 1955 DIGlobalVariable::get(Context, getSubprogram(), Name, LinkageName, 1956 File, Line, Type, IsLocalToUnit, IsDefinition, 1957 StaticDataMemberDeclaration, AlignInBits)); 1958 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, "other", LinkageName, File, 1959 Line, Type, IsLocalToUnit, IsDefinition, 1960 StaticDataMemberDeclaration, AlignInBits)); 1961 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, "other", File, Line, 1962 Type, IsLocalToUnit, IsDefinition, 1963 StaticDataMemberDeclaration, AlignInBits)); 1964 EXPECT_NE(N, 1965 DIGlobalVariable::get(Context, Scope, Name, LinkageName, getFile(), 1966 Line, Type, IsLocalToUnit, IsDefinition, 1967 StaticDataMemberDeclaration, AlignInBits)); 1968 EXPECT_NE(N, 1969 DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 1970 Line + 1, Type, IsLocalToUnit, IsDefinition, 1971 StaticDataMemberDeclaration, AlignInBits)); 1972 EXPECT_NE(N, 1973 DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, Line, 1974 getDerivedType(), IsLocalToUnit, IsDefinition, 1975 StaticDataMemberDeclaration, AlignInBits)); 1976 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 1977 Line, Type, !IsLocalToUnit, IsDefinition, 1978 StaticDataMemberDeclaration, AlignInBits)); 1979 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 1980 Line, Type, IsLocalToUnit, !IsDefinition, 1981 StaticDataMemberDeclaration, AlignInBits)); 1982 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 1983 Line, Type, IsLocalToUnit, IsDefinition, 1984 cast<DIDerivedType>(getDerivedType()), 1985 AlignInBits)); 1986 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 1987 Line, Type, IsLocalToUnit, IsDefinition, 1988 StaticDataMemberDeclaration, 1989 (AlignInBits << 1))); 1990 1991 TempDIGlobalVariable Temp = N->clone(); 1992 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1993 } 1994 1995 typedef MetadataTest DIGlobalVariableExpressionTest; 1996 1997 TEST_F(DIGlobalVariableExpressionTest, get) { 1998 DIScope *Scope = getSubprogram(); 1999 StringRef Name = "name"; 2000 StringRef LinkageName = "linkage"; 2001 DIFile *File = getFile(); 2002 unsigned Line = 5; 2003 DIType *Type = getDerivedType(); 2004 bool IsLocalToUnit = false; 2005 bool IsDefinition = true; 2006 auto *Expr = DIExpression::get(Context, {1, 2}); 2007 auto *Expr2 = DIExpression::get(Context, {1, 2, 3}); 2008 DIDerivedType *StaticDataMemberDeclaration = 2009 cast<DIDerivedType>(getDerivedType()); 2010 uint32_t AlignInBits = 8; 2011 2012 auto *Var = DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 2013 Line, Type, IsLocalToUnit, IsDefinition, 2014 StaticDataMemberDeclaration, AlignInBits); 2015 auto *Var2 = DIGlobalVariable::get(Context, Scope, "other", LinkageName, File, 2016 Line, Type, IsLocalToUnit, IsDefinition, 2017 StaticDataMemberDeclaration, AlignInBits); 2018 auto *N = DIGlobalVariableExpression::get(Context, Var, Expr); 2019 2020 EXPECT_EQ(Var, N->getVariable()); 2021 EXPECT_EQ(Expr, N->getExpression()); 2022 EXPECT_EQ(N, DIGlobalVariableExpression::get(Context, Var, Expr)); 2023 EXPECT_NE(N, DIGlobalVariableExpression::get(Context, Var2, Expr)); 2024 EXPECT_NE(N, DIGlobalVariableExpression::get(Context, Var, Expr2)); 2025 2026 TempDIGlobalVariableExpression Temp = N->clone(); 2027 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2028 } 2029 2030 typedef MetadataTest DILocalVariableTest; 2031 2032 TEST_F(DILocalVariableTest, get) { 2033 DILocalScope *Scope = getSubprogram(); 2034 StringRef Name = "name"; 2035 DIFile *File = getFile(); 2036 unsigned Line = 5; 2037 DIType *Type = getDerivedType(); 2038 unsigned Arg = 6; 2039 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7); 2040 uint32_t AlignInBits = 8; 2041 2042 auto *N = 2043 DILocalVariable::get(Context, Scope, Name, File, Line, Type, Arg, Flags, 2044 AlignInBits); 2045 EXPECT_TRUE(N->isParameter()); 2046 EXPECT_EQ(Scope, N->getScope()); 2047 EXPECT_EQ(Name, N->getName()); 2048 EXPECT_EQ(File, N->getFile()); 2049 EXPECT_EQ(Line, N->getLine()); 2050 EXPECT_EQ(Type, N->getType()); 2051 EXPECT_EQ(Arg, N->getArg()); 2052 EXPECT_EQ(Flags, N->getFlags()); 2053 EXPECT_EQ(AlignInBits, N->getAlignInBits()); 2054 EXPECT_EQ(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type, Arg, 2055 Flags, AlignInBits)); 2056 2057 EXPECT_FALSE( 2058 DILocalVariable::get(Context, Scope, Name, File, Line, Type, 0, Flags, 2059 AlignInBits)->isParameter()); 2060 EXPECT_NE(N, DILocalVariable::get(Context, getSubprogram(), Name, File, Line, 2061 Type, Arg, Flags, AlignInBits)); 2062 EXPECT_NE(N, DILocalVariable::get(Context, Scope, "other", File, Line, Type, 2063 Arg, Flags, AlignInBits)); 2064 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, getFile(), Line, Type, 2065 Arg, Flags, AlignInBits)); 2066 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line + 1, Type, 2067 Arg, Flags, AlignInBits)); 2068 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line, 2069 getDerivedType(), Arg, Flags, AlignInBits)); 2070 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type, 2071 Arg + 1, Flags, AlignInBits)); 2072 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type, 2073 Arg, Flags, (AlignInBits << 1))); 2074 2075 TempDILocalVariable Temp = N->clone(); 2076 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2077 } 2078 2079 TEST_F(DILocalVariableTest, getArg256) { 2080 EXPECT_EQ(255u, DILocalVariable::get(Context, getSubprogram(), "", getFile(), 2081 0, nullptr, 255, DINode::FlagZero, 0) 2082 ->getArg()); 2083 EXPECT_EQ(256u, DILocalVariable::get(Context, getSubprogram(), "", getFile(), 2084 0, nullptr, 256, DINode::FlagZero, 0) 2085 ->getArg()); 2086 EXPECT_EQ(257u, DILocalVariable::get(Context, getSubprogram(), "", getFile(), 2087 0, nullptr, 257, DINode::FlagZero, 0) 2088 ->getArg()); 2089 unsigned Max = UINT16_MAX; 2090 EXPECT_EQ(Max, DILocalVariable::get(Context, getSubprogram(), "", getFile(), 2091 0, nullptr, Max, DINode::FlagZero, 0) 2092 ->getArg()); 2093 } 2094 2095 typedef MetadataTest DIExpressionTest; 2096 2097 TEST_F(DIExpressionTest, get) { 2098 uint64_t Elements[] = {2, 6, 9, 78, 0}; 2099 auto *N = DIExpression::get(Context, Elements); 2100 EXPECT_EQ(makeArrayRef(Elements), N->getElements()); 2101 EXPECT_EQ(N, DIExpression::get(Context, Elements)); 2102 2103 EXPECT_EQ(5u, N->getNumElements()); 2104 EXPECT_EQ(2u, N->getElement(0)); 2105 EXPECT_EQ(6u, N->getElement(1)); 2106 EXPECT_EQ(9u, N->getElement(2)); 2107 EXPECT_EQ(78u, N->getElement(3)); 2108 EXPECT_EQ(0u, N->getElement(4)); 2109 2110 TempDIExpression Temp = N->clone(); 2111 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2112 2113 // Test DIExpression::prepend(). 2114 uint64_t Elts0[] = {dwarf::DW_OP_LLVM_fragment, 0, 32}; 2115 auto *N0 = DIExpression::get(Context, Elts0); 2116 N0 = DIExpression::prepend(N0, true, 64, true, true); 2117 uint64_t Elts1[] = {dwarf::DW_OP_deref, 2118 dwarf::DW_OP_plus_uconst, 64, 2119 dwarf::DW_OP_deref, 2120 dwarf::DW_OP_stack_value, 2121 dwarf::DW_OP_LLVM_fragment, 0, 32}; 2122 auto *N1 = DIExpression::get(Context, Elts1); 2123 EXPECT_EQ(N0, N1); 2124 } 2125 2126 TEST_F(DIExpressionTest, isValid) { 2127 #define EXPECT_VALID(...) \ 2128 do { \ 2129 uint64_t Elements[] = {__VA_ARGS__}; \ 2130 EXPECT_TRUE(DIExpression::get(Context, Elements)->isValid()); \ 2131 } while (false) 2132 #define EXPECT_INVALID(...) \ 2133 do { \ 2134 uint64_t Elements[] = {__VA_ARGS__}; \ 2135 EXPECT_FALSE(DIExpression::get(Context, Elements)->isValid()); \ 2136 } while (false) 2137 2138 // Empty expression should be valid. 2139 EXPECT_TRUE(DIExpression::get(Context, None)); 2140 2141 // Valid constructions. 2142 EXPECT_VALID(dwarf::DW_OP_plus_uconst, 6); 2143 EXPECT_VALID(dwarf::DW_OP_constu, 6, dwarf::DW_OP_plus); 2144 EXPECT_VALID(dwarf::DW_OP_deref); 2145 EXPECT_VALID(dwarf::DW_OP_LLVM_fragment, 3, 7); 2146 EXPECT_VALID(dwarf::DW_OP_plus_uconst, 6, dwarf::DW_OP_deref); 2147 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_plus_uconst, 6); 2148 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_LLVM_fragment, 3, 7); 2149 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_plus_uconst, 6, 2150 dwarf::DW_OP_LLVM_fragment, 3, 7); 2151 2152 // Invalid constructions. 2153 EXPECT_INVALID(~0u); 2154 EXPECT_INVALID(dwarf::DW_OP_plus, 0); 2155 EXPECT_INVALID(dwarf::DW_OP_plus_uconst); 2156 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment); 2157 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment, 3); 2158 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment, 3, 7, dwarf::DW_OP_plus_uconst, 3); 2159 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment, 3, 7, dwarf::DW_OP_deref); 2160 2161 #undef EXPECT_VALID 2162 #undef EXPECT_INVALID 2163 } 2164 2165 typedef MetadataTest DIObjCPropertyTest; 2166 2167 TEST_F(DIObjCPropertyTest, get) { 2168 StringRef Name = "name"; 2169 DIFile *File = getFile(); 2170 unsigned Line = 5; 2171 StringRef GetterName = "getter"; 2172 StringRef SetterName = "setter"; 2173 unsigned Attributes = 7; 2174 DIType *Type = getBasicType("basic"); 2175 2176 auto *N = DIObjCProperty::get(Context, Name, File, Line, GetterName, 2177 SetterName, Attributes, Type); 2178 2179 EXPECT_EQ(dwarf::DW_TAG_APPLE_property, N->getTag()); 2180 EXPECT_EQ(Name, N->getName()); 2181 EXPECT_EQ(File, N->getFile()); 2182 EXPECT_EQ(Line, N->getLine()); 2183 EXPECT_EQ(GetterName, N->getGetterName()); 2184 EXPECT_EQ(SetterName, N->getSetterName()); 2185 EXPECT_EQ(Attributes, N->getAttributes()); 2186 EXPECT_EQ(Type, N->getType()); 2187 EXPECT_EQ(N, DIObjCProperty::get(Context, Name, File, Line, GetterName, 2188 SetterName, Attributes, Type)); 2189 2190 EXPECT_NE(N, DIObjCProperty::get(Context, "other", File, Line, GetterName, 2191 SetterName, Attributes, Type)); 2192 EXPECT_NE(N, DIObjCProperty::get(Context, Name, getFile(), Line, GetterName, 2193 SetterName, Attributes, Type)); 2194 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line + 1, GetterName, 2195 SetterName, Attributes, Type)); 2196 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, "other", 2197 SetterName, Attributes, Type)); 2198 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName, 2199 "other", Attributes, Type)); 2200 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName, 2201 SetterName, Attributes + 1, Type)); 2202 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName, 2203 SetterName, Attributes, 2204 getBasicType("other"))); 2205 2206 TempDIObjCProperty Temp = N->clone(); 2207 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2208 } 2209 2210 typedef MetadataTest DIImportedEntityTest; 2211 2212 TEST_F(DIImportedEntityTest, get) { 2213 unsigned Tag = dwarf::DW_TAG_imported_module; 2214 DIScope *Scope = getSubprogram(); 2215 DINode *Entity = getCompositeType(); 2216 DIFile *File = getFile(); 2217 unsigned Line = 5; 2218 StringRef Name = "name"; 2219 2220 auto *N = 2221 DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line, Name); 2222 2223 EXPECT_EQ(Tag, N->getTag()); 2224 EXPECT_EQ(Scope, N->getScope()); 2225 EXPECT_EQ(Entity, N->getEntity()); 2226 EXPECT_EQ(File, N->getFile()); 2227 EXPECT_EQ(Line, N->getLine()); 2228 EXPECT_EQ(Name, N->getName()); 2229 EXPECT_EQ( 2230 N, DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line, Name)); 2231 2232 EXPECT_NE(N, 2233 DIImportedEntity::get(Context, dwarf::DW_TAG_imported_declaration, 2234 Scope, Entity, File, Line, Name)); 2235 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, getSubprogram(), Entity, 2236 File, Line, Name)); 2237 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, getCompositeType(), 2238 File, Line, Name)); 2239 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, Entity, nullptr, Line, 2240 Name)); 2241 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, Entity, File, 2242 Line + 1, Name)); 2243 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line, 2244 "other")); 2245 2246 TempDIImportedEntity Temp = N->clone(); 2247 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2248 } 2249 2250 typedef MetadataTest MetadataAsValueTest; 2251 2252 TEST_F(MetadataAsValueTest, MDNode) { 2253 MDNode *N = MDNode::get(Context, None); 2254 auto *V = MetadataAsValue::get(Context, N); 2255 EXPECT_TRUE(V->getType()->isMetadataTy()); 2256 EXPECT_EQ(N, V->getMetadata()); 2257 2258 auto *V2 = MetadataAsValue::get(Context, N); 2259 EXPECT_EQ(V, V2); 2260 } 2261 2262 TEST_F(MetadataAsValueTest, MDNodeMDNode) { 2263 MDNode *N = MDNode::get(Context, None); 2264 Metadata *Ops[] = {N}; 2265 MDNode *N2 = MDNode::get(Context, Ops); 2266 auto *V = MetadataAsValue::get(Context, N2); 2267 EXPECT_TRUE(V->getType()->isMetadataTy()); 2268 EXPECT_EQ(N2, V->getMetadata()); 2269 2270 auto *V2 = MetadataAsValue::get(Context, N2); 2271 EXPECT_EQ(V, V2); 2272 2273 auto *V3 = MetadataAsValue::get(Context, N); 2274 EXPECT_TRUE(V3->getType()->isMetadataTy()); 2275 EXPECT_NE(V, V3); 2276 EXPECT_EQ(N, V3->getMetadata()); 2277 } 2278 2279 TEST_F(MetadataAsValueTest, MDNodeConstant) { 2280 auto *C = ConstantInt::getTrue(Context); 2281 auto *MD = ConstantAsMetadata::get(C); 2282 Metadata *Ops[] = {MD}; 2283 auto *N = MDNode::get(Context, Ops); 2284 2285 auto *V = MetadataAsValue::get(Context, MD); 2286 EXPECT_TRUE(V->getType()->isMetadataTy()); 2287 EXPECT_EQ(MD, V->getMetadata()); 2288 2289 auto *V2 = MetadataAsValue::get(Context, N); 2290 EXPECT_EQ(MD, V2->getMetadata()); 2291 EXPECT_EQ(V, V2); 2292 } 2293 2294 typedef MetadataTest ValueAsMetadataTest; 2295 2296 TEST_F(ValueAsMetadataTest, UpdatesOnRAUW) { 2297 Type *Ty = Type::getInt1PtrTy(Context); 2298 std::unique_ptr<GlobalVariable> GV0( 2299 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2300 auto *MD = ValueAsMetadata::get(GV0.get()); 2301 EXPECT_TRUE(MD->getValue() == GV0.get()); 2302 ASSERT_TRUE(GV0->use_empty()); 2303 2304 std::unique_ptr<GlobalVariable> GV1( 2305 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2306 GV0->replaceAllUsesWith(GV1.get()); 2307 EXPECT_TRUE(MD->getValue() == GV1.get()); 2308 } 2309 2310 TEST_F(ValueAsMetadataTest, TempTempReplacement) { 2311 // Create a constant. 2312 ConstantAsMetadata *CI = 2313 ConstantAsMetadata::get(ConstantInt::get(Context, APInt(8, 0))); 2314 2315 auto Temp1 = MDTuple::getTemporary(Context, None); 2316 auto Temp2 = MDTuple::getTemporary(Context, {CI}); 2317 auto *N = MDTuple::get(Context, {Temp1.get()}); 2318 2319 // Test replacing a temporary node with another temporary node. 2320 Temp1->replaceAllUsesWith(Temp2.get()); 2321 EXPECT_EQ(N->getOperand(0), Temp2.get()); 2322 2323 // Clean up Temp2 for teardown. 2324 Temp2->replaceAllUsesWith(nullptr); 2325 } 2326 2327 TEST_F(ValueAsMetadataTest, CollidingDoubleUpdates) { 2328 // Create a constant. 2329 ConstantAsMetadata *CI = 2330 ConstantAsMetadata::get(ConstantInt::get(Context, APInt(8, 0))); 2331 2332 // Create a temporary to prevent nodes from resolving. 2333 auto Temp = MDTuple::getTemporary(Context, None); 2334 2335 // When the first operand of N1 gets reset to nullptr, it'll collide with N2. 2336 Metadata *Ops1[] = {CI, CI, Temp.get()}; 2337 Metadata *Ops2[] = {nullptr, CI, Temp.get()}; 2338 2339 auto *N1 = MDTuple::get(Context, Ops1); 2340 auto *N2 = MDTuple::get(Context, Ops2); 2341 ASSERT_NE(N1, N2); 2342 2343 // Tell metadata that the constant is getting deleted. 2344 // 2345 // After this, N1 will be invalid, so don't touch it. 2346 ValueAsMetadata::handleDeletion(CI->getValue()); 2347 EXPECT_EQ(nullptr, N2->getOperand(0)); 2348 EXPECT_EQ(nullptr, N2->getOperand(1)); 2349 EXPECT_EQ(Temp.get(), N2->getOperand(2)); 2350 2351 // Clean up Temp for teardown. 2352 Temp->replaceAllUsesWith(nullptr); 2353 } 2354 2355 typedef MetadataTest TrackingMDRefTest; 2356 2357 TEST_F(TrackingMDRefTest, UpdatesOnRAUW) { 2358 Type *Ty = Type::getInt1PtrTy(Context); 2359 std::unique_ptr<GlobalVariable> GV0( 2360 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2361 TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV0.get())); 2362 EXPECT_TRUE(MD->getValue() == GV0.get()); 2363 ASSERT_TRUE(GV0->use_empty()); 2364 2365 std::unique_ptr<GlobalVariable> GV1( 2366 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2367 GV0->replaceAllUsesWith(GV1.get()); 2368 EXPECT_TRUE(MD->getValue() == GV1.get()); 2369 2370 // Reset it, so we don't inadvertently test deletion. 2371 MD.reset(); 2372 } 2373 2374 TEST_F(TrackingMDRefTest, UpdatesOnDeletion) { 2375 Type *Ty = Type::getInt1PtrTy(Context); 2376 std::unique_ptr<GlobalVariable> GV( 2377 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2378 TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV.get())); 2379 EXPECT_TRUE(MD->getValue() == GV.get()); 2380 ASSERT_TRUE(GV->use_empty()); 2381 2382 GV.reset(); 2383 EXPECT_TRUE(!MD); 2384 } 2385 2386 TEST(NamedMDNodeTest, Search) { 2387 LLVMContext Context; 2388 ConstantAsMetadata *C = 2389 ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 1)); 2390 ConstantAsMetadata *C2 = 2391 ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 2)); 2392 2393 Metadata *const V = C; 2394 Metadata *const V2 = C2; 2395 MDNode *n = MDNode::get(Context, V); 2396 MDNode *n2 = MDNode::get(Context, V2); 2397 2398 Module M("MyModule", Context); 2399 const char *Name = "llvm.NMD1"; 2400 NamedMDNode *NMD = M.getOrInsertNamedMetadata(Name); 2401 NMD->addOperand(n); 2402 NMD->addOperand(n2); 2403 2404 std::string Str; 2405 raw_string_ostream oss(Str); 2406 NMD->print(oss); 2407 EXPECT_STREQ("!llvm.NMD1 = !{!0, !1}\n", 2408 oss.str().c_str()); 2409 } 2410 2411 typedef MetadataTest FunctionAttachmentTest; 2412 TEST_F(FunctionAttachmentTest, setMetadata) { 2413 Function *F = getFunction("foo"); 2414 ASSERT_FALSE(F->hasMetadata()); 2415 EXPECT_EQ(nullptr, F->getMetadata(LLVMContext::MD_dbg)); 2416 EXPECT_EQ(nullptr, F->getMetadata("dbg")); 2417 EXPECT_EQ(nullptr, F->getMetadata("other")); 2418 2419 DISubprogram *SP1 = getSubprogram(); 2420 DISubprogram *SP2 = getSubprogram(); 2421 ASSERT_NE(SP1, SP2); 2422 2423 F->setMetadata("dbg", SP1); 2424 EXPECT_TRUE(F->hasMetadata()); 2425 EXPECT_EQ(SP1, F->getMetadata(LLVMContext::MD_dbg)); 2426 EXPECT_EQ(SP1, F->getMetadata("dbg")); 2427 EXPECT_EQ(nullptr, F->getMetadata("other")); 2428 2429 F->setMetadata(LLVMContext::MD_dbg, SP2); 2430 EXPECT_TRUE(F->hasMetadata()); 2431 EXPECT_EQ(SP2, F->getMetadata(LLVMContext::MD_dbg)); 2432 EXPECT_EQ(SP2, F->getMetadata("dbg")); 2433 EXPECT_EQ(nullptr, F->getMetadata("other")); 2434 2435 F->setMetadata("dbg", nullptr); 2436 EXPECT_FALSE(F->hasMetadata()); 2437 EXPECT_EQ(nullptr, F->getMetadata(LLVMContext::MD_dbg)); 2438 EXPECT_EQ(nullptr, F->getMetadata("dbg")); 2439 EXPECT_EQ(nullptr, F->getMetadata("other")); 2440 2441 MDTuple *T1 = getTuple(); 2442 MDTuple *T2 = getTuple(); 2443 ASSERT_NE(T1, T2); 2444 2445 F->setMetadata("other1", T1); 2446 F->setMetadata("other2", T2); 2447 EXPECT_TRUE(F->hasMetadata()); 2448 EXPECT_EQ(T1, F->getMetadata("other1")); 2449 EXPECT_EQ(T2, F->getMetadata("other2")); 2450 EXPECT_EQ(nullptr, F->getMetadata("dbg")); 2451 2452 F->setMetadata("other1", T2); 2453 F->setMetadata("other2", T1); 2454 EXPECT_EQ(T2, F->getMetadata("other1")); 2455 EXPECT_EQ(T1, F->getMetadata("other2")); 2456 2457 F->setMetadata("other1", nullptr); 2458 F->setMetadata("other2", nullptr); 2459 EXPECT_FALSE(F->hasMetadata()); 2460 EXPECT_EQ(nullptr, F->getMetadata("other1")); 2461 EXPECT_EQ(nullptr, F->getMetadata("other2")); 2462 } 2463 2464 TEST_F(FunctionAttachmentTest, getAll) { 2465 Function *F = getFunction("foo"); 2466 2467 MDTuple *T1 = getTuple(); 2468 MDTuple *T2 = getTuple(); 2469 MDTuple *P = getTuple(); 2470 DISubprogram *SP = getSubprogram(); 2471 2472 F->setMetadata("other1", T2); 2473 F->setMetadata(LLVMContext::MD_dbg, SP); 2474 F->setMetadata("other2", T1); 2475 F->setMetadata(LLVMContext::MD_prof, P); 2476 F->setMetadata("other2", T2); 2477 F->setMetadata("other1", T1); 2478 2479 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs; 2480 F->getAllMetadata(MDs); 2481 ASSERT_EQ(4u, MDs.size()); 2482 EXPECT_EQ(LLVMContext::MD_dbg, MDs[0].first); 2483 EXPECT_EQ(LLVMContext::MD_prof, MDs[1].first); 2484 EXPECT_EQ(Context.getMDKindID("other1"), MDs[2].first); 2485 EXPECT_EQ(Context.getMDKindID("other2"), MDs[3].first); 2486 EXPECT_EQ(SP, MDs[0].second); 2487 EXPECT_EQ(P, MDs[1].second); 2488 EXPECT_EQ(T1, MDs[2].second); 2489 EXPECT_EQ(T2, MDs[3].second); 2490 } 2491 2492 TEST_F(FunctionAttachmentTest, Verifier) { 2493 Function *F = getFunction("foo"); 2494 F->setMetadata("attach", getTuple()); 2495 F->setIsMaterializable(true); 2496 2497 // Confirm this is materializable. 2498 ASSERT_TRUE(F->isMaterializable()); 2499 2500 // Materializable functions cannot have metadata attachments. 2501 EXPECT_TRUE(verifyFunction(*F)); 2502 2503 // Function declarations can. 2504 F->setIsMaterializable(false); 2505 EXPECT_FALSE(verifyModule(*F->getParent())); 2506 EXPECT_FALSE(verifyFunction(*F)); 2507 2508 // So can definitions. 2509 (void)new UnreachableInst(Context, BasicBlock::Create(Context, "bb", F)); 2510 EXPECT_FALSE(verifyModule(*F->getParent())); 2511 EXPECT_FALSE(verifyFunction(*F)); 2512 } 2513 2514 TEST_F(FunctionAttachmentTest, EntryCount) { 2515 Function *F = getFunction("foo"); 2516 EXPECT_FALSE(F->getEntryCount().hasValue()); 2517 F->setEntryCount(12304, Function::PCT_Real); 2518 auto Count = F->getEntryCount(); 2519 EXPECT_TRUE(Count.hasValue()); 2520 EXPECT_EQ(12304u, Count.getCount()); 2521 EXPECT_EQ(Function::PCT_Real, Count.getType()); 2522 2523 // Repeat the same for synthetic counts. 2524 F = getFunction("bar"); 2525 EXPECT_FALSE(F->getEntryCount().hasValue()); 2526 F->setEntryCount(123, Function::PCT_Synthetic); 2527 Count = F->getEntryCount(); 2528 EXPECT_TRUE(Count.hasValue()); 2529 EXPECT_EQ(123u, Count.getCount()); 2530 EXPECT_EQ(Function::PCT_Synthetic, Count.getType()); 2531 } 2532 2533 TEST_F(FunctionAttachmentTest, SubprogramAttachment) { 2534 Function *F = getFunction("foo"); 2535 DISubprogram *SP = getSubprogram(); 2536 F->setSubprogram(SP); 2537 2538 // Note that the static_cast confirms that F->getSubprogram() actually 2539 // returns an DISubprogram. 2540 EXPECT_EQ(SP, static_cast<DISubprogram *>(F->getSubprogram())); 2541 EXPECT_EQ(SP, F->getMetadata("dbg")); 2542 EXPECT_EQ(SP, F->getMetadata(LLVMContext::MD_dbg)); 2543 } 2544 2545 typedef MetadataTest DistinctMDOperandPlaceholderTest; 2546 TEST_F(DistinctMDOperandPlaceholderTest, getID) { 2547 EXPECT_EQ(7u, DistinctMDOperandPlaceholder(7).getID()); 2548 } 2549 2550 TEST_F(DistinctMDOperandPlaceholderTest, replaceUseWith) { 2551 // Set up some placeholders. 2552 DistinctMDOperandPlaceholder PH0(7); 2553 DistinctMDOperandPlaceholder PH1(3); 2554 DistinctMDOperandPlaceholder PH2(0); 2555 Metadata *Ops[] = {&PH0, &PH1, &PH2}; 2556 auto *D = MDTuple::getDistinct(Context, Ops); 2557 ASSERT_EQ(&PH0, D->getOperand(0)); 2558 ASSERT_EQ(&PH1, D->getOperand(1)); 2559 ASSERT_EQ(&PH2, D->getOperand(2)); 2560 2561 // Replace them. 2562 auto *N0 = MDTuple::get(Context, None); 2563 auto *N1 = MDTuple::get(Context, N0); 2564 PH0.replaceUseWith(N0); 2565 PH1.replaceUseWith(N1); 2566 PH2.replaceUseWith(nullptr); 2567 EXPECT_EQ(N0, D->getOperand(0)); 2568 EXPECT_EQ(N1, D->getOperand(1)); 2569 EXPECT_EQ(nullptr, D->getOperand(2)); 2570 } 2571 2572 TEST_F(DistinctMDOperandPlaceholderTest, replaceUseWithNoUser) { 2573 // There is no user, but we can still call replace. 2574 DistinctMDOperandPlaceholder(7).replaceUseWith(MDTuple::get(Context, None)); 2575 } 2576 2577 // Test various assertions in metadata tracking. Don't run these tests if gtest 2578 // will use SEH to recover from them. Two of these tests get halfway through 2579 // inserting metadata into DenseMaps for tracking purposes, and then they 2580 // assert, and we attempt to destroy an LLVMContext with broken invariants, 2581 // leading to infinite loops. 2582 #if defined(GTEST_HAS_DEATH_TEST) && !defined(NDEBUG) && !defined(GTEST_HAS_SEH) 2583 TEST_F(DistinctMDOperandPlaceholderTest, MetadataAsValue) { 2584 // This shouldn't crash. 2585 DistinctMDOperandPlaceholder PH(7); 2586 EXPECT_DEATH(MetadataAsValue::get(Context, &PH), 2587 "Unexpected callback to owner"); 2588 } 2589 2590 TEST_F(DistinctMDOperandPlaceholderTest, UniquedMDNode) { 2591 // This shouldn't crash. 2592 DistinctMDOperandPlaceholder PH(7); 2593 EXPECT_DEATH(MDTuple::get(Context, &PH), "Unexpected callback to owner"); 2594 } 2595 2596 TEST_F(DistinctMDOperandPlaceholderTest, SecondDistinctMDNode) { 2597 // This shouldn't crash. 2598 DistinctMDOperandPlaceholder PH(7); 2599 MDTuple::getDistinct(Context, &PH); 2600 EXPECT_DEATH(MDTuple::getDistinct(Context, &PH), 2601 "Placeholders can only be used once"); 2602 } 2603 2604 TEST_F(DistinctMDOperandPlaceholderTest, TrackingMDRefAndDistinctMDNode) { 2605 // TrackingMDRef doesn't install an owner callback, so it can't be detected 2606 // as an invalid use. However, using a placeholder in a TrackingMDRef *and* 2607 // a distinct node isn't possible and we should assert. 2608 // 2609 // (There's no positive test for using TrackingMDRef because it's not a 2610 // useful thing to do.) 2611 { 2612 DistinctMDOperandPlaceholder PH(7); 2613 MDTuple::getDistinct(Context, &PH); 2614 EXPECT_DEATH(TrackingMDRef Ref(&PH), "Placeholders can only be used once"); 2615 } 2616 { 2617 DistinctMDOperandPlaceholder PH(7); 2618 TrackingMDRef Ref(&PH); 2619 EXPECT_DEATH(MDTuple::getDistinct(Context, &PH), 2620 "Placeholders can only be used once"); 2621 } 2622 } 2623 #endif 2624 2625 } // end namespace 2626