1 //===- unittests/IR/MetadataTest.cpp - Metadata unit tests ----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/ADT/STLExtras.h"
11 #include "llvm/IR/Constants.h"
12 #include "llvm/IR/DebugInfo.h"
13 #include "llvm/IR/DebugInfoMetadata.h"
14 #include "llvm/IR/Function.h"
15 #include "llvm/IR/Instructions.h"
16 #include "llvm/IR/LLVMContext.h"
17 #include "llvm/IR/Metadata.h"
18 #include "llvm/IR/Module.h"
19 #include "llvm/IR/ModuleSlotTracker.h"
20 #include "llvm/IR/Type.h"
21 #include "llvm/IR/Verifier.h"
22 #include "llvm/Support/raw_ostream.h"
23 #include "gtest/gtest.h"
28 TEST(ContextAndReplaceableUsesTest, FromContext) {
30 ContextAndReplaceableUses CRU(Context);
31 EXPECT_EQ(&Context, &CRU.getContext());
32 EXPECT_FALSE(CRU.hasReplaceableUses());
33 EXPECT_FALSE(CRU.getReplaceableUses());
36 TEST(ContextAndReplaceableUsesTest, FromReplaceableUses) {
38 ContextAndReplaceableUses CRU(make_unique<ReplaceableMetadataImpl>(Context));
39 EXPECT_EQ(&Context, &CRU.getContext());
40 EXPECT_TRUE(CRU.hasReplaceableUses());
41 EXPECT_TRUE(CRU.getReplaceableUses());
44 TEST(ContextAndReplaceableUsesTest, makeReplaceable) {
46 ContextAndReplaceableUses CRU(Context);
47 CRU.makeReplaceable(make_unique<ReplaceableMetadataImpl>(Context));
48 EXPECT_EQ(&Context, &CRU.getContext());
49 EXPECT_TRUE(CRU.hasReplaceableUses());
50 EXPECT_TRUE(CRU.getReplaceableUses());
53 TEST(ContextAndReplaceableUsesTest, takeReplaceableUses) {
55 auto ReplaceableUses = make_unique<ReplaceableMetadataImpl>(Context);
56 auto *Ptr = ReplaceableUses.get();
57 ContextAndReplaceableUses CRU(std::move(ReplaceableUses));
58 ReplaceableUses = CRU.takeReplaceableUses();
59 EXPECT_EQ(&Context, &CRU.getContext());
60 EXPECT_FALSE(CRU.hasReplaceableUses());
61 EXPECT_FALSE(CRU.getReplaceableUses());
62 EXPECT_EQ(Ptr, ReplaceableUses.get());
65 class MetadataTest : public testing::Test {
67 MetadataTest() : M("test", Context), Counter(0) {}
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);
81 MDTuple *getTuple() { return MDTuple::getDistinct(Context, None); }
82 DISubroutineType *getSubroutineType() {
83 return DISubroutineType::getDistinct(Context, 0, getNode(nullptr));
85 DISubprogram *getSubprogram() {
86 return DISubprogram::getDistinct(Context, nullptr, "", "", nullptr, 0,
87 nullptr, false, false, 0, nullptr, 0, 0, 0,
90 DIScopeRef getSubprogramRef() { return getSubprogram()->getRef(); }
92 return DIFile::getDistinct(Context, "file.c", "/path/to/dir");
94 DITypeRef getBasicType(StringRef Name) {
95 return DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type, Name)
98 DITypeRef getDerivedType() {
99 return DIDerivedType::getDistinct(Context, dwarf::DW_TAG_pointer_type, "",
101 getBasicType("basictype"), 1, 2, 0, 0)
104 Constant *getConstant() {
105 return ConstantInt::get(Type::getInt32Ty(Context), Counter++);
107 ConstantAsMetadata *getConstantAsMetadata() {
108 return ConstantAsMetadata::get(getConstant());
110 DITypeRef getCompositeType() {
111 return DICompositeType::getDistinct(
112 Context, dwarf::DW_TAG_structure_type, "", nullptr, 0, nullptr,
113 nullptr, 32, 32, 0, 0, nullptr, 0, nullptr, nullptr, "")
116 Function *getFunction(StringRef Name) {
117 return cast<Function>(M.getOrInsertFunction(
118 Name, FunctionType::get(Type::getVoidTy(Context), None, false)));
121 typedef MetadataTest MDStringTest;
123 // Test that construction of MDString with different value produces different
124 // MDString objects, even with the same string pointer and nulls in the string.
125 TEST_F(MDStringTest, CreateDifferent) {
126 char x[3] = { 'f', 0, 'A' };
127 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
129 MDString *s2 = MDString::get(Context, StringRef(&x[0], 3));
133 // Test that creation of MDStrings with the same string contents produces the
134 // same MDString object, even with different pointers.
135 TEST_F(MDStringTest, CreateSame) {
136 char x[4] = { 'a', 'b', 'c', 'X' };
137 char y[4] = { 'a', 'b', 'c', 'Y' };
139 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
140 MDString *s2 = MDString::get(Context, StringRef(&y[0], 3));
144 // Test that MDString prints out the string we fed it.
145 TEST_F(MDStringTest, PrintingSimple) {
146 char *str = new char[13];
147 strncpy(str, "testing 1 2 3", 13);
148 MDString *s = MDString::get(Context, StringRef(str, 13));
149 strncpy(str, "aaaaaaaaaaaaa", 13);
153 raw_string_ostream oss(Str);
155 EXPECT_STREQ("!\"testing 1 2 3\"", oss.str().c_str());
158 // Test printing of MDString with non-printable characters.
159 TEST_F(MDStringTest, PrintingComplex) {
160 char str[5] = {0, '\n', '"', '\\', (char)-1};
161 MDString *s = MDString::get(Context, StringRef(str+0, 5));
163 raw_string_ostream oss(Str);
165 EXPECT_STREQ("!\"\\00\\0A\\22\\5C\\FF\"", oss.str().c_str());
168 typedef MetadataTest MDNodeTest;
170 // Test the two constructors, and containing other Constants.
171 TEST_F(MDNodeTest, Simple) {
172 char x[3] = { 'a', 'b', 'c' };
173 char y[3] = { '1', '2', '3' };
175 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
176 MDString *s2 = MDString::get(Context, StringRef(&y[0], 3));
177 ConstantAsMetadata *CI = ConstantAsMetadata::get(
178 ConstantInt::get(getGlobalContext(), APInt(8, 0)));
180 std::vector<Metadata *> V;
185 MDNode *n1 = MDNode::get(Context, V);
186 Metadata *const c1 = n1;
187 MDNode *n2 = MDNode::get(Context, c1);
188 Metadata *const c2 = n2;
189 MDNode *n3 = MDNode::get(Context, V);
190 MDNode *n4 = MDNode::getIfExists(Context, V);
191 MDNode *n5 = MDNode::getIfExists(Context, c1);
192 MDNode *n6 = MDNode::getIfExists(Context, c2);
197 EXPECT_EQ(n6, (Metadata *)nullptr);
199 EXPECT_EQ(3u, n1->getNumOperands());
200 EXPECT_EQ(s1, n1->getOperand(0));
201 EXPECT_EQ(CI, n1->getOperand(1));
202 EXPECT_EQ(s2, n1->getOperand(2));
204 EXPECT_EQ(1u, n2->getNumOperands());
205 EXPECT_EQ(n1, n2->getOperand(0));
208 TEST_F(MDNodeTest, Delete) {
209 Constant *C = ConstantInt::get(Type::getInt32Ty(getGlobalContext()), 1);
210 Instruction *I = new BitCastInst(C, Type::getInt32Ty(getGlobalContext()));
212 Metadata *const V = LocalAsMetadata::get(I);
213 MDNode *n = MDNode::get(Context, V);
214 TrackingMDRef wvh(n);
221 TEST_F(MDNodeTest, SelfReference) {
225 auto Temp = MDNode::getTemporary(Context, None);
226 Metadata *Args[] = {Temp.get()};
227 MDNode *Self = MDNode::get(Context, Args);
228 Self->replaceOperandWith(0, Self);
229 ASSERT_EQ(Self, Self->getOperand(0));
231 // Self-references should be distinct, so MDNode::get() should grab a
232 // uniqued node that references Self, not Self.
234 MDNode *Ref1 = MDNode::get(Context, Args);
235 MDNode *Ref2 = MDNode::get(Context, Args);
236 EXPECT_NE(Self, Ref1);
237 EXPECT_EQ(Ref1, Ref2);
243 auto Temp = MDNode::getTemporary(Context, None);
244 Metadata *Args[] = {Temp.get(), MDNode::get(Context, None)};
245 MDNode *Self = MDNode::get(Context, Args);
246 Self->replaceOperandWith(0, Self);
247 ASSERT_EQ(Self, Self->getOperand(0));
249 // Self-references should be distinct, so MDNode::get() should grab a
250 // uniqued node that references Self, not Self itself.
252 MDNode *Ref1 = MDNode::get(Context, Args);
253 MDNode *Ref2 = MDNode::get(Context, Args);
254 EXPECT_NE(Self, Ref1);
255 EXPECT_EQ(Ref1, Ref2);
259 TEST_F(MDNodeTest, Print) {
260 Constant *C = ConstantInt::get(Type::getInt32Ty(Context), 7);
261 MDString *S = MDString::get(Context, "foo");
262 MDNode *N0 = getNode();
263 MDNode *N1 = getNode(N0);
264 MDNode *N2 = getNode(N0, N1);
266 Metadata *Args[] = {ConstantAsMetadata::get(C), S, nullptr, N0, N1, N2};
267 MDNode *N = MDNode::get(Context, Args);
269 std::string Expected;
271 raw_string_ostream OS(Expected);
272 OS << "<" << (void *)N << "> = !{";
273 C->printAsOperand(OS);
275 S->printAsOperand(OS);
277 MDNode *Nodes[] = {N0, N1, N2};
278 for (auto *Node : Nodes)
279 OS << ", <" << (void *)Node << ">";
285 raw_string_ostream OS(Actual);
289 EXPECT_EQ(Expected, Actual);
292 #define EXPECT_PRINTER_EQ(EXPECTED, PRINT) \
294 std::string Actual_; \
295 raw_string_ostream OS(Actual_); \
298 std::string Expected_(EXPECTED); \
299 EXPECT_EQ(Expected_, Actual_); \
302 TEST_F(MDNodeTest, PrintTemporary) {
303 MDNode *Arg = getNode();
304 TempMDNode Temp = MDNode::getTemporary(Context, Arg);
305 MDNode *N = getNode(Temp.get());
306 Module M("test", Context);
307 NamedMDNode *NMD = M.getOrInsertNamedMetadata("named");
310 EXPECT_PRINTER_EQ("!0 = !{!1}", N->print(OS, &M));
311 EXPECT_PRINTER_EQ("!1 = <temporary!> !{!2}", Temp->print(OS, &M));
312 EXPECT_PRINTER_EQ("!2 = !{}", Arg->print(OS, &M));
315 Temp->replaceAllUsesWith(Arg);
318 TEST_F(MDNodeTest, PrintFromModule) {
319 Constant *C = ConstantInt::get(Type::getInt32Ty(Context), 7);
320 MDString *S = MDString::get(Context, "foo");
321 MDNode *N0 = getNode();
322 MDNode *N1 = getNode(N0);
323 MDNode *N2 = getNode(N0, N1);
325 Metadata *Args[] = {ConstantAsMetadata::get(C), S, nullptr, N0, N1, N2};
326 MDNode *N = MDNode::get(Context, Args);
327 Module M("test", Context);
328 NamedMDNode *NMD = M.getOrInsertNamedMetadata("named");
331 std::string Expected;
333 raw_string_ostream OS(Expected);
335 C->printAsOperand(OS);
337 S->printAsOperand(OS);
338 OS << ", null, !1, !2, !3}";
341 EXPECT_PRINTER_EQ(Expected, N->print(OS, &M));
344 TEST_F(MDNodeTest, PrintFromFunction) {
345 Module M("test", Context);
346 auto *FTy = FunctionType::get(Type::getVoidTy(Context), false);
347 auto *F0 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F0", &M);
348 auto *F1 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F1", &M);
349 auto *BB0 = BasicBlock::Create(Context, "entry", F0);
350 auto *BB1 = BasicBlock::Create(Context, "entry", F1);
351 auto *R0 = ReturnInst::Create(Context, BB0);
352 auto *R1 = ReturnInst::Create(Context, BB1);
353 auto *N0 = MDNode::getDistinct(Context, None);
354 auto *N1 = MDNode::getDistinct(Context, None);
355 R0->setMetadata("md", N0);
356 R1->setMetadata("md", N1);
358 EXPECT_PRINTER_EQ("!0 = distinct !{}", N0->print(OS, &M));
359 EXPECT_PRINTER_EQ("!1 = distinct !{}", N1->print(OS, &M));
361 ModuleSlotTracker MST(&M);
362 EXPECT_PRINTER_EQ("!0 = distinct !{}", N0->print(OS, MST));
363 EXPECT_PRINTER_EQ("!1 = distinct !{}", N1->print(OS, MST));
366 TEST_F(MDNodeTest, PrintFromMetadataAsValue) {
367 Module M("test", Context);
370 Function::Create(FunctionType::get(Type::getVoidTy(Context),
371 Type::getMetadataTy(Context), false),
372 GlobalValue::ExternalLinkage, "llvm.intrinsic", &M);
374 auto *FTy = FunctionType::get(Type::getVoidTy(Context), false);
375 auto *F0 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F0", &M);
376 auto *F1 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F1", &M);
377 auto *BB0 = BasicBlock::Create(Context, "entry", F0);
378 auto *BB1 = BasicBlock::Create(Context, "entry", F1);
379 auto *N0 = MDNode::getDistinct(Context, None);
380 auto *N1 = MDNode::getDistinct(Context, None);
381 auto *MAV0 = MetadataAsValue::get(Context, N0);
382 auto *MAV1 = MetadataAsValue::get(Context, N1);
383 CallInst::Create(Intrinsic, MAV0, "", BB0);
384 CallInst::Create(Intrinsic, MAV1, "", BB1);
386 EXPECT_PRINTER_EQ("!0 = distinct !{}", MAV0->print(OS));
387 EXPECT_PRINTER_EQ("!1 = distinct !{}", MAV1->print(OS));
388 EXPECT_PRINTER_EQ("!0", MAV0->printAsOperand(OS, false));
389 EXPECT_PRINTER_EQ("!1", MAV1->printAsOperand(OS, false));
390 EXPECT_PRINTER_EQ("metadata !0", MAV0->printAsOperand(OS, true));
391 EXPECT_PRINTER_EQ("metadata !1", MAV1->printAsOperand(OS, true));
393 ModuleSlotTracker MST(&M);
394 EXPECT_PRINTER_EQ("!0 = distinct !{}", MAV0->print(OS, MST));
395 EXPECT_PRINTER_EQ("!1 = distinct !{}", MAV1->print(OS, MST));
396 EXPECT_PRINTER_EQ("!0", MAV0->printAsOperand(OS, false, MST));
397 EXPECT_PRINTER_EQ("!1", MAV1->printAsOperand(OS, false, MST));
398 EXPECT_PRINTER_EQ("metadata !0", MAV0->printAsOperand(OS, true, MST));
399 EXPECT_PRINTER_EQ("metadata !1", MAV1->printAsOperand(OS, true, MST));
401 #undef EXPECT_PRINTER_EQ
403 TEST_F(MDNodeTest, NullOperand) {
405 MDNode *Empty = MDNode::get(Context, None);
407 // metadata !{metadata !{}}
408 Metadata *Ops[] = {Empty};
409 MDNode *N = MDNode::get(Context, Ops);
410 ASSERT_EQ(Empty, N->getOperand(0));
412 // metadata !{metadata !{}} => metadata !{null}
413 N->replaceOperandWith(0, nullptr);
414 ASSERT_EQ(nullptr, N->getOperand(0));
418 MDNode *NullOp = MDNode::get(Context, Ops);
419 ASSERT_EQ(nullptr, NullOp->getOperand(0));
420 EXPECT_EQ(N, NullOp);
423 TEST_F(MDNodeTest, DistinctOnUniquingCollision) {
425 MDNode *Empty = MDNode::get(Context, None);
426 ASSERT_TRUE(Empty->isResolved());
427 EXPECT_FALSE(Empty->isDistinct());
430 Metadata *Wrapped1Ops[] = {Empty};
431 MDNode *Wrapped1 = MDNode::get(Context, Wrapped1Ops);
432 ASSERT_EQ(Empty, Wrapped1->getOperand(0));
433 ASSERT_TRUE(Wrapped1->isResolved());
434 EXPECT_FALSE(Wrapped1->isDistinct());
437 Metadata *Wrapped2Ops[] = {Wrapped1};
438 MDNode *Wrapped2 = MDNode::get(Context, Wrapped2Ops);
439 ASSERT_EQ(Wrapped1, Wrapped2->getOperand(0));
440 ASSERT_TRUE(Wrapped2->isResolved());
441 EXPECT_FALSE(Wrapped2->isDistinct());
443 // !{!{!{}}} => !{!{}}
444 Wrapped2->replaceOperandWith(0, Empty);
445 ASSERT_EQ(Empty, Wrapped2->getOperand(0));
446 EXPECT_TRUE(Wrapped2->isDistinct());
447 EXPECT_FALSE(Wrapped1->isDistinct());
450 TEST_F(MDNodeTest, getDistinct) {
452 MDNode *Empty = MDNode::get(Context, None);
453 ASSERT_TRUE(Empty->isResolved());
454 ASSERT_FALSE(Empty->isDistinct());
455 ASSERT_EQ(Empty, MDNode::get(Context, None));
458 MDNode *Distinct1 = MDNode::getDistinct(Context, None);
459 MDNode *Distinct2 = MDNode::getDistinct(Context, None);
460 EXPECT_TRUE(Distinct1->isResolved());
461 EXPECT_TRUE(Distinct2->isDistinct());
462 EXPECT_NE(Empty, Distinct1);
463 EXPECT_NE(Empty, Distinct2);
464 EXPECT_NE(Distinct1, Distinct2);
467 ASSERT_EQ(Empty, MDNode::get(Context, None));
470 TEST_F(MDNodeTest, isUniqued) {
471 MDNode *U = MDTuple::get(Context, None);
472 MDNode *D = MDTuple::getDistinct(Context, None);
473 auto T = MDTuple::getTemporary(Context, None);
474 EXPECT_TRUE(U->isUniqued());
475 EXPECT_FALSE(D->isUniqued());
476 EXPECT_FALSE(T->isUniqued());
479 TEST_F(MDNodeTest, isDistinct) {
480 MDNode *U = MDTuple::get(Context, None);
481 MDNode *D = MDTuple::getDistinct(Context, None);
482 auto T = MDTuple::getTemporary(Context, None);
483 EXPECT_FALSE(U->isDistinct());
484 EXPECT_TRUE(D->isDistinct());
485 EXPECT_FALSE(T->isDistinct());
488 TEST_F(MDNodeTest, isTemporary) {
489 MDNode *U = MDTuple::get(Context, None);
490 MDNode *D = MDTuple::getDistinct(Context, None);
491 auto T = MDTuple::getTemporary(Context, None);
492 EXPECT_FALSE(U->isTemporary());
493 EXPECT_FALSE(D->isTemporary());
494 EXPECT_TRUE(T->isTemporary());
497 TEST_F(MDNodeTest, getDistinctWithUnresolvedOperands) {
499 auto Temp = MDTuple::getTemporary(Context, None);
500 ASSERT_FALSE(Temp->isResolved());
502 // distinct !{temporary !{}}
503 Metadata *Ops[] = {Temp.get()};
504 MDNode *Distinct = MDNode::getDistinct(Context, Ops);
505 EXPECT_TRUE(Distinct->isResolved());
506 EXPECT_EQ(Temp.get(), Distinct->getOperand(0));
508 // temporary !{} => !{}
509 MDNode *Empty = MDNode::get(Context, None);
510 Temp->replaceAllUsesWith(Empty);
511 EXPECT_EQ(Empty, Distinct->getOperand(0));
514 TEST_F(MDNodeTest, handleChangedOperandRecursion) {
516 MDNode *N0 = MDNode::get(Context, None);
519 auto Temp3 = MDTuple::getTemporary(Context, None);
520 Metadata *Ops1[] = {Temp3.get(), nullptr};
521 MDNode *N1 = MDNode::get(Context, Ops1);
524 Metadata *Ops2[] = {Temp3.get(), N0};
525 MDNode *N2 = MDNode::get(Context, Ops2);
528 Metadata *Ops3[] = {N2};
529 MDNode *N3 = MDNode::get(Context, Ops3);
530 Temp3->replaceAllUsesWith(N3);
533 Metadata *Ops4[] = {N1};
534 MDNode *N4 = MDNode::get(Context, Ops4);
536 // Confirm that the cycle prevented RAUW from getting dropped.
537 EXPECT_TRUE(N0->isResolved());
538 EXPECT_FALSE(N1->isResolved());
539 EXPECT_FALSE(N2->isResolved());
540 EXPECT_FALSE(N3->isResolved());
541 EXPECT_FALSE(N4->isResolved());
543 // Create a couple of distinct nodes to observe what's going on.
545 // !5 = distinct !{!2}
546 // !6 = distinct !{!3}
547 Metadata *Ops5[] = {N2};
548 MDNode *N5 = MDNode::getDistinct(Context, Ops5);
549 Metadata *Ops6[] = {N3};
550 MDNode *N6 = MDNode::getDistinct(Context, Ops6);
552 // Mutate !2 to look like !1, causing a uniquing collision (and an RAUW).
553 // This will ripple up, with !3 colliding with !4, and RAUWing. Since !2
554 // references !3, this can cause a re-entry of handleChangedOperand() when !3
555 // is not ready for it.
557 // !2->replaceOperandWith(1, nullptr)
558 // !2: !{!3, !0} => !{!3, null}
559 // !2->replaceAllUsesWith(!1)
560 // !3: !{!2] => !{!1}
561 // !3->replaceAllUsesWith(!4)
562 N2->replaceOperandWith(1, nullptr);
564 // If all has gone well, N2 and N3 will have been RAUW'ed and deleted from
565 // under us. Just check that the other nodes are sane.
569 // !5 = distinct !{!1}
570 // !6 = distinct !{!4}
571 EXPECT_EQ(N4, N1->getOperand(0));
572 EXPECT_EQ(N1, N4->getOperand(0));
573 EXPECT_EQ(N1, N5->getOperand(0));
574 EXPECT_EQ(N4, N6->getOperand(0));
577 TEST_F(MDNodeTest, replaceResolvedOperand) {
578 // Check code for replacing one resolved operand with another. If doing this
579 // directly (via replaceOperandWith()) becomes illegal, change the operand to
580 // a global value that gets RAUW'ed.
582 // Use a temporary node to keep N from being resolved.
583 auto Temp = MDTuple::getTemporary(Context, None);
584 Metadata *Ops[] = {nullptr, Temp.get()};
586 MDNode *Empty = MDTuple::get(Context, ArrayRef<Metadata *>());
587 MDNode *N = MDTuple::get(Context, Ops);
588 EXPECT_EQ(nullptr, N->getOperand(0));
589 ASSERT_FALSE(N->isResolved());
591 // Check code for replacing resolved nodes.
592 N->replaceOperandWith(0, Empty);
593 EXPECT_EQ(Empty, N->getOperand(0));
595 // Check code for adding another unresolved operand.
596 N->replaceOperandWith(0, Temp.get());
597 EXPECT_EQ(Temp.get(), N->getOperand(0));
599 // Remove the references to Temp; required for teardown.
600 Temp->replaceAllUsesWith(nullptr);
603 TEST_F(MDNodeTest, replaceWithUniqued) {
604 auto *Empty = MDTuple::get(Context, None);
605 MDTuple *FirstUniqued;
607 Metadata *Ops[] = {Empty};
608 auto Temp = MDTuple::getTemporary(Context, Ops);
609 EXPECT_TRUE(Temp->isTemporary());
611 // Don't expect a collision.
612 auto *Current = Temp.get();
613 FirstUniqued = MDNode::replaceWithUniqued(std::move(Temp));
614 EXPECT_TRUE(FirstUniqued->isUniqued());
615 EXPECT_TRUE(FirstUniqued->isResolved());
616 EXPECT_EQ(Current, FirstUniqued);
619 Metadata *Ops[] = {Empty};
620 auto Temp = MDTuple::getTemporary(Context, Ops);
621 EXPECT_TRUE(Temp->isTemporary());
623 // Should collide with Uniqued above this time.
624 auto *Uniqued = MDNode::replaceWithUniqued(std::move(Temp));
625 EXPECT_TRUE(Uniqued->isUniqued());
626 EXPECT_TRUE(Uniqued->isResolved());
627 EXPECT_EQ(FirstUniqued, Uniqued);
630 auto Unresolved = MDTuple::getTemporary(Context, None);
631 Metadata *Ops[] = {Unresolved.get()};
632 auto Temp = MDTuple::getTemporary(Context, Ops);
633 EXPECT_TRUE(Temp->isTemporary());
635 // Shouldn't be resolved.
636 auto *Uniqued = MDNode::replaceWithUniqued(std::move(Temp));
637 EXPECT_TRUE(Uniqued->isUniqued());
638 EXPECT_FALSE(Uniqued->isResolved());
640 // Should be a different node.
641 EXPECT_NE(FirstUniqued, Uniqued);
643 // Should resolve when we update its node (note: be careful to avoid a
644 // collision with any other nodes above).
645 Uniqued->replaceOperandWith(0, nullptr);
646 EXPECT_TRUE(Uniqued->isResolved());
650 TEST_F(MDNodeTest, replaceWithUniquedResolvingOperand) {
652 MDTuple *Op = MDTuple::getTemporary(Context, None).release();
653 EXPECT_FALSE(Op->isResolved());
656 Metadata *Ops[] = {Op};
657 MDTuple *N = MDTuple::getTemporary(Context, Ops).release();
658 EXPECT_FALSE(N->isResolved());
660 // temp !{temp !{}} => !{temp !{}}
661 ASSERT_EQ(N, MDNode::replaceWithUniqued(TempMDTuple(N)));
662 EXPECT_FALSE(N->isResolved());
664 // !{temp !{}} => !{!{}}
665 ASSERT_EQ(Op, MDNode::replaceWithUniqued(TempMDTuple(Op)));
666 EXPECT_TRUE(Op->isResolved());
667 EXPECT_TRUE(N->isResolved());
670 TEST_F(MDNodeTest, replaceWithUniquedChangingOperand) {
672 Type *Ty = Type::getInt1PtrTy(Context);
673 std::unique_ptr<GlobalVariable> GV(
674 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
675 ConstantAsMetadata *Op = ConstantAsMetadata::get(GV.get());
678 Metadata *Ops[] = {Op};
679 MDTuple *N = MDTuple::getTemporary(Context, Ops).release();
681 // temp !{i1* @GV} => !{i1* @GV}
682 ASSERT_EQ(N, MDNode::replaceWithUniqued(TempMDTuple(N)));
683 ASSERT_TRUE(N->isUniqued());
685 // !{i1* @GV} => !{null}
687 ASSERT_TRUE(N->isUniqued());
688 Metadata *NullOps[] = {nullptr};
689 ASSERT_EQ(N, MDTuple::get(Context, NullOps));
692 TEST_F(MDNodeTest, replaceWithDistinct) {
694 auto *Empty = MDTuple::get(Context, None);
695 Metadata *Ops[] = {Empty};
696 auto Temp = MDTuple::getTemporary(Context, Ops);
697 EXPECT_TRUE(Temp->isTemporary());
699 // Don't expect a collision.
700 auto *Current = Temp.get();
701 auto *Distinct = MDNode::replaceWithDistinct(std::move(Temp));
702 EXPECT_TRUE(Distinct->isDistinct());
703 EXPECT_TRUE(Distinct->isResolved());
704 EXPECT_EQ(Current, Distinct);
707 auto Unresolved = MDTuple::getTemporary(Context, None);
708 Metadata *Ops[] = {Unresolved.get()};
709 auto Temp = MDTuple::getTemporary(Context, Ops);
710 EXPECT_TRUE(Temp->isTemporary());
712 // Don't expect a collision.
713 auto *Current = Temp.get();
714 auto *Distinct = MDNode::replaceWithDistinct(std::move(Temp));
715 EXPECT_TRUE(Distinct->isDistinct());
716 EXPECT_TRUE(Distinct->isResolved());
717 EXPECT_EQ(Current, Distinct);
719 // Cleanup; required for teardown.
720 Unresolved->replaceAllUsesWith(nullptr);
724 TEST_F(MDNodeTest, replaceWithPermanent) {
725 Metadata *Ops[] = {nullptr};
726 auto Temp = MDTuple::getTemporary(Context, Ops);
727 auto *T = Temp.get();
729 // U is a normal, uniqued node that references T.
730 auto *U = MDTuple::get(Context, T);
731 EXPECT_TRUE(U->isUniqued());
733 // Make Temp self-referencing.
734 Temp->replaceOperandWith(0, T);
736 // Try to uniquify Temp. This should, despite the name in the API, give a
737 // 'distinct' node, since self-references aren't allowed to be uniqued.
739 // Since it's distinct, N should have the same address as when it was a
740 // temporary (i.e., be equal to T not U).
741 auto *N = MDNode::replaceWithPermanent(std::move(Temp));
743 EXPECT_TRUE(N->isDistinct());
745 // U should be the canonical unique node with N as the argument.
746 EXPECT_EQ(U, MDTuple::get(Context, N));
747 EXPECT_TRUE(U->isUniqued());
749 // This temporary should collide with U when replaced, but it should still be
751 EXPECT_EQ(U, MDNode::replaceWithPermanent(MDTuple::getTemporary(Context, N)));
752 EXPECT_TRUE(U->isUniqued());
754 // This temporary should become a new uniqued node.
755 auto Temp2 = MDTuple::getTemporary(Context, U);
756 auto *V = Temp2.get();
757 EXPECT_EQ(V, MDNode::replaceWithPermanent(std::move(Temp2)));
758 EXPECT_TRUE(V->isUniqued());
759 EXPECT_EQ(U, V->getOperand(0));
762 TEST_F(MDNodeTest, deleteTemporaryWithTrackingRef) {
764 EXPECT_EQ(nullptr, Ref.get());
766 auto Temp = MDTuple::getTemporary(Context, None);
767 Ref.reset(Temp.get());
768 EXPECT_EQ(Temp.get(), Ref.get());
770 EXPECT_EQ(nullptr, Ref.get());
773 typedef MetadataTest DILocationTest;
775 TEST_F(DILocationTest, Overflow) {
776 DISubprogram *N = getSubprogram();
778 DILocation *L = DILocation::get(Context, 2, 7, N);
779 EXPECT_EQ(2u, L->getLine());
780 EXPECT_EQ(7u, L->getColumn());
782 unsigned U16 = 1u << 16;
784 DILocation *L = DILocation::get(Context, UINT32_MAX, U16 - 1, N);
785 EXPECT_EQ(UINT32_MAX, L->getLine());
786 EXPECT_EQ(U16 - 1, L->getColumn());
789 DILocation *L = DILocation::get(Context, UINT32_MAX, U16, N);
790 EXPECT_EQ(UINT32_MAX, L->getLine());
791 EXPECT_EQ(0u, L->getColumn());
794 DILocation *L = DILocation::get(Context, UINT32_MAX, U16 + 1, N);
795 EXPECT_EQ(UINT32_MAX, L->getLine());
796 EXPECT_EQ(0u, L->getColumn());
800 TEST_F(DILocationTest, getDistinct) {
801 MDNode *N = getSubprogram();
802 DILocation *L0 = DILocation::getDistinct(Context, 2, 7, N);
803 EXPECT_TRUE(L0->isDistinct());
804 DILocation *L1 = DILocation::get(Context, 2, 7, N);
805 EXPECT_FALSE(L1->isDistinct());
806 EXPECT_EQ(L1, DILocation::get(Context, 2, 7, N));
809 TEST_F(DILocationTest, getTemporary) {
810 MDNode *N = MDNode::get(Context, None);
811 auto L = DILocation::getTemporary(Context, 2, 7, N);
812 EXPECT_TRUE(L->isTemporary());
813 EXPECT_FALSE(L->isResolved());
816 TEST_F(DILocationTest, cloneTemporary) {
817 MDNode *N = MDNode::get(Context, None);
818 auto L = DILocation::getTemporary(Context, 2, 7, N);
819 EXPECT_TRUE(L->isTemporary());
820 auto L2 = L->clone();
821 EXPECT_TRUE(L2->isTemporary());
824 typedef MetadataTest GenericDINodeTest;
826 TEST_F(GenericDINodeTest, get) {
827 StringRef Header = "header";
828 auto *Empty = MDNode::get(Context, None);
829 Metadata *Ops1[] = {Empty};
830 auto *N = GenericDINode::get(Context, 15, Header, Ops1);
831 EXPECT_EQ(15u, N->getTag());
832 EXPECT_EQ(2u, N->getNumOperands());
833 EXPECT_EQ(Header, N->getHeader());
834 EXPECT_EQ(MDString::get(Context, Header), N->getOperand(0));
835 EXPECT_EQ(1u, N->getNumDwarfOperands());
836 EXPECT_EQ(Empty, N->getDwarfOperand(0));
837 EXPECT_EQ(Empty, N->getOperand(1));
838 ASSERT_TRUE(N->isUniqued());
840 EXPECT_EQ(N, GenericDINode::get(Context, 15, Header, Ops1));
842 N->replaceOperandWith(1, nullptr);
843 EXPECT_EQ(15u, N->getTag());
844 EXPECT_EQ(Header, N->getHeader());
845 EXPECT_EQ(nullptr, N->getDwarfOperand(0));
846 ASSERT_TRUE(N->isUniqued());
848 Metadata *Ops2[] = {nullptr};
849 EXPECT_EQ(N, GenericDINode::get(Context, 15, Header, Ops2));
851 N->replaceDwarfOperandWith(0, Empty);
852 EXPECT_EQ(15u, N->getTag());
853 EXPECT_EQ(Header, N->getHeader());
854 EXPECT_EQ(Empty, N->getDwarfOperand(0));
855 ASSERT_TRUE(N->isUniqued());
856 EXPECT_EQ(N, GenericDINode::get(Context, 15, Header, Ops1));
858 TempGenericDINode Temp = N->clone();
859 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
862 TEST_F(GenericDINodeTest, getEmptyHeader) {
863 // Canonicalize !"" to null.
864 auto *N = GenericDINode::get(Context, 15, StringRef(), None);
865 EXPECT_EQ(StringRef(), N->getHeader());
866 EXPECT_EQ(nullptr, N->getOperand(0));
869 typedef MetadataTest DISubrangeTest;
871 TEST_F(DISubrangeTest, get) {
872 auto *N = DISubrange::get(Context, 5, 7);
873 EXPECT_EQ(dwarf::DW_TAG_subrange_type, N->getTag());
874 EXPECT_EQ(5, N->getCount());
875 EXPECT_EQ(7, N->getLowerBound());
876 EXPECT_EQ(N, DISubrange::get(Context, 5, 7));
877 EXPECT_EQ(DISubrange::get(Context, 5, 0), DISubrange::get(Context, 5));
879 TempDISubrange Temp = N->clone();
880 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
883 TEST_F(DISubrangeTest, getEmptyArray) {
884 auto *N = DISubrange::get(Context, -1, 0);
885 EXPECT_EQ(dwarf::DW_TAG_subrange_type, N->getTag());
886 EXPECT_EQ(-1, N->getCount());
887 EXPECT_EQ(0, N->getLowerBound());
888 EXPECT_EQ(N, DISubrange::get(Context, -1, 0));
891 typedef MetadataTest DIEnumeratorTest;
893 TEST_F(DIEnumeratorTest, get) {
894 auto *N = DIEnumerator::get(Context, 7, "name");
895 EXPECT_EQ(dwarf::DW_TAG_enumerator, N->getTag());
896 EXPECT_EQ(7, N->getValue());
897 EXPECT_EQ("name", N->getName());
898 EXPECT_EQ(N, DIEnumerator::get(Context, 7, "name"));
900 EXPECT_NE(N, DIEnumerator::get(Context, 8, "name"));
901 EXPECT_NE(N, DIEnumerator::get(Context, 7, "nam"));
903 TempDIEnumerator Temp = N->clone();
904 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
907 typedef MetadataTest DIBasicTypeTest;
909 TEST_F(DIBasicTypeTest, get) {
911 DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 26, 7);
912 EXPECT_EQ(dwarf::DW_TAG_base_type, N->getTag());
913 EXPECT_EQ("special", N->getName());
914 EXPECT_EQ(33u, N->getSizeInBits());
915 EXPECT_EQ(26u, N->getAlignInBits());
916 EXPECT_EQ(7u, N->getEncoding());
917 EXPECT_EQ(0u, N->getLine());
918 EXPECT_EQ(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33,
921 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type,
922 "special", 33, 26, 7));
924 DIBasicType::get(Context, dwarf::DW_TAG_base_type, "s", 33, 26, 7));
925 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 32,
927 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33,
929 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33,
932 TempDIBasicType Temp = N->clone();
933 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
936 TEST_F(DIBasicTypeTest, getWithLargeValues) {
937 auto *N = DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special",
938 UINT64_MAX, UINT64_MAX - 1, 7);
939 EXPECT_EQ(UINT64_MAX, N->getSizeInBits());
940 EXPECT_EQ(UINT64_MAX - 1, N->getAlignInBits());
943 TEST_F(DIBasicTypeTest, getUnspecified) {
945 DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type, "unspecified");
946 EXPECT_EQ(dwarf::DW_TAG_unspecified_type, N->getTag());
947 EXPECT_EQ("unspecified", N->getName());
948 EXPECT_EQ(0u, N->getSizeInBits());
949 EXPECT_EQ(0u, N->getAlignInBits());
950 EXPECT_EQ(0u, N->getEncoding());
951 EXPECT_EQ(0u, N->getLine());
954 typedef MetadataTest DITypeTest;
956 TEST_F(DITypeTest, clone) {
957 // Check that DIType has a specialized clone that returns TempDIType.
958 DIType *N = DIBasicType::get(Context, dwarf::DW_TAG_base_type, "int", 32, 32,
959 dwarf::DW_ATE_signed);
961 TempDIType Temp = N->clone();
962 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
965 TEST_F(DITypeTest, setFlags) {
967 Metadata *TypesOps[] = {nullptr};
968 Metadata *Types = MDTuple::get(Context, TypesOps);
970 DIType *D = DISubroutineType::getDistinct(Context, 0u, Types);
971 EXPECT_EQ(0u, D->getFlags());
972 D->setFlags(DINode::FlagRValueReference);
973 EXPECT_EQ(DINode::FlagRValueReference, D->getFlags());
975 EXPECT_EQ(0u, D->getFlags());
977 TempDIType T = DISubroutineType::getTemporary(Context, 0u, Types);
978 EXPECT_EQ(0u, T->getFlags());
979 T->setFlags(DINode::FlagRValueReference);
980 EXPECT_EQ(DINode::FlagRValueReference, T->getFlags());
982 EXPECT_EQ(0u, T->getFlags());
985 typedef MetadataTest DIDerivedTypeTest;
987 TEST_F(DIDerivedTypeTest, get) {
988 DIFile *File = getFile();
989 DIScopeRef Scope = getSubprogramRef();
990 DITypeRef BaseType = getBasicType("basic");
991 MDTuple *ExtraData = getTuple();
993 auto *N = DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "something",
994 File, 1, Scope, BaseType, 2, 3, 4, 5, ExtraData);
995 EXPECT_EQ(dwarf::DW_TAG_pointer_type, N->getTag());
996 EXPECT_EQ("something", N->getName());
997 EXPECT_EQ(File, N->getFile());
998 EXPECT_EQ(1u, N->getLine());
999 EXPECT_EQ(Scope, N->getScope());
1000 EXPECT_EQ(BaseType, N->getBaseType());
1001 EXPECT_EQ(2u, N->getSizeInBits());
1002 EXPECT_EQ(3u, N->getAlignInBits());
1003 EXPECT_EQ(4u, N->getOffsetInBits());
1004 EXPECT_EQ(5u, N->getFlags());
1005 EXPECT_EQ(ExtraData, N->getExtraData());
1006 EXPECT_EQ(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1007 "something", File, 1, Scope, BaseType, 2, 3,
1010 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_reference_type,
1011 "something", File, 1, Scope, BaseType, 2, 3,
1013 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "else",
1014 File, 1, Scope, BaseType, 2, 3, 4, 5,
1016 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1017 "something", getFile(), 1, Scope, BaseType, 2,
1018 3, 4, 5, ExtraData));
1019 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1020 "something", File, 2, Scope, BaseType, 2, 3,
1022 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1023 "something", File, 1, getSubprogramRef(),
1024 BaseType, 2, 3, 4, 5, ExtraData));
1025 EXPECT_NE(N, DIDerivedType::get(
1026 Context, dwarf::DW_TAG_pointer_type, "something", File, 1,
1027 Scope, getBasicType("basic2"), 2, 3, 4, 5, ExtraData));
1028 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1029 "something", File, 1, Scope, BaseType, 3, 3,
1031 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1032 "something", File, 1, Scope, BaseType, 2, 2,
1034 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1035 "something", File, 1, Scope, BaseType, 2, 3,
1037 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1038 "something", File, 1, Scope, BaseType, 2, 3,
1040 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1041 "something", File, 1, Scope, BaseType, 2, 3,
1044 TempDIDerivedType Temp = N->clone();
1045 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1048 TEST_F(DIDerivedTypeTest, getWithLargeValues) {
1049 DIFile *File = getFile();
1050 DIScopeRef Scope = getSubprogramRef();
1051 DITypeRef BaseType = getBasicType("basic");
1052 MDTuple *ExtraData = getTuple();
1054 auto *N = DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "something",
1055 File, 1, Scope, BaseType, UINT64_MAX,
1056 UINT64_MAX - 1, UINT64_MAX - 2, 5, ExtraData);
1057 EXPECT_EQ(UINT64_MAX, N->getSizeInBits());
1058 EXPECT_EQ(UINT64_MAX - 1, N->getAlignInBits());
1059 EXPECT_EQ(UINT64_MAX - 2, N->getOffsetInBits());
1062 typedef MetadataTest DICompositeTypeTest;
1064 TEST_F(DICompositeTypeTest, get) {
1065 unsigned Tag = dwarf::DW_TAG_structure_type;
1066 StringRef Name = "some name";
1067 DIFile *File = getFile();
1069 DIScopeRef Scope = getSubprogramRef();
1070 DITypeRef BaseType = getCompositeType();
1071 uint64_t SizeInBits = 2;
1072 uint64_t AlignInBits = 3;
1073 uint64_t OffsetInBits = 4;
1075 MDTuple *Elements = getTuple();
1076 unsigned RuntimeLang = 6;
1077 DITypeRef VTableHolder = getCompositeType();
1078 MDTuple *TemplateParams = getTuple();
1079 StringRef Identifier = "some id";
1081 auto *N = DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1082 BaseType, SizeInBits, AlignInBits,
1083 OffsetInBits, Flags, Elements, RuntimeLang,
1084 VTableHolder, TemplateParams, Identifier);
1085 EXPECT_EQ(Tag, N->getTag());
1086 EXPECT_EQ(Name, N->getName());
1087 EXPECT_EQ(File, N->getFile());
1088 EXPECT_EQ(Line, N->getLine());
1089 EXPECT_EQ(Scope, N->getScope());
1090 EXPECT_EQ(BaseType, N->getBaseType());
1091 EXPECT_EQ(SizeInBits, N->getSizeInBits());
1092 EXPECT_EQ(AlignInBits, N->getAlignInBits());
1093 EXPECT_EQ(OffsetInBits, N->getOffsetInBits());
1094 EXPECT_EQ(Flags, N->getFlags());
1095 EXPECT_EQ(Elements, N->getElements().get());
1096 EXPECT_EQ(RuntimeLang, N->getRuntimeLang());
1097 EXPECT_EQ(VTableHolder, N->getVTableHolder());
1098 EXPECT_EQ(TemplateParams, N->getTemplateParams().get());
1099 EXPECT_EQ(Identifier, N->getIdentifier());
1101 EXPECT_EQ(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1102 BaseType, SizeInBits, AlignInBits,
1103 OffsetInBits, Flags, Elements, RuntimeLang,
1104 VTableHolder, TemplateParams, Identifier));
1106 EXPECT_NE(N, DICompositeType::get(Context, Tag + 1, Name, File, Line, Scope,
1107 BaseType, SizeInBits, AlignInBits,
1108 OffsetInBits, Flags, Elements, RuntimeLang,
1109 VTableHolder, TemplateParams, Identifier));
1110 EXPECT_NE(N, DICompositeType::get(Context, Tag, "abc", File, Line, Scope,
1111 BaseType, SizeInBits, AlignInBits,
1112 OffsetInBits, Flags, Elements, RuntimeLang,
1113 VTableHolder, TemplateParams, Identifier));
1114 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, getFile(), Line, Scope,
1115 BaseType, SizeInBits, AlignInBits,
1116 OffsetInBits, Flags, Elements, RuntimeLang,
1117 VTableHolder, TemplateParams, Identifier));
1118 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line + 1, Scope,
1119 BaseType, SizeInBits, AlignInBits,
1120 OffsetInBits, Flags, Elements, RuntimeLang,
1121 VTableHolder, TemplateParams, Identifier));
1122 EXPECT_NE(N, DICompositeType::get(
1123 Context, Tag, Name, File, Line, getSubprogramRef(), BaseType,
1124 SizeInBits, AlignInBits, OffsetInBits, Flags, Elements,
1125 RuntimeLang, VTableHolder, TemplateParams, Identifier));
1126 EXPECT_NE(N, DICompositeType::get(
1127 Context, Tag, Name, File, Line, Scope, getBasicType("other"),
1128 SizeInBits, AlignInBits, OffsetInBits, Flags, Elements,
1129 RuntimeLang, VTableHolder, TemplateParams, Identifier));
1130 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1131 BaseType, SizeInBits + 1, AlignInBits,
1132 OffsetInBits, Flags, Elements, RuntimeLang,
1133 VTableHolder, TemplateParams, Identifier));
1134 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1135 BaseType, SizeInBits, AlignInBits + 1,
1136 OffsetInBits, Flags, Elements, RuntimeLang,
1137 VTableHolder, TemplateParams, Identifier));
1138 EXPECT_NE(N, DICompositeType::get(
1139 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
1140 AlignInBits, OffsetInBits + 1, Flags, Elements, RuntimeLang,
1141 VTableHolder, TemplateParams, Identifier));
1142 EXPECT_NE(N, DICompositeType::get(
1143 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
1144 AlignInBits, OffsetInBits, Flags + 1, Elements, RuntimeLang,
1145 VTableHolder, TemplateParams, Identifier));
1146 EXPECT_NE(N, DICompositeType::get(
1147 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
1148 AlignInBits, OffsetInBits, Flags, getTuple(), RuntimeLang,
1149 VTableHolder, TemplateParams, Identifier));
1150 EXPECT_NE(N, DICompositeType::get(
1151 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
1152 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang + 1,
1153 VTableHolder, TemplateParams, Identifier));
1154 EXPECT_NE(N, DICompositeType::get(
1155 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
1156 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
1157 getCompositeType(), TemplateParams, Identifier));
1158 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1159 BaseType, SizeInBits, AlignInBits,
1160 OffsetInBits, Flags, Elements, RuntimeLang,
1161 VTableHolder, getTuple(), Identifier));
1162 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1163 BaseType, SizeInBits, AlignInBits,
1164 OffsetInBits, Flags, Elements, RuntimeLang,
1165 VTableHolder, TemplateParams, "other"));
1167 // Be sure that missing identifiers get null pointers.
1168 EXPECT_FALSE(DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1169 BaseType, SizeInBits, AlignInBits,
1170 OffsetInBits, Flags, Elements, RuntimeLang,
1171 VTableHolder, TemplateParams, "")
1172 ->getRawIdentifier());
1173 EXPECT_FALSE(DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1174 BaseType, SizeInBits, AlignInBits,
1175 OffsetInBits, Flags, Elements, RuntimeLang,
1176 VTableHolder, TemplateParams)
1177 ->getRawIdentifier());
1179 TempDICompositeType Temp = N->clone();
1180 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1183 TEST_F(DICompositeTypeTest, getWithLargeValues) {
1184 unsigned Tag = dwarf::DW_TAG_structure_type;
1185 StringRef Name = "some name";
1186 DIFile *File = getFile();
1188 DIScopeRef Scope = getSubprogramRef();
1189 DITypeRef BaseType = getCompositeType();
1190 uint64_t SizeInBits = UINT64_MAX;
1191 uint64_t AlignInBits = UINT64_MAX - 1;
1192 uint64_t OffsetInBits = UINT64_MAX - 2;
1194 MDTuple *Elements = getTuple();
1195 unsigned RuntimeLang = 6;
1196 DITypeRef VTableHolder = getCompositeType();
1197 MDTuple *TemplateParams = getTuple();
1198 StringRef Identifier = "some id";
1200 auto *N = DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1201 BaseType, SizeInBits, AlignInBits,
1202 OffsetInBits, Flags, Elements, RuntimeLang,
1203 VTableHolder, TemplateParams, Identifier);
1204 EXPECT_EQ(SizeInBits, N->getSizeInBits());
1205 EXPECT_EQ(AlignInBits, N->getAlignInBits());
1206 EXPECT_EQ(OffsetInBits, N->getOffsetInBits());
1209 TEST_F(DICompositeTypeTest, replaceOperands) {
1210 unsigned Tag = dwarf::DW_TAG_structure_type;
1211 StringRef Name = "some name";
1212 DIFile *File = getFile();
1214 DIScopeRef Scope = getSubprogramRef();
1215 DITypeRef BaseType = getCompositeType();
1216 uint64_t SizeInBits = 2;
1217 uint64_t AlignInBits = 3;
1218 uint64_t OffsetInBits = 4;
1220 unsigned RuntimeLang = 6;
1221 StringRef Identifier = "some id";
1223 auto *N = DICompositeType::get(
1224 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
1225 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier);
1227 auto *Elements = MDTuple::getDistinct(Context, None);
1228 EXPECT_EQ(nullptr, N->getElements().get());
1229 N->replaceElements(Elements);
1230 EXPECT_EQ(Elements, N->getElements().get());
1231 N->replaceElements(nullptr);
1232 EXPECT_EQ(nullptr, N->getElements().get());
1234 DITypeRef VTableHolder = getCompositeType();
1235 EXPECT_EQ(nullptr, N->getVTableHolder());
1236 N->replaceVTableHolder(VTableHolder);
1237 EXPECT_EQ(VTableHolder, N->getVTableHolder());
1238 N->replaceVTableHolder(nullptr);
1239 EXPECT_EQ(nullptr, N->getVTableHolder());
1241 auto *TemplateParams = MDTuple::getDistinct(Context, None);
1242 EXPECT_EQ(nullptr, N->getTemplateParams().get());
1243 N->replaceTemplateParams(TemplateParams);
1244 EXPECT_EQ(TemplateParams, N->getTemplateParams().get());
1245 N->replaceTemplateParams(nullptr);
1246 EXPECT_EQ(nullptr, N->getTemplateParams().get());
1249 typedef MetadataTest DISubroutineTypeTest;
1251 TEST_F(DISubroutineTypeTest, get) {
1253 MDTuple *TypeArray = getTuple();
1255 auto *N = DISubroutineType::get(Context, Flags, TypeArray);
1256 EXPECT_EQ(dwarf::DW_TAG_subroutine_type, N->getTag());
1257 EXPECT_EQ(Flags, N->getFlags());
1258 EXPECT_EQ(TypeArray, N->getTypeArray().get());
1259 EXPECT_EQ(N, DISubroutineType::get(Context, Flags, TypeArray));
1261 EXPECT_NE(N, DISubroutineType::get(Context, Flags + 1, TypeArray));
1262 EXPECT_NE(N, DISubroutineType::get(Context, Flags, getTuple()));
1264 TempDISubroutineType Temp = N->clone();
1265 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1267 // Test always-empty operands.
1268 EXPECT_EQ(nullptr, N->getScope());
1269 EXPECT_EQ(nullptr, N->getFile());
1270 EXPECT_EQ("", N->getName());
1273 typedef MetadataTest DIFileTest;
1275 TEST_F(DIFileTest, get) {
1276 StringRef Filename = "file";
1277 StringRef Directory = "dir";
1278 auto *N = DIFile::get(Context, Filename, Directory);
1280 EXPECT_EQ(dwarf::DW_TAG_file_type, N->getTag());
1281 EXPECT_EQ(Filename, N->getFilename());
1282 EXPECT_EQ(Directory, N->getDirectory());
1283 EXPECT_EQ(N, DIFile::get(Context, Filename, Directory));
1285 EXPECT_NE(N, DIFile::get(Context, "other", Directory));
1286 EXPECT_NE(N, DIFile::get(Context, Filename, "other"));
1288 TempDIFile Temp = N->clone();
1289 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1292 TEST_F(DIFileTest, ScopeGetFile) {
1293 // Ensure that DIScope::getFile() returns itself.
1294 DIScope *N = DIFile::get(Context, "file", "dir");
1295 EXPECT_EQ(N, N->getFile());
1298 typedef MetadataTest DICompileUnitTest;
1300 TEST_F(DICompileUnitTest, get) {
1301 unsigned SourceLanguage = 1;
1302 DIFile *File = getFile();
1303 StringRef Producer = "some producer";
1304 bool IsOptimized = false;
1305 StringRef Flags = "flag after flag";
1306 unsigned RuntimeVersion = 2;
1307 StringRef SplitDebugFilename = "another/file";
1308 unsigned EmissionKind = 3;
1309 MDTuple *EnumTypes = getTuple();
1310 MDTuple *RetainedTypes = getTuple();
1311 MDTuple *Subprograms = getTuple();
1312 MDTuple *GlobalVariables = getTuple();
1313 MDTuple *ImportedEntities = getTuple();
1314 uint64_t DWOId = 0x10000000c0ffee;
1315 auto *N = DICompileUnit::getDistinct(
1316 Context, SourceLanguage, File, Producer, IsOptimized, Flags,
1317 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes,
1318 RetainedTypes, Subprograms, GlobalVariables, ImportedEntities, DWOId);
1320 EXPECT_EQ(dwarf::DW_TAG_compile_unit, N->getTag());
1321 EXPECT_EQ(SourceLanguage, N->getSourceLanguage());
1322 EXPECT_EQ(File, N->getFile());
1323 EXPECT_EQ(Producer, N->getProducer());
1324 EXPECT_EQ(IsOptimized, N->isOptimized());
1325 EXPECT_EQ(Flags, N->getFlags());
1326 EXPECT_EQ(RuntimeVersion, N->getRuntimeVersion());
1327 EXPECT_EQ(SplitDebugFilename, N->getSplitDebugFilename());
1328 EXPECT_EQ(EmissionKind, N->getEmissionKind());
1329 EXPECT_EQ(EnumTypes, N->getEnumTypes().get());
1330 EXPECT_EQ(RetainedTypes, N->getRetainedTypes().get());
1331 EXPECT_EQ(Subprograms, N->getSubprograms().get());
1332 EXPECT_EQ(GlobalVariables, N->getGlobalVariables().get());
1333 EXPECT_EQ(ImportedEntities, N->getImportedEntities().get());
1334 EXPECT_EQ(DWOId, N->getDWOId());
1336 TempDICompileUnit Temp = N->clone();
1337 EXPECT_EQ(dwarf::DW_TAG_compile_unit, Temp->getTag());
1338 EXPECT_EQ(SourceLanguage, Temp->getSourceLanguage());
1339 EXPECT_EQ(File, Temp->getFile());
1340 EXPECT_EQ(Producer, Temp->getProducer());
1341 EXPECT_EQ(IsOptimized, Temp->isOptimized());
1342 EXPECT_EQ(Flags, Temp->getFlags());
1343 EXPECT_EQ(RuntimeVersion, Temp->getRuntimeVersion());
1344 EXPECT_EQ(SplitDebugFilename, Temp->getSplitDebugFilename());
1345 EXPECT_EQ(EmissionKind, Temp->getEmissionKind());
1346 EXPECT_EQ(EnumTypes, Temp->getEnumTypes().get());
1347 EXPECT_EQ(RetainedTypes, Temp->getRetainedTypes().get());
1348 EXPECT_EQ(Subprograms, Temp->getSubprograms().get());
1349 EXPECT_EQ(GlobalVariables, Temp->getGlobalVariables().get());
1350 EXPECT_EQ(ImportedEntities, Temp->getImportedEntities().get());
1351 EXPECT_EQ(DWOId, Temp->getDWOId());
1353 auto *TempAddress = Temp.get();
1354 auto *Clone = MDNode::replaceWithPermanent(std::move(Temp));
1355 EXPECT_TRUE(Clone->isDistinct());
1356 EXPECT_EQ(TempAddress, Clone);
1359 TEST_F(DICompileUnitTest, replaceArrays) {
1360 unsigned SourceLanguage = 1;
1361 DIFile *File = getFile();
1362 StringRef Producer = "some producer";
1363 bool IsOptimized = false;
1364 StringRef Flags = "flag after flag";
1365 unsigned RuntimeVersion = 2;
1366 StringRef SplitDebugFilename = "another/file";
1367 unsigned EmissionKind = 3;
1368 MDTuple *EnumTypes = MDTuple::getDistinct(Context, None);
1369 MDTuple *RetainedTypes = MDTuple::getDistinct(Context, None);
1370 MDTuple *ImportedEntities = MDTuple::getDistinct(Context, None);
1371 uint64_t DWOId = 0xc0ffee;
1372 auto *N = DICompileUnit::getDistinct(
1373 Context, SourceLanguage, File, Producer, IsOptimized, Flags,
1374 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes,
1375 RetainedTypes, nullptr, nullptr, ImportedEntities, DWOId);
1377 auto *Subprograms = MDTuple::getDistinct(Context, None);
1378 EXPECT_EQ(nullptr, N->getSubprograms().get());
1379 N->replaceSubprograms(Subprograms);
1380 EXPECT_EQ(Subprograms, N->getSubprograms().get());
1381 N->replaceSubprograms(nullptr);
1382 EXPECT_EQ(nullptr, N->getSubprograms().get());
1384 auto *GlobalVariables = MDTuple::getDistinct(Context, None);
1385 EXPECT_EQ(nullptr, N->getGlobalVariables().get());
1386 N->replaceGlobalVariables(GlobalVariables);
1387 EXPECT_EQ(GlobalVariables, N->getGlobalVariables().get());
1388 N->replaceGlobalVariables(nullptr);
1389 EXPECT_EQ(nullptr, N->getGlobalVariables().get());
1392 typedef MetadataTest DISubprogramTest;
1394 TEST_F(DISubprogramTest, get) {
1395 DIScopeRef Scope = getCompositeType();
1396 StringRef Name = "name";
1397 StringRef LinkageName = "linkage";
1398 DIFile *File = getFile();
1400 DISubroutineType *Type = getSubroutineType();
1401 bool IsLocalToUnit = false;
1402 bool IsDefinition = true;
1403 unsigned ScopeLine = 3;
1404 DITypeRef ContainingType = getCompositeType();
1405 unsigned Virtuality = 4;
1406 unsigned VirtualIndex = 5;
1408 bool IsOptimized = false;
1409 MDTuple *TemplateParams = getTuple();
1410 DISubprogram *Declaration = getSubprogram();
1411 MDTuple *Variables = getTuple();
1413 auto *N = DISubprogram::get(
1414 Context, Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1415 IsDefinition, ScopeLine, ContainingType, Virtuality, VirtualIndex, Flags,
1416 IsOptimized, TemplateParams, Declaration, Variables);
1418 EXPECT_EQ(dwarf::DW_TAG_subprogram, N->getTag());
1419 EXPECT_EQ(Scope, N->getScope());
1420 EXPECT_EQ(Name, N->getName());
1421 EXPECT_EQ(LinkageName, N->getLinkageName());
1422 EXPECT_EQ(File, N->getFile());
1423 EXPECT_EQ(Line, N->getLine());
1424 EXPECT_EQ(Type, N->getType());
1425 EXPECT_EQ(IsLocalToUnit, N->isLocalToUnit());
1426 EXPECT_EQ(IsDefinition, N->isDefinition());
1427 EXPECT_EQ(ScopeLine, N->getScopeLine());
1428 EXPECT_EQ(ContainingType, N->getContainingType());
1429 EXPECT_EQ(Virtuality, N->getVirtuality());
1430 EXPECT_EQ(VirtualIndex, N->getVirtualIndex());
1431 EXPECT_EQ(Flags, N->getFlags());
1432 EXPECT_EQ(IsOptimized, N->isOptimized());
1433 EXPECT_EQ(TemplateParams, N->getTemplateParams().get());
1434 EXPECT_EQ(Declaration, N->getDeclaration());
1435 EXPECT_EQ(Variables, N->getVariables().get());
1436 EXPECT_EQ(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1437 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1438 ContainingType, Virtuality, VirtualIndex,
1439 Flags, IsOptimized, TemplateParams,
1440 Declaration, Variables));
1442 EXPECT_NE(N, DISubprogram::get(Context, getCompositeType(), Name, LinkageName,
1443 File, Line, Type, IsLocalToUnit, IsDefinition,
1444 ScopeLine, ContainingType, Virtuality,
1445 VirtualIndex, Flags, IsOptimized,
1446 TemplateParams, Declaration, Variables));
1447 EXPECT_NE(N, DISubprogram::get(Context, Scope, "other", LinkageName, File,
1448 Line, Type, IsLocalToUnit, IsDefinition,
1449 ScopeLine, ContainingType, Virtuality,
1450 VirtualIndex, Flags, IsOptimized,
1451 TemplateParams, Declaration, Variables));
1452 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, "other", File, Line,
1453 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1454 ContainingType, Virtuality, VirtualIndex,
1455 Flags, IsOptimized, TemplateParams,
1456 Declaration, Variables));
1457 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, getFile(),
1458 Line, Type, IsLocalToUnit, IsDefinition,
1459 ScopeLine, ContainingType, Virtuality,
1460 VirtualIndex, Flags, IsOptimized,
1461 TemplateParams, Declaration, Variables));
1462 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File,
1463 Line + 1, Type, IsLocalToUnit, IsDefinition,
1464 ScopeLine, ContainingType, Virtuality,
1465 VirtualIndex, Flags, IsOptimized,
1466 TemplateParams, Declaration, Variables));
1467 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1468 getSubroutineType(), IsLocalToUnit,
1469 IsDefinition, ScopeLine, ContainingType,
1470 Virtuality, VirtualIndex, Flags, IsOptimized,
1471 TemplateParams, Declaration, Variables));
1472 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1473 Type, !IsLocalToUnit, IsDefinition, ScopeLine,
1474 ContainingType, Virtuality, VirtualIndex,
1475 Flags, IsOptimized, TemplateParams,
1476 Declaration, Variables));
1477 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1478 Type, IsLocalToUnit, !IsDefinition, ScopeLine,
1479 ContainingType, Virtuality, VirtualIndex,
1480 Flags, IsOptimized, TemplateParams,
1481 Declaration, Variables));
1482 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1483 Type, IsLocalToUnit, IsDefinition,
1484 ScopeLine + 1, ContainingType, Virtuality,
1485 VirtualIndex, Flags, IsOptimized,
1486 TemplateParams, Declaration, Variables));
1487 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1488 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1489 getCompositeType(), Virtuality, VirtualIndex,
1490 Flags, IsOptimized, TemplateParams,
1491 Declaration, Variables));
1492 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1493 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1494 ContainingType, Virtuality + 1, VirtualIndex,
1495 Flags, IsOptimized, TemplateParams,
1496 Declaration, Variables));
1497 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1498 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1499 ContainingType, Virtuality, VirtualIndex + 1,
1500 Flags, IsOptimized, TemplateParams,
1501 Declaration, Variables));
1502 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1503 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1504 ContainingType, Virtuality, VirtualIndex,
1505 ~Flags, IsOptimized, TemplateParams,
1506 Declaration, Variables));
1507 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1508 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1509 ContainingType, Virtuality, VirtualIndex,
1510 Flags, !IsOptimized, TemplateParams,
1511 Declaration, Variables));
1513 DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1514 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1515 ContainingType, Virtuality, VirtualIndex, Flags,
1516 IsOptimized, getTuple(), Declaration, Variables));
1517 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1518 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1519 ContainingType, Virtuality, VirtualIndex,
1520 Flags, IsOptimized, TemplateParams,
1521 getSubprogram(), Variables));
1522 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1523 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1524 ContainingType, Virtuality, VirtualIndex,
1525 Flags, IsOptimized, TemplateParams,
1526 Declaration, getTuple()));
1528 TempDISubprogram Temp = N->clone();
1529 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1532 typedef MetadataTest DILexicalBlockTest;
1534 TEST_F(DILexicalBlockTest, get) {
1535 DILocalScope *Scope = getSubprogram();
1536 DIFile *File = getFile();
1538 unsigned Column = 8;
1540 auto *N = DILexicalBlock::get(Context, Scope, File, Line, Column);
1542 EXPECT_EQ(dwarf::DW_TAG_lexical_block, N->getTag());
1543 EXPECT_EQ(Scope, N->getScope());
1544 EXPECT_EQ(File, N->getFile());
1545 EXPECT_EQ(Line, N->getLine());
1546 EXPECT_EQ(Column, N->getColumn());
1547 EXPECT_EQ(N, DILexicalBlock::get(Context, Scope, File, Line, Column));
1550 DILexicalBlock::get(Context, getSubprogram(), File, Line, Column));
1551 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, getFile(), Line, Column));
1552 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, File, Line + 1, Column));
1553 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, File, Line, Column + 1));
1555 TempDILexicalBlock Temp = N->clone();
1556 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1559 TEST_F(DILexicalBlockTest, Overflow) {
1560 DISubprogram *SP = getSubprogram();
1561 DIFile *F = getFile();
1563 auto *LB = DILexicalBlock::get(Context, SP, F, 2, 7);
1564 EXPECT_EQ(2u, LB->getLine());
1565 EXPECT_EQ(7u, LB->getColumn());
1567 unsigned U16 = 1u << 16;
1569 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16 - 1);
1570 EXPECT_EQ(UINT32_MAX, LB->getLine());
1571 EXPECT_EQ(U16 - 1, LB->getColumn());
1574 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16);
1575 EXPECT_EQ(UINT32_MAX, LB->getLine());
1576 EXPECT_EQ(0u, LB->getColumn());
1579 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16 + 1);
1580 EXPECT_EQ(UINT32_MAX, LB->getLine());
1581 EXPECT_EQ(0u, LB->getColumn());
1585 typedef MetadataTest DILexicalBlockFileTest;
1587 TEST_F(DILexicalBlockFileTest, get) {
1588 DILocalScope *Scope = getSubprogram();
1589 DIFile *File = getFile();
1590 unsigned Discriminator = 5;
1592 auto *N = DILexicalBlockFile::get(Context, Scope, File, Discriminator);
1594 EXPECT_EQ(dwarf::DW_TAG_lexical_block, N->getTag());
1595 EXPECT_EQ(Scope, N->getScope());
1596 EXPECT_EQ(File, N->getFile());
1597 EXPECT_EQ(Discriminator, N->getDiscriminator());
1598 EXPECT_EQ(N, DILexicalBlockFile::get(Context, Scope, File, Discriminator));
1600 EXPECT_NE(N, DILexicalBlockFile::get(Context, getSubprogram(), File,
1603 DILexicalBlockFile::get(Context, Scope, getFile(), Discriminator));
1605 DILexicalBlockFile::get(Context, Scope, File, Discriminator + 1));
1607 TempDILexicalBlockFile Temp = N->clone();
1608 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1611 typedef MetadataTest DINamespaceTest;
1613 TEST_F(DINamespaceTest, get) {
1614 DIScope *Scope = getFile();
1615 DIFile *File = getFile();
1616 StringRef Name = "namespace";
1619 auto *N = DINamespace::get(Context, Scope, File, Name, Line);
1621 EXPECT_EQ(dwarf::DW_TAG_namespace, N->getTag());
1622 EXPECT_EQ(Scope, N->getScope());
1623 EXPECT_EQ(File, N->getFile());
1624 EXPECT_EQ(Name, N->getName());
1625 EXPECT_EQ(Line, N->getLine());
1626 EXPECT_EQ(N, DINamespace::get(Context, Scope, File, Name, Line));
1628 EXPECT_NE(N, DINamespace::get(Context, getFile(), File, Name, Line));
1629 EXPECT_NE(N, DINamespace::get(Context, Scope, getFile(), Name, Line));
1630 EXPECT_NE(N, DINamespace::get(Context, Scope, File, "other", Line));
1631 EXPECT_NE(N, DINamespace::get(Context, Scope, File, Name, Line + 1));
1633 TempDINamespace Temp = N->clone();
1634 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1637 typedef MetadataTest DIModuleTest;
1639 TEST_F(DIModuleTest, get) {
1640 DIScope *Scope = getFile();
1641 StringRef Name = "module";
1642 StringRef ConfigMacro = "-DNDEBUG";
1643 StringRef Includes = "-I.";
1644 StringRef Sysroot = "/";
1646 auto *N = DIModule::get(Context, Scope, Name, ConfigMacro, Includes, Sysroot);
1648 EXPECT_EQ(dwarf::DW_TAG_module, N->getTag());
1649 EXPECT_EQ(Scope, N->getScope());
1650 EXPECT_EQ(Name, N->getName());
1651 EXPECT_EQ(ConfigMacro, N->getConfigurationMacros());
1652 EXPECT_EQ(Includes, N->getIncludePath());
1653 EXPECT_EQ(Sysroot, N->getISysRoot());
1654 EXPECT_EQ(N, DIModule::get(Context, Scope, Name,
1655 ConfigMacro, Includes, Sysroot));
1656 EXPECT_NE(N, DIModule::get(Context, getFile(), Name,
1657 ConfigMacro, Includes, Sysroot));
1658 EXPECT_NE(N, DIModule::get(Context, Scope, "other",
1659 ConfigMacro, Includes, Sysroot));
1660 EXPECT_NE(N, DIModule::get(Context, Scope, Name,
1661 "other", Includes, Sysroot));
1662 EXPECT_NE(N, DIModule::get(Context, Scope, Name,
1663 ConfigMacro, "other", Sysroot));
1664 EXPECT_NE(N, DIModule::get(Context, Scope, Name,
1665 ConfigMacro, Includes, "other"));
1667 TempDIModule Temp = N->clone();
1668 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1671 typedef MetadataTest DITemplateTypeParameterTest;
1673 TEST_F(DITemplateTypeParameterTest, get) {
1674 StringRef Name = "template";
1675 DITypeRef Type = getBasicType("basic");
1677 auto *N = DITemplateTypeParameter::get(Context, Name, Type);
1679 EXPECT_EQ(dwarf::DW_TAG_template_type_parameter, N->getTag());
1680 EXPECT_EQ(Name, N->getName());
1681 EXPECT_EQ(Type, N->getType());
1682 EXPECT_EQ(N, DITemplateTypeParameter::get(Context, Name, Type));
1684 EXPECT_NE(N, DITemplateTypeParameter::get(Context, "other", Type));
1686 DITemplateTypeParameter::get(Context, Name, getBasicType("other")));
1688 TempDITemplateTypeParameter Temp = N->clone();
1689 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1692 typedef MetadataTest DITemplateValueParameterTest;
1694 TEST_F(DITemplateValueParameterTest, get) {
1695 unsigned Tag = dwarf::DW_TAG_template_value_parameter;
1696 StringRef Name = "template";
1697 DITypeRef Type = getBasicType("basic");
1698 Metadata *Value = getConstantAsMetadata();
1700 auto *N = DITemplateValueParameter::get(Context, Tag, Name, Type, Value);
1701 EXPECT_EQ(Tag, N->getTag());
1702 EXPECT_EQ(Name, N->getName());
1703 EXPECT_EQ(Type, N->getType());
1704 EXPECT_EQ(Value, N->getValue());
1705 EXPECT_EQ(N, DITemplateValueParameter::get(Context, Tag, Name, Type, Value));
1707 EXPECT_NE(N, DITemplateValueParameter::get(
1708 Context, dwarf::DW_TAG_GNU_template_template_param, Name,
1711 DITemplateValueParameter::get(Context, Tag, "other", Type, Value));
1712 EXPECT_NE(N, DITemplateValueParameter::get(Context, Tag, Name,
1713 getBasicType("other"), Value));
1714 EXPECT_NE(N, DITemplateValueParameter::get(Context, Tag, Name, Type,
1715 getConstantAsMetadata()));
1717 TempDITemplateValueParameter Temp = N->clone();
1718 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1721 typedef MetadataTest DIGlobalVariableTest;
1723 TEST_F(DIGlobalVariableTest, get) {
1724 DIScope *Scope = getSubprogram();
1725 StringRef Name = "name";
1726 StringRef LinkageName = "linkage";
1727 DIFile *File = getFile();
1729 DITypeRef Type = getDerivedType();
1730 bool IsLocalToUnit = false;
1731 bool IsDefinition = true;
1732 Constant *Variable = getConstant();
1733 DIDerivedType *StaticDataMemberDeclaration =
1734 cast<DIDerivedType>(getDerivedType());
1736 auto *N = DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, Line,
1737 Type, IsLocalToUnit, IsDefinition, Variable,
1738 StaticDataMemberDeclaration);
1739 EXPECT_EQ(dwarf::DW_TAG_variable, N->getTag());
1740 EXPECT_EQ(Scope, N->getScope());
1741 EXPECT_EQ(Name, N->getName());
1742 EXPECT_EQ(LinkageName, N->getLinkageName());
1743 EXPECT_EQ(File, N->getFile());
1744 EXPECT_EQ(Line, N->getLine());
1745 EXPECT_EQ(Type, N->getType());
1746 EXPECT_EQ(IsLocalToUnit, N->isLocalToUnit());
1747 EXPECT_EQ(IsDefinition, N->isDefinition());
1748 EXPECT_EQ(Variable, N->getVariable());
1749 EXPECT_EQ(StaticDataMemberDeclaration, N->getStaticDataMemberDeclaration());
1750 EXPECT_EQ(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File,
1751 Line, Type, IsLocalToUnit, IsDefinition,
1752 Variable, StaticDataMemberDeclaration));
1755 DIGlobalVariable::get(Context, getSubprogram(), Name, LinkageName,
1756 File, Line, Type, IsLocalToUnit, IsDefinition,
1757 Variable, StaticDataMemberDeclaration));
1758 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, "other", LinkageName, File,
1759 Line, Type, IsLocalToUnit, IsDefinition,
1760 Variable, StaticDataMemberDeclaration));
1761 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, "other", File, Line,
1762 Type, IsLocalToUnit, IsDefinition,
1763 Variable, StaticDataMemberDeclaration));
1765 DIGlobalVariable::get(Context, Scope, Name, LinkageName, getFile(),
1766 Line, Type, IsLocalToUnit, IsDefinition,
1767 Variable, StaticDataMemberDeclaration));
1769 DIGlobalVariable::get(Context, Scope, Name, LinkageName, File,
1770 Line + 1, Type, IsLocalToUnit, IsDefinition,
1771 Variable, StaticDataMemberDeclaration));
1773 DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, Line,
1774 getDerivedType(), IsLocalToUnit, IsDefinition,
1775 Variable, StaticDataMemberDeclaration));
1776 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File,
1777 Line, Type, !IsLocalToUnit, IsDefinition,
1778 Variable, StaticDataMemberDeclaration));
1779 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File,
1780 Line, Type, IsLocalToUnit, !IsDefinition,
1781 Variable, StaticDataMemberDeclaration));
1783 DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, Line,
1784 Type, IsLocalToUnit, IsDefinition,
1785 getConstant(), StaticDataMemberDeclaration));
1787 DIGlobalVariable::get(Context, Scope, Name, LinkageName, File, Line,
1788 Type, IsLocalToUnit, IsDefinition, Variable,
1789 cast<DIDerivedType>(getDerivedType())));
1791 TempDIGlobalVariable Temp = N->clone();
1792 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1795 typedef MetadataTest DILocalVariableTest;
1797 TEST_F(DILocalVariableTest, get) {
1798 DILocalScope *Scope = getSubprogram();
1799 StringRef Name = "name";
1800 DIFile *File = getFile();
1802 DITypeRef Type = getDerivedType();
1807 DILocalVariable::get(Context, Scope, Name, File, Line, Type, Arg, Flags);
1808 EXPECT_TRUE(N->isParameter());
1809 EXPECT_EQ(Scope, N->getScope());
1810 EXPECT_EQ(Name, N->getName());
1811 EXPECT_EQ(File, N->getFile());
1812 EXPECT_EQ(Line, N->getLine());
1813 EXPECT_EQ(Type, N->getType());
1814 EXPECT_EQ(Arg, N->getArg());
1815 EXPECT_EQ(Flags, N->getFlags());
1816 EXPECT_EQ(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type, Arg,
1820 DILocalVariable::get(Context, Scope, Name, File, Line, Type, 0, Flags)
1822 EXPECT_NE(N, DILocalVariable::get(Context, getSubprogram(), Name, File, Line,
1824 EXPECT_NE(N, DILocalVariable::get(Context, Scope, "other", File, Line, Type,
1826 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, getFile(), Line, Type,
1828 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line + 1, Type,
1830 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line,
1831 getDerivedType(), Arg, Flags));
1832 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type,
1834 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type, Arg,
1837 TempDILocalVariable Temp = N->clone();
1838 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1841 TEST_F(DILocalVariableTest, getArg256) {
1842 EXPECT_EQ(255u, DILocalVariable::get(Context, getSubprogram(), "", getFile(),
1845 EXPECT_EQ(256u, DILocalVariable::get(Context, getSubprogram(), "", getFile(),
1848 EXPECT_EQ(257u, DILocalVariable::get(Context, getSubprogram(), "", getFile(),
1851 unsigned Max = UINT16_MAX;
1852 EXPECT_EQ(Max, DILocalVariable::get(Context, getSubprogram(), "", getFile(),
1857 typedef MetadataTest DIExpressionTest;
1859 TEST_F(DIExpressionTest, get) {
1860 uint64_t Elements[] = {2, 6, 9, 78, 0};
1861 auto *N = DIExpression::get(Context, Elements);
1862 EXPECT_EQ(makeArrayRef(Elements), N->getElements());
1863 EXPECT_EQ(N, DIExpression::get(Context, Elements));
1865 EXPECT_EQ(5u, N->getNumElements());
1866 EXPECT_EQ(2u, N->getElement(0));
1867 EXPECT_EQ(6u, N->getElement(1));
1868 EXPECT_EQ(9u, N->getElement(2));
1869 EXPECT_EQ(78u, N->getElement(3));
1870 EXPECT_EQ(0u, N->getElement(4));
1872 TempDIExpression Temp = N->clone();
1873 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1876 TEST_F(DIExpressionTest, isValid) {
1877 #define EXPECT_VALID(...) \
1879 uint64_t Elements[] = {__VA_ARGS__}; \
1880 EXPECT_TRUE(DIExpression::get(Context, Elements)->isValid()); \
1882 #define EXPECT_INVALID(...) \
1884 uint64_t Elements[] = {__VA_ARGS__}; \
1885 EXPECT_FALSE(DIExpression::get(Context, Elements)->isValid()); \
1888 // Empty expression should be valid.
1889 EXPECT_TRUE(DIExpression::get(Context, None));
1891 // Valid constructions.
1892 EXPECT_VALID(dwarf::DW_OP_plus, 6);
1893 EXPECT_VALID(dwarf::DW_OP_deref);
1894 EXPECT_VALID(dwarf::DW_OP_bit_piece, 3, 7);
1895 EXPECT_VALID(dwarf::DW_OP_plus, 6, dwarf::DW_OP_deref);
1896 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_plus, 6);
1897 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_bit_piece, 3, 7);
1898 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_plus, 6, dwarf::DW_OP_bit_piece, 3, 7);
1900 // Invalid constructions.
1901 EXPECT_INVALID(~0u);
1902 EXPECT_INVALID(dwarf::DW_OP_plus);
1903 EXPECT_INVALID(dwarf::DW_OP_bit_piece);
1904 EXPECT_INVALID(dwarf::DW_OP_bit_piece, 3);
1905 EXPECT_INVALID(dwarf::DW_OP_bit_piece, 3, 7, dwarf::DW_OP_plus, 3);
1906 EXPECT_INVALID(dwarf::DW_OP_bit_piece, 3, 7, dwarf::DW_OP_deref);
1909 #undef EXPECT_INVALID
1912 typedef MetadataTest DIObjCPropertyTest;
1914 TEST_F(DIObjCPropertyTest, get) {
1915 StringRef Name = "name";
1916 DIFile *File = getFile();
1918 StringRef GetterName = "getter";
1919 StringRef SetterName = "setter";
1920 unsigned Attributes = 7;
1921 DITypeRef Type = getBasicType("basic");
1923 auto *N = DIObjCProperty::get(Context, Name, File, Line, GetterName,
1924 SetterName, Attributes, Type);
1926 EXPECT_EQ(dwarf::DW_TAG_APPLE_property, N->getTag());
1927 EXPECT_EQ(Name, N->getName());
1928 EXPECT_EQ(File, N->getFile());
1929 EXPECT_EQ(Line, N->getLine());
1930 EXPECT_EQ(GetterName, N->getGetterName());
1931 EXPECT_EQ(SetterName, N->getSetterName());
1932 EXPECT_EQ(Attributes, N->getAttributes());
1933 EXPECT_EQ(Type, N->getType());
1934 EXPECT_EQ(N, DIObjCProperty::get(Context, Name, File, Line, GetterName,
1935 SetterName, Attributes, Type));
1937 EXPECT_NE(N, DIObjCProperty::get(Context, "other", File, Line, GetterName,
1938 SetterName, Attributes, Type));
1939 EXPECT_NE(N, DIObjCProperty::get(Context, Name, getFile(), Line, GetterName,
1940 SetterName, Attributes, Type));
1941 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line + 1, GetterName,
1942 SetterName, Attributes, Type));
1943 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, "other",
1944 SetterName, Attributes, Type));
1945 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName,
1946 "other", Attributes, Type));
1947 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName,
1948 SetterName, Attributes + 1, Type));
1949 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName,
1950 SetterName, Attributes,
1951 getBasicType("other")));
1953 TempDIObjCProperty Temp = N->clone();
1954 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1957 typedef MetadataTest DIImportedEntityTest;
1959 TEST_F(DIImportedEntityTest, get) {
1960 unsigned Tag = dwarf::DW_TAG_imported_module;
1961 DIScope *Scope = getSubprogram();
1962 DINodeRef Entity = getCompositeType();
1964 StringRef Name = "name";
1966 auto *N = DIImportedEntity::get(Context, Tag, Scope, Entity, Line, Name);
1968 EXPECT_EQ(Tag, N->getTag());
1969 EXPECT_EQ(Scope, N->getScope());
1970 EXPECT_EQ(Entity, N->getEntity());
1971 EXPECT_EQ(Line, N->getLine());
1972 EXPECT_EQ(Name, N->getName());
1973 EXPECT_EQ(N, DIImportedEntity::get(Context, Tag, Scope, Entity, Line, Name));
1976 DIImportedEntity::get(Context, dwarf::DW_TAG_imported_declaration,
1977 Scope, Entity, Line, Name));
1978 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, getSubprogram(), Entity,
1980 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, getCompositeType(),
1983 DIImportedEntity::get(Context, Tag, Scope, Entity, Line + 1, Name));
1985 DIImportedEntity::get(Context, Tag, Scope, Entity, Line, "other"));
1987 TempDIImportedEntity Temp = N->clone();
1988 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1991 typedef MetadataTest MetadataAsValueTest;
1993 TEST_F(MetadataAsValueTest, MDNode) {
1994 MDNode *N = MDNode::get(Context, None);
1995 auto *V = MetadataAsValue::get(Context, N);
1996 EXPECT_TRUE(V->getType()->isMetadataTy());
1997 EXPECT_EQ(N, V->getMetadata());
1999 auto *V2 = MetadataAsValue::get(Context, N);
2003 TEST_F(MetadataAsValueTest, MDNodeMDNode) {
2004 MDNode *N = MDNode::get(Context, None);
2005 Metadata *Ops[] = {N};
2006 MDNode *N2 = MDNode::get(Context, Ops);
2007 auto *V = MetadataAsValue::get(Context, N2);
2008 EXPECT_TRUE(V->getType()->isMetadataTy());
2009 EXPECT_EQ(N2, V->getMetadata());
2011 auto *V2 = MetadataAsValue::get(Context, N2);
2014 auto *V3 = MetadataAsValue::get(Context, N);
2015 EXPECT_TRUE(V3->getType()->isMetadataTy());
2017 EXPECT_EQ(N, V3->getMetadata());
2020 TEST_F(MetadataAsValueTest, MDNodeConstant) {
2021 auto *C = ConstantInt::getTrue(Context);
2022 auto *MD = ConstantAsMetadata::get(C);
2023 Metadata *Ops[] = {MD};
2024 auto *N = MDNode::get(Context, Ops);
2026 auto *V = MetadataAsValue::get(Context, MD);
2027 EXPECT_TRUE(V->getType()->isMetadataTy());
2028 EXPECT_EQ(MD, V->getMetadata());
2030 auto *V2 = MetadataAsValue::get(Context, N);
2031 EXPECT_EQ(MD, V2->getMetadata());
2035 typedef MetadataTest ValueAsMetadataTest;
2037 TEST_F(ValueAsMetadataTest, UpdatesOnRAUW) {
2038 Type *Ty = Type::getInt1PtrTy(Context);
2039 std::unique_ptr<GlobalVariable> GV0(
2040 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
2041 auto *MD = ValueAsMetadata::get(GV0.get());
2042 EXPECT_TRUE(MD->getValue() == GV0.get());
2043 ASSERT_TRUE(GV0->use_empty());
2045 std::unique_ptr<GlobalVariable> GV1(
2046 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
2047 GV0->replaceAllUsesWith(GV1.get());
2048 EXPECT_TRUE(MD->getValue() == GV1.get());
2051 TEST_F(ValueAsMetadataTest, CollidingDoubleUpdates) {
2052 // Create a constant.
2053 ConstantAsMetadata *CI = ConstantAsMetadata::get(
2054 ConstantInt::get(getGlobalContext(), APInt(8, 0)));
2056 // Create a temporary to prevent nodes from resolving.
2057 auto Temp = MDTuple::getTemporary(Context, None);
2059 // When the first operand of N1 gets reset to nullptr, it'll collide with N2.
2060 Metadata *Ops1[] = {CI, CI, Temp.get()};
2061 Metadata *Ops2[] = {nullptr, CI, Temp.get()};
2063 auto *N1 = MDTuple::get(Context, Ops1);
2064 auto *N2 = MDTuple::get(Context, Ops2);
2067 // Tell metadata that the constant is getting deleted.
2069 // After this, N1 will be invalid, so don't touch it.
2070 ValueAsMetadata::handleDeletion(CI->getValue());
2071 EXPECT_EQ(nullptr, N2->getOperand(0));
2072 EXPECT_EQ(nullptr, N2->getOperand(1));
2073 EXPECT_EQ(Temp.get(), N2->getOperand(2));
2075 // Clean up Temp for teardown.
2076 Temp->replaceAllUsesWith(nullptr);
2079 typedef MetadataTest TrackingMDRefTest;
2081 TEST_F(TrackingMDRefTest, UpdatesOnRAUW) {
2082 Type *Ty = Type::getInt1PtrTy(Context);
2083 std::unique_ptr<GlobalVariable> GV0(
2084 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
2085 TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV0.get()));
2086 EXPECT_TRUE(MD->getValue() == GV0.get());
2087 ASSERT_TRUE(GV0->use_empty());
2089 std::unique_ptr<GlobalVariable> GV1(
2090 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
2091 GV0->replaceAllUsesWith(GV1.get());
2092 EXPECT_TRUE(MD->getValue() == GV1.get());
2094 // Reset it, so we don't inadvertently test deletion.
2098 TEST_F(TrackingMDRefTest, UpdatesOnDeletion) {
2099 Type *Ty = Type::getInt1PtrTy(Context);
2100 std::unique_ptr<GlobalVariable> GV(
2101 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
2102 TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV.get()));
2103 EXPECT_TRUE(MD->getValue() == GV.get());
2104 ASSERT_TRUE(GV->use_empty());
2110 TEST(NamedMDNodeTest, Search) {
2111 LLVMContext Context;
2112 ConstantAsMetadata *C =
2113 ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 1));
2114 ConstantAsMetadata *C2 =
2115 ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 2));
2117 Metadata *const V = C;
2118 Metadata *const V2 = C2;
2119 MDNode *n = MDNode::get(Context, V);
2120 MDNode *n2 = MDNode::get(Context, V2);
2122 Module M("MyModule", Context);
2123 const char *Name = "llvm.NMD1";
2124 NamedMDNode *NMD = M.getOrInsertNamedMetadata(Name);
2126 NMD->addOperand(n2);
2129 raw_string_ostream oss(Str);
2131 EXPECT_STREQ("!llvm.NMD1 = !{!0, !1}\n",
2135 typedef MetadataTest FunctionAttachmentTest;
2136 TEST_F(FunctionAttachmentTest, setMetadata) {
2137 Function *F = getFunction("foo");
2138 ASSERT_FALSE(F->hasMetadata());
2139 EXPECT_EQ(nullptr, F->getMetadata(LLVMContext::MD_dbg));
2140 EXPECT_EQ(nullptr, F->getMetadata("dbg"));
2141 EXPECT_EQ(nullptr, F->getMetadata("other"));
2143 DISubprogram *SP1 = getSubprogram();
2144 DISubprogram *SP2 = getSubprogram();
2145 ASSERT_NE(SP1, SP2);
2147 F->setMetadata("dbg", SP1);
2148 EXPECT_TRUE(F->hasMetadata());
2149 EXPECT_EQ(SP1, F->getMetadata(LLVMContext::MD_dbg));
2150 EXPECT_EQ(SP1, F->getMetadata("dbg"));
2151 EXPECT_EQ(nullptr, F->getMetadata("other"));
2153 F->setMetadata(LLVMContext::MD_dbg, SP2);
2154 EXPECT_TRUE(F->hasMetadata());
2155 EXPECT_EQ(SP2, F->getMetadata(LLVMContext::MD_dbg));
2156 EXPECT_EQ(SP2, F->getMetadata("dbg"));
2157 EXPECT_EQ(nullptr, F->getMetadata("other"));
2159 F->setMetadata("dbg", nullptr);
2160 EXPECT_FALSE(F->hasMetadata());
2161 EXPECT_EQ(nullptr, F->getMetadata(LLVMContext::MD_dbg));
2162 EXPECT_EQ(nullptr, F->getMetadata("dbg"));
2163 EXPECT_EQ(nullptr, F->getMetadata("other"));
2165 MDTuple *T1 = getTuple();
2166 MDTuple *T2 = getTuple();
2169 F->setMetadata("other1", T1);
2170 F->setMetadata("other2", T2);
2171 EXPECT_TRUE(F->hasMetadata());
2172 EXPECT_EQ(T1, F->getMetadata("other1"));
2173 EXPECT_EQ(T2, F->getMetadata("other2"));
2174 EXPECT_EQ(nullptr, F->getMetadata("dbg"));
2176 F->setMetadata("other1", T2);
2177 F->setMetadata("other2", T1);
2178 EXPECT_EQ(T2, F->getMetadata("other1"));
2179 EXPECT_EQ(T1, F->getMetadata("other2"));
2181 F->setMetadata("other1", nullptr);
2182 F->setMetadata("other2", nullptr);
2183 EXPECT_FALSE(F->hasMetadata());
2184 EXPECT_EQ(nullptr, F->getMetadata("other1"));
2185 EXPECT_EQ(nullptr, F->getMetadata("other2"));
2188 TEST_F(FunctionAttachmentTest, getAll) {
2189 Function *F = getFunction("foo");
2191 MDTuple *T1 = getTuple();
2192 MDTuple *T2 = getTuple();
2193 MDTuple *P = getTuple();
2194 DISubprogram *SP = getSubprogram();
2196 F->setMetadata("other1", T2);
2197 F->setMetadata(LLVMContext::MD_dbg, SP);
2198 F->setMetadata("other2", T1);
2199 F->setMetadata(LLVMContext::MD_prof, P);
2200 F->setMetadata("other2", T2);
2201 F->setMetadata("other1", T1);
2203 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2204 F->getAllMetadata(MDs);
2205 ASSERT_EQ(4u, MDs.size());
2206 EXPECT_EQ(LLVMContext::MD_dbg, MDs[0].first);
2207 EXPECT_EQ(LLVMContext::MD_prof, MDs[1].first);
2208 EXPECT_EQ(Context.getMDKindID("other1"), MDs[2].first);
2209 EXPECT_EQ(Context.getMDKindID("other2"), MDs[3].first);
2210 EXPECT_EQ(SP, MDs[0].second);
2211 EXPECT_EQ(P, MDs[1].second);
2212 EXPECT_EQ(T1, MDs[2].second);
2213 EXPECT_EQ(T2, MDs[3].second);
2216 TEST_F(FunctionAttachmentTest, dropUnknownMetadata) {
2217 Function *F = getFunction("foo");
2219 MDTuple *T1 = getTuple();
2220 MDTuple *T2 = getTuple();
2221 MDTuple *P = getTuple();
2222 DISubprogram *SP = getSubprogram();
2224 F->setMetadata("other1", T1);
2225 F->setMetadata(LLVMContext::MD_dbg, SP);
2226 F->setMetadata("other2", T2);
2227 F->setMetadata(LLVMContext::MD_prof, P);
2229 unsigned Known[] = {Context.getMDKindID("other2"), LLVMContext::MD_prof};
2230 F->dropUnknownMetadata(Known);
2232 EXPECT_EQ(T2, F->getMetadata("other2"));
2233 EXPECT_EQ(P, F->getMetadata(LLVMContext::MD_prof));
2234 EXPECT_EQ(nullptr, F->getMetadata("other1"));
2235 EXPECT_EQ(nullptr, F->getMetadata(LLVMContext::MD_dbg));
2237 F->setMetadata("other2", nullptr);
2238 F->setMetadata(LLVMContext::MD_prof, nullptr);
2239 EXPECT_FALSE(F->hasMetadata());
2242 TEST_F(FunctionAttachmentTest, Verifier) {
2243 Function *F = getFunction("foo");
2244 F->setMetadata("attach", getTuple());
2246 // Confirm this has no body.
2247 ASSERT_TRUE(F->empty());
2249 // Functions without a body cannot have metadata attachments (they also can't
2250 // be verified directly, so check that the module fails to verify).
2251 EXPECT_TRUE(verifyModule(*F->getParent()));
2253 // Functions with a body can.
2254 (void)new UnreachableInst(Context, BasicBlock::Create(Context, "bb", F));
2255 EXPECT_FALSE(verifyModule(*F->getParent()));
2256 EXPECT_FALSE(verifyFunction(*F));
2259 TEST_F(FunctionAttachmentTest, EntryCount) {
2260 Function *F = getFunction("foo");
2261 EXPECT_FALSE(F->getEntryCount().hasValue());
2262 F->setEntryCount(12304);
2263 EXPECT_TRUE(F->getEntryCount().hasValue());
2264 EXPECT_EQ(12304u, *F->getEntryCount());
2267 TEST_F(FunctionAttachmentTest, SubprogramAttachment) {
2268 Function *F = getFunction("foo");
2269 DISubprogram *SP = getSubprogram();
2270 F->setSubprogram(SP);
2272 // Note that the static_cast confirms that F->getSubprogram() actually
2273 // returns an DISubprogram.
2274 EXPECT_EQ(SP, static_cast<DISubprogram *>(F->getSubprogram()));
2275 EXPECT_EQ(SP, F->getMetadata("dbg"));
2276 EXPECT_EQ(SP, F->getMetadata(LLVMContext::MD_dbg));