1 //===- unittests/IR/MetadataTest.cpp - Metadata unit tests ----------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "llvm/IR/Metadata.h" 10 #include "llvm/ADT/DenseMap.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(std::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(std::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 = std::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( 88 Context, nullptr, "", "", nullptr, 0, nullptr, 0, nullptr, 0, 0, 89 DINode::FlagZero, DISubprogram::SPFlagZero, 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, 99 DICompileUnit::DebugNameTableKind::Default, false, "/", ""); 100 } 101 DIType *getBasicType(StringRef Name) { 102 return DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type, Name); 103 } 104 DIType *getDerivedType() { 105 return DIDerivedType::getDistinct( 106 Context, dwarf::DW_TAG_pointer_type, "", nullptr, 0, nullptr, 107 getBasicType("basictype"), 1, 2, 0, None, DINode::FlagZero); 108 } 109 Constant *getConstant() { 110 return ConstantInt::get(Type::getInt32Ty(Context), Counter++); 111 } 112 ConstantAsMetadata *getConstantAsMetadata() { 113 return ConstantAsMetadata::get(getConstant()); 114 } 115 DIType *getCompositeType() { 116 return DICompositeType::getDistinct( 117 Context, dwarf::DW_TAG_structure_type, "", nullptr, 0, nullptr, nullptr, 118 32, 32, 0, DINode::FlagZero, nullptr, 0, nullptr, nullptr, ""); 119 } 120 Function *getFunction(StringRef Name) { 121 return Function::Create( 122 FunctionType::get(Type::getVoidTy(Context), None, false), 123 Function::ExternalLinkage, Name, M); 124 } 125 }; 126 typedef MetadataTest MDStringTest; 127 128 // Test that construction of MDString with different value produces different 129 // MDString objects, even with the same string pointer and nulls in the string. 130 TEST_F(MDStringTest, CreateDifferent) { 131 char x[3] = { 'f', 0, 'A' }; 132 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3)); 133 x[2] = 'B'; 134 MDString *s2 = MDString::get(Context, StringRef(&x[0], 3)); 135 EXPECT_NE(s1, s2); 136 } 137 138 // Test that creation of MDStrings with the same string contents produces the 139 // same MDString object, even with different pointers. 140 TEST_F(MDStringTest, CreateSame) { 141 char x[4] = { 'a', 'b', 'c', 'X' }; 142 char y[4] = { 'a', 'b', 'c', 'Y' }; 143 144 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3)); 145 MDString *s2 = MDString::get(Context, StringRef(&y[0], 3)); 146 EXPECT_EQ(s1, s2); 147 } 148 149 // Test that MDString prints out the string we fed it. 150 TEST_F(MDStringTest, PrintingSimple) { 151 char str[14] = "testing 1 2 3"; 152 MDString *s = MDString::get(Context, StringRef(&str[0], 13)); 153 strncpy(str, "aaaaaaaaaaaaa", 14); 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\\\\\\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 405 TEST_F(MDNodeTest, PrintWithDroppedCallOperand) { 406 Module M("test", Context); 407 408 auto *FTy = FunctionType::get(Type::getVoidTy(Context), false); 409 auto *F0 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F0", &M); 410 auto *F1 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F1", &M); 411 auto *BB0 = BasicBlock::Create(Context, "entry", F0); 412 413 CallInst *CI0 = CallInst::Create(F1, "", BB0); 414 CI0->dropAllReferences(); 415 416 auto *R0 = ReturnInst::Create(Context, BB0); 417 auto *N0 = MDNode::getDistinct(Context, None); 418 R0->setMetadata("md", N0); 419 420 // Printing the metadata node would previously result in a failed assertion 421 // due to the call instruction's dropped function operand. 422 ModuleSlotTracker MST(&M); 423 EXPECT_PRINTER_EQ("!0 = distinct !{}", N0->print(OS, MST)); 424 } 425 #undef EXPECT_PRINTER_EQ 426 427 TEST_F(MDNodeTest, NullOperand) { 428 // metadata !{} 429 MDNode *Empty = MDNode::get(Context, None); 430 431 // metadata !{metadata !{}} 432 Metadata *Ops[] = {Empty}; 433 MDNode *N = MDNode::get(Context, Ops); 434 ASSERT_EQ(Empty, N->getOperand(0)); 435 436 // metadata !{metadata !{}} => metadata !{null} 437 N->replaceOperandWith(0, nullptr); 438 ASSERT_EQ(nullptr, N->getOperand(0)); 439 440 // metadata !{null} 441 Ops[0] = nullptr; 442 MDNode *NullOp = MDNode::get(Context, Ops); 443 ASSERT_EQ(nullptr, NullOp->getOperand(0)); 444 EXPECT_EQ(N, NullOp); 445 } 446 447 TEST_F(MDNodeTest, DistinctOnUniquingCollision) { 448 // !{} 449 MDNode *Empty = MDNode::get(Context, None); 450 ASSERT_TRUE(Empty->isResolved()); 451 EXPECT_FALSE(Empty->isDistinct()); 452 453 // !{!{}} 454 Metadata *Wrapped1Ops[] = {Empty}; 455 MDNode *Wrapped1 = MDNode::get(Context, Wrapped1Ops); 456 ASSERT_EQ(Empty, Wrapped1->getOperand(0)); 457 ASSERT_TRUE(Wrapped1->isResolved()); 458 EXPECT_FALSE(Wrapped1->isDistinct()); 459 460 // !{!{!{}}} 461 Metadata *Wrapped2Ops[] = {Wrapped1}; 462 MDNode *Wrapped2 = MDNode::get(Context, Wrapped2Ops); 463 ASSERT_EQ(Wrapped1, Wrapped2->getOperand(0)); 464 ASSERT_TRUE(Wrapped2->isResolved()); 465 EXPECT_FALSE(Wrapped2->isDistinct()); 466 467 // !{!{!{}}} => !{!{}} 468 Wrapped2->replaceOperandWith(0, Empty); 469 ASSERT_EQ(Empty, Wrapped2->getOperand(0)); 470 EXPECT_TRUE(Wrapped2->isDistinct()); 471 EXPECT_FALSE(Wrapped1->isDistinct()); 472 } 473 474 TEST_F(MDNodeTest, UniquedOnDeletedOperand) { 475 // temp !{} 476 TempMDTuple T = MDTuple::getTemporary(Context, None); 477 478 // !{temp !{}} 479 Metadata *Ops[] = {T.get()}; 480 MDTuple *N = MDTuple::get(Context, Ops); 481 482 // !{temp !{}} => !{null} 483 T.reset(); 484 ASSERT_TRUE(N->isUniqued()); 485 Metadata *NullOps[] = {nullptr}; 486 ASSERT_EQ(N, MDTuple::get(Context, NullOps)); 487 } 488 489 TEST_F(MDNodeTest, DistinctOnDeletedValueOperand) { 490 // i1* @GV 491 Type *Ty = Type::getInt1PtrTy(Context); 492 std::unique_ptr<GlobalVariable> GV( 493 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 494 ConstantAsMetadata *Op = ConstantAsMetadata::get(GV.get()); 495 496 // !{i1* @GV} 497 Metadata *Ops[] = {Op}; 498 MDTuple *N = MDTuple::get(Context, Ops); 499 500 // !{i1* @GV} => !{null} 501 GV.reset(); 502 ASSERT_TRUE(N->isDistinct()); 503 ASSERT_EQ(nullptr, N->getOperand(0)); 504 Metadata *NullOps[] = {nullptr}; 505 ASSERT_NE(N, MDTuple::get(Context, NullOps)); 506 } 507 508 TEST_F(MDNodeTest, getDistinct) { 509 // !{} 510 MDNode *Empty = MDNode::get(Context, None); 511 ASSERT_TRUE(Empty->isResolved()); 512 ASSERT_FALSE(Empty->isDistinct()); 513 ASSERT_EQ(Empty, MDNode::get(Context, None)); 514 515 // distinct !{} 516 MDNode *Distinct1 = MDNode::getDistinct(Context, None); 517 MDNode *Distinct2 = MDNode::getDistinct(Context, None); 518 EXPECT_TRUE(Distinct1->isResolved()); 519 EXPECT_TRUE(Distinct2->isDistinct()); 520 EXPECT_NE(Empty, Distinct1); 521 EXPECT_NE(Empty, Distinct2); 522 EXPECT_NE(Distinct1, Distinct2); 523 524 // !{} 525 ASSERT_EQ(Empty, MDNode::get(Context, None)); 526 } 527 528 TEST_F(MDNodeTest, isUniqued) { 529 MDNode *U = MDTuple::get(Context, None); 530 MDNode *D = MDTuple::getDistinct(Context, None); 531 auto T = MDTuple::getTemporary(Context, None); 532 EXPECT_TRUE(U->isUniqued()); 533 EXPECT_FALSE(D->isUniqued()); 534 EXPECT_FALSE(T->isUniqued()); 535 } 536 537 TEST_F(MDNodeTest, isDistinct) { 538 MDNode *U = MDTuple::get(Context, None); 539 MDNode *D = MDTuple::getDistinct(Context, None); 540 auto T = MDTuple::getTemporary(Context, None); 541 EXPECT_FALSE(U->isDistinct()); 542 EXPECT_TRUE(D->isDistinct()); 543 EXPECT_FALSE(T->isDistinct()); 544 } 545 546 TEST_F(MDNodeTest, isTemporary) { 547 MDNode *U = MDTuple::get(Context, None); 548 MDNode *D = MDTuple::getDistinct(Context, None); 549 auto T = MDTuple::getTemporary(Context, None); 550 EXPECT_FALSE(U->isTemporary()); 551 EXPECT_FALSE(D->isTemporary()); 552 EXPECT_TRUE(T->isTemporary()); 553 } 554 555 TEST_F(MDNodeTest, getDistinctWithUnresolvedOperands) { 556 // temporary !{} 557 auto Temp = MDTuple::getTemporary(Context, None); 558 ASSERT_FALSE(Temp->isResolved()); 559 560 // distinct !{temporary !{}} 561 Metadata *Ops[] = {Temp.get()}; 562 MDNode *Distinct = MDNode::getDistinct(Context, Ops); 563 EXPECT_TRUE(Distinct->isResolved()); 564 EXPECT_EQ(Temp.get(), Distinct->getOperand(0)); 565 566 // temporary !{} => !{} 567 MDNode *Empty = MDNode::get(Context, None); 568 Temp->replaceAllUsesWith(Empty); 569 EXPECT_EQ(Empty, Distinct->getOperand(0)); 570 } 571 572 TEST_F(MDNodeTest, handleChangedOperandRecursion) { 573 // !0 = !{} 574 MDNode *N0 = MDNode::get(Context, None); 575 576 // !1 = !{!3, null} 577 auto Temp3 = MDTuple::getTemporary(Context, None); 578 Metadata *Ops1[] = {Temp3.get(), nullptr}; 579 MDNode *N1 = MDNode::get(Context, Ops1); 580 581 // !2 = !{!3, !0} 582 Metadata *Ops2[] = {Temp3.get(), N0}; 583 MDNode *N2 = MDNode::get(Context, Ops2); 584 585 // !3 = !{!2} 586 Metadata *Ops3[] = {N2}; 587 MDNode *N3 = MDNode::get(Context, Ops3); 588 Temp3->replaceAllUsesWith(N3); 589 590 // !4 = !{!1} 591 Metadata *Ops4[] = {N1}; 592 MDNode *N4 = MDNode::get(Context, Ops4); 593 594 // Confirm that the cycle prevented RAUW from getting dropped. 595 EXPECT_TRUE(N0->isResolved()); 596 EXPECT_FALSE(N1->isResolved()); 597 EXPECT_FALSE(N2->isResolved()); 598 EXPECT_FALSE(N3->isResolved()); 599 EXPECT_FALSE(N4->isResolved()); 600 601 // Create a couple of distinct nodes to observe what's going on. 602 // 603 // !5 = distinct !{!2} 604 // !6 = distinct !{!3} 605 Metadata *Ops5[] = {N2}; 606 MDNode *N5 = MDNode::getDistinct(Context, Ops5); 607 Metadata *Ops6[] = {N3}; 608 MDNode *N6 = MDNode::getDistinct(Context, Ops6); 609 610 // Mutate !2 to look like !1, causing a uniquing collision (and an RAUW). 611 // This will ripple up, with !3 colliding with !4, and RAUWing. Since !2 612 // references !3, this can cause a re-entry of handleChangedOperand() when !3 613 // is not ready for it. 614 // 615 // !2->replaceOperandWith(1, nullptr) 616 // !2: !{!3, !0} => !{!3, null} 617 // !2->replaceAllUsesWith(!1) 618 // !3: !{!2] => !{!1} 619 // !3->replaceAllUsesWith(!4) 620 N2->replaceOperandWith(1, nullptr); 621 622 // If all has gone well, N2 and N3 will have been RAUW'ed and deleted from 623 // under us. Just check that the other nodes are sane. 624 // 625 // !1 = !{!4, null} 626 // !4 = !{!1} 627 // !5 = distinct !{!1} 628 // !6 = distinct !{!4} 629 EXPECT_EQ(N4, N1->getOperand(0)); 630 EXPECT_EQ(N1, N4->getOperand(0)); 631 EXPECT_EQ(N1, N5->getOperand(0)); 632 EXPECT_EQ(N4, N6->getOperand(0)); 633 } 634 635 TEST_F(MDNodeTest, replaceResolvedOperand) { 636 // Check code for replacing one resolved operand with another. If doing this 637 // directly (via replaceOperandWith()) becomes illegal, change the operand to 638 // a global value that gets RAUW'ed. 639 // 640 // Use a temporary node to keep N from being resolved. 641 auto Temp = MDTuple::getTemporary(Context, None); 642 Metadata *Ops[] = {nullptr, Temp.get()}; 643 644 MDNode *Empty = MDTuple::get(Context, ArrayRef<Metadata *>()); 645 MDNode *N = MDTuple::get(Context, Ops); 646 EXPECT_EQ(nullptr, N->getOperand(0)); 647 ASSERT_FALSE(N->isResolved()); 648 649 // Check code for replacing resolved nodes. 650 N->replaceOperandWith(0, Empty); 651 EXPECT_EQ(Empty, N->getOperand(0)); 652 653 // Check code for adding another unresolved operand. 654 N->replaceOperandWith(0, Temp.get()); 655 EXPECT_EQ(Temp.get(), N->getOperand(0)); 656 657 // Remove the references to Temp; required for teardown. 658 Temp->replaceAllUsesWith(nullptr); 659 } 660 661 TEST_F(MDNodeTest, replaceWithUniqued) { 662 auto *Empty = MDTuple::get(Context, None); 663 MDTuple *FirstUniqued; 664 { 665 Metadata *Ops[] = {Empty}; 666 auto Temp = MDTuple::getTemporary(Context, Ops); 667 EXPECT_TRUE(Temp->isTemporary()); 668 669 // Don't expect a collision. 670 auto *Current = Temp.get(); 671 FirstUniqued = MDNode::replaceWithUniqued(std::move(Temp)); 672 EXPECT_TRUE(FirstUniqued->isUniqued()); 673 EXPECT_TRUE(FirstUniqued->isResolved()); 674 EXPECT_EQ(Current, FirstUniqued); 675 } 676 { 677 Metadata *Ops[] = {Empty}; 678 auto Temp = MDTuple::getTemporary(Context, Ops); 679 EXPECT_TRUE(Temp->isTemporary()); 680 681 // Should collide with Uniqued above this time. 682 auto *Uniqued = MDNode::replaceWithUniqued(std::move(Temp)); 683 EXPECT_TRUE(Uniqued->isUniqued()); 684 EXPECT_TRUE(Uniqued->isResolved()); 685 EXPECT_EQ(FirstUniqued, Uniqued); 686 } 687 { 688 auto Unresolved = MDTuple::getTemporary(Context, None); 689 Metadata *Ops[] = {Unresolved.get()}; 690 auto Temp = MDTuple::getTemporary(Context, Ops); 691 EXPECT_TRUE(Temp->isTemporary()); 692 693 // Shouldn't be resolved. 694 auto *Uniqued = MDNode::replaceWithUniqued(std::move(Temp)); 695 EXPECT_TRUE(Uniqued->isUniqued()); 696 EXPECT_FALSE(Uniqued->isResolved()); 697 698 // Should be a different node. 699 EXPECT_NE(FirstUniqued, Uniqued); 700 701 // Should resolve when we update its node (note: be careful to avoid a 702 // collision with any other nodes above). 703 Uniqued->replaceOperandWith(0, nullptr); 704 EXPECT_TRUE(Uniqued->isResolved()); 705 } 706 } 707 708 TEST_F(MDNodeTest, replaceWithUniquedResolvingOperand) { 709 // temp !{} 710 MDTuple *Op = MDTuple::getTemporary(Context, None).release(); 711 EXPECT_FALSE(Op->isResolved()); 712 713 // temp !{temp !{}} 714 Metadata *Ops[] = {Op}; 715 MDTuple *N = MDTuple::getTemporary(Context, Ops).release(); 716 EXPECT_FALSE(N->isResolved()); 717 718 // temp !{temp !{}} => !{temp !{}} 719 ASSERT_EQ(N, MDNode::replaceWithUniqued(TempMDTuple(N))); 720 EXPECT_FALSE(N->isResolved()); 721 722 // !{temp !{}} => !{!{}} 723 ASSERT_EQ(Op, MDNode::replaceWithUniqued(TempMDTuple(Op))); 724 EXPECT_TRUE(Op->isResolved()); 725 EXPECT_TRUE(N->isResolved()); 726 } 727 728 TEST_F(MDNodeTest, replaceWithUniquedDeletedOperand) { 729 // i1* @GV 730 Type *Ty = Type::getInt1PtrTy(Context); 731 std::unique_ptr<GlobalVariable> GV( 732 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 733 ConstantAsMetadata *Op = ConstantAsMetadata::get(GV.get()); 734 735 // temp !{i1* @GV} 736 Metadata *Ops[] = {Op}; 737 MDTuple *N = MDTuple::getTemporary(Context, Ops).release(); 738 739 // temp !{i1* @GV} => !{i1* @GV} 740 ASSERT_EQ(N, MDNode::replaceWithUniqued(TempMDTuple(N))); 741 ASSERT_TRUE(N->isUniqued()); 742 743 // !{i1* @GV} => !{null} 744 GV.reset(); 745 ASSERT_TRUE(N->isDistinct()); 746 ASSERT_EQ(nullptr, N->getOperand(0)); 747 Metadata *NullOps[] = {nullptr}; 748 ASSERT_NE(N, MDTuple::get(Context, NullOps)); 749 } 750 751 TEST_F(MDNodeTest, replaceWithUniquedChangedOperand) { 752 // i1* @GV 753 Type *Ty = Type::getInt1PtrTy(Context); 754 std::unique_ptr<GlobalVariable> GV( 755 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 756 ConstantAsMetadata *Op = ConstantAsMetadata::get(GV.get()); 757 758 // temp !{i1* @GV} 759 Metadata *Ops[] = {Op}; 760 MDTuple *N = MDTuple::getTemporary(Context, Ops).release(); 761 762 // temp !{i1* @GV} => !{i1* @GV} 763 ASSERT_EQ(N, MDNode::replaceWithUniqued(TempMDTuple(N))); 764 ASSERT_TRUE(N->isUniqued()); 765 766 // !{i1* @GV} => !{i1* @GV2} 767 std::unique_ptr<GlobalVariable> GV2( 768 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 769 GV->replaceAllUsesWith(GV2.get()); 770 ASSERT_TRUE(N->isUniqued()); 771 Metadata *NullOps[] = {ConstantAsMetadata::get(GV2.get())}; 772 ASSERT_EQ(N, MDTuple::get(Context, NullOps)); 773 } 774 775 TEST_F(MDNodeTest, replaceWithDistinct) { 776 { 777 auto *Empty = MDTuple::get(Context, None); 778 Metadata *Ops[] = {Empty}; 779 auto Temp = MDTuple::getTemporary(Context, Ops); 780 EXPECT_TRUE(Temp->isTemporary()); 781 782 // Don't expect a collision. 783 auto *Current = Temp.get(); 784 auto *Distinct = MDNode::replaceWithDistinct(std::move(Temp)); 785 EXPECT_TRUE(Distinct->isDistinct()); 786 EXPECT_TRUE(Distinct->isResolved()); 787 EXPECT_EQ(Current, Distinct); 788 } 789 { 790 auto Unresolved = MDTuple::getTemporary(Context, None); 791 Metadata *Ops[] = {Unresolved.get()}; 792 auto Temp = MDTuple::getTemporary(Context, Ops); 793 EXPECT_TRUE(Temp->isTemporary()); 794 795 // Don't expect a collision. 796 auto *Current = Temp.get(); 797 auto *Distinct = MDNode::replaceWithDistinct(std::move(Temp)); 798 EXPECT_TRUE(Distinct->isDistinct()); 799 EXPECT_TRUE(Distinct->isResolved()); 800 EXPECT_EQ(Current, Distinct); 801 802 // Cleanup; required for teardown. 803 Unresolved->replaceAllUsesWith(nullptr); 804 } 805 } 806 807 TEST_F(MDNodeTest, replaceWithPermanent) { 808 Metadata *Ops[] = {nullptr}; 809 auto Temp = MDTuple::getTemporary(Context, Ops); 810 auto *T = Temp.get(); 811 812 // U is a normal, uniqued node that references T. 813 auto *U = MDTuple::get(Context, T); 814 EXPECT_TRUE(U->isUniqued()); 815 816 // Make Temp self-referencing. 817 Temp->replaceOperandWith(0, T); 818 819 // Try to uniquify Temp. This should, despite the name in the API, give a 820 // 'distinct' node, since self-references aren't allowed to be uniqued. 821 // 822 // Since it's distinct, N should have the same address as when it was a 823 // temporary (i.e., be equal to T not U). 824 auto *N = MDNode::replaceWithPermanent(std::move(Temp)); 825 EXPECT_EQ(N, T); 826 EXPECT_TRUE(N->isDistinct()); 827 828 // U should be the canonical unique node with N as the argument. 829 EXPECT_EQ(U, MDTuple::get(Context, N)); 830 EXPECT_TRUE(U->isUniqued()); 831 832 // This temporary should collide with U when replaced, but it should still be 833 // uniqued. 834 EXPECT_EQ(U, MDNode::replaceWithPermanent(MDTuple::getTemporary(Context, N))); 835 EXPECT_TRUE(U->isUniqued()); 836 837 // This temporary should become a new uniqued node. 838 auto Temp2 = MDTuple::getTemporary(Context, U); 839 auto *V = Temp2.get(); 840 EXPECT_EQ(V, MDNode::replaceWithPermanent(std::move(Temp2))); 841 EXPECT_TRUE(V->isUniqued()); 842 EXPECT_EQ(U, V->getOperand(0)); 843 } 844 845 TEST_F(MDNodeTest, deleteTemporaryWithTrackingRef) { 846 TrackingMDRef Ref; 847 EXPECT_EQ(nullptr, Ref.get()); 848 { 849 auto Temp = MDTuple::getTemporary(Context, None); 850 Ref.reset(Temp.get()); 851 EXPECT_EQ(Temp.get(), Ref.get()); 852 } 853 EXPECT_EQ(nullptr, Ref.get()); 854 } 855 856 typedef MetadataTest DILocationTest; 857 858 TEST_F(DILocationTest, Overflow) { 859 DISubprogram *N = getSubprogram(); 860 { 861 DILocation *L = DILocation::get(Context, 2, 7, N); 862 EXPECT_EQ(2u, L->getLine()); 863 EXPECT_EQ(7u, L->getColumn()); 864 } 865 unsigned U16 = 1u << 16; 866 { 867 DILocation *L = DILocation::get(Context, UINT32_MAX, U16 - 1, N); 868 EXPECT_EQ(UINT32_MAX, L->getLine()); 869 EXPECT_EQ(U16 - 1, L->getColumn()); 870 } 871 { 872 DILocation *L = DILocation::get(Context, UINT32_MAX, U16, N); 873 EXPECT_EQ(UINT32_MAX, L->getLine()); 874 EXPECT_EQ(0u, L->getColumn()); 875 } 876 { 877 DILocation *L = DILocation::get(Context, UINT32_MAX, U16 + 1, N); 878 EXPECT_EQ(UINT32_MAX, L->getLine()); 879 EXPECT_EQ(0u, L->getColumn()); 880 } 881 } 882 883 TEST_F(DILocationTest, Merge) { 884 DISubprogram *N = getSubprogram(); 885 DIScope *S = DILexicalBlock::get(Context, N, getFile(), 3, 4); 886 887 { 888 // Identical. 889 auto *A = DILocation::get(Context, 2, 7, N); 890 auto *B = DILocation::get(Context, 2, 7, N); 891 auto *M = DILocation::getMergedLocation(A, B); 892 EXPECT_EQ(2u, M->getLine()); 893 EXPECT_EQ(7u, M->getColumn()); 894 EXPECT_EQ(N, M->getScope()); 895 } 896 897 { 898 // Identical, different scopes. 899 auto *A = DILocation::get(Context, 2, 7, N); 900 auto *B = DILocation::get(Context, 2, 7, S); 901 auto *M = DILocation::getMergedLocation(A, B); 902 EXPECT_EQ(0u, M->getLine()); // FIXME: Should this be 2? 903 EXPECT_EQ(0u, M->getColumn()); // FIXME: Should this be 7? 904 EXPECT_EQ(N, M->getScope()); 905 } 906 907 { 908 // Different lines, same scopes. 909 auto *A = DILocation::get(Context, 1, 6, N); 910 auto *B = DILocation::get(Context, 2, 7, N); 911 auto *M = DILocation::getMergedLocation(A, B); 912 EXPECT_EQ(0u, M->getLine()); 913 EXPECT_EQ(0u, M->getColumn()); 914 EXPECT_EQ(N, M->getScope()); 915 } 916 917 { 918 // Twisty locations, all different, same function. 919 auto *A = DILocation::get(Context, 1, 6, N); 920 auto *B = DILocation::get(Context, 2, 7, S); 921 auto *M = DILocation::getMergedLocation(A, B); 922 EXPECT_EQ(0u, M->getLine()); 923 EXPECT_EQ(0u, M->getColumn()); 924 EXPECT_EQ(N, M->getScope()); 925 } 926 927 { 928 // Different function, same inlined-at. 929 auto *F = getFile(); 930 auto *SP1 = DISubprogram::getDistinct(Context, F, "a", "a", F, 0, nullptr, 931 0, nullptr, 0, 0, DINode::FlagZero, 932 DISubprogram::SPFlagZero, nullptr); 933 auto *SP2 = DISubprogram::getDistinct(Context, F, "b", "b", F, 0, nullptr, 934 0, nullptr, 0, 0, DINode::FlagZero, 935 DISubprogram::SPFlagZero, nullptr); 936 937 auto *I = DILocation::get(Context, 2, 7, N); 938 auto *A = DILocation::get(Context, 1, 6, SP1, I); 939 auto *B = DILocation::get(Context, 2, 7, SP2, I); 940 auto *M = DILocation::getMergedLocation(A, B); 941 EXPECT_EQ(0u, M->getLine()); 942 EXPECT_EQ(0u, M->getColumn()); 943 EXPECT_TRUE(isa<DILocalScope>(M->getScope())); 944 EXPECT_EQ(I, M->getInlinedAt()); 945 } 946 947 { 948 // Completely different. 949 auto *I = DILocation::get(Context, 2, 7, N); 950 auto *A = DILocation::get(Context, 1, 6, S, I); 951 auto *B = DILocation::get(Context, 2, 7, getSubprogram()); 952 auto *M = DILocation::getMergedLocation(A, B); 953 EXPECT_EQ(0u, M->getLine()); 954 EXPECT_EQ(0u, M->getColumn()); 955 EXPECT_TRUE(isa<DILocalScope>(M->getScope())); 956 EXPECT_EQ(S, M->getScope()); 957 EXPECT_EQ(nullptr, M->getInlinedAt()); 958 } 959 } 960 961 TEST_F(DILocationTest, getDistinct) { 962 MDNode *N = getSubprogram(); 963 DILocation *L0 = DILocation::getDistinct(Context, 2, 7, N); 964 EXPECT_TRUE(L0->isDistinct()); 965 DILocation *L1 = DILocation::get(Context, 2, 7, N); 966 EXPECT_FALSE(L1->isDistinct()); 967 EXPECT_EQ(L1, DILocation::get(Context, 2, 7, N)); 968 } 969 970 TEST_F(DILocationTest, getTemporary) { 971 MDNode *N = MDNode::get(Context, None); 972 auto L = DILocation::getTemporary(Context, 2, 7, N); 973 EXPECT_TRUE(L->isTemporary()); 974 EXPECT_FALSE(L->isResolved()); 975 } 976 977 TEST_F(DILocationTest, cloneTemporary) { 978 MDNode *N = MDNode::get(Context, None); 979 auto L = DILocation::getTemporary(Context, 2, 7, N); 980 EXPECT_TRUE(L->isTemporary()); 981 auto L2 = L->clone(); 982 EXPECT_TRUE(L2->isTemporary()); 983 } 984 985 TEST_F(DILocationTest, discriminatorEncoding) { 986 EXPECT_EQ(0U, DILocation::encodeDiscriminator(0, 0, 0).getValue()); 987 988 // Encode base discriminator as a component: lsb is 0, then the value. 989 // The other components are all absent, so we leave all the other bits 0. 990 EXPECT_EQ(2U, DILocation::encodeDiscriminator(1, 0, 0).getValue()); 991 992 // Base discriminator component is empty, so lsb is 1. Next component is not 993 // empty, so its lsb is 0, then its value (1). Next component is empty. 994 // So the bit pattern is 101. 995 EXPECT_EQ(5U, DILocation::encodeDiscriminator(0, 1, 0).getValue()); 996 997 // First 2 components are empty, so the bit pattern is 11. Then the 998 // next component - ending up with 1011. 999 EXPECT_EQ(0xbU, DILocation::encodeDiscriminator(0, 0, 1).getValue()); 1000 1001 // The bit pattern for the first 2 components is 11. The next bit is 0, 1002 // because the last component is not empty. We have 29 bits usable for 1003 // encoding, but we cap it at 12 bits uniformously for all components. We 1004 // encode the last component over 14 bits. 1005 EXPECT_EQ(0xfffbU, DILocation::encodeDiscriminator(0, 0, 0xfff).getValue()); 1006 1007 EXPECT_EQ(0x102U, DILocation::encodeDiscriminator(1, 1, 0).getValue()); 1008 1009 EXPECT_EQ(0x13eU, DILocation::encodeDiscriminator(0x1f, 1, 0).getValue()); 1010 1011 EXPECT_EQ(0x87feU, DILocation::encodeDiscriminator(0x1ff, 1, 0).getValue()); 1012 1013 EXPECT_EQ(0x1f3eU, DILocation::encodeDiscriminator(0x1f, 0x1f, 0).getValue()); 1014 1015 EXPECT_EQ(0x3ff3eU, 1016 DILocation::encodeDiscriminator(0x1f, 0x1ff, 0).getValue()); 1017 1018 EXPECT_EQ(0x1ff87feU, 1019 DILocation::encodeDiscriminator(0x1ff, 0x1ff, 0).getValue()); 1020 1021 EXPECT_EQ(0xfff9f3eU, 1022 DILocation::encodeDiscriminator(0x1f, 0x1f, 0xfff).getValue()); 1023 1024 EXPECT_EQ(0xffc3ff3eU, 1025 DILocation::encodeDiscriminator(0x1f, 0x1ff, 0x1ff).getValue()); 1026 1027 EXPECT_EQ(0xffcf87feU, 1028 DILocation::encodeDiscriminator(0x1ff, 0x1f, 0x1ff).getValue()); 1029 1030 EXPECT_EQ(0xe1ff87feU, 1031 DILocation::encodeDiscriminator(0x1ff, 0x1ff, 7).getValue()); 1032 } 1033 1034 TEST_F(DILocationTest, discriminatorEncodingNegativeTests) { 1035 EXPECT_EQ(None, DILocation::encodeDiscriminator(0, 0, 0x1000)); 1036 EXPECT_EQ(None, DILocation::encodeDiscriminator(0x1000, 0, 0)); 1037 EXPECT_EQ(None, DILocation::encodeDiscriminator(0, 0x1000, 0)); 1038 EXPECT_EQ(None, DILocation::encodeDiscriminator(0, 0, 0x1000)); 1039 EXPECT_EQ(None, DILocation::encodeDiscriminator(0x1ff, 0x1ff, 8)); 1040 EXPECT_EQ(None, 1041 DILocation::encodeDiscriminator(std::numeric_limits<uint32_t>::max(), 1042 std::numeric_limits<uint32_t>::max(), 1043 0)); 1044 } 1045 1046 TEST_F(DILocationTest, discriminatorSpecialCases) { 1047 // We don't test getCopyIdentifier here because the only way 1048 // to set it is by constructing an encoded discriminator using 1049 // encodeDiscriminator, which is already tested. 1050 auto L1 = DILocation::get(Context, 1, 2, getSubprogram()); 1051 EXPECT_EQ(0U, L1->getBaseDiscriminator()); 1052 EXPECT_EQ(1U, L1->getDuplicationFactor()); 1053 1054 EXPECT_EQ(L1, L1->cloneWithBaseDiscriminator(0).getValue()); 1055 EXPECT_EQ(L1, L1->cloneByMultiplyingDuplicationFactor(0).getValue()); 1056 EXPECT_EQ(L1, L1->cloneByMultiplyingDuplicationFactor(1).getValue()); 1057 1058 auto L2 = L1->cloneWithBaseDiscriminator(1).getValue(); 1059 EXPECT_EQ(0U, L1->getBaseDiscriminator()); 1060 EXPECT_EQ(1U, L1->getDuplicationFactor()); 1061 1062 EXPECT_EQ(1U, L2->getBaseDiscriminator()); 1063 EXPECT_EQ(1U, L2->getDuplicationFactor()); 1064 1065 auto L3 = L2->cloneByMultiplyingDuplicationFactor(2).getValue(); 1066 EXPECT_EQ(1U, L3->getBaseDiscriminator()); 1067 EXPECT_EQ(2U, L3->getDuplicationFactor()); 1068 1069 EXPECT_EQ(L2, L2->cloneByMultiplyingDuplicationFactor(1).getValue()); 1070 1071 auto L4 = L3->cloneByMultiplyingDuplicationFactor(4).getValue(); 1072 EXPECT_EQ(1U, L4->getBaseDiscriminator()); 1073 EXPECT_EQ(8U, L4->getDuplicationFactor()); 1074 1075 auto L5 = L4->cloneWithBaseDiscriminator(2).getValue(); 1076 EXPECT_EQ(2U, L5->getBaseDiscriminator()); 1077 EXPECT_EQ(8U, L5->getDuplicationFactor()); 1078 1079 // Check extreme cases 1080 auto L6 = L1->cloneWithBaseDiscriminator(0xfff).getValue(); 1081 EXPECT_EQ(0xfffU, L6->getBaseDiscriminator()); 1082 EXPECT_EQ(0xfffU, L6->cloneByMultiplyingDuplicationFactor(0xfff) 1083 .getValue() 1084 ->getDuplicationFactor()); 1085 1086 // Check we return None for unencodable cases. 1087 EXPECT_EQ(None, L4->cloneWithBaseDiscriminator(0x1000)); 1088 EXPECT_EQ(None, L4->cloneByMultiplyingDuplicationFactor(0x1000)); 1089 } 1090 1091 1092 typedef MetadataTest GenericDINodeTest; 1093 1094 TEST_F(GenericDINodeTest, get) { 1095 StringRef Header = "header"; 1096 auto *Empty = MDNode::get(Context, None); 1097 Metadata *Ops1[] = {Empty}; 1098 auto *N = GenericDINode::get(Context, 15, Header, Ops1); 1099 EXPECT_EQ(15u, N->getTag()); 1100 EXPECT_EQ(2u, N->getNumOperands()); 1101 EXPECT_EQ(Header, N->getHeader()); 1102 EXPECT_EQ(MDString::get(Context, Header), N->getOperand(0)); 1103 EXPECT_EQ(1u, N->getNumDwarfOperands()); 1104 EXPECT_EQ(Empty, N->getDwarfOperand(0)); 1105 EXPECT_EQ(Empty, N->getOperand(1)); 1106 ASSERT_TRUE(N->isUniqued()); 1107 1108 EXPECT_EQ(N, GenericDINode::get(Context, 15, Header, Ops1)); 1109 1110 N->replaceOperandWith(1, nullptr); 1111 EXPECT_EQ(15u, N->getTag()); 1112 EXPECT_EQ(Header, N->getHeader()); 1113 EXPECT_EQ(nullptr, N->getDwarfOperand(0)); 1114 ASSERT_TRUE(N->isUniqued()); 1115 1116 Metadata *Ops2[] = {nullptr}; 1117 EXPECT_EQ(N, GenericDINode::get(Context, 15, Header, Ops2)); 1118 1119 N->replaceDwarfOperandWith(0, Empty); 1120 EXPECT_EQ(15u, N->getTag()); 1121 EXPECT_EQ(Header, N->getHeader()); 1122 EXPECT_EQ(Empty, N->getDwarfOperand(0)); 1123 ASSERT_TRUE(N->isUniqued()); 1124 EXPECT_EQ(N, GenericDINode::get(Context, 15, Header, Ops1)); 1125 1126 TempGenericDINode Temp = N->clone(); 1127 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1128 } 1129 1130 TEST_F(GenericDINodeTest, getEmptyHeader) { 1131 // Canonicalize !"" to null. 1132 auto *N = GenericDINode::get(Context, 15, StringRef(), None); 1133 EXPECT_EQ(StringRef(), N->getHeader()); 1134 EXPECT_EQ(nullptr, N->getOperand(0)); 1135 } 1136 1137 typedef MetadataTest DISubrangeTest; 1138 1139 TEST_F(DISubrangeTest, get) { 1140 auto *N = DISubrange::get(Context, 5, 7); 1141 auto Count = N->getCount(); 1142 EXPECT_EQ(dwarf::DW_TAG_subrange_type, N->getTag()); 1143 ASSERT_TRUE(Count); 1144 ASSERT_TRUE(Count.is<ConstantInt*>()); 1145 EXPECT_EQ(5, Count.get<ConstantInt*>()->getSExtValue()); 1146 EXPECT_EQ(7, N->getLowerBound()); 1147 EXPECT_EQ(N, DISubrange::get(Context, 5, 7)); 1148 EXPECT_EQ(DISubrange::get(Context, 5, 0), DISubrange::get(Context, 5)); 1149 1150 TempDISubrange Temp = N->clone(); 1151 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1152 } 1153 1154 TEST_F(DISubrangeTest, getEmptyArray) { 1155 auto *N = DISubrange::get(Context, -1, 0); 1156 auto Count = N->getCount(); 1157 EXPECT_EQ(dwarf::DW_TAG_subrange_type, N->getTag()); 1158 ASSERT_TRUE(Count); 1159 ASSERT_TRUE(Count.is<ConstantInt*>()); 1160 EXPECT_EQ(-1, Count.get<ConstantInt*>()->getSExtValue()); 1161 EXPECT_EQ(0, N->getLowerBound()); 1162 EXPECT_EQ(N, DISubrange::get(Context, -1, 0)); 1163 } 1164 1165 TEST_F(DISubrangeTest, getVariableCount) { 1166 DILocalScope *Scope = getSubprogram(); 1167 DIFile *File = getFile(); 1168 DIType *Type = getDerivedType(); 1169 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7); 1170 auto *VlaExpr = DILocalVariable::get(Context, Scope, "vla_expr", File, 8, 1171 Type, 2, Flags, 8); 1172 1173 auto *N = DISubrange::get(Context, VlaExpr, 0); 1174 auto Count = N->getCount(); 1175 ASSERT_TRUE(Count); 1176 ASSERT_TRUE(Count.is<DIVariable*>()); 1177 EXPECT_EQ(VlaExpr, Count.get<DIVariable*>()); 1178 ASSERT_TRUE(isa<DIVariable>(N->getRawCountNode())); 1179 EXPECT_EQ(0, N->getLowerBound()); 1180 EXPECT_EQ("vla_expr", Count.get<DIVariable*>()->getName()); 1181 EXPECT_EQ(N, DISubrange::get(Context, VlaExpr, 0)); 1182 } 1183 1184 typedef MetadataTest DIEnumeratorTest; 1185 1186 TEST_F(DIEnumeratorTest, get) { 1187 auto *N = DIEnumerator::get(Context, 7, false, "name"); 1188 EXPECT_EQ(dwarf::DW_TAG_enumerator, N->getTag()); 1189 EXPECT_EQ(7, N->getValue()); 1190 EXPECT_FALSE(N->isUnsigned()); 1191 EXPECT_EQ("name", N->getName()); 1192 EXPECT_EQ(N, DIEnumerator::get(Context, 7, false, "name")); 1193 1194 EXPECT_NE(N, DIEnumerator::get(Context, 7, true, "name")); 1195 EXPECT_NE(N, DIEnumerator::get(Context, 8, false, "name")); 1196 EXPECT_NE(N, DIEnumerator::get(Context, 7, false, "nam")); 1197 1198 TempDIEnumerator Temp = N->clone(); 1199 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1200 } 1201 1202 typedef MetadataTest DIBasicTypeTest; 1203 1204 TEST_F(DIBasicTypeTest, get) { 1205 auto *N = 1206 DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 26, 7, 1207 DINode::FlagZero); 1208 EXPECT_EQ(dwarf::DW_TAG_base_type, N->getTag()); 1209 EXPECT_EQ("special", N->getName()); 1210 EXPECT_EQ(33u, N->getSizeInBits()); 1211 EXPECT_EQ(26u, N->getAlignInBits()); 1212 EXPECT_EQ(7u, N->getEncoding()); 1213 EXPECT_EQ(0u, N->getLine()); 1214 EXPECT_EQ(DINode::FlagZero, N->getFlags()); 1215 EXPECT_EQ(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 1216 26, 7, DINode::FlagZero)); 1217 1218 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type, 1219 "special", 33, 26, 7, DINode::FlagZero)); 1220 EXPECT_NE(N, 1221 DIBasicType::get(Context, dwarf::DW_TAG_base_type, "s", 33, 26, 7, 1222 DINode::FlagZero)); 1223 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 32, 1224 26, 7, DINode::FlagZero)); 1225 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 1226 25, 7, DINode::FlagZero)); 1227 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 1228 26, 6, DINode::FlagZero)); 1229 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 1230 26, 7, DINode::FlagBigEndian)); 1231 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 1232 26, 7, DINode::FlagLittleEndian)); 1233 1234 TempDIBasicType Temp = N->clone(); 1235 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1236 } 1237 1238 TEST_F(DIBasicTypeTest, getWithLargeValues) { 1239 auto *N = DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 1240 UINT64_MAX, UINT32_MAX - 1, 7, DINode::FlagZero); 1241 EXPECT_EQ(UINT64_MAX, N->getSizeInBits()); 1242 EXPECT_EQ(UINT32_MAX - 1, N->getAlignInBits()); 1243 } 1244 1245 TEST_F(DIBasicTypeTest, getUnspecified) { 1246 auto *N = 1247 DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type, "unspecified"); 1248 EXPECT_EQ(dwarf::DW_TAG_unspecified_type, N->getTag()); 1249 EXPECT_EQ("unspecified", N->getName()); 1250 EXPECT_EQ(0u, N->getSizeInBits()); 1251 EXPECT_EQ(0u, N->getAlignInBits()); 1252 EXPECT_EQ(0u, N->getEncoding()); 1253 EXPECT_EQ(0u, N->getLine()); 1254 EXPECT_EQ(DINode::FlagZero, N->getFlags()); 1255 } 1256 1257 typedef MetadataTest DITypeTest; 1258 1259 TEST_F(DITypeTest, clone) { 1260 // Check that DIType has a specialized clone that returns TempDIType. 1261 DIType *N = DIBasicType::get(Context, dwarf::DW_TAG_base_type, "int", 32, 32, 1262 dwarf::DW_ATE_signed, DINode::FlagZero); 1263 1264 TempDIType Temp = N->clone(); 1265 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1266 } 1267 1268 TEST_F(DITypeTest, cloneWithFlags) { 1269 // void (void) 1270 Metadata *TypesOps[] = {nullptr}; 1271 Metadata *Types = MDTuple::get(Context, TypesOps); 1272 1273 DIType *D = 1274 DISubroutineType::getDistinct(Context, DINode::FlagZero, 0, Types); 1275 EXPECT_EQ(DINode::FlagZero, D->getFlags()); 1276 TempDIType D2 = D->cloneWithFlags(DINode::FlagRValueReference); 1277 EXPECT_EQ(DINode::FlagRValueReference, D2->getFlags()); 1278 EXPECT_EQ(DINode::FlagZero, D->getFlags()); 1279 1280 TempDIType T = 1281 DISubroutineType::getTemporary(Context, DINode::FlagZero, 0, Types); 1282 EXPECT_EQ(DINode::FlagZero, T->getFlags()); 1283 TempDIType T2 = T->cloneWithFlags(DINode::FlagRValueReference); 1284 EXPECT_EQ(DINode::FlagRValueReference, T2->getFlags()); 1285 EXPECT_EQ(DINode::FlagZero, T->getFlags()); 1286 } 1287 1288 typedef MetadataTest DIDerivedTypeTest; 1289 1290 TEST_F(DIDerivedTypeTest, get) { 1291 DIFile *File = getFile(); 1292 DIScope *Scope = getSubprogram(); 1293 DIType *BaseType = getBasicType("basic"); 1294 MDTuple *ExtraData = getTuple(); 1295 unsigned DWARFAddressSpace = 8; 1296 DINode::DIFlags Flags5 = static_cast<DINode::DIFlags>(5); 1297 DINode::DIFlags Flags4 = static_cast<DINode::DIFlags>(4); 1298 1299 auto *N = 1300 DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "something", File, 1301 1, Scope, BaseType, 2, 3, 4, DWARFAddressSpace, Flags5, 1302 ExtraData); 1303 EXPECT_EQ(dwarf::DW_TAG_pointer_type, N->getTag()); 1304 EXPECT_EQ("something", N->getName()); 1305 EXPECT_EQ(File, N->getFile()); 1306 EXPECT_EQ(1u, N->getLine()); 1307 EXPECT_EQ(Scope, N->getScope()); 1308 EXPECT_EQ(BaseType, N->getBaseType()); 1309 EXPECT_EQ(2u, N->getSizeInBits()); 1310 EXPECT_EQ(3u, N->getAlignInBits()); 1311 EXPECT_EQ(4u, N->getOffsetInBits()); 1312 EXPECT_EQ(DWARFAddressSpace, N->getDWARFAddressSpace().getValue()); 1313 EXPECT_EQ(5u, N->getFlags()); 1314 EXPECT_EQ(ExtraData, N->getExtraData()); 1315 EXPECT_EQ(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1316 "something", File, 1, Scope, BaseType, 2, 3, 1317 4, DWARFAddressSpace, Flags5, ExtraData)); 1318 1319 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_reference_type, 1320 "something", File, 1, Scope, BaseType, 2, 3, 1321 4, DWARFAddressSpace, Flags5, ExtraData)); 1322 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "else", 1323 File, 1, Scope, BaseType, 2, 3, 1324 4, DWARFAddressSpace, Flags5, ExtraData)); 1325 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1326 "something", getFile(), 1, Scope, BaseType, 2, 1327 3, 4, DWARFAddressSpace, Flags5, ExtraData)); 1328 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1329 "something", File, 2, Scope, BaseType, 2, 3, 1330 4, DWARFAddressSpace, Flags5, ExtraData)); 1331 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1332 "something", File, 1, getSubprogram(), 1333 BaseType, 2, 3, 4, DWARFAddressSpace, Flags5, 1334 ExtraData)); 1335 EXPECT_NE(N, DIDerivedType::get( 1336 Context, dwarf::DW_TAG_pointer_type, "something", File, 1, 1337 Scope, getBasicType("basic2"), 2, 3, 4, DWARFAddressSpace, 1338 Flags5, ExtraData)); 1339 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1340 "something", File, 1, Scope, BaseType, 3, 3, 1341 4, DWARFAddressSpace, Flags5, ExtraData)); 1342 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1343 "something", File, 1, Scope, BaseType, 2, 2, 1344 4, DWARFAddressSpace, Flags5, ExtraData)); 1345 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1346 "something", File, 1, Scope, BaseType, 2, 3, 1347 5, DWARFAddressSpace, Flags5, ExtraData)); 1348 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1349 "something", File, 1, Scope, BaseType, 2, 3, 1350 4, DWARFAddressSpace + 1, Flags5, ExtraData)); 1351 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1352 "something", File, 1, Scope, BaseType, 2, 3, 1353 4, DWARFAddressSpace, Flags4, ExtraData)); 1354 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, 1355 "something", File, 1, Scope, BaseType, 2, 3, 1356 4, DWARFAddressSpace, Flags5, getTuple())); 1357 1358 TempDIDerivedType Temp = N->clone(); 1359 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1360 } 1361 1362 TEST_F(DIDerivedTypeTest, getWithLargeValues) { 1363 DIFile *File = getFile(); 1364 DIScope *Scope = getSubprogram(); 1365 DIType *BaseType = getBasicType("basic"); 1366 MDTuple *ExtraData = getTuple(); 1367 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1368 1369 auto *N = DIDerivedType::get( 1370 Context, dwarf::DW_TAG_pointer_type, "something", File, 1, Scope, 1371 BaseType, UINT64_MAX, UINT32_MAX - 1, UINT64_MAX - 2, UINT32_MAX - 3, 1372 Flags, ExtraData); 1373 EXPECT_EQ(UINT64_MAX, N->getSizeInBits()); 1374 EXPECT_EQ(UINT32_MAX - 1, N->getAlignInBits()); 1375 EXPECT_EQ(UINT64_MAX - 2, N->getOffsetInBits()); 1376 EXPECT_EQ(UINT32_MAX - 3, N->getDWARFAddressSpace().getValue()); 1377 } 1378 1379 typedef MetadataTest DICompositeTypeTest; 1380 1381 TEST_F(DICompositeTypeTest, get) { 1382 unsigned Tag = dwarf::DW_TAG_structure_type; 1383 StringRef Name = "some name"; 1384 DIFile *File = getFile(); 1385 unsigned Line = 1; 1386 DIScope *Scope = getSubprogram(); 1387 DIType *BaseType = getCompositeType(); 1388 uint64_t SizeInBits = 2; 1389 uint32_t AlignInBits = 3; 1390 uint64_t OffsetInBits = 4; 1391 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1392 MDTuple *Elements = getTuple(); 1393 unsigned RuntimeLang = 6; 1394 DIType *VTableHolder = getCompositeType(); 1395 MDTuple *TemplateParams = getTuple(); 1396 StringRef Identifier = "some id"; 1397 1398 auto *N = DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1399 BaseType, SizeInBits, AlignInBits, 1400 OffsetInBits, Flags, Elements, RuntimeLang, 1401 VTableHolder, TemplateParams, Identifier); 1402 EXPECT_EQ(Tag, N->getTag()); 1403 EXPECT_EQ(Name, N->getName()); 1404 EXPECT_EQ(File, N->getFile()); 1405 EXPECT_EQ(Line, N->getLine()); 1406 EXPECT_EQ(Scope, N->getScope()); 1407 EXPECT_EQ(BaseType, N->getBaseType()); 1408 EXPECT_EQ(SizeInBits, N->getSizeInBits()); 1409 EXPECT_EQ(AlignInBits, N->getAlignInBits()); 1410 EXPECT_EQ(OffsetInBits, N->getOffsetInBits()); 1411 EXPECT_EQ(Flags, N->getFlags()); 1412 EXPECT_EQ(Elements, N->getElements().get()); 1413 EXPECT_EQ(RuntimeLang, N->getRuntimeLang()); 1414 EXPECT_EQ(VTableHolder, N->getVTableHolder()); 1415 EXPECT_EQ(TemplateParams, N->getTemplateParams().get()); 1416 EXPECT_EQ(Identifier, N->getIdentifier()); 1417 1418 EXPECT_EQ(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1419 BaseType, SizeInBits, AlignInBits, 1420 OffsetInBits, Flags, Elements, RuntimeLang, 1421 VTableHolder, TemplateParams, Identifier)); 1422 1423 EXPECT_NE(N, DICompositeType::get(Context, Tag + 1, Name, File, Line, Scope, 1424 BaseType, SizeInBits, AlignInBits, 1425 OffsetInBits, Flags, Elements, RuntimeLang, 1426 VTableHolder, TemplateParams, Identifier)); 1427 EXPECT_NE(N, DICompositeType::get(Context, Tag, "abc", File, Line, Scope, 1428 BaseType, SizeInBits, AlignInBits, 1429 OffsetInBits, Flags, Elements, RuntimeLang, 1430 VTableHolder, TemplateParams, Identifier)); 1431 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, getFile(), Line, Scope, 1432 BaseType, SizeInBits, AlignInBits, 1433 OffsetInBits, Flags, Elements, RuntimeLang, 1434 VTableHolder, TemplateParams, Identifier)); 1435 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line + 1, Scope, 1436 BaseType, SizeInBits, AlignInBits, 1437 OffsetInBits, Flags, Elements, RuntimeLang, 1438 VTableHolder, TemplateParams, Identifier)); 1439 EXPECT_NE(N, DICompositeType::get( 1440 Context, Tag, Name, File, Line, getSubprogram(), BaseType, 1441 SizeInBits, AlignInBits, OffsetInBits, Flags, Elements, 1442 RuntimeLang, VTableHolder, TemplateParams, Identifier)); 1443 EXPECT_NE(N, DICompositeType::get( 1444 Context, Tag, Name, File, Line, Scope, getBasicType("other"), 1445 SizeInBits, AlignInBits, OffsetInBits, Flags, Elements, 1446 RuntimeLang, VTableHolder, TemplateParams, Identifier)); 1447 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1448 BaseType, SizeInBits + 1, AlignInBits, 1449 OffsetInBits, Flags, Elements, RuntimeLang, 1450 VTableHolder, TemplateParams, Identifier)); 1451 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1452 BaseType, SizeInBits, AlignInBits + 1, 1453 OffsetInBits, Flags, Elements, RuntimeLang, 1454 VTableHolder, TemplateParams, Identifier)); 1455 EXPECT_NE(N, DICompositeType::get( 1456 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1457 AlignInBits, OffsetInBits + 1, Flags, Elements, RuntimeLang, 1458 VTableHolder, TemplateParams, Identifier)); 1459 DINode::DIFlags FlagsPOne = static_cast<DINode::DIFlags>(Flags + 1); 1460 EXPECT_NE(N, DICompositeType::get( 1461 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1462 AlignInBits, OffsetInBits, FlagsPOne, Elements, RuntimeLang, 1463 VTableHolder, TemplateParams, Identifier)); 1464 EXPECT_NE(N, DICompositeType::get( 1465 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1466 AlignInBits, OffsetInBits, Flags, getTuple(), RuntimeLang, 1467 VTableHolder, TemplateParams, Identifier)); 1468 EXPECT_NE(N, DICompositeType::get( 1469 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1470 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang + 1, 1471 VTableHolder, TemplateParams, Identifier)); 1472 EXPECT_NE(N, DICompositeType::get( 1473 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, 1474 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang, 1475 getCompositeType(), TemplateParams, Identifier)); 1476 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1477 BaseType, SizeInBits, AlignInBits, 1478 OffsetInBits, Flags, Elements, RuntimeLang, 1479 VTableHolder, getTuple(), Identifier)); 1480 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1481 BaseType, SizeInBits, AlignInBits, 1482 OffsetInBits, Flags, Elements, RuntimeLang, 1483 VTableHolder, TemplateParams, "other")); 1484 1485 // Be sure that missing identifiers get null pointers. 1486 EXPECT_FALSE(DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1487 BaseType, SizeInBits, AlignInBits, 1488 OffsetInBits, Flags, Elements, RuntimeLang, 1489 VTableHolder, TemplateParams, "") 1490 ->getRawIdentifier()); 1491 EXPECT_FALSE(DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1492 BaseType, SizeInBits, AlignInBits, 1493 OffsetInBits, Flags, Elements, RuntimeLang, 1494 VTableHolder, TemplateParams) 1495 ->getRawIdentifier()); 1496 1497 TempDICompositeType Temp = N->clone(); 1498 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1499 } 1500 1501 TEST_F(DICompositeTypeTest, getWithLargeValues) { 1502 unsigned Tag = dwarf::DW_TAG_structure_type; 1503 StringRef Name = "some name"; 1504 DIFile *File = getFile(); 1505 unsigned Line = 1; 1506 DIScope *Scope = getSubprogram(); 1507 DIType *BaseType = getCompositeType(); 1508 uint64_t SizeInBits = UINT64_MAX; 1509 uint32_t AlignInBits = UINT32_MAX - 1; 1510 uint64_t OffsetInBits = UINT64_MAX - 2; 1511 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1512 MDTuple *Elements = getTuple(); 1513 unsigned RuntimeLang = 6; 1514 DIType *VTableHolder = getCompositeType(); 1515 MDTuple *TemplateParams = getTuple(); 1516 StringRef Identifier = "some id"; 1517 1518 auto *N = DICompositeType::get(Context, Tag, Name, File, Line, Scope, 1519 BaseType, SizeInBits, AlignInBits, 1520 OffsetInBits, Flags, Elements, RuntimeLang, 1521 VTableHolder, TemplateParams, Identifier); 1522 EXPECT_EQ(SizeInBits, N->getSizeInBits()); 1523 EXPECT_EQ(AlignInBits, N->getAlignInBits()); 1524 EXPECT_EQ(OffsetInBits, N->getOffsetInBits()); 1525 } 1526 1527 TEST_F(DICompositeTypeTest, replaceOperands) { 1528 unsigned Tag = dwarf::DW_TAG_structure_type; 1529 StringRef Name = "some name"; 1530 DIFile *File = getFile(); 1531 unsigned Line = 1; 1532 DIScope *Scope = getSubprogram(); 1533 DIType *BaseType = getCompositeType(); 1534 uint64_t SizeInBits = 2; 1535 uint32_t AlignInBits = 3; 1536 uint64_t OffsetInBits = 4; 1537 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1538 unsigned RuntimeLang = 6; 1539 StringRef Identifier = "some id"; 1540 1541 auto *N = DICompositeType::get( 1542 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, 1543 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier); 1544 1545 auto *Elements = MDTuple::getDistinct(Context, None); 1546 EXPECT_EQ(nullptr, N->getElements().get()); 1547 N->replaceElements(Elements); 1548 EXPECT_EQ(Elements, N->getElements().get()); 1549 N->replaceElements(nullptr); 1550 EXPECT_EQ(nullptr, N->getElements().get()); 1551 1552 DIType *VTableHolder = getCompositeType(); 1553 EXPECT_EQ(nullptr, N->getVTableHolder()); 1554 N->replaceVTableHolder(VTableHolder); 1555 EXPECT_EQ(VTableHolder, N->getVTableHolder()); 1556 // As an extension, the containing type can be anything. This is 1557 // used by Rust to associate vtables with their concrete type. 1558 DIType *BasicType = getBasicType("basic"); 1559 N->replaceVTableHolder(BasicType); 1560 EXPECT_EQ(BasicType, N->getVTableHolder()); 1561 N->replaceVTableHolder(nullptr); 1562 EXPECT_EQ(nullptr, N->getVTableHolder()); 1563 1564 auto *TemplateParams = MDTuple::getDistinct(Context, None); 1565 EXPECT_EQ(nullptr, N->getTemplateParams().get()); 1566 N->replaceTemplateParams(TemplateParams); 1567 EXPECT_EQ(TemplateParams, N->getTemplateParams().get()); 1568 N->replaceTemplateParams(nullptr); 1569 EXPECT_EQ(nullptr, N->getTemplateParams().get()); 1570 } 1571 1572 TEST_F(DICompositeTypeTest, variant_part) { 1573 unsigned Tag = dwarf::DW_TAG_variant_part; 1574 StringRef Name = "some name"; 1575 DIFile *File = getFile(); 1576 unsigned Line = 1; 1577 DIScope *Scope = getSubprogram(); 1578 DIType *BaseType = getCompositeType(); 1579 uint64_t SizeInBits = 2; 1580 uint32_t AlignInBits = 3; 1581 uint64_t OffsetInBits = 4; 1582 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5); 1583 unsigned RuntimeLang = 6; 1584 StringRef Identifier = "some id"; 1585 DIDerivedType *Discriminator = cast<DIDerivedType>(getDerivedType()); 1586 DIDerivedType *Discriminator2 = cast<DIDerivedType>(getDerivedType()); 1587 1588 EXPECT_NE(Discriminator, Discriminator2); 1589 1590 auto *N = DICompositeType::get( 1591 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, 1592 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier, 1593 Discriminator); 1594 1595 // Test the hashing. 1596 auto *Same = DICompositeType::get( 1597 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, 1598 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier, 1599 Discriminator); 1600 auto *Other = DICompositeType::get( 1601 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, 1602 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier, 1603 Discriminator2); 1604 auto *NoDisc = DICompositeType::get( 1605 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, 1606 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier, 1607 nullptr); 1608 1609 EXPECT_EQ(N, Same); 1610 EXPECT_NE(Same, Other); 1611 EXPECT_NE(Same, NoDisc); 1612 EXPECT_NE(Other, NoDisc); 1613 1614 EXPECT_EQ(N->getDiscriminator(), Discriminator); 1615 } 1616 1617 typedef MetadataTest DISubroutineTypeTest; 1618 1619 TEST_F(DISubroutineTypeTest, get) { 1620 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(1); 1621 DINode::DIFlags FlagsPOne = static_cast<DINode::DIFlags>(Flags + 1); 1622 MDTuple *TypeArray = getTuple(); 1623 1624 auto *N = DISubroutineType::get(Context, Flags, 0, TypeArray); 1625 EXPECT_EQ(dwarf::DW_TAG_subroutine_type, N->getTag()); 1626 EXPECT_EQ(Flags, N->getFlags()); 1627 EXPECT_EQ(TypeArray, N->getTypeArray().get()); 1628 EXPECT_EQ(N, DISubroutineType::get(Context, Flags, 0, TypeArray)); 1629 1630 EXPECT_NE(N, DISubroutineType::get(Context, FlagsPOne, 0, TypeArray)); 1631 EXPECT_NE(N, DISubroutineType::get(Context, Flags, 0, getTuple())); 1632 1633 // Test the hashing of calling conventions. 1634 auto *Fast = DISubroutineType::get( 1635 Context, Flags, dwarf::DW_CC_BORLAND_msfastcall, TypeArray); 1636 auto *Std = DISubroutineType::get(Context, Flags, 1637 dwarf::DW_CC_BORLAND_stdcall, TypeArray); 1638 EXPECT_EQ(Fast, 1639 DISubroutineType::get(Context, Flags, 1640 dwarf::DW_CC_BORLAND_msfastcall, TypeArray)); 1641 EXPECT_EQ(Std, DISubroutineType::get( 1642 Context, Flags, dwarf::DW_CC_BORLAND_stdcall, TypeArray)); 1643 1644 EXPECT_NE(N, Fast); 1645 EXPECT_NE(N, Std); 1646 EXPECT_NE(Fast, Std); 1647 1648 TempDISubroutineType Temp = N->clone(); 1649 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1650 1651 // Test always-empty operands. 1652 EXPECT_EQ(nullptr, N->getScope()); 1653 EXPECT_EQ(nullptr, N->getFile()); 1654 EXPECT_EQ("", N->getName()); 1655 } 1656 1657 typedef MetadataTest DIFileTest; 1658 1659 TEST_F(DIFileTest, get) { 1660 StringRef Filename = "file"; 1661 StringRef Directory = "dir"; 1662 DIFile::ChecksumKind CSKind = DIFile::ChecksumKind::CSK_MD5; 1663 StringRef ChecksumString = "000102030405060708090a0b0c0d0e0f"; 1664 DIFile::ChecksumInfo<StringRef> Checksum(CSKind, ChecksumString); 1665 StringRef Source = "source"; 1666 auto *N = DIFile::get(Context, Filename, Directory, Checksum, Source); 1667 1668 EXPECT_EQ(dwarf::DW_TAG_file_type, N->getTag()); 1669 EXPECT_EQ(Filename, N->getFilename()); 1670 EXPECT_EQ(Directory, N->getDirectory()); 1671 EXPECT_EQ(Checksum, N->getChecksum()); 1672 EXPECT_EQ(Source, N->getSource()); 1673 EXPECT_EQ(N, DIFile::get(Context, Filename, Directory, Checksum, Source)); 1674 1675 EXPECT_NE(N, DIFile::get(Context, "other", Directory, Checksum, Source)); 1676 EXPECT_NE(N, DIFile::get(Context, Filename, "other", Checksum, Source)); 1677 DIFile::ChecksumInfo<StringRef> OtherChecksum(DIFile::ChecksumKind::CSK_SHA1, ChecksumString); 1678 EXPECT_NE( 1679 N, DIFile::get(Context, Filename, Directory, OtherChecksum)); 1680 StringRef OtherSource = "other"; 1681 EXPECT_NE(N, DIFile::get(Context, Filename, Directory, Checksum, OtherSource)); 1682 EXPECT_NE(N, DIFile::get(Context, Filename, Directory, Checksum)); 1683 EXPECT_NE(N, DIFile::get(Context, Filename, Directory)); 1684 1685 TempDIFile Temp = N->clone(); 1686 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1687 } 1688 1689 TEST_F(DIFileTest, ScopeGetFile) { 1690 // Ensure that DIScope::getFile() returns itself. 1691 DIScope *N = DIFile::get(Context, "file", "dir"); 1692 EXPECT_EQ(N, N->getFile()); 1693 } 1694 1695 typedef MetadataTest DICompileUnitTest; 1696 1697 TEST_F(DICompileUnitTest, get) { 1698 unsigned SourceLanguage = 1; 1699 DIFile *File = getFile(); 1700 StringRef Producer = "some producer"; 1701 bool IsOptimized = false; 1702 StringRef Flags = "flag after flag"; 1703 unsigned RuntimeVersion = 2; 1704 StringRef SplitDebugFilename = "another/file"; 1705 auto EmissionKind = DICompileUnit::FullDebug; 1706 MDTuple *EnumTypes = getTuple(); 1707 MDTuple *RetainedTypes = getTuple(); 1708 MDTuple *GlobalVariables = getTuple(); 1709 MDTuple *ImportedEntities = getTuple(); 1710 uint64_t DWOId = 0x10000000c0ffee; 1711 MDTuple *Macros = getTuple(); 1712 StringRef SysRoot = "/"; 1713 StringRef SDK = "MacOSX.sdk"; 1714 auto *N = DICompileUnit::getDistinct( 1715 Context, SourceLanguage, File, Producer, IsOptimized, Flags, 1716 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes, 1717 RetainedTypes, GlobalVariables, ImportedEntities, Macros, DWOId, true, 1718 false, DICompileUnit::DebugNameTableKind::Default, false, SysRoot, SDK); 1719 1720 EXPECT_EQ(dwarf::DW_TAG_compile_unit, N->getTag()); 1721 EXPECT_EQ(SourceLanguage, N->getSourceLanguage()); 1722 EXPECT_EQ(File, N->getFile()); 1723 EXPECT_EQ(Producer, N->getProducer()); 1724 EXPECT_EQ(IsOptimized, N->isOptimized()); 1725 EXPECT_EQ(Flags, N->getFlags()); 1726 EXPECT_EQ(RuntimeVersion, N->getRuntimeVersion()); 1727 EXPECT_EQ(SplitDebugFilename, N->getSplitDebugFilename()); 1728 EXPECT_EQ(EmissionKind, N->getEmissionKind()); 1729 EXPECT_EQ(EnumTypes, N->getEnumTypes().get()); 1730 EXPECT_EQ(RetainedTypes, N->getRetainedTypes().get()); 1731 EXPECT_EQ(GlobalVariables, N->getGlobalVariables().get()); 1732 EXPECT_EQ(ImportedEntities, N->getImportedEntities().get()); 1733 EXPECT_EQ(Macros, N->getMacros().get()); 1734 EXPECT_EQ(DWOId, N->getDWOId()); 1735 EXPECT_EQ(SysRoot, N->getSysRoot()); 1736 EXPECT_EQ(SDK, N->getSDK()); 1737 1738 TempDICompileUnit Temp = N->clone(); 1739 EXPECT_EQ(dwarf::DW_TAG_compile_unit, Temp->getTag()); 1740 EXPECT_EQ(SourceLanguage, Temp->getSourceLanguage()); 1741 EXPECT_EQ(File, Temp->getFile()); 1742 EXPECT_EQ(Producer, Temp->getProducer()); 1743 EXPECT_EQ(IsOptimized, Temp->isOptimized()); 1744 EXPECT_EQ(Flags, Temp->getFlags()); 1745 EXPECT_EQ(RuntimeVersion, Temp->getRuntimeVersion()); 1746 EXPECT_EQ(SplitDebugFilename, Temp->getSplitDebugFilename()); 1747 EXPECT_EQ(EmissionKind, Temp->getEmissionKind()); 1748 EXPECT_EQ(EnumTypes, Temp->getEnumTypes().get()); 1749 EXPECT_EQ(RetainedTypes, Temp->getRetainedTypes().get()); 1750 EXPECT_EQ(GlobalVariables, Temp->getGlobalVariables().get()); 1751 EXPECT_EQ(ImportedEntities, Temp->getImportedEntities().get()); 1752 EXPECT_EQ(Macros, Temp->getMacros().get()); 1753 EXPECT_EQ(SysRoot, Temp->getSysRoot()); 1754 EXPECT_EQ(SDK, Temp->getSDK()); 1755 1756 auto *TempAddress = Temp.get(); 1757 auto *Clone = MDNode::replaceWithPermanent(std::move(Temp)); 1758 EXPECT_TRUE(Clone->isDistinct()); 1759 EXPECT_EQ(TempAddress, Clone); 1760 } 1761 1762 TEST_F(DICompileUnitTest, replaceArrays) { 1763 unsigned SourceLanguage = 1; 1764 DIFile *File = getFile(); 1765 StringRef Producer = "some producer"; 1766 bool IsOptimized = false; 1767 StringRef Flags = "flag after flag"; 1768 unsigned RuntimeVersion = 2; 1769 StringRef SplitDebugFilename = "another/file"; 1770 auto EmissionKind = DICompileUnit::FullDebug; 1771 MDTuple *EnumTypes = MDTuple::getDistinct(Context, None); 1772 MDTuple *RetainedTypes = MDTuple::getDistinct(Context, None); 1773 MDTuple *ImportedEntities = MDTuple::getDistinct(Context, None); 1774 uint64_t DWOId = 0xc0ffee; 1775 StringRef SysRoot = "/"; 1776 StringRef SDK = "MacOSX.sdk"; 1777 auto *N = DICompileUnit::getDistinct( 1778 Context, SourceLanguage, File, Producer, IsOptimized, Flags, 1779 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes, 1780 RetainedTypes, nullptr, ImportedEntities, nullptr, DWOId, true, false, 1781 DICompileUnit::DebugNameTableKind::Default, false, SysRoot, SDK); 1782 1783 auto *GlobalVariables = MDTuple::getDistinct(Context, None); 1784 EXPECT_EQ(nullptr, N->getGlobalVariables().get()); 1785 N->replaceGlobalVariables(GlobalVariables); 1786 EXPECT_EQ(GlobalVariables, N->getGlobalVariables().get()); 1787 N->replaceGlobalVariables(nullptr); 1788 EXPECT_EQ(nullptr, N->getGlobalVariables().get()); 1789 1790 auto *Macros = MDTuple::getDistinct(Context, None); 1791 EXPECT_EQ(nullptr, N->getMacros().get()); 1792 N->replaceMacros(Macros); 1793 EXPECT_EQ(Macros, N->getMacros().get()); 1794 N->replaceMacros(nullptr); 1795 EXPECT_EQ(nullptr, N->getMacros().get()); 1796 } 1797 1798 typedef MetadataTest DISubprogramTest; 1799 1800 TEST_F(DISubprogramTest, get) { 1801 DIScope *Scope = getCompositeType(); 1802 StringRef Name = "name"; 1803 StringRef LinkageName = "linkage"; 1804 DIFile *File = getFile(); 1805 unsigned Line = 2; 1806 DISubroutineType *Type = getSubroutineType(); 1807 bool IsLocalToUnit = false; 1808 bool IsDefinition = true; 1809 unsigned ScopeLine = 3; 1810 DIType *ContainingType = getCompositeType(); 1811 unsigned Virtuality = 2; 1812 unsigned VirtualIndex = 5; 1813 int ThisAdjustment = -3; 1814 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(6); 1815 bool IsOptimized = false; 1816 MDTuple *TemplateParams = getTuple(); 1817 DISubprogram *Declaration = getSubprogram(); 1818 MDTuple *RetainedNodes = getTuple(); 1819 MDTuple *ThrownTypes = getTuple(); 1820 DICompileUnit *Unit = getUnit(); 1821 DISubprogram::DISPFlags SPFlags = 1822 static_cast<DISubprogram::DISPFlags>(Virtuality); 1823 assert(!IsLocalToUnit && IsDefinition && !IsOptimized && 1824 "bools and SPFlags have to match"); 1825 SPFlags |= DISubprogram::SPFlagDefinition; 1826 1827 auto *N = DISubprogram::get( 1828 Context, Scope, Name, LinkageName, File, Line, Type, ScopeLine, 1829 ContainingType, VirtualIndex, ThisAdjustment, Flags, SPFlags, Unit, 1830 TemplateParams, Declaration, RetainedNodes, ThrownTypes); 1831 1832 EXPECT_EQ(dwarf::DW_TAG_subprogram, N->getTag()); 1833 EXPECT_EQ(Scope, N->getScope()); 1834 EXPECT_EQ(Name, N->getName()); 1835 EXPECT_EQ(LinkageName, N->getLinkageName()); 1836 EXPECT_EQ(File, N->getFile()); 1837 EXPECT_EQ(Line, N->getLine()); 1838 EXPECT_EQ(Type, N->getType()); 1839 EXPECT_EQ(IsLocalToUnit, N->isLocalToUnit()); 1840 EXPECT_EQ(IsDefinition, N->isDefinition()); 1841 EXPECT_EQ(ScopeLine, N->getScopeLine()); 1842 EXPECT_EQ(ContainingType, N->getContainingType()); 1843 EXPECT_EQ(Virtuality, N->getVirtuality()); 1844 EXPECT_EQ(VirtualIndex, N->getVirtualIndex()); 1845 EXPECT_EQ(ThisAdjustment, N->getThisAdjustment()); 1846 EXPECT_EQ(Flags, N->getFlags()); 1847 EXPECT_EQ(IsOptimized, N->isOptimized()); 1848 EXPECT_EQ(Unit, N->getUnit()); 1849 EXPECT_EQ(TemplateParams, N->getTemplateParams().get()); 1850 EXPECT_EQ(Declaration, N->getDeclaration()); 1851 EXPECT_EQ(RetainedNodes, N->getRetainedNodes().get()); 1852 EXPECT_EQ(ThrownTypes, N->getThrownTypes().get()); 1853 EXPECT_EQ(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1854 Type, ScopeLine, ContainingType, VirtualIndex, 1855 ThisAdjustment, Flags, SPFlags, Unit, 1856 TemplateParams, Declaration, RetainedNodes, 1857 ThrownTypes)); 1858 1859 EXPECT_NE(N, DISubprogram::get(Context, getCompositeType(), Name, LinkageName, 1860 File, Line, Type, ScopeLine, ContainingType, 1861 VirtualIndex, ThisAdjustment, Flags, SPFlags, 1862 Unit, TemplateParams, Declaration, 1863 RetainedNodes, ThrownTypes)); 1864 EXPECT_NE(N, DISubprogram::get(Context, Scope, "other", LinkageName, File, 1865 Line, Type, ScopeLine, ContainingType, 1866 VirtualIndex, ThisAdjustment, Flags, SPFlags, 1867 Unit, TemplateParams, Declaration, 1868 RetainedNodes, ThrownTypes)); 1869 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, "other", File, Line, 1870 Type, ScopeLine, ContainingType, VirtualIndex, 1871 ThisAdjustment, Flags, SPFlags, Unit, 1872 TemplateParams, Declaration, RetainedNodes, 1873 ThrownTypes)); 1874 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, getFile(), 1875 Line, Type, ScopeLine, ContainingType, 1876 VirtualIndex, ThisAdjustment, Flags, SPFlags, 1877 Unit, TemplateParams, Declaration, 1878 RetainedNodes, ThrownTypes)); 1879 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, 1880 Line + 1, Type, ScopeLine, ContainingType, 1881 VirtualIndex, ThisAdjustment, Flags, SPFlags, 1882 Unit, TemplateParams, Declaration, 1883 RetainedNodes, ThrownTypes)); 1884 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1885 getSubroutineType(), ScopeLine, ContainingType, 1886 VirtualIndex, ThisAdjustment, Flags, SPFlags, 1887 Unit, TemplateParams, Declaration, 1888 RetainedNodes, ThrownTypes)); 1889 EXPECT_NE(N, DISubprogram::get( 1890 Context, Scope, Name, LinkageName, File, Line, Type, 1891 ScopeLine, ContainingType, VirtualIndex, ThisAdjustment, 1892 Flags, SPFlags ^ DISubprogram::SPFlagLocalToUnit, Unit, 1893 TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1894 EXPECT_NE(N, DISubprogram::get( 1895 Context, Scope, Name, LinkageName, File, Line, Type, 1896 ScopeLine, ContainingType, VirtualIndex, ThisAdjustment, 1897 Flags, SPFlags ^ DISubprogram::SPFlagDefinition, Unit, 1898 TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1899 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1900 Type, ScopeLine + 1, ContainingType, 1901 VirtualIndex, ThisAdjustment, Flags, SPFlags, 1902 Unit, TemplateParams, Declaration, 1903 RetainedNodes, ThrownTypes)); 1904 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1905 Type, ScopeLine, getCompositeType(), 1906 VirtualIndex, ThisAdjustment, Flags, SPFlags, 1907 Unit, TemplateParams, Declaration, 1908 RetainedNodes, ThrownTypes)); 1909 EXPECT_NE(N, DISubprogram::get( 1910 Context, Scope, Name, LinkageName, File, Line, Type, 1911 ScopeLine, ContainingType, VirtualIndex, ThisAdjustment, 1912 Flags, SPFlags ^ DISubprogram::SPFlagVirtual, Unit, 1913 TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1914 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1915 Type, ScopeLine, ContainingType, 1916 VirtualIndex + 1, ThisAdjustment, Flags, 1917 SPFlags, Unit, TemplateParams, Declaration, 1918 RetainedNodes, ThrownTypes)); 1919 EXPECT_NE(N, DISubprogram::get( 1920 Context, Scope, Name, LinkageName, File, Line, Type, 1921 ScopeLine, ContainingType, VirtualIndex, ThisAdjustment, 1922 Flags, SPFlags ^ DISubprogram::SPFlagOptimized, Unit, 1923 TemplateParams, Declaration, RetainedNodes, ThrownTypes)); 1924 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1925 Type, ScopeLine, ContainingType, VirtualIndex, 1926 ThisAdjustment, Flags, SPFlags, nullptr, 1927 TemplateParams, Declaration, RetainedNodes, 1928 ThrownTypes)); 1929 EXPECT_NE(N, 1930 DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1931 Type, ScopeLine, ContainingType, VirtualIndex, 1932 ThisAdjustment, Flags, SPFlags, Unit, getTuple(), 1933 Declaration, RetainedNodes, ThrownTypes)); 1934 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1935 Type, ScopeLine, ContainingType, VirtualIndex, 1936 ThisAdjustment, Flags, SPFlags, Unit, 1937 TemplateParams, getSubprogram(), RetainedNodes, 1938 ThrownTypes)); 1939 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1940 Type, ScopeLine, ContainingType, VirtualIndex, 1941 ThisAdjustment, Flags, SPFlags, Unit, 1942 TemplateParams, Declaration, getTuple())); 1943 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line, 1944 Type, ScopeLine, ContainingType, VirtualIndex, 1945 ThisAdjustment, Flags, SPFlags, Unit, 1946 TemplateParams, Declaration, RetainedNodes, 1947 getTuple())); 1948 1949 TempDISubprogram Temp = N->clone(); 1950 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1951 } 1952 1953 typedef MetadataTest DILexicalBlockTest; 1954 1955 TEST_F(DILexicalBlockTest, get) { 1956 DILocalScope *Scope = getSubprogram(); 1957 DIFile *File = getFile(); 1958 unsigned Line = 5; 1959 unsigned Column = 8; 1960 1961 auto *N = DILexicalBlock::get(Context, Scope, File, Line, Column); 1962 1963 EXPECT_EQ(dwarf::DW_TAG_lexical_block, N->getTag()); 1964 EXPECT_EQ(Scope, N->getScope()); 1965 EXPECT_EQ(File, N->getFile()); 1966 EXPECT_EQ(Line, N->getLine()); 1967 EXPECT_EQ(Column, N->getColumn()); 1968 EXPECT_EQ(N, DILexicalBlock::get(Context, Scope, File, Line, Column)); 1969 1970 EXPECT_NE(N, 1971 DILexicalBlock::get(Context, getSubprogram(), File, Line, Column)); 1972 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, getFile(), Line, Column)); 1973 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, File, Line + 1, Column)); 1974 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, File, Line, Column + 1)); 1975 1976 TempDILexicalBlock Temp = N->clone(); 1977 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 1978 } 1979 1980 TEST_F(DILexicalBlockTest, Overflow) { 1981 DISubprogram *SP = getSubprogram(); 1982 DIFile *F = getFile(); 1983 { 1984 auto *LB = DILexicalBlock::get(Context, SP, F, 2, 7); 1985 EXPECT_EQ(2u, LB->getLine()); 1986 EXPECT_EQ(7u, LB->getColumn()); 1987 } 1988 unsigned U16 = 1u << 16; 1989 { 1990 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16 - 1); 1991 EXPECT_EQ(UINT32_MAX, LB->getLine()); 1992 EXPECT_EQ(U16 - 1, LB->getColumn()); 1993 } 1994 { 1995 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16); 1996 EXPECT_EQ(UINT32_MAX, LB->getLine()); 1997 EXPECT_EQ(0u, LB->getColumn()); 1998 } 1999 { 2000 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16 + 1); 2001 EXPECT_EQ(UINT32_MAX, LB->getLine()); 2002 EXPECT_EQ(0u, LB->getColumn()); 2003 } 2004 } 2005 2006 typedef MetadataTest DILexicalBlockFileTest; 2007 2008 TEST_F(DILexicalBlockFileTest, get) { 2009 DILocalScope *Scope = getSubprogram(); 2010 DIFile *File = getFile(); 2011 unsigned Discriminator = 5; 2012 2013 auto *N = DILexicalBlockFile::get(Context, Scope, File, Discriminator); 2014 2015 EXPECT_EQ(dwarf::DW_TAG_lexical_block, N->getTag()); 2016 EXPECT_EQ(Scope, N->getScope()); 2017 EXPECT_EQ(File, N->getFile()); 2018 EXPECT_EQ(Discriminator, N->getDiscriminator()); 2019 EXPECT_EQ(N, DILexicalBlockFile::get(Context, Scope, File, Discriminator)); 2020 2021 EXPECT_NE(N, DILexicalBlockFile::get(Context, getSubprogram(), File, 2022 Discriminator)); 2023 EXPECT_NE(N, 2024 DILexicalBlockFile::get(Context, Scope, getFile(), Discriminator)); 2025 EXPECT_NE(N, 2026 DILexicalBlockFile::get(Context, Scope, File, Discriminator + 1)); 2027 2028 TempDILexicalBlockFile Temp = N->clone(); 2029 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2030 } 2031 2032 typedef MetadataTest DINamespaceTest; 2033 2034 TEST_F(DINamespaceTest, get) { 2035 DIScope *Scope = getFile(); 2036 StringRef Name = "namespace"; 2037 bool ExportSymbols = true; 2038 2039 auto *N = DINamespace::get(Context, Scope, Name, ExportSymbols); 2040 2041 EXPECT_EQ(dwarf::DW_TAG_namespace, N->getTag()); 2042 EXPECT_EQ(Scope, N->getScope()); 2043 EXPECT_EQ(Name, N->getName()); 2044 EXPECT_EQ(N, DINamespace::get(Context, Scope, Name, ExportSymbols)); 2045 EXPECT_NE(N, DINamespace::get(Context, getFile(), Name, ExportSymbols)); 2046 EXPECT_NE(N, DINamespace::get(Context, Scope, "other", ExportSymbols)); 2047 EXPECT_NE(N, DINamespace::get(Context, Scope, Name, !ExportSymbols)); 2048 2049 TempDINamespace Temp = N->clone(); 2050 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2051 } 2052 2053 typedef MetadataTest DIModuleTest; 2054 2055 TEST_F(DIModuleTest, get) { 2056 DIScope *Scope = getFile(); 2057 StringRef Name = "module"; 2058 StringRef ConfigMacro = "-DNDEBUG"; 2059 StringRef Includes = "-I."; 2060 StringRef APINotes = "/tmp/m.apinotes"; 2061 2062 auto *N = DIModule::get(Context, Scope, Name, ConfigMacro, Includes, APINotes); 2063 2064 EXPECT_EQ(dwarf::DW_TAG_module, N->getTag()); 2065 EXPECT_EQ(Scope, N->getScope()); 2066 EXPECT_EQ(Name, N->getName()); 2067 EXPECT_EQ(ConfigMacro, N->getConfigurationMacros()); 2068 EXPECT_EQ(Includes, N->getIncludePath()); 2069 EXPECT_EQ(APINotes, N->getAPINotesFile()); 2070 EXPECT_EQ( 2071 N, DIModule::get(Context, Scope, Name, ConfigMacro, Includes, APINotes)); 2072 EXPECT_NE(N, DIModule::get(Context, getFile(), Name, ConfigMacro, Includes, 2073 APINotes)); 2074 EXPECT_NE(N, DIModule::get(Context, Scope, "other", ConfigMacro, Includes, 2075 APINotes)); 2076 EXPECT_NE(N, 2077 DIModule::get(Context, Scope, Name, "other", Includes, APINotes)); 2078 EXPECT_NE( 2079 N, DIModule::get(Context, Scope, Name, ConfigMacro, "other", APINotes)); 2080 EXPECT_NE( 2081 N, DIModule::get(Context, Scope, Name, ConfigMacro, Includes, "other")); 2082 2083 TempDIModule Temp = N->clone(); 2084 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2085 } 2086 2087 typedef MetadataTest DITemplateTypeParameterTest; 2088 2089 TEST_F(DITemplateTypeParameterTest, get) { 2090 StringRef Name = "template"; 2091 DIType *Type = getBasicType("basic"); 2092 bool defaulted = false; 2093 2094 auto *N = DITemplateTypeParameter::get(Context, Name, Type, defaulted); 2095 2096 EXPECT_EQ(dwarf::DW_TAG_template_type_parameter, N->getTag()); 2097 EXPECT_EQ(Name, N->getName()); 2098 EXPECT_EQ(Type, N->getType()); 2099 EXPECT_EQ(N, DITemplateTypeParameter::get(Context, Name, Type, defaulted)); 2100 2101 EXPECT_NE(N, DITemplateTypeParameter::get(Context, "other", Type, defaulted)); 2102 EXPECT_NE(N, DITemplateTypeParameter::get(Context, Name, 2103 getBasicType("other"), defaulted)); 2104 EXPECT_NE(N, DITemplateTypeParameter::get(Context, Name, Type, true)); 2105 2106 TempDITemplateTypeParameter Temp = N->clone(); 2107 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2108 } 2109 2110 typedef MetadataTest DITemplateValueParameterTest; 2111 2112 TEST_F(DITemplateValueParameterTest, get) { 2113 unsigned Tag = dwarf::DW_TAG_template_value_parameter; 2114 StringRef Name = "template"; 2115 DIType *Type = getBasicType("basic"); 2116 bool defaulted = false; 2117 Metadata *Value = getConstantAsMetadata(); 2118 2119 auto *N = 2120 DITemplateValueParameter::get(Context, Tag, Name, Type, defaulted, Value); 2121 EXPECT_EQ(Tag, N->getTag()); 2122 EXPECT_EQ(Name, N->getName()); 2123 EXPECT_EQ(Type, N->getType()); 2124 EXPECT_EQ(Value, N->getValue()); 2125 EXPECT_EQ(N, DITemplateValueParameter::get(Context, Tag, Name, Type, 2126 defaulted, Value)); 2127 2128 EXPECT_NE(N, DITemplateValueParameter::get( 2129 Context, dwarf::DW_TAG_GNU_template_template_param, Name, 2130 Type, defaulted, Value)); 2131 EXPECT_NE(N, DITemplateValueParameter::get(Context, Tag, "other", Type, 2132 defaulted, Value)); 2133 EXPECT_NE(N, DITemplateValueParameter::get(Context, Tag, Name, 2134 getBasicType("other"), defaulted, 2135 Value)); 2136 EXPECT_NE(N, 2137 DITemplateValueParameter::get(Context, Tag, Name, Type, defaulted, 2138 getConstantAsMetadata())); 2139 EXPECT_NE( 2140 N, DITemplateValueParameter::get(Context, Tag, Name, Type, true, Value)); 2141 2142 TempDITemplateValueParameter Temp = N->clone(); 2143 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2144 } 2145 2146 typedef MetadataTest DIGlobalVariableTest; 2147 2148 TEST_F(DIGlobalVariableTest, get) { 2149 DIScope *Scope = getSubprogram(); 2150 StringRef Name = "name"; 2151 StringRef LinkageName = "linkage"; 2152 DIFile *File = getFile(); 2153 unsigned Line = 5; 2154 DIType *Type = getDerivedType(); 2155 bool IsLocalToUnit = false; 2156 bool IsDefinition = true; 2157 MDTuple *templateParams = getTuple(); 2158 DIDerivedType *StaticDataMemberDeclaration = 2159 cast<DIDerivedType>(getDerivedType()); 2160 2161 uint32_t AlignInBits = 8; 2162 2163 auto *N = DIGlobalVariable::get( 2164 Context, Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, 2165 IsDefinition, StaticDataMemberDeclaration, templateParams, AlignInBits); 2166 2167 EXPECT_EQ(dwarf::DW_TAG_variable, N->getTag()); 2168 EXPECT_EQ(Scope, N->getScope()); 2169 EXPECT_EQ(Name, N->getName()); 2170 EXPECT_EQ(LinkageName, N->getLinkageName()); 2171 EXPECT_EQ(File, N->getFile()); 2172 EXPECT_EQ(Line, N->getLine()); 2173 EXPECT_EQ(Type, N->getType()); 2174 EXPECT_EQ(IsLocalToUnit, N->isLocalToUnit()); 2175 EXPECT_EQ(IsDefinition, N->isDefinition()); 2176 EXPECT_EQ(StaticDataMemberDeclaration, N->getStaticDataMemberDeclaration()); 2177 EXPECT_EQ(templateParams, N->getTemplateParams()); 2178 EXPECT_EQ(AlignInBits, N->getAlignInBits()); 2179 EXPECT_EQ(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 2180 Line, Type, IsLocalToUnit, IsDefinition, 2181 StaticDataMemberDeclaration, 2182 templateParams, AlignInBits)); 2183 2184 EXPECT_NE(N, DIGlobalVariable::get( 2185 Context, getSubprogram(), Name, LinkageName, File, Line, 2186 Type, IsLocalToUnit, IsDefinition, 2187 StaticDataMemberDeclaration, templateParams, AlignInBits)); 2188 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, "other", LinkageName, File, 2189 Line, Type, IsLocalToUnit, IsDefinition, 2190 StaticDataMemberDeclaration, 2191 templateParams, AlignInBits)); 2192 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, "other", File, Line, 2193 Type, IsLocalToUnit, IsDefinition, 2194 StaticDataMemberDeclaration, 2195 templateParams, AlignInBits)); 2196 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, 2197 getFile(), Line, Type, IsLocalToUnit, 2198 IsDefinition, StaticDataMemberDeclaration, 2199 templateParams, AlignInBits)); 2200 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 2201 Line + 1, Type, IsLocalToUnit, 2202 IsDefinition, StaticDataMemberDeclaration, 2203 templateParams, AlignInBits)); 2204 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 2205 Line, getDerivedType(), IsLocalToUnit, 2206 IsDefinition, StaticDataMemberDeclaration, 2207 templateParams, AlignInBits)); 2208 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 2209 Line, Type, !IsLocalToUnit, IsDefinition, 2210 StaticDataMemberDeclaration, 2211 templateParams, AlignInBits)); 2212 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 2213 Line, Type, IsLocalToUnit, !IsDefinition, 2214 StaticDataMemberDeclaration, 2215 templateParams, AlignInBits)); 2216 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 2217 Line, Type, IsLocalToUnit, IsDefinition, 2218 cast<DIDerivedType>(getDerivedType()), 2219 templateParams, AlignInBits)); 2220 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 2221 Line, Type, IsLocalToUnit, IsDefinition, 2222 StaticDataMemberDeclaration, nullptr, 2223 AlignInBits)); 2224 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, 2225 Line, Type, IsLocalToUnit, IsDefinition, 2226 StaticDataMemberDeclaration, 2227 templateParams, (AlignInBits << 1))); 2228 2229 TempDIGlobalVariable Temp = N->clone(); 2230 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2231 } 2232 2233 typedef MetadataTest DIGlobalVariableExpressionTest; 2234 2235 TEST_F(DIGlobalVariableExpressionTest, get) { 2236 DIScope *Scope = getSubprogram(); 2237 StringRef Name = "name"; 2238 StringRef LinkageName = "linkage"; 2239 DIFile *File = getFile(); 2240 unsigned Line = 5; 2241 DIType *Type = getDerivedType(); 2242 bool IsLocalToUnit = false; 2243 bool IsDefinition = true; 2244 MDTuple *templateParams = getTuple(); 2245 auto *Expr = DIExpression::get(Context, {1, 2}); 2246 auto *Expr2 = DIExpression::get(Context, {1, 2, 3}); 2247 DIDerivedType *StaticDataMemberDeclaration = 2248 cast<DIDerivedType>(getDerivedType()); 2249 uint32_t AlignInBits = 8; 2250 2251 auto *Var = DIGlobalVariable::get( 2252 Context, Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, 2253 IsDefinition, StaticDataMemberDeclaration, templateParams, AlignInBits); 2254 auto *Var2 = DIGlobalVariable::get( 2255 Context, Scope, "other", LinkageName, File, Line, Type, IsLocalToUnit, 2256 IsDefinition, StaticDataMemberDeclaration, templateParams, AlignInBits); 2257 auto *N = DIGlobalVariableExpression::get(Context, Var, Expr); 2258 2259 EXPECT_EQ(Var, N->getVariable()); 2260 EXPECT_EQ(Expr, N->getExpression()); 2261 EXPECT_EQ(N, DIGlobalVariableExpression::get(Context, Var, Expr)); 2262 EXPECT_NE(N, DIGlobalVariableExpression::get(Context, Var2, Expr)); 2263 EXPECT_NE(N, DIGlobalVariableExpression::get(Context, Var, Expr2)); 2264 2265 TempDIGlobalVariableExpression Temp = N->clone(); 2266 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2267 } 2268 2269 typedef MetadataTest DILocalVariableTest; 2270 2271 TEST_F(DILocalVariableTest, get) { 2272 DILocalScope *Scope = getSubprogram(); 2273 StringRef Name = "name"; 2274 DIFile *File = getFile(); 2275 unsigned Line = 5; 2276 DIType *Type = getDerivedType(); 2277 unsigned Arg = 6; 2278 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7); 2279 uint32_t AlignInBits = 8; 2280 2281 auto *N = 2282 DILocalVariable::get(Context, Scope, Name, File, Line, Type, Arg, Flags, 2283 AlignInBits); 2284 EXPECT_TRUE(N->isParameter()); 2285 EXPECT_EQ(Scope, N->getScope()); 2286 EXPECT_EQ(Name, N->getName()); 2287 EXPECT_EQ(File, N->getFile()); 2288 EXPECT_EQ(Line, N->getLine()); 2289 EXPECT_EQ(Type, N->getType()); 2290 EXPECT_EQ(Arg, N->getArg()); 2291 EXPECT_EQ(Flags, N->getFlags()); 2292 EXPECT_EQ(AlignInBits, N->getAlignInBits()); 2293 EXPECT_EQ(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type, Arg, 2294 Flags, AlignInBits)); 2295 2296 EXPECT_FALSE( 2297 DILocalVariable::get(Context, Scope, Name, File, Line, Type, 0, Flags, 2298 AlignInBits)->isParameter()); 2299 EXPECT_NE(N, DILocalVariable::get(Context, getSubprogram(), Name, File, Line, 2300 Type, Arg, Flags, AlignInBits)); 2301 EXPECT_NE(N, DILocalVariable::get(Context, Scope, "other", File, Line, Type, 2302 Arg, Flags, AlignInBits)); 2303 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, getFile(), Line, Type, 2304 Arg, Flags, AlignInBits)); 2305 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line + 1, Type, 2306 Arg, Flags, AlignInBits)); 2307 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line, 2308 getDerivedType(), Arg, Flags, AlignInBits)); 2309 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type, 2310 Arg + 1, Flags, AlignInBits)); 2311 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type, 2312 Arg, Flags, (AlignInBits << 1))); 2313 2314 TempDILocalVariable Temp = N->clone(); 2315 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2316 } 2317 2318 TEST_F(DILocalVariableTest, getArg256) { 2319 EXPECT_EQ(255u, DILocalVariable::get(Context, getSubprogram(), "", getFile(), 2320 0, nullptr, 255, DINode::FlagZero, 0) 2321 ->getArg()); 2322 EXPECT_EQ(256u, DILocalVariable::get(Context, getSubprogram(), "", getFile(), 2323 0, nullptr, 256, DINode::FlagZero, 0) 2324 ->getArg()); 2325 EXPECT_EQ(257u, DILocalVariable::get(Context, getSubprogram(), "", getFile(), 2326 0, nullptr, 257, DINode::FlagZero, 0) 2327 ->getArg()); 2328 unsigned Max = UINT16_MAX; 2329 EXPECT_EQ(Max, DILocalVariable::get(Context, getSubprogram(), "", getFile(), 2330 0, nullptr, Max, DINode::FlagZero, 0) 2331 ->getArg()); 2332 } 2333 2334 typedef MetadataTest DIExpressionTest; 2335 2336 TEST_F(DIExpressionTest, get) { 2337 uint64_t Elements[] = {2, 6, 9, 78, 0}; 2338 auto *N = DIExpression::get(Context, Elements); 2339 EXPECT_EQ(makeArrayRef(Elements), N->getElements()); 2340 EXPECT_EQ(N, DIExpression::get(Context, Elements)); 2341 2342 EXPECT_EQ(5u, N->getNumElements()); 2343 EXPECT_EQ(2u, N->getElement(0)); 2344 EXPECT_EQ(6u, N->getElement(1)); 2345 EXPECT_EQ(9u, N->getElement(2)); 2346 EXPECT_EQ(78u, N->getElement(3)); 2347 EXPECT_EQ(0u, N->getElement(4)); 2348 2349 TempDIExpression Temp = N->clone(); 2350 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2351 2352 // Test DIExpression::prepend(). 2353 uint64_t Elts0[] = {dwarf::DW_OP_LLVM_fragment, 0, 32}; 2354 auto *N0 = DIExpression::get(Context, Elts0); 2355 uint8_t DIExprFlags = DIExpression::ApplyOffset; 2356 DIExprFlags |= DIExpression::DerefBefore; 2357 DIExprFlags |= DIExpression::DerefAfter; 2358 DIExprFlags |= DIExpression::StackValue; 2359 auto *N0WithPrependedOps = DIExpression::prepend(N0, DIExprFlags, 64); 2360 uint64_t Elts1[] = {dwarf::DW_OP_deref, 2361 dwarf::DW_OP_plus_uconst, 64, 2362 dwarf::DW_OP_deref, 2363 dwarf::DW_OP_stack_value, 2364 dwarf::DW_OP_LLVM_fragment, 0, 32}; 2365 auto *N1 = DIExpression::get(Context, Elts1); 2366 EXPECT_EQ(N0WithPrependedOps, N1); 2367 2368 // Test DIExpression::append(). 2369 uint64_t Elts2[] = {dwarf::DW_OP_deref, dwarf::DW_OP_plus_uconst, 64, 2370 dwarf::DW_OP_deref, dwarf::DW_OP_stack_value}; 2371 auto *N2 = DIExpression::append(N0, Elts2); 2372 EXPECT_EQ(N0WithPrependedOps, N2); 2373 } 2374 2375 TEST_F(DIExpressionTest, isValid) { 2376 #define EXPECT_VALID(...) \ 2377 do { \ 2378 uint64_t Elements[] = {__VA_ARGS__}; \ 2379 EXPECT_TRUE(DIExpression::get(Context, Elements)->isValid()); \ 2380 } while (false) 2381 #define EXPECT_INVALID(...) \ 2382 do { \ 2383 uint64_t Elements[] = {__VA_ARGS__}; \ 2384 EXPECT_FALSE(DIExpression::get(Context, Elements)->isValid()); \ 2385 } while (false) 2386 2387 // Empty expression should be valid. 2388 EXPECT_TRUE(DIExpression::get(Context, None)); 2389 2390 // Valid constructions. 2391 EXPECT_VALID(dwarf::DW_OP_plus_uconst, 6); 2392 EXPECT_VALID(dwarf::DW_OP_constu, 6, dwarf::DW_OP_plus); 2393 EXPECT_VALID(dwarf::DW_OP_deref); 2394 EXPECT_VALID(dwarf::DW_OP_LLVM_fragment, 3, 7); 2395 EXPECT_VALID(dwarf::DW_OP_plus_uconst, 6, dwarf::DW_OP_deref); 2396 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_plus_uconst, 6); 2397 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_LLVM_fragment, 3, 7); 2398 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_plus_uconst, 6, 2399 dwarf::DW_OP_LLVM_fragment, 3, 7); 2400 2401 // Invalid constructions. 2402 EXPECT_INVALID(~0u); 2403 EXPECT_INVALID(dwarf::DW_OP_plus, 0); 2404 EXPECT_INVALID(dwarf::DW_OP_plus_uconst); 2405 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment); 2406 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment, 3); 2407 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment, 3, 7, dwarf::DW_OP_plus_uconst, 3); 2408 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment, 3, 7, dwarf::DW_OP_deref); 2409 2410 #undef EXPECT_VALID 2411 #undef EXPECT_INVALID 2412 } 2413 2414 TEST_F(DIExpressionTest, createFragmentExpression) { 2415 #define EXPECT_VALID_FRAGMENT(Offset, Size, ...) \ 2416 do { \ 2417 uint64_t Elements[] = {__VA_ARGS__}; \ 2418 DIExpression* Expression = DIExpression::get(Context, Elements); \ 2419 EXPECT_TRUE(DIExpression::createFragmentExpression( \ 2420 Expression, Offset, Size).hasValue()); \ 2421 } while (false) 2422 #define EXPECT_INVALID_FRAGMENT(Offset, Size, ...) \ 2423 do { \ 2424 uint64_t Elements[] = {__VA_ARGS__}; \ 2425 DIExpression* Expression = DIExpression::get(Context, Elements); \ 2426 EXPECT_FALSE(DIExpression::createFragmentExpression( \ 2427 Expression, Offset, Size).hasValue()); \ 2428 } while (false) 2429 2430 // createFragmentExpression adds correct ops. 2431 Optional<DIExpression*> R = DIExpression::createFragmentExpression( 2432 DIExpression::get(Context, {}), 0, 32); 2433 EXPECT_EQ(R.hasValue(), true); 2434 EXPECT_EQ(3u, (*R)->getNumElements()); 2435 EXPECT_EQ(dwarf::DW_OP_LLVM_fragment, (*R)->getElement(0)); 2436 EXPECT_EQ(0u, (*R)->getElement(1)); 2437 EXPECT_EQ(32u, (*R)->getElement(2)); 2438 2439 // Valid fragment expressions. 2440 EXPECT_VALID_FRAGMENT(0, 32, {}); 2441 EXPECT_VALID_FRAGMENT(0, 32, dwarf::DW_OP_deref); 2442 EXPECT_VALID_FRAGMENT(0, 32, dwarf::DW_OP_LLVM_fragment, 0, 32); 2443 EXPECT_VALID_FRAGMENT(16, 16, dwarf::DW_OP_LLVM_fragment, 0, 32); 2444 2445 // Invalid fragment expressions (incompatible ops). 2446 EXPECT_INVALID_FRAGMENT(0, 32, dwarf::DW_OP_constu, 6, dwarf::DW_OP_plus); 2447 EXPECT_INVALID_FRAGMENT(0, 32, dwarf::DW_OP_constu, 14, dwarf::DW_OP_minus); 2448 EXPECT_INVALID_FRAGMENT(0, 32, dwarf::DW_OP_constu, 16, dwarf::DW_OP_shr); 2449 EXPECT_INVALID_FRAGMENT(0, 32, dwarf::DW_OP_constu, 16, dwarf::DW_OP_shl); 2450 EXPECT_INVALID_FRAGMENT(0, 32, dwarf::DW_OP_constu, 16, dwarf::DW_OP_shra); 2451 EXPECT_INVALID_FRAGMENT(0, 32, dwarf::DW_OP_plus_uconst, 6); 2452 2453 #undef EXPECT_VALID_FRAGMENT 2454 #undef EXPECT_INVALID_FRAGMENT 2455 } 2456 2457 typedef MetadataTest DIObjCPropertyTest; 2458 2459 TEST_F(DIObjCPropertyTest, get) { 2460 StringRef Name = "name"; 2461 DIFile *File = getFile(); 2462 unsigned Line = 5; 2463 StringRef GetterName = "getter"; 2464 StringRef SetterName = "setter"; 2465 unsigned Attributes = 7; 2466 DIType *Type = getBasicType("basic"); 2467 2468 auto *N = DIObjCProperty::get(Context, Name, File, Line, GetterName, 2469 SetterName, Attributes, Type); 2470 2471 EXPECT_EQ(dwarf::DW_TAG_APPLE_property, N->getTag()); 2472 EXPECT_EQ(Name, N->getName()); 2473 EXPECT_EQ(File, N->getFile()); 2474 EXPECT_EQ(Line, N->getLine()); 2475 EXPECT_EQ(GetterName, N->getGetterName()); 2476 EXPECT_EQ(SetterName, N->getSetterName()); 2477 EXPECT_EQ(Attributes, N->getAttributes()); 2478 EXPECT_EQ(Type, N->getType()); 2479 EXPECT_EQ(N, DIObjCProperty::get(Context, Name, File, Line, GetterName, 2480 SetterName, Attributes, Type)); 2481 2482 EXPECT_NE(N, DIObjCProperty::get(Context, "other", File, Line, GetterName, 2483 SetterName, Attributes, Type)); 2484 EXPECT_NE(N, DIObjCProperty::get(Context, Name, getFile(), Line, GetterName, 2485 SetterName, Attributes, Type)); 2486 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line + 1, GetterName, 2487 SetterName, Attributes, Type)); 2488 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, "other", 2489 SetterName, Attributes, Type)); 2490 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName, 2491 "other", Attributes, Type)); 2492 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName, 2493 SetterName, Attributes + 1, Type)); 2494 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName, 2495 SetterName, Attributes, 2496 getBasicType("other"))); 2497 2498 TempDIObjCProperty Temp = N->clone(); 2499 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2500 } 2501 2502 typedef MetadataTest DIImportedEntityTest; 2503 2504 TEST_F(DIImportedEntityTest, get) { 2505 unsigned Tag = dwarf::DW_TAG_imported_module; 2506 DIScope *Scope = getSubprogram(); 2507 DINode *Entity = getCompositeType(); 2508 DIFile *File = getFile(); 2509 unsigned Line = 5; 2510 StringRef Name = "name"; 2511 2512 auto *N = 2513 DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line, Name); 2514 2515 EXPECT_EQ(Tag, N->getTag()); 2516 EXPECT_EQ(Scope, N->getScope()); 2517 EXPECT_EQ(Entity, N->getEntity()); 2518 EXPECT_EQ(File, N->getFile()); 2519 EXPECT_EQ(Line, N->getLine()); 2520 EXPECT_EQ(Name, N->getName()); 2521 EXPECT_EQ( 2522 N, DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line, Name)); 2523 2524 EXPECT_NE(N, 2525 DIImportedEntity::get(Context, dwarf::DW_TAG_imported_declaration, 2526 Scope, Entity, File, Line, Name)); 2527 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, getSubprogram(), Entity, 2528 File, Line, Name)); 2529 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, getCompositeType(), 2530 File, Line, Name)); 2531 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, Entity, nullptr, Line, 2532 Name)); 2533 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, Entity, File, 2534 Line + 1, Name)); 2535 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line, 2536 "other")); 2537 2538 TempDIImportedEntity Temp = N->clone(); 2539 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp))); 2540 } 2541 2542 typedef MetadataTest MetadataAsValueTest; 2543 2544 TEST_F(MetadataAsValueTest, MDNode) { 2545 MDNode *N = MDNode::get(Context, None); 2546 auto *V = MetadataAsValue::get(Context, N); 2547 EXPECT_TRUE(V->getType()->isMetadataTy()); 2548 EXPECT_EQ(N, V->getMetadata()); 2549 2550 auto *V2 = MetadataAsValue::get(Context, N); 2551 EXPECT_EQ(V, V2); 2552 } 2553 2554 TEST_F(MetadataAsValueTest, MDNodeMDNode) { 2555 MDNode *N = MDNode::get(Context, None); 2556 Metadata *Ops[] = {N}; 2557 MDNode *N2 = MDNode::get(Context, Ops); 2558 auto *V = MetadataAsValue::get(Context, N2); 2559 EXPECT_TRUE(V->getType()->isMetadataTy()); 2560 EXPECT_EQ(N2, V->getMetadata()); 2561 2562 auto *V2 = MetadataAsValue::get(Context, N2); 2563 EXPECT_EQ(V, V2); 2564 2565 auto *V3 = MetadataAsValue::get(Context, N); 2566 EXPECT_TRUE(V3->getType()->isMetadataTy()); 2567 EXPECT_NE(V, V3); 2568 EXPECT_EQ(N, V3->getMetadata()); 2569 } 2570 2571 TEST_F(MetadataAsValueTest, MDNodeConstant) { 2572 auto *C = ConstantInt::getTrue(Context); 2573 auto *MD = ConstantAsMetadata::get(C); 2574 Metadata *Ops[] = {MD}; 2575 auto *N = MDNode::get(Context, Ops); 2576 2577 auto *V = MetadataAsValue::get(Context, MD); 2578 EXPECT_TRUE(V->getType()->isMetadataTy()); 2579 EXPECT_EQ(MD, V->getMetadata()); 2580 2581 auto *V2 = MetadataAsValue::get(Context, N); 2582 EXPECT_EQ(MD, V2->getMetadata()); 2583 EXPECT_EQ(V, V2); 2584 } 2585 2586 typedef MetadataTest ValueAsMetadataTest; 2587 2588 TEST_F(ValueAsMetadataTest, UpdatesOnRAUW) { 2589 Type *Ty = Type::getInt1PtrTy(Context); 2590 std::unique_ptr<GlobalVariable> GV0( 2591 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2592 auto *MD = ValueAsMetadata::get(GV0.get()); 2593 EXPECT_TRUE(MD->getValue() == GV0.get()); 2594 ASSERT_TRUE(GV0->use_empty()); 2595 2596 std::unique_ptr<GlobalVariable> GV1( 2597 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2598 GV0->replaceAllUsesWith(GV1.get()); 2599 EXPECT_TRUE(MD->getValue() == GV1.get()); 2600 } 2601 2602 TEST_F(ValueAsMetadataTest, TempTempReplacement) { 2603 // Create a constant. 2604 ConstantAsMetadata *CI = 2605 ConstantAsMetadata::get(ConstantInt::get(Context, APInt(8, 0))); 2606 2607 auto Temp1 = MDTuple::getTemporary(Context, None); 2608 auto Temp2 = MDTuple::getTemporary(Context, {CI}); 2609 auto *N = MDTuple::get(Context, {Temp1.get()}); 2610 2611 // Test replacing a temporary node with another temporary node. 2612 Temp1->replaceAllUsesWith(Temp2.get()); 2613 EXPECT_EQ(N->getOperand(0), Temp2.get()); 2614 2615 // Clean up Temp2 for teardown. 2616 Temp2->replaceAllUsesWith(nullptr); 2617 } 2618 2619 TEST_F(ValueAsMetadataTest, CollidingDoubleUpdates) { 2620 // Create a constant. 2621 ConstantAsMetadata *CI = 2622 ConstantAsMetadata::get(ConstantInt::get(Context, APInt(8, 0))); 2623 2624 // Create a temporary to prevent nodes from resolving. 2625 auto Temp = MDTuple::getTemporary(Context, None); 2626 2627 // When the first operand of N1 gets reset to nullptr, it'll collide with N2. 2628 Metadata *Ops1[] = {CI, CI, Temp.get()}; 2629 Metadata *Ops2[] = {nullptr, CI, Temp.get()}; 2630 2631 auto *N1 = MDTuple::get(Context, Ops1); 2632 auto *N2 = MDTuple::get(Context, Ops2); 2633 ASSERT_NE(N1, N2); 2634 2635 // Tell metadata that the constant is getting deleted. 2636 // 2637 // After this, N1 will be invalid, so don't touch it. 2638 ValueAsMetadata::handleDeletion(CI->getValue()); 2639 EXPECT_EQ(nullptr, N2->getOperand(0)); 2640 EXPECT_EQ(nullptr, N2->getOperand(1)); 2641 EXPECT_EQ(Temp.get(), N2->getOperand(2)); 2642 2643 // Clean up Temp for teardown. 2644 Temp->replaceAllUsesWith(nullptr); 2645 } 2646 2647 typedef MetadataTest TrackingMDRefTest; 2648 2649 TEST_F(TrackingMDRefTest, UpdatesOnRAUW) { 2650 Type *Ty = Type::getInt1PtrTy(Context); 2651 std::unique_ptr<GlobalVariable> GV0( 2652 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2653 TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV0.get())); 2654 EXPECT_TRUE(MD->getValue() == GV0.get()); 2655 ASSERT_TRUE(GV0->use_empty()); 2656 2657 std::unique_ptr<GlobalVariable> GV1( 2658 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2659 GV0->replaceAllUsesWith(GV1.get()); 2660 EXPECT_TRUE(MD->getValue() == GV1.get()); 2661 2662 // Reset it, so we don't inadvertently test deletion. 2663 MD.reset(); 2664 } 2665 2666 TEST_F(TrackingMDRefTest, UpdatesOnDeletion) { 2667 Type *Ty = Type::getInt1PtrTy(Context); 2668 std::unique_ptr<GlobalVariable> GV( 2669 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage)); 2670 TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV.get())); 2671 EXPECT_TRUE(MD->getValue() == GV.get()); 2672 ASSERT_TRUE(GV->use_empty()); 2673 2674 GV.reset(); 2675 EXPECT_TRUE(!MD); 2676 } 2677 2678 TEST(NamedMDNodeTest, Search) { 2679 LLVMContext Context; 2680 ConstantAsMetadata *C = 2681 ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 1)); 2682 ConstantAsMetadata *C2 = 2683 ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 2)); 2684 2685 Metadata *const V = C; 2686 Metadata *const V2 = C2; 2687 MDNode *n = MDNode::get(Context, V); 2688 MDNode *n2 = MDNode::get(Context, V2); 2689 2690 Module M("MyModule", Context); 2691 const char *Name = "llvm.NMD1"; 2692 NamedMDNode *NMD = M.getOrInsertNamedMetadata(Name); 2693 NMD->addOperand(n); 2694 NMD->addOperand(n2); 2695 2696 std::string Str; 2697 raw_string_ostream oss(Str); 2698 NMD->print(oss); 2699 EXPECT_STREQ("!llvm.NMD1 = !{!0, !1}\n", 2700 oss.str().c_str()); 2701 } 2702 2703 typedef MetadataTest FunctionAttachmentTest; 2704 TEST_F(FunctionAttachmentTest, setMetadata) { 2705 Function *F = getFunction("foo"); 2706 ASSERT_FALSE(F->hasMetadata()); 2707 EXPECT_EQ(nullptr, F->getMetadata(LLVMContext::MD_dbg)); 2708 EXPECT_EQ(nullptr, F->getMetadata("dbg")); 2709 EXPECT_EQ(nullptr, F->getMetadata("other")); 2710 2711 DISubprogram *SP1 = getSubprogram(); 2712 DISubprogram *SP2 = getSubprogram(); 2713 ASSERT_NE(SP1, SP2); 2714 2715 F->setMetadata("dbg", SP1); 2716 EXPECT_TRUE(F->hasMetadata()); 2717 EXPECT_EQ(SP1, F->getMetadata(LLVMContext::MD_dbg)); 2718 EXPECT_EQ(SP1, F->getMetadata("dbg")); 2719 EXPECT_EQ(nullptr, F->getMetadata("other")); 2720 2721 F->setMetadata(LLVMContext::MD_dbg, SP2); 2722 EXPECT_TRUE(F->hasMetadata()); 2723 EXPECT_EQ(SP2, F->getMetadata(LLVMContext::MD_dbg)); 2724 EXPECT_EQ(SP2, F->getMetadata("dbg")); 2725 EXPECT_EQ(nullptr, F->getMetadata("other")); 2726 2727 F->setMetadata("dbg", nullptr); 2728 EXPECT_FALSE(F->hasMetadata()); 2729 EXPECT_EQ(nullptr, F->getMetadata(LLVMContext::MD_dbg)); 2730 EXPECT_EQ(nullptr, F->getMetadata("dbg")); 2731 EXPECT_EQ(nullptr, F->getMetadata("other")); 2732 2733 MDTuple *T1 = getTuple(); 2734 MDTuple *T2 = getTuple(); 2735 ASSERT_NE(T1, T2); 2736 2737 F->setMetadata("other1", T1); 2738 F->setMetadata("other2", T2); 2739 EXPECT_TRUE(F->hasMetadata()); 2740 EXPECT_EQ(T1, F->getMetadata("other1")); 2741 EXPECT_EQ(T2, F->getMetadata("other2")); 2742 EXPECT_EQ(nullptr, F->getMetadata("dbg")); 2743 2744 F->setMetadata("other1", T2); 2745 F->setMetadata("other2", T1); 2746 EXPECT_EQ(T2, F->getMetadata("other1")); 2747 EXPECT_EQ(T1, F->getMetadata("other2")); 2748 2749 F->setMetadata("other1", nullptr); 2750 F->setMetadata("other2", nullptr); 2751 EXPECT_FALSE(F->hasMetadata()); 2752 EXPECT_EQ(nullptr, F->getMetadata("other1")); 2753 EXPECT_EQ(nullptr, F->getMetadata("other2")); 2754 } 2755 2756 TEST_F(FunctionAttachmentTest, getAll) { 2757 Function *F = getFunction("foo"); 2758 2759 MDTuple *T1 = getTuple(); 2760 MDTuple *T2 = getTuple(); 2761 MDTuple *P = getTuple(); 2762 DISubprogram *SP = getSubprogram(); 2763 2764 F->setMetadata("other1", T2); 2765 F->setMetadata(LLVMContext::MD_dbg, SP); 2766 F->setMetadata("other2", T1); 2767 F->setMetadata(LLVMContext::MD_prof, P); 2768 F->setMetadata("other2", T2); 2769 F->setMetadata("other1", T1); 2770 2771 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs; 2772 F->getAllMetadata(MDs); 2773 ASSERT_EQ(4u, MDs.size()); 2774 EXPECT_EQ(LLVMContext::MD_dbg, MDs[0].first); 2775 EXPECT_EQ(LLVMContext::MD_prof, MDs[1].first); 2776 EXPECT_EQ(Context.getMDKindID("other1"), MDs[2].first); 2777 EXPECT_EQ(Context.getMDKindID("other2"), MDs[3].first); 2778 EXPECT_EQ(SP, MDs[0].second); 2779 EXPECT_EQ(P, MDs[1].second); 2780 EXPECT_EQ(T1, MDs[2].second); 2781 EXPECT_EQ(T2, MDs[3].second); 2782 } 2783 2784 TEST_F(FunctionAttachmentTest, Verifier) { 2785 Function *F = getFunction("foo"); 2786 F->setMetadata("attach", getTuple()); 2787 F->setIsMaterializable(true); 2788 2789 // Confirm this is materializable. 2790 ASSERT_TRUE(F->isMaterializable()); 2791 2792 // Materializable functions cannot have metadata attachments. 2793 EXPECT_TRUE(verifyFunction(*F)); 2794 2795 // Function declarations can. 2796 F->setIsMaterializable(false); 2797 EXPECT_FALSE(verifyModule(*F->getParent())); 2798 EXPECT_FALSE(verifyFunction(*F)); 2799 2800 // So can definitions. 2801 (void)new UnreachableInst(Context, BasicBlock::Create(Context, "bb", F)); 2802 EXPECT_FALSE(verifyModule(*F->getParent())); 2803 EXPECT_FALSE(verifyFunction(*F)); 2804 } 2805 2806 TEST_F(FunctionAttachmentTest, EntryCount) { 2807 Function *F = getFunction("foo"); 2808 EXPECT_FALSE(F->getEntryCount().hasValue()); 2809 F->setEntryCount(12304, Function::PCT_Real); 2810 auto Count = F->getEntryCount(); 2811 EXPECT_TRUE(Count.hasValue()); 2812 EXPECT_EQ(12304u, Count.getCount()); 2813 EXPECT_EQ(Function::PCT_Real, Count.getType()); 2814 2815 // Repeat the same for synthetic counts. 2816 F = getFunction("bar"); 2817 EXPECT_FALSE(F->getEntryCount().hasValue()); 2818 F->setEntryCount(123, Function::PCT_Synthetic); 2819 Count = F->getEntryCount(true /*allow synthetic*/); 2820 EXPECT_TRUE(Count.hasValue()); 2821 EXPECT_EQ(123u, Count.getCount()); 2822 EXPECT_EQ(Function::PCT_Synthetic, Count.getType()); 2823 } 2824 2825 TEST_F(FunctionAttachmentTest, SubprogramAttachment) { 2826 Function *F = getFunction("foo"); 2827 DISubprogram *SP = getSubprogram(); 2828 F->setSubprogram(SP); 2829 2830 // Note that the static_cast confirms that F->getSubprogram() actually 2831 // returns an DISubprogram. 2832 EXPECT_EQ(SP, static_cast<DISubprogram *>(F->getSubprogram())); 2833 EXPECT_EQ(SP, F->getMetadata("dbg")); 2834 EXPECT_EQ(SP, F->getMetadata(LLVMContext::MD_dbg)); 2835 } 2836 2837 typedef MetadataTest DistinctMDOperandPlaceholderTest; 2838 TEST_F(DistinctMDOperandPlaceholderTest, getID) { 2839 EXPECT_EQ(7u, DistinctMDOperandPlaceholder(7).getID()); 2840 } 2841 2842 TEST_F(DistinctMDOperandPlaceholderTest, replaceUseWith) { 2843 // Set up some placeholders. 2844 DistinctMDOperandPlaceholder PH0(7); 2845 DistinctMDOperandPlaceholder PH1(3); 2846 DistinctMDOperandPlaceholder PH2(0); 2847 Metadata *Ops[] = {&PH0, &PH1, &PH2}; 2848 auto *D = MDTuple::getDistinct(Context, Ops); 2849 ASSERT_EQ(&PH0, D->getOperand(0)); 2850 ASSERT_EQ(&PH1, D->getOperand(1)); 2851 ASSERT_EQ(&PH2, D->getOperand(2)); 2852 2853 // Replace them. 2854 auto *N0 = MDTuple::get(Context, None); 2855 auto *N1 = MDTuple::get(Context, N0); 2856 PH0.replaceUseWith(N0); 2857 PH1.replaceUseWith(N1); 2858 PH2.replaceUseWith(nullptr); 2859 EXPECT_EQ(N0, D->getOperand(0)); 2860 EXPECT_EQ(N1, D->getOperand(1)); 2861 EXPECT_EQ(nullptr, D->getOperand(2)); 2862 } 2863 2864 TEST_F(DistinctMDOperandPlaceholderTest, replaceUseWithNoUser) { 2865 // There is no user, but we can still call replace. 2866 DistinctMDOperandPlaceholder(7).replaceUseWith(MDTuple::get(Context, None)); 2867 } 2868 2869 // Test various assertions in metadata tracking. Don't run these tests if gtest 2870 // will use SEH to recover from them. Two of these tests get halfway through 2871 // inserting metadata into DenseMaps for tracking purposes, and then they 2872 // assert, and we attempt to destroy an LLVMContext with broken invariants, 2873 // leading to infinite loops. 2874 #if defined(GTEST_HAS_DEATH_TEST) && !defined(NDEBUG) && !defined(GTEST_HAS_SEH) 2875 TEST_F(DistinctMDOperandPlaceholderTest, MetadataAsValue) { 2876 // This shouldn't crash. 2877 DistinctMDOperandPlaceholder PH(7); 2878 EXPECT_DEATH(MetadataAsValue::get(Context, &PH), 2879 "Unexpected callback to owner"); 2880 } 2881 2882 TEST_F(DistinctMDOperandPlaceholderTest, UniquedMDNode) { 2883 // This shouldn't crash. 2884 DistinctMDOperandPlaceholder PH(7); 2885 EXPECT_DEATH(MDTuple::get(Context, &PH), "Unexpected callback to owner"); 2886 } 2887 2888 TEST_F(DistinctMDOperandPlaceholderTest, SecondDistinctMDNode) { 2889 // This shouldn't crash. 2890 DistinctMDOperandPlaceholder PH(7); 2891 MDTuple::getDistinct(Context, &PH); 2892 EXPECT_DEATH(MDTuple::getDistinct(Context, &PH), 2893 "Placeholders can only be used once"); 2894 } 2895 2896 TEST_F(DistinctMDOperandPlaceholderTest, TrackingMDRefAndDistinctMDNode) { 2897 // TrackingMDRef doesn't install an owner callback, so it can't be detected 2898 // as an invalid use. However, using a placeholder in a TrackingMDRef *and* 2899 // a distinct node isn't possible and we should assert. 2900 // 2901 // (There's no positive test for using TrackingMDRef because it's not a 2902 // useful thing to do.) 2903 { 2904 DistinctMDOperandPlaceholder PH(7); 2905 MDTuple::getDistinct(Context, &PH); 2906 EXPECT_DEATH(TrackingMDRef Ref(&PH), "Placeholders can only be used once"); 2907 } 2908 { 2909 DistinctMDOperandPlaceholder PH(7); 2910 TrackingMDRef Ref(&PH); 2911 EXPECT_DEATH(MDTuple::getDistinct(Context, &PH), 2912 "Placeholders can only be used once"); 2913 } 2914 } 2915 #endif 2916 2917 typedef MetadataTest DebugVariableTest; 2918 TEST_F(DebugVariableTest, DenseMap) { 2919 DenseMap<DebugVariable, uint64_t> DebugVariableMap; 2920 2921 DILocalScope *Scope = getSubprogram(); 2922 DIFile *File = getFile(); 2923 DIType *Type = getDerivedType(); 2924 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7); 2925 2926 DILocation *InlinedLoc = DILocation::get(Context, 2, 7, Scope); 2927 2928 DILocalVariable *VarA = 2929 DILocalVariable::get(Context, Scope, "A", File, 5, Type, 2, Flags, 8); 2930 DILocalVariable *VarB = 2931 DILocalVariable::get(Context, Scope, "B", File, 7, Type, 3, Flags, 8); 2932 2933 DebugVariable DebugVariableA(VarA, NoneType(), nullptr); 2934 DebugVariable DebugVariableInlineA(VarA, NoneType(), InlinedLoc); 2935 DebugVariable DebugVariableB(VarB, NoneType(), nullptr); 2936 DebugVariable DebugVariableFragB(VarB, {{16, 16}}, nullptr); 2937 2938 DebugVariableMap.insert({DebugVariableA, 2}); 2939 DebugVariableMap.insert({DebugVariableInlineA, 3}); 2940 DebugVariableMap.insert({DebugVariableB, 6}); 2941 DebugVariableMap.insert({DebugVariableFragB, 12}); 2942 2943 EXPECT_EQ(DebugVariableMap.count(DebugVariableA), 1u); 2944 EXPECT_EQ(DebugVariableMap.count(DebugVariableInlineA), 1u); 2945 EXPECT_EQ(DebugVariableMap.count(DebugVariableB), 1u); 2946 EXPECT_EQ(DebugVariableMap.count(DebugVariableFragB), 1u); 2947 2948 EXPECT_EQ(DebugVariableMap.find(DebugVariableA)->second, 2u); 2949 EXPECT_EQ(DebugVariableMap.find(DebugVariableInlineA)->second, 3u); 2950 EXPECT_EQ(DebugVariableMap.find(DebugVariableB)->second, 6u); 2951 EXPECT_EQ(DebugVariableMap.find(DebugVariableFragB)->second, 12u); 2952 } 2953 2954 } // end namespace 2955