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