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, 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(Context, 1, getFile(), "clang", false, 96 "-g", 2, "", DICompileUnit::FullDebug, 97 getTuple(), getTuple(), getTuple(), 98 getTuple(), getTuple(), 0, true); 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, 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 delete I; 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 EXPECT_EQ(dwarf::DW_TAG_subrange_type, N->getTag()); 936 EXPECT_EQ(5, N->getCount()); 937 EXPECT_EQ(7, N->getLowerBound()); 938 EXPECT_EQ(N, DISubrange::get(Context, 5, 7)); 939 EXPECT_EQ(DISubrange::get(Context, 5, 0), DISubrange::get(Context, 5)); 940 941 TempDISubrange Temp = N->clone(); 942 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 943 } 944 945 TEST_F(DISubrangeTest, getEmptyArray) { 946 auto *N = DISubrange::get(Context, -1, 0); 947 EXPECT_EQ(dwarf::DW_TAG_subrange_type, N->getTag()); 948 EXPECT_EQ(-1, N->getCount()); 949 EXPECT_EQ(0, N->getLowerBound()); 950 EXPECT_EQ(N, DISubrange::get(Context, -1, 0)); 951 } 952 953 typedef MetadataTest DIEnumeratorTest; 954 955 TEST_F(DIEnumeratorTest, get) { 956 auto *N = DIEnumerator::get(Context, 7, "name"); 957 EXPECT_EQ(dwarf::DW_TAG_enumerator, N->getTag()); 958 EXPECT_EQ(7, N->getValue()); 959 EXPECT_EQ("name", N->getName()); 960 EXPECT_EQ(N, DIEnumerator::get(Context, 7, "name")); 961 962 EXPECT_NE(N, DIEnumerator::get(Context, 8, "name")); 963 EXPECT_NE(N, DIEnumerator::get(Context, 7, "nam")); 964 965 TempDIEnumerator Temp = N->clone(); 966 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 967 } 968 969 typedef MetadataTest DIBasicTypeTest; 970 971 TEST_F(DIBasicTypeTest, get) { 972 auto *N = 973 DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 26, 7); 974 EXPECT_EQ(dwarf::DW_TAG_base_type, N->getTag()); 975 EXPECT_EQ("special", N->getName()); 976 EXPECT_EQ(33u, N->getSizeInBits()); 977 EXPECT_EQ(26u, N->getAlignInBits()); 978 EXPECT_EQ(7u, N->getEncoding()); 979 EXPECT_EQ(0u, N->getLine()); 980 EXPECT_EQ(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 981 26, 7)); 982 983 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type, 984 "special", 33, 26, 7)); 985 EXPECT_NE(N, 986 DIBasicType::get(Context, dwarf::DW_TAG_base_type, "s", 33, 26, 7)); 987 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 32, 988 26, 7)); 989 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 990 25, 7)); 991 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 992 26, 6)); 993 994 TempDIBasicType Temp = N->clone(); 995 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 996 } 997 998 TEST_F(DIBasicTypeTest, getWithLargeValues) { 999 auto *N = DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 1000 UINT64_MAX, UINT32_MAX - 1, 7); 1001 EXPECT_EQ(UINT64_MAX, N->getSizeInBits()); 1002 EXPECT_EQ(UINT32_MAX - 1, N->getAlignInBits()); 1003 } 1004 1005 TEST_F(DIBasicTypeTest, getUnspecified) { 1006 auto *N = 1007 DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type, "unspecified"); 1008 EXPECT_EQ(dwarf::DW_TAG_unspecified_type, N->getTag()); 1009 EXPECT_EQ("unspecified", N->getName()); 1010 EXPECT_EQ(0u, N->getSizeInBits()); 1011 EXPECT_EQ(0u, N->getAlignInBits()); 1012 EXPECT_EQ(0u, N->getEncoding()); 1013 EXPECT_EQ(0u, N->getLine()); 1014 } 1015 1016 typedef MetadataTest DITypeTest; 1017 1018 TEST_F(DITypeTest, clone) { 1019 // Check that DIType has a specialized clone that returns TempDIType. 1020 DIType *N = DIBasicType::get(Context, dwarf::DW_TAG_base_type, "int", 32, 32, 1021 dwarf::DW_ATE_signed); 1022 1023 TempDIType Temp = N->clone(); 1024 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1025 } 1026 1027 TEST_F(DITypeTest, setFlags) { 1028 // void (void) 1029 Metadata *TypesOps[] = {nullptr}; 1030 Metadata *Types = MDTuple::get(Context, TypesOps); 1031 1032 DIType *D = 1033 DISubroutineType::getDistinct(Context, DINode::FlagZero, 0, Types); 1034 EXPECT_EQ(DINode::FlagZero, D->getFlags()); 1035 D->setFlags(DINode::FlagRValueReference); 1036 EXPECT_EQ(DINode::FlagRValueReference, D->getFlags()); 1037 D->setFlags(DINode::FlagZero); 1038 EXPECT_EQ(DINode::FlagZero, D->getFlags()); 1039 1040 TempDIType T = 1041 DISubroutineType::getTemporary(Context, DINode::FlagZero, 0, Types); 1042 EXPECT_EQ(DINode::FlagZero, T->getFlags()); 1043 T->setFlags(DINode::FlagRValueReference); 1044 EXPECT_EQ(DINode::FlagRValueReference, T->getFlags()); 1045 T->setFlags(DINode::FlagZero); 1046 EXPECT_EQ(DINode::FlagZero, T->getFlags()); 1047 } 1048 1049 typedef MetadataTest DIDerivedTypeTest; 1050 1051 TEST_F(DIDerivedTypeTest, get) { 1052 DIFile *File = getFile(); 1053 DIScope *Scope = getSubprogram(); 1054 DIType *BaseType = getBasicType("basic"); 1055 MDTuple *ExtraData = getTuple(); 1056 DINode::DIFlags Flags5 = static_cast<DINode::DIFlags>(5); 1057 DINode::DIFlags Flags4 = static_cast<DINode::DIFlags>(4); 1058 1059 auto *N = 1060 DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "something", File, 1061 1, Scope, BaseType, 2, 3, 4, Flags5, ExtraData); 1062 EXPECT_EQ(dwarf::DW_TAG_pointer_type, N->getTag()); 1063 EXPECT_EQ("something", N->getName()); 1064 EXPECT_EQ(File, N->getFile()); 1065 EXPECT_EQ(1u, N->getLine()); 1066 EXPECT_EQ(Scope, N->getScope()); 1067 EXPECT_EQ(BaseType, N->getBaseType()); 1068 EXPECT_EQ(2u, N->getSizeInBits()); 1069 EXPECT_EQ(3u, N->getAlignInBits()); 1070 EXPECT_EQ(4u, N->getOffsetInBits()); 1071 EXPECT_EQ(5u, N->getFlags()); 1072 EXPECT_EQ(ExtraData, N->getExtraData()); 1073 EXPECT_EQ(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1074 "something", File, 1, Scope, BaseType, 2, 3, 1075 4, Flags5, ExtraData)); 1076 1077 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_reference_type, 1078 "something", File, 1, Scope, BaseType, 2, 3, 1079 4, Flags5, ExtraData)); 1080 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "else", 1081 File, 1, Scope, BaseType, 2, 3, 4, Flags5, 1082 ExtraData)); 1083 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1084 "something", getFile(), 1, Scope, BaseType, 2, 1085 3, 4, Flags5, ExtraData)); 1086 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1087 "something", File, 2, Scope, BaseType, 2, 3, 1088 4, Flags5, ExtraData)); 1089 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1090 "something", File, 1, getSubprogram(), 1091 BaseType, 2, 3, 4, Flags5, ExtraData)); 1092 EXPECT_NE(N, DIDerivedType::get( 1093 Context, dwarf::DW_TAG_pointer_type, "something", File, 1, 1094 Scope, getBasicType("basic2"), 2, 3, 4, Flags5, ExtraData)); 1095 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1096 "something", File, 1, Scope, BaseType, 3, 3, 1097 4, Flags5, ExtraData)); 1098 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1099 "something", File, 1, Scope, BaseType, 2, 2, 1100 4, Flags5, ExtraData)); 1101 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1102 "something", File, 1, Scope, BaseType, 2, 3, 1103 5, Flags5, ExtraData)); 1104 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1105 "something", File, 1, Scope, BaseType, 2, 3, 1106 4, Flags4, ExtraData)); 1107 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1108 "something", File, 1, Scope, BaseType, 2, 3, 1109 4, Flags5, getTuple())); 1110 1111 TempDIDerivedType Temp = N->clone(); 1112 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1113 } 1114 1115 TEST_F(DIDerivedTypeTest, getWithLargeValues) { 1116 DIFile *File = getFile(); 1117 DIScope *Scope = getSubprogram(); 1118 DIType *BaseType = getBasicType("basic"); 1119 MDTuple *ExtraData = getTuple(); 1120 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1121 1122 auto *N = DIDerivedType::get( 1123 Context, dwarf::DW_TAG_pointer_type, "something", File, 1, Scope, 1124 BaseType, UINT64_MAX, UINT32_MAX - 1, UINT64_MAX - 2, Flags, ExtraData); 1125 EXPECT_EQ(UINT64_MAX, N->getSizeInBits()); 1126 EXPECT_EQ(UINT32_MAX - 1, N->getAlignInBits()); 1127 EXPECT_EQ(UINT64_MAX - 2, N->getOffsetInBits()); 1128 } 1129 1130 typedef MetadataTest DICompositeTypeTest; 1131 1132 TEST_F(DICompositeTypeTest, get) { 1133 unsigned Tag = dwarf::DW_TAG_structure_type; 1134 StringRef Name = "some name"; 1135 DIFile *File = getFile(); 1136 unsigned Line = 1; 1137 DIScope *Scope = getSubprogram(); 1138 DIType *BaseType = getCompositeType(); 1139 uint64_t SizeInBits = 2; 1140 uint32_t AlignInBits = 3; 1141 uint64_t OffsetInBits = 4; 1142 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1143 MDTuple *Elements = getTuple(); 1144 unsigned RuntimeLang = 6; 1145 DIType *VTableHolder = getCompositeType(); 1146 MDTuple *TemplateParams = getTuple(); 1147 StringRef Identifier = "some id"; 1148 1149 auto *N = DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1150 BaseType, SizeInBits, AlignInBits, 1151 OffsetInBits, Flags, Elements, RuntimeLang, 1152 VTableHolder, TemplateParams, Identifier); 1153 EXPECT_EQ(Tag, N->getTag()); 1154 EXPECT_EQ(Name, N->getName()); 1155 EXPECT_EQ(File, N->getFile()); 1156 EXPECT_EQ(Line, N->getLine()); 1157 EXPECT_EQ(Scope, N->getScope()); 1158 EXPECT_EQ(BaseType, N->getBaseType()); 1159 EXPECT_EQ(SizeInBits, N->getSizeInBits()); 1160 EXPECT_EQ(AlignInBits, N->getAlignInBits()); 1161 EXPECT_EQ(OffsetInBits, N->getOffsetInBits()); 1162 EXPECT_EQ(Flags, N->getFlags()); 1163 EXPECT_EQ(Elements, N->getElements().get()); 1164 EXPECT_EQ(RuntimeLang, N->getRuntimeLang()); 1165 EXPECT_EQ(VTableHolder, N->getVTableHolder()); 1166 EXPECT_EQ(TemplateParams, N->getTemplateParams().get()); 1167 EXPECT_EQ(Identifier, N->getIdentifier()); 1168 1169 EXPECT_EQ(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1170 BaseType, SizeInBits, AlignInBits, 1171 OffsetInBits, Flags, Elements, RuntimeLang, 1172 VTableHolder, TemplateParams, Identifier)); 1173 1174 EXPECT_NE(N, DICompositeType::get(Context, Tag + 1, Name, File, Line, Scope, 1175 BaseType, SizeInBits, AlignInBits, 1176 OffsetInBits, Flags, Elements, RuntimeLang, 1177 VTableHolder, TemplateParams, Identifier)); 1178 EXPECT_NE(N, DICompositeType::get(Context, Tag, "abc", File, Line, Scope, 1179 BaseType, SizeInBits, AlignInBits, 1180 OffsetInBits, Flags, Elements, RuntimeLang, 1181 VTableHolder, TemplateParams, Identifier)); 1182 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, getFile(), Line, Scope, 1183 BaseType, SizeInBits, AlignInBits, 1184 OffsetInBits, Flags, Elements, RuntimeLang, 1185 VTableHolder, TemplateParams, Identifier)); 1186 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line + 1, Scope, 1187 BaseType, SizeInBits, AlignInBits, 1188 OffsetInBits, Flags, Elements, RuntimeLang, 1189 VTableHolder, TemplateParams, Identifier)); 1190 EXPECT_NE(N, DICompositeType::get( 1191 Context, Tag, Name, File, Line, getSubprogram(), BaseType, 1192 SizeInBits, AlignInBits, OffsetInBits, Flags, Elements, 1193 RuntimeLang, VTableHolder, TemplateParams, Identifier)); 1194 EXPECT_NE(N, DICompositeType::get( 1195 Context, Tag, Name, File, Line, Scope, getBasicType("other"), 1196 SizeInBits, AlignInBits, OffsetInBits, Flags, Elements, 1197 RuntimeLang, VTableHolder, TemplateParams, Identifier)); 1198 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1199 BaseType, SizeInBits + 1, AlignInBits, 1200 OffsetInBits, Flags, Elements, RuntimeLang, 1201 VTableHolder, TemplateParams, Identifier)); 1202 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1203 BaseType, SizeInBits, AlignInBits + 1, 1204 OffsetInBits, Flags, Elements, RuntimeLang, 1205 VTableHolder, TemplateParams, Identifier)); 1206 EXPECT_NE(N, DICompositeType::get( 1207 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1208 AlignInBits, OffsetInBits + 1, Flags, Elements, RuntimeLang, 1209 VTableHolder, TemplateParams, Identifier)); 1210 DINode::DIFlags FlagsPOne = static_cast<DINode::DIFlags>(Flags + 1); 1211 EXPECT_NE(N, DICompositeType::get( 1212 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1213 AlignInBits, OffsetInBits, FlagsPOne, Elements, RuntimeLang, 1214 VTableHolder, TemplateParams, Identifier)); 1215 EXPECT_NE(N, DICompositeType::get( 1216 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1217 AlignInBits, OffsetInBits, Flags, getTuple(), RuntimeLang, 1218 VTableHolder, TemplateParams, Identifier)); 1219 EXPECT_NE(N, DICompositeType::get( 1220 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1221 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang + 1, 1222 VTableHolder, TemplateParams, Identifier)); 1223 EXPECT_NE(N, DICompositeType::get( 1224 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1225 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang, 1226 getCompositeType(), TemplateParams, Identifier)); 1227 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1228 BaseType, SizeInBits, AlignInBits, 1229 OffsetInBits, Flags, Elements, RuntimeLang, 1230 VTableHolder, getTuple(), Identifier)); 1231 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1232 BaseType, SizeInBits, AlignInBits, 1233 OffsetInBits, Flags, Elements, RuntimeLang, 1234 VTableHolder, TemplateParams, "other")); 1235 1236 // Be sure that missing identifiers get null pointers. 1237 EXPECT_FALSE(DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1238 BaseType, SizeInBits, AlignInBits, 1239 OffsetInBits, Flags, Elements, RuntimeLang, 1240 VTableHolder, TemplateParams, "") 1241 ->getRawIdentifier()); 1242 EXPECT_FALSE(DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1243 BaseType, SizeInBits, AlignInBits, 1244 OffsetInBits, Flags, Elements, RuntimeLang, 1245 VTableHolder, TemplateParams) 1246 ->getRawIdentifier()); 1247 1248 TempDICompositeType Temp = N->clone(); 1249 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1250 } 1251 1252 TEST_F(DICompositeTypeTest, getWithLargeValues) { 1253 unsigned Tag = dwarf::DW_TAG_structure_type; 1254 StringRef Name = "some name"; 1255 DIFile *File = getFile(); 1256 unsigned Line = 1; 1257 DIScope *Scope = getSubprogram(); 1258 DIType *BaseType = getCompositeType(); 1259 uint64_t SizeInBits = UINT64_MAX; 1260 uint32_t AlignInBits = UINT32_MAX - 1; 1261 uint64_t OffsetInBits = UINT64_MAX - 2; 1262 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1263 MDTuple *Elements = getTuple(); 1264 unsigned RuntimeLang = 6; 1265 DIType *VTableHolder = getCompositeType(); 1266 MDTuple *TemplateParams = getTuple(); 1267 StringRef Identifier = "some id"; 1268 1269 auto *N = DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1270 BaseType, SizeInBits, AlignInBits, 1271 OffsetInBits, Flags, Elements, RuntimeLang, 1272 VTableHolder, TemplateParams, Identifier); 1273 EXPECT_EQ(SizeInBits, N->getSizeInBits()); 1274 EXPECT_EQ(AlignInBits, N->getAlignInBits()); 1275 EXPECT_EQ(OffsetInBits, N->getOffsetInBits()); 1276 } 1277 1278 TEST_F(DICompositeTypeTest, replaceOperands) { 1279 unsigned Tag = dwarf::DW_TAG_structure_type; 1280 StringRef Name = "some name"; 1281 DIFile *File = getFile(); 1282 unsigned Line = 1; 1283 DIScope *Scope = getSubprogram(); 1284 DIType *BaseType = getCompositeType(); 1285 uint64_t SizeInBits = 2; 1286 uint32_t AlignInBits = 3; 1287 uint64_t OffsetInBits = 4; 1288 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1289 unsigned RuntimeLang = 6; 1290 StringRef Identifier = "some id"; 1291 1292 auto *N = DICompositeType::get( 1293 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, 1294 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier); 1295 1296 auto *Elements = MDTuple::getDistinct(Context, None); 1297 EXPECT_EQ(nullptr, N->getElements().get()); 1298 N->replaceElements(Elements); 1299 EXPECT_EQ(Elements, N->getElements().get()); 1300 N->replaceElements(nullptr); 1301 EXPECT_EQ(nullptr, N->getElements().get()); 1302 1303 DIType *VTableHolder = getCompositeType(); 1304 EXPECT_EQ(nullptr, N->getVTableHolder()); 1305 N->replaceVTableHolder(VTableHolder); 1306 EXPECT_EQ(VTableHolder, N->getVTableHolder()); 1307 N->replaceVTableHolder(nullptr); 1308 EXPECT_EQ(nullptr, N->getVTableHolder()); 1309 1310 auto *TemplateParams = MDTuple::getDistinct(Context, None); 1311 EXPECT_EQ(nullptr, N->getTemplateParams().get()); 1312 N->replaceTemplateParams(TemplateParams); 1313 EXPECT_EQ(TemplateParams, N->getTemplateParams().get()); 1314 N->replaceTemplateParams(nullptr); 1315 EXPECT_EQ(nullptr, N->getTemplateParams().get()); 1316 } 1317 1318 typedef MetadataTest DISubroutineTypeTest; 1319 1320 TEST_F(DISubroutineTypeTest, get) { 1321 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(1); 1322 DINode::DIFlags FlagsPOne = static_cast<DINode::DIFlags>(Flags + 1); 1323 MDTuple *TypeArray = getTuple(); 1324 1325 auto *N = DISubroutineType::get(Context, Flags, 0, TypeArray); 1326 EXPECT_EQ(dwarf::DW_TAG_subroutine_type, N->getTag()); 1327 EXPECT_EQ(Flags, N->getFlags()); 1328 EXPECT_EQ(TypeArray, N->getTypeArray().get()); 1329 EXPECT_EQ(N, DISubroutineType::get(Context, Flags, 0, TypeArray)); 1330 1331 EXPECT_NE(N, DISubroutineType::get(Context, FlagsPOne, 0, TypeArray)); 1332 EXPECT_NE(N, DISubroutineType::get(Context, Flags, 0, getTuple())); 1333 1334 // Test the hashing of calling conventions. 1335 auto *Fast = DISubroutineType::get( 1336 Context, Flags, dwarf::DW_CC_BORLAND_msfastcall, TypeArray); 1337 auto *Std = DISubroutineType::get(Context, Flags, 1338 dwarf::DW_CC_BORLAND_stdcall, TypeArray); 1339 EXPECT_EQ(Fast, 1340 DISubroutineType::get(Context, Flags, 1341 dwarf::DW_CC_BORLAND_msfastcall, TypeArray)); 1342 EXPECT_EQ(Std, DISubroutineType::get( 1343 Context, Flags, dwarf::DW_CC_BORLAND_stdcall, TypeArray)); 1344 1345 EXPECT_NE(N, Fast); 1346 EXPECT_NE(N, Std); 1347 EXPECT_NE(Fast, Std); 1348 1349 TempDISubroutineType Temp = N->clone(); 1350 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1351 1352 // Test always-empty operands. 1353 EXPECT_EQ(nullptr, N->getScope()); 1354 EXPECT_EQ(nullptr, N->getFile()); 1355 EXPECT_EQ("", N->getName()); 1356 } 1357 1358 typedef MetadataTest DIFileTest; 1359 1360 TEST_F(DIFileTest, get) { 1361 StringRef Filename = "file"; 1362 StringRef Directory = "dir"; 1363 DIFile::ChecksumKind CSKind = DIFile::CSK_MD5; 1364 StringRef Checksum = "000102030405060708090a0b0c0d0e0f"; 1365 auto *N = DIFile::get(Context, Filename, Directory, CSKind, Checksum); 1366 1367 EXPECT_EQ(dwarf::DW_TAG_file_type, N->getTag()); 1368 EXPECT_EQ(Filename, N->getFilename()); 1369 EXPECT_EQ(Directory, N->getDirectory()); 1370 EXPECT_EQ(CSKind, N->getChecksumKind()); 1371 EXPECT_EQ(Checksum, N->getChecksum()); 1372 EXPECT_EQ(N, DIFile::get(Context, Filename, Directory, CSKind, Checksum)); 1373 1374 EXPECT_NE(N, DIFile::get(Context, "other", Directory, CSKind, Checksum)); 1375 EXPECT_NE(N, DIFile::get(Context, Filename, "other", CSKind, Checksum)); 1376 EXPECT_NE(N, DIFile::get(Context, Filename, Directory, DIFile::CSK_SHA1, Checksum)); 1377 EXPECT_NE(N, DIFile::get(Context, Filename, Directory)); 1378 1379 TempDIFile Temp = N->clone(); 1380 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1381 } 1382 1383 TEST_F(DIFileTest, ScopeGetFile) { 1384 // Ensure that DIScope::getFile() returns itself. 1385 DIScope *N = DIFile::get(Context, "file", "dir"); 1386 EXPECT_EQ(N, N->getFile()); 1387 } 1388 1389 typedef MetadataTest DICompileUnitTest; 1390 1391 TEST_F(DICompileUnitTest, get) { 1392 unsigned SourceLanguage = 1; 1393 DIFile *File = getFile(); 1394 StringRef Producer = "some producer"; 1395 bool IsOptimized = false; 1396 StringRef Flags = "flag after flag"; 1397 unsigned RuntimeVersion = 2; 1398 StringRef SplitDebugFilename = "another/file"; 1399 auto EmissionKind = DICompileUnit::FullDebug; 1400 MDTuple *EnumTypes = getTuple(); 1401 MDTuple *RetainedTypes = getTuple(); 1402 MDTuple *GlobalVariables = getTuple(); 1403 MDTuple *ImportedEntities = getTuple(); 1404 uint64_t DWOId = 0x10000000c0ffee; 1405 MDTuple *Macros = getTuple(); 1406 auto *N = DICompileUnit::getDistinct( 1407 Context, SourceLanguage, File, Producer, IsOptimized, Flags, 1408 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes, 1409 RetainedTypes, GlobalVariables, ImportedEntities, Macros, DWOId, true); 1410 1411 EXPECT_EQ(dwarf::DW_TAG_compile_unit, N->getTag()); 1412 EXPECT_EQ(SourceLanguage, N->getSourceLanguage()); 1413 EXPECT_EQ(File, N->getFile()); 1414 EXPECT_EQ(Producer, N->getProducer()); 1415 EXPECT_EQ(IsOptimized, N->isOptimized()); 1416 EXPECT_EQ(Flags, N->getFlags()); 1417 EXPECT_EQ(RuntimeVersion, N->getRuntimeVersion()); 1418 EXPECT_EQ(SplitDebugFilename, N->getSplitDebugFilename()); 1419 EXPECT_EQ(EmissionKind, N->getEmissionKind()); 1420 EXPECT_EQ(EnumTypes, N->getEnumTypes().get()); 1421 EXPECT_EQ(RetainedTypes, N->getRetainedTypes().get()); 1422 EXPECT_EQ(GlobalVariables, N->getGlobalVariables().get()); 1423 EXPECT_EQ(ImportedEntities, N->getImportedEntities().get()); 1424 EXPECT_EQ(Macros, N->getMacros().get()); 1425 EXPECT_EQ(DWOId, N->getDWOId()); 1426 1427 TempDICompileUnit Temp = N->clone(); 1428 EXPECT_EQ(dwarf::DW_TAG_compile_unit, Temp->getTag()); 1429 EXPECT_EQ(SourceLanguage, Temp->getSourceLanguage()); 1430 EXPECT_EQ(File, Temp->getFile()); 1431 EXPECT_EQ(Producer, Temp->getProducer()); 1432 EXPECT_EQ(IsOptimized, Temp->isOptimized()); 1433 EXPECT_EQ(Flags, Temp->getFlags()); 1434 EXPECT_EQ(RuntimeVersion, Temp->getRuntimeVersion()); 1435 EXPECT_EQ(SplitDebugFilename, Temp->getSplitDebugFilename()); 1436 EXPECT_EQ(EmissionKind, Temp->getEmissionKind()); 1437 EXPECT_EQ(EnumTypes, Temp->getEnumTypes().get()); 1438 EXPECT_EQ(RetainedTypes, Temp->getRetainedTypes().get()); 1439 EXPECT_EQ(GlobalVariables, Temp->getGlobalVariables().get()); 1440 EXPECT_EQ(ImportedEntities, Temp->getImportedEntities().get()); 1441 EXPECT_EQ(Macros, Temp->getMacros().get()); 1442 EXPECT_EQ(DWOId, Temp->getDWOId()); 1443 1444 auto *TempAddress = Temp.get(); 1445 auto *Clone = MDNode::replaceWithPermanent(std::move(Temp)); 1446 EXPECT_TRUE(Clone->isDistinct()); 1447 EXPECT_EQ(TempAddress, Clone); 1448 } 1449 1450 TEST_F(DICompileUnitTest, replaceArrays) { 1451 unsigned SourceLanguage = 1; 1452 DIFile *File = getFile(); 1453 StringRef Producer = "some producer"; 1454 bool IsOptimized = false; 1455 StringRef Flags = "flag after flag"; 1456 unsigned RuntimeVersion = 2; 1457 StringRef SplitDebugFilename = "another/file"; 1458 auto EmissionKind = DICompileUnit::FullDebug; 1459 MDTuple *EnumTypes = MDTuple::getDistinct(Context, None); 1460 MDTuple *RetainedTypes = MDTuple::getDistinct(Context, None); 1461 MDTuple *ImportedEntities = MDTuple::getDistinct(Context, None); 1462 uint64_t DWOId = 0xc0ffee; 1463 auto *N = DICompileUnit::getDistinct( 1464 Context, SourceLanguage, File, Producer, IsOptimized, Flags, 1465 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes, 1466 RetainedTypes, nullptr, ImportedEntities, nullptr, DWOId, true); 1467 1468 auto *GlobalVariables = MDTuple::getDistinct(Context, None); 1469 EXPECT_EQ(nullptr, N->getGlobalVariables().get()); 1470 N->replaceGlobalVariables(GlobalVariables); 1471 EXPECT_EQ(GlobalVariables, N->getGlobalVariables().get()); 1472 N->replaceGlobalVariables(nullptr); 1473 EXPECT_EQ(nullptr, N->getGlobalVariables().get()); 1474 1475 auto *Macros = MDTuple::getDistinct(Context, None); 1476 EXPECT_EQ(nullptr, N->getMacros().get()); 1477 N->replaceMacros(Macros); 1478 EXPECT_EQ(Macros, N->getMacros().get()); 1479 N->replaceMacros(nullptr); 1480 EXPECT_EQ(nullptr, N->getMacros().get()); 1481 } 1482 1483 typedef MetadataTest DISubprogramTest; 1484 1485 TEST_F(DISubprogramTest, get) { 1486 DIScope *Scope = getCompositeType(); 1487 StringRef Name = "name"; 1488 StringRef LinkageName = "linkage"; 1489 DIFile *File = getFile(); 1490 unsigned Line = 2; 1491 DISubroutineType *Type = getSubroutineType(); 1492 bool IsLocalToUnit = false; 1493 bool IsDefinition = true; 1494 unsigned ScopeLine = 3; 1495 DIType *ContainingType = getCompositeType(); 1496 unsigned Virtuality = 2; 1497 unsigned VirtualIndex = 5; 1498 int ThisAdjustment = -3; 1499 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(6); 1500 bool IsOptimized = false; 1501 MDTuple *TemplateParams = getTuple(); 1502 DISubprogram *Declaration = getSubprogram(); 1503 MDTuple *Variables = getTuple(); 1504 DICompileUnit *Unit = getUnit(); 1505 1506 auto *N = DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1507 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1508 ContainingType, Virtuality, VirtualIndex, 1509 ThisAdjustment, Flags, IsOptimized, Unit, 1510 TemplateParams, Declaration, Variables); 1511 1512 EXPECT_EQ(dwarf::DW_TAG_subprogram, N->getTag()); 1513 EXPECT_EQ(Scope, N->getScope()); 1514 EXPECT_EQ(Name, N->getName()); 1515 EXPECT_EQ(LinkageName, N->getLinkageName()); 1516 EXPECT_EQ(File, N->getFile()); 1517 EXPECT_EQ(Line, N->getLine()); 1518 EXPECT_EQ(Type, N->getType()); 1519 EXPECT_EQ(IsLocalToUnit, N->isLocalToUnit()); 1520 EXPECT_EQ(IsDefinition, N->isDefinition()); 1521 EXPECT_EQ(ScopeLine, N->getScopeLine()); 1522 EXPECT_EQ(ContainingType, N->getContainingType()); 1523 EXPECT_EQ(Virtuality, N->getVirtuality()); 1524 EXPECT_EQ(VirtualIndex, N->getVirtualIndex()); 1525 EXPECT_EQ(ThisAdjustment, N->getThisAdjustment()); 1526 EXPECT_EQ(Flags, N->getFlags()); 1527 EXPECT_EQ(IsOptimized, N->isOptimized()); 1528 EXPECT_EQ(Unit, N->getUnit()); 1529 EXPECT_EQ(TemplateParams, N->getTemplateParams().get()); 1530 EXPECT_EQ(Declaration, N->getDeclaration()); 1531 EXPECT_EQ(Variables, N->getVariables().get()); 1532 EXPECT_EQ(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1533 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1534 ContainingType, Virtuality, VirtualIndex, 1535 ThisAdjustment, Flags, IsOptimized, Unit, 1536 TemplateParams, Declaration, Variables)); 1537 1538 EXPECT_NE(N, DISubprogram::get( 1539 Context, getCompositeType(), Name, LinkageName, File, Line, 1540 Type, IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, 1541 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1542 Unit, TemplateParams, Declaration, Variables)); 1543 EXPECT_NE(N, DISubprogram::get( 1544 Context, Scope, "other", LinkageName, File, Line, Type, 1545 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, 1546 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1547 Unit, TemplateParams, Declaration, Variables)); 1548 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, "other", File, Line, 1549 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1550 ContainingType, Virtuality, VirtualIndex, 1551 ThisAdjustment, Flags, IsOptimized, Unit, 1552 TemplateParams, Declaration, Variables)); 1553 EXPECT_NE(N, DISubprogram::get( 1554 Context, Scope, Name, LinkageName, getFile(), Line, Type, 1555 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, 1556 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1557 Unit, TemplateParams, Declaration, Variables)); 1558 EXPECT_NE(N, DISubprogram::get( 1559 Context, Scope, Name, LinkageName, File, Line + 1, Type, 1560 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, 1561 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1562 Unit, TemplateParams, Declaration, Variables)); 1563 EXPECT_NE(N, 1564 DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1565 getSubroutineType(), IsLocalToUnit, IsDefinition, 1566 ScopeLine, ContainingType, Virtuality, 1567 VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1568 Unit, TemplateParams, Declaration, Variables)); 1569 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1570 Type, !IsLocalToUnit, IsDefinition, ScopeLine, 1571 ContainingType, Virtuality, VirtualIndex, 1572 ThisAdjustment, Flags, IsOptimized, Unit, 1573 TemplateParams, Declaration, Variables)); 1574 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1575 Type, IsLocalToUnit, !IsDefinition, ScopeLine, 1576 ContainingType, Virtuality, VirtualIndex, 1577 ThisAdjustment, Flags, IsOptimized, Unit, 1578 TemplateParams, Declaration, Variables)); 1579 EXPECT_NE(N, DISubprogram::get( 1580 Context, Scope, Name, LinkageName, File, Line, Type, 1581 IsLocalToUnit, IsDefinition, ScopeLine + 1, ContainingType, 1582 Virtuality, VirtualIndex, ThisAdjustment, Flags, IsOptimized, 1583 Unit, TemplateParams, Declaration, Variables)); 1584 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1585 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1586 getCompositeType(), Virtuality, VirtualIndex, 1587 ThisAdjustment, Flags, IsOptimized, Unit, 1588 TemplateParams, Declaration, Variables)); 1589 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1590 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1591 ContainingType, Virtuality + 1, VirtualIndex, 1592 ThisAdjustment, Flags, IsOptimized, Unit, 1593 TemplateParams, Declaration, Variables)); 1594 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1595 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1596 ContainingType, Virtuality, VirtualIndex + 1, 1597 ThisAdjustment, Flags, IsOptimized, Unit, 1598 TemplateParams, Declaration, Variables)); 1599 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1600 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1601 ContainingType, Virtuality, VirtualIndex, 1602 ThisAdjustment, Flags, !IsOptimized, Unit, 1603 TemplateParams, Declaration, Variables)); 1604 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1605 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1606 ContainingType, Virtuality, VirtualIndex, 1607 ThisAdjustment, Flags, IsOptimized, nullptr, 1608 TemplateParams, Declaration, Variables)); 1609 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1610 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1611 ContainingType, Virtuality, VirtualIndex, 1612 ThisAdjustment, Flags, IsOptimized, Unit, 1613 getTuple(), Declaration, Variables)); 1614 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1615 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1616 ContainingType, Virtuality, VirtualIndex, 1617 ThisAdjustment, Flags, IsOptimized, Unit, 1618 TemplateParams, getSubprogram(), Variables)); 1619 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1620 Type, IsLocalToUnit, IsDefinition, ScopeLine, 1621 ContainingType, Virtuality, VirtualIndex, 1622 ThisAdjustment, Flags, IsOptimized, Unit, 1623 TemplateParams, Declaration, getTuple())); 1624 1625 TempDISubprogram Temp = N->clone(); 1626 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1627 } 1628 1629 typedef MetadataTest DILexicalBlockTest; 1630 1631 TEST_F(DILexicalBlockTest, get) { 1632 DILocalScope *Scope = getSubprogram(); 1633 DIFile *File = getFile(); 1634 unsigned Line = 5; 1635 unsigned Column = 8; 1636 1637 auto *N = DILexicalBlock::get(Context, Scope, File, Line, Column); 1638 1639 EXPECT_EQ(dwarf::DW_TAG_lexical_block, N->getTag()); 1640 EXPECT_EQ(Scope, N->getScope()); 1641 EXPECT_EQ(File, N->getFile()); 1642 EXPECT_EQ(Line, N->getLine()); 1643 EXPECT_EQ(Column, N->getColumn()); 1644 EXPECT_EQ(N, DILexicalBlock::get(Context, Scope, File, Line, Column)); 1645 1646 EXPECT_NE(N, 1647 DILexicalBlock::get(Context, getSubprogram(), File, Line, Column)); 1648 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, getFile(), Line, Column)); 1649 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, File, Line + 1, Column)); 1650 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, File, Line, Column + 1)); 1651 1652 TempDILexicalBlock Temp = N->clone(); 1653 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1654 } 1655 1656 TEST_F(DILexicalBlockTest, Overflow) { 1657 DISubprogram *SP = getSubprogram(); 1658 DIFile *F = getFile(); 1659 { 1660 auto *LB = DILexicalBlock::get(Context, SP, F, 2, 7); 1661 EXPECT_EQ(2u, LB->getLine()); 1662 EXPECT_EQ(7u, LB->getColumn()); 1663 } 1664 unsigned U16 = 1u << 16; 1665 { 1666 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16 - 1); 1667 EXPECT_EQ(UINT32_MAX, LB->getLine()); 1668 EXPECT_EQ(U16 - 1, LB->getColumn()); 1669 } 1670 { 1671 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16); 1672 EXPECT_EQ(UINT32_MAX, LB->getLine()); 1673 EXPECT_EQ(0u, LB->getColumn()); 1674 } 1675 { 1676 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16 + 1); 1677 EXPECT_EQ(UINT32_MAX, LB->getLine()); 1678 EXPECT_EQ(0u, LB->getColumn()); 1679 } 1680 } 1681 1682 typedef MetadataTest DILexicalBlockFileTest; 1683 1684 TEST_F(DILexicalBlockFileTest, get) { 1685 DILocalScope *Scope = getSubprogram(); 1686 DIFile *File = getFile(); 1687 unsigned Discriminator = 5; 1688 1689 auto *N = DILexicalBlockFile::get(Context, Scope, File, Discriminator); 1690 1691 EXPECT_EQ(dwarf::DW_TAG_lexical_block, N->getTag()); 1692 EXPECT_EQ(Scope, N->getScope()); 1693 EXPECT_EQ(File, N->getFile()); 1694 EXPECT_EQ(Discriminator, N->getDiscriminator()); 1695 EXPECT_EQ(N, DILexicalBlockFile::get(Context, Scope, File, Discriminator)); 1696 1697 EXPECT_NE(N, DILexicalBlockFile::get(Context, getSubprogram(), File, 1698 Discriminator)); 1699 EXPECT_NE(N, 1700 DILexicalBlockFile::get(Context, Scope, getFile(), Discriminator)); 1701 EXPECT_NE(N, 1702 DILexicalBlockFile::get(Context, Scope, File, Discriminator + 1)); 1703 1704 TempDILexicalBlockFile Temp = N->clone(); 1705 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1706 } 1707 1708 typedef MetadataTest DINamespaceTest; 1709 1710 TEST_F(DINamespaceTest, get) { 1711 DIScope *Scope = getFile(); 1712 DIFile *File = getFile(); 1713 StringRef Name = "namespace"; 1714 unsigned Line = 5; 1715 bool ExportSymbols = true; 1716 1717 auto *N = DINamespace::get(Context, Scope, File, Name, Line, ExportSymbols); 1718 1719 EXPECT_EQ(dwarf::DW_TAG_namespace, N->getTag()); 1720 EXPECT_EQ(Scope, N->getScope()); 1721 EXPECT_EQ(File, N->getFile()); 1722 EXPECT_EQ(Name, N->getName()); 1723 EXPECT_EQ(Line, N->getLine()); 1724 EXPECT_EQ(N, 1725 DINamespace::get(Context, Scope, File, Name, Line, ExportSymbols)); 1726 1727 EXPECT_NE(N, 1728 DINamespace::get(Context, getFile(), File, Name, Line, ExportSymbols)); 1729 EXPECT_NE(N, 1730 DINamespace::get(Context, Scope, getFile(), Name, Line, ExportSymbols)); 1731 EXPECT_NE(N, 1732 DINamespace::get(Context, Scope, File, "other", Line, ExportSymbols)); 1733 EXPECT_NE(N, 1734 DINamespace::get(Context, Scope, File, Name, Line + 1, ExportSymbols)); 1735 EXPECT_NE(N, 1736 DINamespace::get(Context, Scope, File, Name, Line, !ExportSymbols)); 1737 1738 TempDINamespace Temp = N->clone(); 1739 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1740 } 1741 1742 typedef MetadataTest DIModuleTest; 1743 1744 TEST_F(DIModuleTest, get) { 1745 DIScope *Scope = getFile(); 1746 StringRef Name = "module"; 1747 StringRef ConfigMacro = "-DNDEBUG"; 1748 StringRef Includes = "-I."; 1749 StringRef Sysroot = "/"; 1750 1751 auto *N = DIModule::get(Context, Scope, Name, ConfigMacro, Includes, Sysroot); 1752 1753 EXPECT_EQ(dwarf::DW_TAG_module, N->getTag()); 1754 EXPECT_EQ(Scope, N->getScope()); 1755 EXPECT_EQ(Name, N->getName()); 1756 EXPECT_EQ(ConfigMacro, N->getConfigurationMacros()); 1757 EXPECT_EQ(Includes, N->getIncludePath()); 1758 EXPECT_EQ(Sysroot, N->getISysRoot()); 1759 EXPECT_EQ(N, DIModule::get(Context, Scope, Name, 1760 ConfigMacro, Includes, Sysroot)); 1761 EXPECT_NE(N, DIModule::get(Context, getFile(), Name, 1762 ConfigMacro, Includes, Sysroot)); 1763 EXPECT_NE(N, DIModule::get(Context, Scope, "other", 1764 ConfigMacro, Includes, Sysroot)); 1765 EXPECT_NE(N, DIModule::get(Context, Scope, Name, 1766 "other", Includes, Sysroot)); 1767 EXPECT_NE(N, DIModule::get(Context, Scope, Name, 1768 ConfigMacro, "other", Sysroot)); 1769 EXPECT_NE(N, DIModule::get(Context, Scope, Name, 1770 ConfigMacro, Includes, "other")); 1771 1772 TempDIModule Temp = N->clone(); 1773 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1774 } 1775 1776 typedef MetadataTest DITemplateTypeParameterTest; 1777 1778 TEST_F(DITemplateTypeParameterTest, get) { 1779 StringRef Name = "template"; 1780 DIType *Type = getBasicType("basic"); 1781 1782 auto *N = DITemplateTypeParameter::get(Context, Name, Type); 1783 1784 EXPECT_EQ(dwarf::DW_TAG_template_type_parameter, N->getTag()); 1785 EXPECT_EQ(Name, N->getName()); 1786 EXPECT_EQ(Type, N->getType()); 1787 EXPECT_EQ(N, DITemplateTypeParameter::get(Context, Name, Type)); 1788 1789 EXPECT_NE(N, DITemplateTypeParameter::get(Context, "other", Type)); 1790 EXPECT_NE(N, 1791 DITemplateTypeParameter::get(Context, Name, getBasicType("other"))); 1792 1793 TempDITemplateTypeParameter Temp = N->clone(); 1794 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1795 } 1796 1797 typedef MetadataTest DITemplateValueParameterTest; 1798 1799 TEST_F(DITemplateValueParameterTest, get) { 1800 unsigned Tag = dwarf::DW_TAG_template_value_parameter; 1801 StringRef Name = "template"; 1802 DIType *Type = getBasicType("basic"); 1803 Metadata *Value = getConstantAsMetadata(); 1804 1805 auto *N = DITemplateValueParameter::get(Context, Tag, Name, Type, Value); 1806 EXPECT_EQ(Tag, N->getTag()); 1807 EXPECT_EQ(Name, N->getName()); 1808 EXPECT_EQ(Type, N->getType()); 1809 EXPECT_EQ(Value, N->getValue()); 1810 EXPECT_EQ(N, DITemplateValueParameter::get(Context, Tag, Name, Type, Value)); 1811 1812 EXPECT_NE(N, DITemplateValueParameter::get( 1813 Context, dwarf::DW_TAG_GNU_template_template_param, Name, 1814 Type, Value)); 1815 EXPECT_NE(N, 1816 DITemplateValueParameter::get(Context, Tag, "other", Type, Value)); 1817 EXPECT_NE(N, DITemplateValueParameter::get(Context, Tag, Name, 1818 getBasicType("other"), Value)); 1819 EXPECT_NE(N, DITemplateValueParameter::get(Context, Tag, Name, Type, 1820 getConstantAsMetadata())); 1821 1822 TempDITemplateValueParameter Temp = N->clone(); 1823 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1824 } 1825 1826 typedef MetadataTest DIGlobalVariableTest; 1827 1828 TEST_F(DIGlobalVariableTest, get) { 1829 DIScope *Scope = getSubprogram(); 1830 StringRef Name = "name"; 1831 StringRef LinkageName = "linkage"; 1832 DIFile *File = getFile(); 1833 unsigned Line = 5; 1834 DIType *Type = getDerivedType(); 1835 bool IsLocalToUnit = false; 1836 bool IsDefinition = true; 1837 DIDerivedType *StaticDataMemberDeclaration = 1838 cast<DIDerivedType>(getDerivedType()); 1839 uint32_t AlignInBits = 8; 1840 1841 auto *N = DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, Line, 1842 Type, IsLocalToUnit, IsDefinition, 1843 StaticDataMemberDeclaration, AlignInBits); 1844 EXPECT_EQ(dwarf::DW_TAG_variable, N->getTag()); 1845 EXPECT_EQ(Scope, N->getScope()); 1846 EXPECT_EQ(Name, N->getName()); 1847 EXPECT_EQ(LinkageName, N->getLinkageName()); 1848 EXPECT_EQ(File, N->getFile()); 1849 EXPECT_EQ(Line, N->getLine()); 1850 EXPECT_EQ(Type, N->getType()); 1851 EXPECT_EQ(IsLocalToUnit, N->isLocalToUnit()); 1852 EXPECT_EQ(IsDefinition, N->isDefinition()); 1853 EXPECT_EQ(StaticDataMemberDeclaration, N->getStaticDataMemberDeclaration()); 1854 EXPECT_EQ(AlignInBits, N->getAlignInBits()); 1855 EXPECT_EQ(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 1856 Line, Type, IsLocalToUnit, IsDefinition, 1857 StaticDataMemberDeclaration, AlignInBits)); 1858 1859 EXPECT_NE(N, 1860 DIGlobalVariable::get(Context, getSubprogram(), Name, LinkageName, 1861 File, Line, Type, IsLocalToUnit, IsDefinition, 1862 StaticDataMemberDeclaration, AlignInBits)); 1863 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, "other", LinkageName, File, 1864 Line, Type, IsLocalToUnit, IsDefinition, 1865 StaticDataMemberDeclaration, AlignInBits)); 1866 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, "other", File, Line, 1867 Type, IsLocalToUnit, IsDefinition, 1868 StaticDataMemberDeclaration, AlignInBits)); 1869 EXPECT_NE(N, 1870 DIGlobalVariable::get(Context, Scope, Name, LinkageName, getFile(), 1871 Line, Type, IsLocalToUnit, IsDefinition, 1872 StaticDataMemberDeclaration, AlignInBits)); 1873 EXPECT_NE(N, 1874 DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 1875 Line + 1, Type, IsLocalToUnit, IsDefinition, 1876 StaticDataMemberDeclaration, AlignInBits)); 1877 EXPECT_NE(N, 1878 DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, Line, 1879 getDerivedType(), IsLocalToUnit, IsDefinition, 1880 StaticDataMemberDeclaration, AlignInBits)); 1881 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 1882 Line, Type, !IsLocalToUnit, IsDefinition, 1883 StaticDataMemberDeclaration, AlignInBits)); 1884 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 1885 Line, Type, IsLocalToUnit, !IsDefinition, 1886 StaticDataMemberDeclaration, AlignInBits)); 1887 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 1888 Line, Type, IsLocalToUnit, IsDefinition, 1889 cast<DIDerivedType>(getDerivedType()), 1890 AlignInBits)); 1891 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 1892 Line, Type, IsLocalToUnit, IsDefinition, 1893 StaticDataMemberDeclaration, 1894 (AlignInBits << 1))); 1895 1896 TempDIGlobalVariable Temp = N->clone(); 1897 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1898 } 1899 1900 typedef MetadataTest DIGlobalVariableExpressionTest; 1901 1902 TEST_F(DIGlobalVariableExpressionTest, get) { 1903 DIScope *Scope = getSubprogram(); 1904 StringRef Name = "name"; 1905 StringRef LinkageName = "linkage"; 1906 DIFile *File = getFile(); 1907 unsigned Line = 5; 1908 DIType *Type = getDerivedType(); 1909 bool IsLocalToUnit = false; 1910 bool IsDefinition = true; 1911 auto *Expr = DIExpression::get(Context, {1, 2}); 1912 auto *Expr2 = DIExpression::get(Context, {1, 2, 3}); 1913 DIDerivedType *StaticDataMemberDeclaration = 1914 cast<DIDerivedType>(getDerivedType()); 1915 uint32_t AlignInBits = 8; 1916 1917 auto *Var = DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 1918 Line, Type, IsLocalToUnit, IsDefinition, 1919 StaticDataMemberDeclaration, AlignInBits); 1920 auto *Var2 = DIGlobalVariable::get(Context, Scope, "other", LinkageName, File, 1921 Line, Type, IsLocalToUnit, IsDefinition, 1922 StaticDataMemberDeclaration, AlignInBits); 1923 auto *N = DIGlobalVariableExpression::get(Context, Var, Expr); 1924 1925 EXPECT_EQ(Var, N->getVariable()); 1926 EXPECT_EQ(Expr, N->getExpression()); 1927 EXPECT_EQ(N, DIGlobalVariableExpression::get(Context, Var, Expr)); 1928 EXPECT_NE(N, DIGlobalVariableExpression::get(Context, Var2, Expr)); 1929 EXPECT_NE(N, DIGlobalVariableExpression::get(Context, Var, Expr2)); 1930 1931 TempDIGlobalVariableExpression Temp = N->clone(); 1932 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1933 } 1934 1935 typedef MetadataTest DILocalVariableTest; 1936 1937 TEST_F(DILocalVariableTest, get) { 1938 DILocalScope *Scope = getSubprogram(); 1939 StringRef Name = "name"; 1940 DIFile *File = getFile(); 1941 unsigned Line = 5; 1942 DIType *Type = getDerivedType(); 1943 unsigned Arg = 6; 1944 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7); 1945 uint32_t AlignInBits = 8; 1946 1947 auto *N = 1948 DILocalVariable::get(Context, Scope, Name, File, Line, Type, Arg, Flags, 1949 AlignInBits); 1950 EXPECT_TRUE(N->isParameter()); 1951 EXPECT_EQ(Scope, N->getScope()); 1952 EXPECT_EQ(Name, N->getName()); 1953 EXPECT_EQ(File, N->getFile()); 1954 EXPECT_EQ(Line, N->getLine()); 1955 EXPECT_EQ(Type, N->getType()); 1956 EXPECT_EQ(Arg, N->getArg()); 1957 EXPECT_EQ(Flags, N->getFlags()); 1958 EXPECT_EQ(AlignInBits, N->getAlignInBits()); 1959 EXPECT_EQ(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type, Arg, 1960 Flags, AlignInBits)); 1961 1962 EXPECT_FALSE( 1963 DILocalVariable::get(Context, Scope, Name, File, Line, Type, 0, Flags, 1964 AlignInBits)->isParameter()); 1965 EXPECT_NE(N, DILocalVariable::get(Context, getSubprogram(), Name, File, Line, 1966 Type, Arg, Flags, AlignInBits)); 1967 EXPECT_NE(N, DILocalVariable::get(Context, Scope, "other", File, Line, Type, 1968 Arg, Flags, AlignInBits)); 1969 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, getFile(), Line, Type, 1970 Arg, Flags, AlignInBits)); 1971 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line + 1, Type, 1972 Arg, Flags, AlignInBits)); 1973 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line, 1974 getDerivedType(), Arg, Flags, AlignInBits)); 1975 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type, 1976 Arg + 1, Flags, AlignInBits)); 1977 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type, 1978 Arg, Flags, (AlignInBits << 1))); 1979 1980 TempDILocalVariable Temp = N->clone(); 1981 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1982 } 1983 1984 TEST_F(DILocalVariableTest, getArg256) { 1985 EXPECT_EQ(255u, DILocalVariable::get(Context, getSubprogram(), "", getFile(), 1986 0, nullptr, 255, DINode::FlagZero, 0) 1987 ->getArg()); 1988 EXPECT_EQ(256u, DILocalVariable::get(Context, getSubprogram(), "", getFile(), 1989 0, nullptr, 256, DINode::FlagZero, 0) 1990 ->getArg()); 1991 EXPECT_EQ(257u, DILocalVariable::get(Context, getSubprogram(), "", getFile(), 1992 0, nullptr, 257, DINode::FlagZero, 0) 1993 ->getArg()); 1994 unsigned Max = UINT16_MAX; 1995 EXPECT_EQ(Max, DILocalVariable::get(Context, getSubprogram(), "", getFile(), 1996 0, nullptr, Max, DINode::FlagZero, 0) 1997 ->getArg()); 1998 } 1999 2000 typedef MetadataTest DIExpressionTest; 2001 2002 TEST_F(DIExpressionTest, get) { 2003 uint64_t Elements[] = {2, 6, 9, 78, 0}; 2004 auto *N = DIExpression::get(Context, Elements); 2005 EXPECT_EQ(makeArrayRef(Elements), N->getElements()); 2006 EXPECT_EQ(N, DIExpression::get(Context, Elements)); 2007 2008 EXPECT_EQ(5u, N->getNumElements()); 2009 EXPECT_EQ(2u, N->getElement(0)); 2010 EXPECT_EQ(6u, N->getElement(1)); 2011 EXPECT_EQ(9u, N->getElement(2)); 2012 EXPECT_EQ(78u, N->getElement(3)); 2013 EXPECT_EQ(0u, N->getElement(4)); 2014 2015 TempDIExpression Temp = N->clone(); 2016 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2017 } 2018 2019 TEST_F(DIExpressionTest, isValid) { 2020 #define EXPECT_VALID(...) \ 2021 do { \ 2022 uint64_t Elements[] = {__VA_ARGS__}; \ 2023 EXPECT_TRUE(DIExpression::get(Context, Elements)->isValid()); \ 2024 } while (false) 2025 #define EXPECT_INVALID(...) \ 2026 do { \ 2027 uint64_t Elements[] = {__VA_ARGS__}; \ 2028 EXPECT_FALSE(DIExpression::get(Context, Elements)->isValid()); \ 2029 } while (false) 2030 2031 // Empty expression should be valid. 2032 EXPECT_TRUE(DIExpression::get(Context, None)); 2033 2034 // Valid constructions. 2035 EXPECT_VALID(dwarf::DW_OP_plus, 6); 2036 EXPECT_VALID(dwarf::DW_OP_deref); 2037 EXPECT_VALID(dwarf::DW_OP_LLVM_fragment, 3, 7); 2038 EXPECT_VALID(dwarf::DW_OP_plus, 6, dwarf::DW_OP_deref); 2039 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_plus, 6); 2040 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_LLVM_fragment, 3, 7); 2041 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_plus, 6, 2042 dwarf::DW_OP_LLVM_fragment, 3, 7); 2043 2044 // Invalid constructions. 2045 EXPECT_INVALID(~0u); 2046 EXPECT_INVALID(dwarf::DW_OP_plus); 2047 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment); 2048 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment, 3); 2049 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment, 3, 7, dwarf::DW_OP_plus, 3); 2050 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment, 3, 7, dwarf::DW_OP_deref); 2051 2052 #undef EXPECT_VALID 2053 #undef EXPECT_INVALID 2054 } 2055 2056 typedef MetadataTest DIObjCPropertyTest; 2057 2058 TEST_F(DIObjCPropertyTest, get) { 2059 StringRef Name = "name"; 2060 DIFile *File = getFile(); 2061 unsigned Line = 5; 2062 StringRef GetterName = "getter"; 2063 StringRef SetterName = "setter"; 2064 unsigned Attributes = 7; 2065 DIType *Type = getBasicType("basic"); 2066 2067 auto *N = DIObjCProperty::get(Context, Name, File, Line, GetterName, 2068 SetterName, Attributes, Type); 2069 2070 EXPECT_EQ(dwarf::DW_TAG_APPLE_property, N->getTag()); 2071 EXPECT_EQ(Name, N->getName()); 2072 EXPECT_EQ(File, N->getFile()); 2073 EXPECT_EQ(Line, N->getLine()); 2074 EXPECT_EQ(GetterName, N->getGetterName()); 2075 EXPECT_EQ(SetterName, N->getSetterName()); 2076 EXPECT_EQ(Attributes, N->getAttributes()); 2077 EXPECT_EQ(Type, N->getType()); 2078 EXPECT_EQ(N, DIObjCProperty::get(Context, Name, File, Line, GetterName, 2079 SetterName, Attributes, Type)); 2080 2081 EXPECT_NE(N, DIObjCProperty::get(Context, "other", File, Line, GetterName, 2082 SetterName, Attributes, Type)); 2083 EXPECT_NE(N, DIObjCProperty::get(Context, Name, getFile(), Line, GetterName, 2084 SetterName, Attributes, Type)); 2085 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line + 1, GetterName, 2086 SetterName, Attributes, Type)); 2087 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, "other", 2088 SetterName, Attributes, Type)); 2089 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName, 2090 "other", Attributes, Type)); 2091 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName, 2092 SetterName, Attributes + 1, Type)); 2093 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName, 2094 SetterName, Attributes, 2095 getBasicType("other"))); 2096 2097 TempDIObjCProperty Temp = N->clone(); 2098 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2099 } 2100 2101 typedef MetadataTest DIImportedEntityTest; 2102 2103 TEST_F(DIImportedEntityTest, get) { 2104 unsigned Tag = dwarf::DW_TAG_imported_module; 2105 DIScope *Scope = getSubprogram(); 2106 DINode *Entity = getCompositeType(); 2107 unsigned Line = 5; 2108 StringRef Name = "name"; 2109 2110 auto *N = DIImportedEntity::get(Context, Tag, Scope, Entity, Line, Name); 2111 2112 EXPECT_EQ(Tag, N->getTag()); 2113 EXPECT_EQ(Scope, N->getScope()); 2114 EXPECT_EQ(Entity, N->getEntity()); 2115 EXPECT_EQ(Line, N->getLine()); 2116 EXPECT_EQ(Name, N->getName()); 2117 EXPECT_EQ(N, DIImportedEntity::get(Context, Tag, Scope, Entity, Line, Name)); 2118 2119 EXPECT_NE(N, 2120 DIImportedEntity::get(Context, dwarf::DW_TAG_imported_declaration, 2121 Scope, Entity, Line, Name)); 2122 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, getSubprogram(), Entity, 2123 Line, Name)); 2124 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, getCompositeType(), 2125 Line, Name)); 2126 EXPECT_NE(N, 2127 DIImportedEntity::get(Context, Tag, Scope, Entity, Line + 1, Name)); 2128 EXPECT_NE(N, 2129 DIImportedEntity::get(Context, Tag, Scope, Entity, Line, "other")); 2130 2131 TempDIImportedEntity Temp = N->clone(); 2132 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2133 } 2134 2135 typedef MetadataTest MetadataAsValueTest; 2136 2137 TEST_F(MetadataAsValueTest, MDNode) { 2138 MDNode *N = MDNode::get(Context, None); 2139 auto *V = MetadataAsValue::get(Context, N); 2140 EXPECT_TRUE(V->getType()->isMetadataTy()); 2141 EXPECT_EQ(N, V->getMetadata()); 2142 2143 auto *V2 = MetadataAsValue::get(Context, N); 2144 EXPECT_EQ(V, V2); 2145 } 2146 2147 TEST_F(MetadataAsValueTest, MDNodeMDNode) { 2148 MDNode *N = MDNode::get(Context, None); 2149 Metadata *Ops[] = {N}; 2150 MDNode *N2 = MDNode::get(Context, Ops); 2151 auto *V = MetadataAsValue::get(Context, N2); 2152 EXPECT_TRUE(V->getType()->isMetadataTy()); 2153 EXPECT_EQ(N2, V->getMetadata()); 2154 2155 auto *V2 = MetadataAsValue::get(Context, N2); 2156 EXPECT_EQ(V, V2); 2157 2158 auto *V3 = MetadataAsValue::get(Context, N); 2159 EXPECT_TRUE(V3->getType()->isMetadataTy()); 2160 EXPECT_NE(V, V3); 2161 EXPECT_EQ(N, V3->getMetadata()); 2162 } 2163 2164 TEST_F(MetadataAsValueTest, MDNodeConstant) { 2165 auto *C = ConstantInt::getTrue(Context); 2166 auto *MD = ConstantAsMetadata::get(C); 2167 Metadata *Ops[] = {MD}; 2168 auto *N = MDNode::get(Context, Ops); 2169 2170 auto *V = MetadataAsValue::get(Context, MD); 2171 EXPECT_TRUE(V->getType()->isMetadataTy()); 2172 EXPECT_EQ(MD, V->getMetadata()); 2173 2174 auto *V2 = MetadataAsValue::get(Context, N); 2175 EXPECT_EQ(MD, V2->getMetadata()); 2176 EXPECT_EQ(V, V2); 2177 } 2178 2179 typedef MetadataTest ValueAsMetadataTest; 2180 2181 TEST_F(ValueAsMetadataTest, UpdatesOnRAUW) { 2182 Type *Ty = Type::getInt1PtrTy(Context); 2183 std::unique_ptr<GlobalVariable> GV0( 2184 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2185 auto *MD = ValueAsMetadata::get(GV0.get()); 2186 EXPECT_TRUE(MD->getValue() == GV0.get()); 2187 ASSERT_TRUE(GV0->use_empty()); 2188 2189 std::unique_ptr<GlobalVariable> GV1( 2190 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2191 GV0->replaceAllUsesWith(GV1.get()); 2192 EXPECT_TRUE(MD->getValue() == GV1.get()); 2193 } 2194 2195 TEST_F(ValueAsMetadataTest, TempTempReplacement) { 2196 // Create a constant. 2197 ConstantAsMetadata *CI = 2198 ConstantAsMetadata::get(ConstantInt::get(Context, APInt(8, 0))); 2199 2200 auto Temp1 = MDTuple::getTemporary(Context, None); 2201 auto Temp2 = MDTuple::getTemporary(Context, {CI}); 2202 auto *N = MDTuple::get(Context, {Temp1.get()}); 2203 2204 // Test replacing a temporary node with another temporary node. 2205 Temp1->replaceAllUsesWith(Temp2.get()); 2206 EXPECT_EQ(N->getOperand(0), Temp2.get()); 2207 2208 // Clean up Temp2 for teardown. 2209 Temp2->replaceAllUsesWith(nullptr); 2210 } 2211 2212 TEST_F(ValueAsMetadataTest, CollidingDoubleUpdates) { 2213 // Create a constant. 2214 ConstantAsMetadata *CI = 2215 ConstantAsMetadata::get(ConstantInt::get(Context, APInt(8, 0))); 2216 2217 // Create a temporary to prevent nodes from resolving. 2218 auto Temp = MDTuple::getTemporary(Context, None); 2219 2220 // When the first operand of N1 gets reset to nullptr, it'll collide with N2. 2221 Metadata *Ops1[] = {CI, CI, Temp.get()}; 2222 Metadata *Ops2[] = {nullptr, CI, Temp.get()}; 2223 2224 auto *N1 = MDTuple::get(Context, Ops1); 2225 auto *N2 = MDTuple::get(Context, Ops2); 2226 ASSERT_NE(N1, N2); 2227 2228 // Tell metadata that the constant is getting deleted. 2229 // 2230 // After this, N1 will be invalid, so don't touch it. 2231 ValueAsMetadata::handleDeletion(CI->getValue()); 2232 EXPECT_EQ(nullptr, N2->getOperand(0)); 2233 EXPECT_EQ(nullptr, N2->getOperand(1)); 2234 EXPECT_EQ(Temp.get(), N2->getOperand(2)); 2235 2236 // Clean up Temp for teardown. 2237 Temp->replaceAllUsesWith(nullptr); 2238 } 2239 2240 typedef MetadataTest TrackingMDRefTest; 2241 2242 TEST_F(TrackingMDRefTest, UpdatesOnRAUW) { 2243 Type *Ty = Type::getInt1PtrTy(Context); 2244 std::unique_ptr<GlobalVariable> GV0( 2245 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2246 TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV0.get())); 2247 EXPECT_TRUE(MD->getValue() == GV0.get()); 2248 ASSERT_TRUE(GV0->use_empty()); 2249 2250 std::unique_ptr<GlobalVariable> GV1( 2251 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2252 GV0->replaceAllUsesWith(GV1.get()); 2253 EXPECT_TRUE(MD->getValue() == GV1.get()); 2254 2255 // Reset it, so we don't inadvertently test deletion. 2256 MD.reset(); 2257 } 2258 2259 TEST_F(TrackingMDRefTest, UpdatesOnDeletion) { 2260 Type *Ty = Type::getInt1PtrTy(Context); 2261 std::unique_ptr<GlobalVariable> GV( 2262 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2263 TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV.get())); 2264 EXPECT_TRUE(MD->getValue() == GV.get()); 2265 ASSERT_TRUE(GV->use_empty()); 2266 2267 GV.reset(); 2268 EXPECT_TRUE(!MD); 2269 } 2270 2271 TEST(NamedMDNodeTest, Search) { 2272 LLVMContext Context; 2273 ConstantAsMetadata *C = 2274 ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 1)); 2275 ConstantAsMetadata *C2 = 2276 ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 2)); 2277 2278 Metadata *const V = C; 2279 Metadata *const V2 = C2; 2280 MDNode *n = MDNode::get(Context, V); 2281 MDNode *n2 = MDNode::get(Context, V2); 2282 2283 Module M("MyModule", Context); 2284 const char *Name = "llvm.NMD1"; 2285 NamedMDNode *NMD = M.getOrInsertNamedMetadata(Name); 2286 NMD->addOperand(n); 2287 NMD->addOperand(n2); 2288 2289 std::string Str; 2290 raw_string_ostream oss(Str); 2291 NMD->print(oss); 2292 EXPECT_STREQ("!llvm.NMD1 = !{!0, !1}\n", 2293 oss.str().c_str()); 2294 } 2295 2296 typedef MetadataTest FunctionAttachmentTest; 2297 TEST_F(FunctionAttachmentTest, setMetadata) { 2298 Function *F = getFunction("foo"); 2299 ASSERT_FALSE(F->hasMetadata()); 2300 EXPECT_EQ(nullptr, F->getMetadata(LLVMContext::MD_dbg)); 2301 EXPECT_EQ(nullptr, F->getMetadata("dbg")); 2302 EXPECT_EQ(nullptr, F->getMetadata("other")); 2303 2304 DISubprogram *SP1 = getSubprogram(); 2305 DISubprogram *SP2 = getSubprogram(); 2306 ASSERT_NE(SP1, SP2); 2307 2308 F->setMetadata("dbg", SP1); 2309 EXPECT_TRUE(F->hasMetadata()); 2310 EXPECT_EQ(SP1, F->getMetadata(LLVMContext::MD_dbg)); 2311 EXPECT_EQ(SP1, F->getMetadata("dbg")); 2312 EXPECT_EQ(nullptr, F->getMetadata("other")); 2313 2314 F->setMetadata(LLVMContext::MD_dbg, SP2); 2315 EXPECT_TRUE(F->hasMetadata()); 2316 EXPECT_EQ(SP2, F->getMetadata(LLVMContext::MD_dbg)); 2317 EXPECT_EQ(SP2, F->getMetadata("dbg")); 2318 EXPECT_EQ(nullptr, F->getMetadata("other")); 2319 2320 F->setMetadata("dbg", nullptr); 2321 EXPECT_FALSE(F->hasMetadata()); 2322 EXPECT_EQ(nullptr, F->getMetadata(LLVMContext::MD_dbg)); 2323 EXPECT_EQ(nullptr, F->getMetadata("dbg")); 2324 EXPECT_EQ(nullptr, F->getMetadata("other")); 2325 2326 MDTuple *T1 = getTuple(); 2327 MDTuple *T2 = getTuple(); 2328 ASSERT_NE(T1, T2); 2329 2330 F->setMetadata("other1", T1); 2331 F->setMetadata("other2", T2); 2332 EXPECT_TRUE(F->hasMetadata()); 2333 EXPECT_EQ(T1, F->getMetadata("other1")); 2334 EXPECT_EQ(T2, F->getMetadata("other2")); 2335 EXPECT_EQ(nullptr, F->getMetadata("dbg")); 2336 2337 F->setMetadata("other1", T2); 2338 F->setMetadata("other2", T1); 2339 EXPECT_EQ(T2, F->getMetadata("other1")); 2340 EXPECT_EQ(T1, F->getMetadata("other2")); 2341 2342 F->setMetadata("other1", nullptr); 2343 F->setMetadata("other2", nullptr); 2344 EXPECT_FALSE(F->hasMetadata()); 2345 EXPECT_EQ(nullptr, F->getMetadata("other1")); 2346 EXPECT_EQ(nullptr, F->getMetadata("other2")); 2347 } 2348 2349 TEST_F(FunctionAttachmentTest, getAll) { 2350 Function *F = getFunction("foo"); 2351 2352 MDTuple *T1 = getTuple(); 2353 MDTuple *T2 = getTuple(); 2354 MDTuple *P = getTuple(); 2355 DISubprogram *SP = getSubprogram(); 2356 2357 F->setMetadata("other1", T2); 2358 F->setMetadata(LLVMContext::MD_dbg, SP); 2359 F->setMetadata("other2", T1); 2360 F->setMetadata(LLVMContext::MD_prof, P); 2361 F->setMetadata("other2", T2); 2362 F->setMetadata("other1", T1); 2363 2364 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs; 2365 F->getAllMetadata(MDs); 2366 ASSERT_EQ(4u, MDs.size()); 2367 EXPECT_EQ(LLVMContext::MD_dbg, MDs[0].first); 2368 EXPECT_EQ(LLVMContext::MD_prof, MDs[1].first); 2369 EXPECT_EQ(Context.getMDKindID("other1"), MDs[2].first); 2370 EXPECT_EQ(Context.getMDKindID("other2"), MDs[3].first); 2371 EXPECT_EQ(SP, MDs[0].second); 2372 EXPECT_EQ(P, MDs[1].second); 2373 EXPECT_EQ(T1, MDs[2].second); 2374 EXPECT_EQ(T2, MDs[3].second); 2375 } 2376 2377 TEST_F(FunctionAttachmentTest, Verifier) { 2378 Function *F = getFunction("foo"); 2379 F->setMetadata("attach", getTuple()); 2380 F->setIsMaterializable(true); 2381 2382 // Confirm this is materializable. 2383 ASSERT_TRUE(F->isMaterializable()); 2384 2385 // Materializable functions cannot have metadata attachments. 2386 EXPECT_TRUE(verifyFunction(*F)); 2387 2388 // Function declarations can. 2389 F->setIsMaterializable(false); 2390 EXPECT_FALSE(verifyModule(*F->getParent())); 2391 EXPECT_FALSE(verifyFunction(*F)); 2392 2393 // So can definitions. 2394 (void)new UnreachableInst(Context, BasicBlock::Create(Context, "bb", F)); 2395 EXPECT_FALSE(verifyModule(*F->getParent())); 2396 EXPECT_FALSE(verifyFunction(*F)); 2397 } 2398 2399 TEST_F(FunctionAttachmentTest, EntryCount) { 2400 Function *F = getFunction("foo"); 2401 EXPECT_FALSE(F->getEntryCount().hasValue()); 2402 F->setEntryCount(12304); 2403 EXPECT_TRUE(F->getEntryCount().hasValue()); 2404 EXPECT_EQ(12304u, *F->getEntryCount()); 2405 } 2406 2407 TEST_F(FunctionAttachmentTest, SubprogramAttachment) { 2408 Function *F = getFunction("foo"); 2409 DISubprogram *SP = getSubprogram(); 2410 F->setSubprogram(SP); 2411 2412 // Note that the static_cast confirms that F->getSubprogram() actually 2413 // returns an DISubprogram. 2414 EXPECT_EQ(SP, static_cast<DISubprogram *>(F->getSubprogram())); 2415 EXPECT_EQ(SP, F->getMetadata("dbg")); 2416 EXPECT_EQ(SP, F->getMetadata(LLVMContext::MD_dbg)); 2417 } 2418 2419 typedef MetadataTest DistinctMDOperandPlaceholderTest; 2420 TEST_F(DistinctMDOperandPlaceholderTest, getID) { 2421 EXPECT_EQ(7u, DistinctMDOperandPlaceholder(7).getID()); 2422 } 2423 2424 TEST_F(DistinctMDOperandPlaceholderTest, replaceUseWith) { 2425 // Set up some placeholders. 2426 DistinctMDOperandPlaceholder PH0(7); 2427 DistinctMDOperandPlaceholder PH1(3); 2428 DistinctMDOperandPlaceholder PH2(0); 2429 Metadata *Ops[] = {&PH0, &PH1, &PH2}; 2430 auto *D = MDTuple::getDistinct(Context, Ops); 2431 ASSERT_EQ(&PH0, D->getOperand(0)); 2432 ASSERT_EQ(&PH1, D->getOperand(1)); 2433 ASSERT_EQ(&PH2, D->getOperand(2)); 2434 2435 // Replace them. 2436 auto *N0 = MDTuple::get(Context, None); 2437 auto *N1 = MDTuple::get(Context, N0); 2438 PH0.replaceUseWith(N0); 2439 PH1.replaceUseWith(N1); 2440 PH2.replaceUseWith(nullptr); 2441 EXPECT_EQ(N0, D->getOperand(0)); 2442 EXPECT_EQ(N1, D->getOperand(1)); 2443 EXPECT_EQ(nullptr, D->getOperand(2)); 2444 } 2445 2446 TEST_F(DistinctMDOperandPlaceholderTest, replaceUseWithNoUser) { 2447 // There is no user, but we can still call replace. 2448 DistinctMDOperandPlaceholder(7).replaceUseWith(MDTuple::get(Context, None)); 2449 } 2450 2451 #ifndef NDEBUG 2452 #ifdef GTEST_HAS_DEATH_TEST 2453 TEST_F(DistinctMDOperandPlaceholderTest, MetadataAsValue) { 2454 // This shouldn't crash. 2455 DistinctMDOperandPlaceholder PH(7); 2456 EXPECT_DEATH(MetadataAsValue::get(Context, &PH), 2457 "Unexpected callback to owner"); 2458 } 2459 2460 TEST_F(DistinctMDOperandPlaceholderTest, UniquedMDNode) { 2461 // This shouldn't crash. 2462 DistinctMDOperandPlaceholder PH(7); 2463 EXPECT_DEATH(MDTuple::get(Context, &PH), "Unexpected callback to owner"); 2464 } 2465 2466 TEST_F(DistinctMDOperandPlaceholderTest, SecondDistinctMDNode) { 2467 // This shouldn't crash. 2468 DistinctMDOperandPlaceholder PH(7); 2469 MDTuple::getDistinct(Context, &PH); 2470 EXPECT_DEATH(MDTuple::getDistinct(Context, &PH), 2471 "Placeholders can only be used once"); 2472 } 2473 2474 TEST_F(DistinctMDOperandPlaceholderTest, TrackingMDRefAndDistinctMDNode) { 2475 // TrackingMDRef doesn't install an owner callback, so it can't be detected 2476 // as an invalid use. However, using a placeholder in a TrackingMDRef *and* 2477 // a distinct node isn't possible and we should assert. 2478 // 2479 // (There's no positive test for using TrackingMDRef because it's not a 2480 // useful thing to do.) 2481 { 2482 DistinctMDOperandPlaceholder PH(7); 2483 MDTuple::getDistinct(Context, &PH); 2484 EXPECT_DEATH(TrackingMDRef Ref(&PH), "Placeholders can only be used once"); 2485 } 2486 { 2487 DistinctMDOperandPlaceholder PH(7); 2488 TrackingMDRef Ref(&PH); 2489 EXPECT_DEATH(MDTuple::getDistinct(Context, &PH), 2490 "Placeholders can only be used once"); 2491 } 2492 } 2493 #endif 2494 #endif 2495 2496 } // end namespace 2497