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