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/DebugInfoMetadata.h"
13 #include "llvm/IR/Function.h"
14 #include "llvm/IR/Instructions.h"
15 #include "llvm/IR/LLVMContext.h"
16 #include "llvm/IR/Metadata.h"
17 #include "llvm/IR/Module.h"
18 #include "llvm/IR/Type.h"
19 #include "llvm/Support/raw_ostream.h"
20 #include "gtest/gtest.h"
25 TEST(ContextAndReplaceableUsesTest, FromContext) {
27 ContextAndReplaceableUses CRU(Context);
28 EXPECT_EQ(&Context, &CRU.getContext());
29 EXPECT_FALSE(CRU.hasReplaceableUses());
30 EXPECT_FALSE(CRU.getReplaceableUses());
33 TEST(ContextAndReplaceableUsesTest, FromReplaceableUses) {
35 ContextAndReplaceableUses CRU(make_unique<ReplaceableMetadataImpl>(Context));
36 EXPECT_EQ(&Context, &CRU.getContext());
37 EXPECT_TRUE(CRU.hasReplaceableUses());
38 EXPECT_TRUE(CRU.getReplaceableUses());
41 TEST(ContextAndReplaceableUsesTest, makeReplaceable) {
43 ContextAndReplaceableUses CRU(Context);
44 CRU.makeReplaceable(make_unique<ReplaceableMetadataImpl>(Context));
45 EXPECT_EQ(&Context, &CRU.getContext());
46 EXPECT_TRUE(CRU.hasReplaceableUses());
47 EXPECT_TRUE(CRU.getReplaceableUses());
50 TEST(ContextAndReplaceableUsesTest, takeReplaceableUses) {
52 auto ReplaceableUses = make_unique<ReplaceableMetadataImpl>(Context);
53 auto *Ptr = ReplaceableUses.get();
54 ContextAndReplaceableUses CRU(std::move(ReplaceableUses));
55 ReplaceableUses = CRU.takeReplaceableUses();
56 EXPECT_EQ(&Context, &CRU.getContext());
57 EXPECT_FALSE(CRU.hasReplaceableUses());
58 EXPECT_FALSE(CRU.getReplaceableUses());
59 EXPECT_EQ(Ptr, ReplaceableUses.get());
62 class MetadataTest : public testing::Test {
65 MDNode *getNode() { return MDNode::get(Context, None); }
66 MDNode *getNode(Metadata *MD) { return MDNode::get(Context, MD); }
67 MDNode *getNode(Metadata *MD1, Metadata *MD2) {
68 Metadata *MDs[] = {MD1, MD2};
69 return MDNode::get(Context, MDs);
72 typedef MetadataTest MDStringTest;
74 // Test that construction of MDString with different value produces different
75 // MDString objects, even with the same string pointer and nulls in the string.
76 TEST_F(MDStringTest, CreateDifferent) {
77 char x[3] = { 'f', 0, 'A' };
78 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
80 MDString *s2 = MDString::get(Context, StringRef(&x[0], 3));
84 // Test that creation of MDStrings with the same string contents produces the
85 // same MDString object, even with different pointers.
86 TEST_F(MDStringTest, CreateSame) {
87 char x[4] = { 'a', 'b', 'c', 'X' };
88 char y[4] = { 'a', 'b', 'c', 'Y' };
90 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
91 MDString *s2 = MDString::get(Context, StringRef(&y[0], 3));
95 // Test that MDString prints out the string we fed it.
96 TEST_F(MDStringTest, PrintingSimple) {
97 char *str = new char[13];
98 strncpy(str, "testing 1 2 3", 13);
99 MDString *s = MDString::get(Context, StringRef(str, 13));
100 strncpy(str, "aaaaaaaaaaaaa", 13);
104 raw_string_ostream oss(Str);
106 EXPECT_STREQ("!\"testing 1 2 3\"", oss.str().c_str());
109 // Test printing of MDString with non-printable characters.
110 TEST_F(MDStringTest, PrintingComplex) {
111 char str[5] = {0, '\n', '"', '\\', (char)-1};
112 MDString *s = MDString::get(Context, StringRef(str+0, 5));
114 raw_string_ostream oss(Str);
116 EXPECT_STREQ("!\"\\00\\0A\\22\\5C\\FF\"", oss.str().c_str());
119 typedef MetadataTest MDNodeTest;
121 // Test the two constructors, and containing other Constants.
122 TEST_F(MDNodeTest, Simple) {
123 char x[3] = { 'a', 'b', 'c' };
124 char y[3] = { '1', '2', '3' };
126 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
127 MDString *s2 = MDString::get(Context, StringRef(&y[0], 3));
128 ConstantAsMetadata *CI = ConstantAsMetadata::get(
129 ConstantInt::get(getGlobalContext(), APInt(8, 0)));
131 std::vector<Metadata *> V;
136 MDNode *n1 = MDNode::get(Context, V);
137 Metadata *const c1 = n1;
138 MDNode *n2 = MDNode::get(Context, c1);
139 Metadata *const c2 = n2;
140 MDNode *n3 = MDNode::get(Context, V);
141 MDNode *n4 = MDNode::getIfExists(Context, V);
142 MDNode *n5 = MDNode::getIfExists(Context, c1);
143 MDNode *n6 = MDNode::getIfExists(Context, c2);
148 EXPECT_EQ(n6, (Metadata *)nullptr);
150 EXPECT_EQ(3u, n1->getNumOperands());
151 EXPECT_EQ(s1, n1->getOperand(0));
152 EXPECT_EQ(CI, n1->getOperand(1));
153 EXPECT_EQ(s2, n1->getOperand(2));
155 EXPECT_EQ(1u, n2->getNumOperands());
156 EXPECT_EQ(n1, n2->getOperand(0));
159 TEST_F(MDNodeTest, Delete) {
160 Constant *C = ConstantInt::get(Type::getInt32Ty(getGlobalContext()), 1);
161 Instruction *I = new BitCastInst(C, Type::getInt32Ty(getGlobalContext()));
163 Metadata *const V = LocalAsMetadata::get(I);
164 MDNode *n = MDNode::get(Context, V);
165 TrackingMDRef wvh(n);
172 TEST_F(MDNodeTest, SelfReference) {
176 auto Temp = MDNode::getTemporary(Context, None);
177 Metadata *Args[] = {Temp.get()};
178 MDNode *Self = MDNode::get(Context, Args);
179 Self->replaceOperandWith(0, Self);
180 ASSERT_EQ(Self, Self->getOperand(0));
182 // Self-references should be distinct, so MDNode::get() should grab a
183 // uniqued node that references Self, not Self.
185 MDNode *Ref1 = MDNode::get(Context, Args);
186 MDNode *Ref2 = MDNode::get(Context, Args);
187 EXPECT_NE(Self, Ref1);
188 EXPECT_EQ(Ref1, Ref2);
194 auto Temp = MDNode::getTemporary(Context, None);
195 Metadata *Args[] = {Temp.get(), MDNode::get(Context, None)};
196 MDNode *Self = MDNode::get(Context, Args);
197 Self->replaceOperandWith(0, Self);
198 ASSERT_EQ(Self, Self->getOperand(0));
200 // Self-references should be distinct, so MDNode::get() should grab a
201 // uniqued node that references Self, not Self itself.
203 MDNode *Ref1 = MDNode::get(Context, Args);
204 MDNode *Ref2 = MDNode::get(Context, Args);
205 EXPECT_NE(Self, Ref1);
206 EXPECT_EQ(Ref1, Ref2);
210 TEST_F(MDNodeTest, Print) {
211 Constant *C = ConstantInt::get(Type::getInt32Ty(Context), 7);
212 MDString *S = MDString::get(Context, "foo");
213 MDNode *N0 = getNode();
214 MDNode *N1 = getNode(N0);
215 MDNode *N2 = getNode(N0, N1);
217 Metadata *Args[] = {ConstantAsMetadata::get(C), S, nullptr, N0, N1, N2};
218 MDNode *N = MDNode::get(Context, Args);
220 std::string Expected;
222 raw_string_ostream OS(Expected);
224 C->printAsOperand(OS);
226 S->printAsOperand(OS);
228 MDNode *Nodes[] = {N0, N1, N2};
229 for (auto *Node : Nodes)
230 OS << ", <" << (void *)Node << ">";
236 raw_string_ostream OS(Actual);
240 EXPECT_EQ(Expected, Actual);
243 TEST_F(MDNodeTest, NullOperand) {
245 MDNode *Empty = MDNode::get(Context, None);
247 // metadata !{metadata !{}}
248 Metadata *Ops[] = {Empty};
249 MDNode *N = MDNode::get(Context, Ops);
250 ASSERT_EQ(Empty, N->getOperand(0));
252 // metadata !{metadata !{}} => metadata !{null}
253 N->replaceOperandWith(0, nullptr);
254 ASSERT_EQ(nullptr, N->getOperand(0));
258 MDNode *NullOp = MDNode::get(Context, Ops);
259 ASSERT_EQ(nullptr, NullOp->getOperand(0));
260 EXPECT_EQ(N, NullOp);
263 TEST_F(MDNodeTest, DistinctOnUniquingCollision) {
265 MDNode *Empty = MDNode::get(Context, None);
266 ASSERT_TRUE(Empty->isResolved());
267 EXPECT_FALSE(Empty->isDistinct());
270 Metadata *Wrapped1Ops[] = {Empty};
271 MDNode *Wrapped1 = MDNode::get(Context, Wrapped1Ops);
272 ASSERT_EQ(Empty, Wrapped1->getOperand(0));
273 ASSERT_TRUE(Wrapped1->isResolved());
274 EXPECT_FALSE(Wrapped1->isDistinct());
277 Metadata *Wrapped2Ops[] = {Wrapped1};
278 MDNode *Wrapped2 = MDNode::get(Context, Wrapped2Ops);
279 ASSERT_EQ(Wrapped1, Wrapped2->getOperand(0));
280 ASSERT_TRUE(Wrapped2->isResolved());
281 EXPECT_FALSE(Wrapped2->isDistinct());
283 // !{!{!{}}} => !{!{}}
284 Wrapped2->replaceOperandWith(0, Empty);
285 ASSERT_EQ(Empty, Wrapped2->getOperand(0));
286 EXPECT_TRUE(Wrapped2->isDistinct());
287 EXPECT_FALSE(Wrapped1->isDistinct());
290 TEST_F(MDNodeTest, getDistinct) {
292 MDNode *Empty = MDNode::get(Context, None);
293 ASSERT_TRUE(Empty->isResolved());
294 ASSERT_FALSE(Empty->isDistinct());
295 ASSERT_EQ(Empty, MDNode::get(Context, None));
298 MDNode *Distinct1 = MDNode::getDistinct(Context, None);
299 MDNode *Distinct2 = MDNode::getDistinct(Context, None);
300 EXPECT_TRUE(Distinct1->isResolved());
301 EXPECT_TRUE(Distinct2->isDistinct());
302 EXPECT_NE(Empty, Distinct1);
303 EXPECT_NE(Empty, Distinct2);
304 EXPECT_NE(Distinct1, Distinct2);
307 ASSERT_EQ(Empty, MDNode::get(Context, None));
310 TEST_F(MDNodeTest, isUniqued) {
311 MDNode *U = MDTuple::get(Context, None);
312 MDNode *D = MDTuple::getDistinct(Context, None);
313 auto T = MDTuple::getTemporary(Context, None);
314 EXPECT_TRUE(U->isUniqued());
315 EXPECT_FALSE(D->isUniqued());
316 EXPECT_FALSE(T->isUniqued());
319 TEST_F(MDNodeTest, isDistinct) {
320 MDNode *U = MDTuple::get(Context, None);
321 MDNode *D = MDTuple::getDistinct(Context, None);
322 auto T = MDTuple::getTemporary(Context, None);
323 EXPECT_FALSE(U->isDistinct());
324 EXPECT_TRUE(D->isDistinct());
325 EXPECT_FALSE(T->isDistinct());
328 TEST_F(MDNodeTest, isTemporary) {
329 MDNode *U = MDTuple::get(Context, None);
330 MDNode *D = MDTuple::getDistinct(Context, None);
331 auto T = MDTuple::getTemporary(Context, None);
332 EXPECT_FALSE(U->isTemporary());
333 EXPECT_FALSE(D->isTemporary());
334 EXPECT_TRUE(T->isTemporary());
337 TEST_F(MDNodeTest, getDistinctWithUnresolvedOperands) {
339 auto Temp = MDTuple::getTemporary(Context, None);
340 ASSERT_FALSE(Temp->isResolved());
342 // distinct !{temporary !{}}
343 Metadata *Ops[] = {Temp.get()};
344 MDNode *Distinct = MDNode::getDistinct(Context, Ops);
345 EXPECT_TRUE(Distinct->isResolved());
346 EXPECT_EQ(Temp.get(), Distinct->getOperand(0));
348 // temporary !{} => !{}
349 MDNode *Empty = MDNode::get(Context, None);
350 Temp->replaceAllUsesWith(Empty);
351 EXPECT_EQ(Empty, Distinct->getOperand(0));
354 TEST_F(MDNodeTest, handleChangedOperandRecursion) {
356 MDNode *N0 = MDNode::get(Context, None);
359 auto Temp3 = MDTuple::getTemporary(Context, None);
360 Metadata *Ops1[] = {Temp3.get(), nullptr};
361 MDNode *N1 = MDNode::get(Context, Ops1);
364 Metadata *Ops2[] = {Temp3.get(), N0};
365 MDNode *N2 = MDNode::get(Context, Ops2);
368 Metadata *Ops3[] = {N2};
369 MDNode *N3 = MDNode::get(Context, Ops3);
370 Temp3->replaceAllUsesWith(N3);
373 Metadata *Ops4[] = {N1};
374 MDNode *N4 = MDNode::get(Context, Ops4);
376 // Confirm that the cycle prevented RAUW from getting dropped.
377 EXPECT_TRUE(N0->isResolved());
378 EXPECT_FALSE(N1->isResolved());
379 EXPECT_FALSE(N2->isResolved());
380 EXPECT_FALSE(N3->isResolved());
381 EXPECT_FALSE(N4->isResolved());
383 // Create a couple of distinct nodes to observe what's going on.
385 // !5 = distinct !{!2}
386 // !6 = distinct !{!3}
387 Metadata *Ops5[] = {N2};
388 MDNode *N5 = MDNode::getDistinct(Context, Ops5);
389 Metadata *Ops6[] = {N3};
390 MDNode *N6 = MDNode::getDistinct(Context, Ops6);
392 // Mutate !2 to look like !1, causing a uniquing collision (and an RAUW).
393 // This will ripple up, with !3 colliding with !4, and RAUWing. Since !2
394 // references !3, this can cause a re-entry of handleChangedOperand() when !3
395 // is not ready for it.
397 // !2->replaceOperandWith(1, nullptr)
398 // !2: !{!3, !0} => !{!3, null}
399 // !2->replaceAllUsesWith(!1)
400 // !3: !{!2] => !{!1}
401 // !3->replaceAllUsesWith(!4)
402 N2->replaceOperandWith(1, nullptr);
404 // If all has gone well, N2 and N3 will have been RAUW'ed and deleted from
405 // under us. Just check that the other nodes are sane.
409 // !5 = distinct !{!1}
410 // !6 = distinct !{!4}
411 EXPECT_EQ(N4, N1->getOperand(0));
412 EXPECT_EQ(N1, N4->getOperand(0));
413 EXPECT_EQ(N1, N5->getOperand(0));
414 EXPECT_EQ(N4, N6->getOperand(0));
417 TEST_F(MDNodeTest, replaceResolvedOperand) {
418 // Check code for replacing one resolved operand with another. If doing this
419 // directly (via replaceOperandWith()) becomes illegal, change the operand to
420 // a global value that gets RAUW'ed.
422 // Use a temporary node to keep N from being resolved.
423 auto Temp = MDTuple::getTemporary(Context, None);
424 Metadata *Ops[] = {nullptr, Temp.get()};
426 MDNode *Empty = MDTuple::get(Context, ArrayRef<Metadata *>());
427 MDNode *N = MDTuple::get(Context, Ops);
428 EXPECT_EQ(nullptr, N->getOperand(0));
429 ASSERT_FALSE(N->isResolved());
431 // Check code for replacing resolved nodes.
432 N->replaceOperandWith(0, Empty);
433 EXPECT_EQ(Empty, N->getOperand(0));
435 // Check code for adding another unresolved operand.
436 N->replaceOperandWith(0, Temp.get());
437 EXPECT_EQ(Temp.get(), N->getOperand(0));
439 // Remove the references to Temp; required for teardown.
440 Temp->replaceAllUsesWith(nullptr);
443 TEST_F(MDNodeTest, replaceWithUniqued) {
444 auto *Empty = MDTuple::get(Context, None);
445 MDTuple *FirstUniqued;
447 Metadata *Ops[] = {Empty};
448 auto Temp = MDTuple::getTemporary(Context, Ops);
449 EXPECT_TRUE(Temp->isTemporary());
451 // Don't expect a collision.
452 auto *Current = Temp.get();
453 FirstUniqued = MDNode::replaceWithUniqued(std::move(Temp));
454 EXPECT_TRUE(FirstUniqued->isUniqued());
455 EXPECT_TRUE(FirstUniqued->isResolved());
456 EXPECT_EQ(Current, FirstUniqued);
459 Metadata *Ops[] = {Empty};
460 auto Temp = MDTuple::getTemporary(Context, Ops);
461 EXPECT_TRUE(Temp->isTemporary());
463 // Should collide with Uniqued above this time.
464 auto *Uniqued = MDNode::replaceWithUniqued(std::move(Temp));
465 EXPECT_TRUE(Uniqued->isUniqued());
466 EXPECT_TRUE(Uniqued->isResolved());
467 EXPECT_EQ(FirstUniqued, Uniqued);
470 auto Unresolved = MDTuple::getTemporary(Context, None);
471 Metadata *Ops[] = {Unresolved.get()};
472 auto Temp = MDTuple::getTemporary(Context, Ops);
473 EXPECT_TRUE(Temp->isTemporary());
475 // Shouldn't be resolved.
476 auto *Uniqued = MDNode::replaceWithUniqued(std::move(Temp));
477 EXPECT_TRUE(Uniqued->isUniqued());
478 EXPECT_FALSE(Uniqued->isResolved());
480 // Should be a different node.
481 EXPECT_NE(FirstUniqued, Uniqued);
483 // Should resolve when we update its node (note: be careful to avoid a
484 // collision with any other nodes above).
485 Uniqued->replaceOperandWith(0, nullptr);
486 EXPECT_TRUE(Uniqued->isResolved());
490 TEST_F(MDNodeTest, replaceWithDistinct) {
492 auto *Empty = MDTuple::get(Context, None);
493 Metadata *Ops[] = {Empty};
494 auto Temp = MDTuple::getTemporary(Context, Ops);
495 EXPECT_TRUE(Temp->isTemporary());
497 // Don't expect a collision.
498 auto *Current = Temp.get();
499 auto *Distinct = MDNode::replaceWithDistinct(std::move(Temp));
500 EXPECT_TRUE(Distinct->isDistinct());
501 EXPECT_TRUE(Distinct->isResolved());
502 EXPECT_EQ(Current, Distinct);
505 auto Unresolved = MDTuple::getTemporary(Context, None);
506 Metadata *Ops[] = {Unresolved.get()};
507 auto Temp = MDTuple::getTemporary(Context, Ops);
508 EXPECT_TRUE(Temp->isTemporary());
510 // Don't expect a collision.
511 auto *Current = Temp.get();
512 auto *Distinct = MDNode::replaceWithDistinct(std::move(Temp));
513 EXPECT_TRUE(Distinct->isDistinct());
514 EXPECT_TRUE(Distinct->isResolved());
515 EXPECT_EQ(Current, Distinct);
517 // Cleanup; required for teardown.
518 Unresolved->replaceAllUsesWith(nullptr);
522 TEST_F(MDNodeTest, replaceWithPermanent) {
523 Metadata *Ops[] = {nullptr};
524 auto Temp = MDTuple::getTemporary(Context, Ops);
525 auto *T = Temp.get();
527 // U is a normal, uniqued node that references T.
528 auto *U = MDTuple::get(Context, T);
529 EXPECT_TRUE(U->isUniqued());
531 // Make Temp self-referencing.
532 Temp->replaceOperandWith(0, T);
534 // Try to uniquify Temp. This should, despite the name in the API, give a
535 // 'distinct' node, since self-references aren't allowed to be uniqued.
537 // Since it's distinct, N should have the same address as when it was a
538 // temporary (i.e., be equal to T not U).
539 auto *N = MDNode::replaceWithPermanent(std::move(Temp));
541 EXPECT_TRUE(N->isDistinct());
543 // U should be the canonical unique node with N as the argument.
544 EXPECT_EQ(U, MDTuple::get(Context, N));
545 EXPECT_TRUE(U->isUniqued());
547 // This temporary should collide with U when replaced, but it should still be
549 EXPECT_EQ(U, MDNode::replaceWithPermanent(MDTuple::getTemporary(Context, N)));
550 EXPECT_TRUE(U->isUniqued());
552 // This temporary should become a new uniqued node.
553 auto Temp2 = MDTuple::getTemporary(Context, U);
554 auto *V = Temp2.get();
555 EXPECT_EQ(V, MDNode::replaceWithPermanent(std::move(Temp2)));
556 EXPECT_TRUE(V->isUniqued());
557 EXPECT_EQ(U, V->getOperand(0));
560 TEST_F(MDNodeTest, deleteTemporaryWithTrackingRef) {
562 EXPECT_EQ(nullptr, Ref.get());
564 auto Temp = MDTuple::getTemporary(Context, None);
565 Ref.reset(Temp.get());
566 EXPECT_EQ(Temp.get(), Ref.get());
568 EXPECT_EQ(nullptr, Ref.get());
571 typedef MetadataTest MDLocationTest;
573 TEST_F(MDLocationTest, Overflow) {
574 MDNode *N = MDNode::get(Context, None);
576 MDLocation *L = MDLocation::get(Context, 2, 7, N);
577 EXPECT_EQ(2u, L->getLine());
578 EXPECT_EQ(7u, L->getColumn());
580 unsigned U16 = 1u << 16;
582 MDLocation *L = MDLocation::get(Context, UINT32_MAX, U16 - 1, N);
583 EXPECT_EQ(UINT32_MAX, L->getLine());
584 EXPECT_EQ(U16 - 1, L->getColumn());
587 MDLocation *L = MDLocation::get(Context, UINT32_MAX, U16, N);
588 EXPECT_EQ(UINT32_MAX, L->getLine());
589 EXPECT_EQ(0u, L->getColumn());
592 MDLocation *L = MDLocation::get(Context, UINT32_MAX, U16 + 1, N);
593 EXPECT_EQ(UINT32_MAX, L->getLine());
594 EXPECT_EQ(0u, L->getColumn());
598 TEST_F(MDLocationTest, getDistinct) {
599 MDNode *N = MDNode::get(Context, None);
600 MDLocation *L0 = MDLocation::getDistinct(Context, 2, 7, N);
601 EXPECT_TRUE(L0->isDistinct());
602 MDLocation *L1 = MDLocation::get(Context, 2, 7, N);
603 EXPECT_FALSE(L1->isDistinct());
604 EXPECT_EQ(L1, MDLocation::get(Context, 2, 7, N));
607 TEST_F(MDLocationTest, getTemporary) {
608 MDNode *N = MDNode::get(Context, None);
609 auto L = MDLocation::getTemporary(Context, 2, 7, N);
610 EXPECT_TRUE(L->isTemporary());
611 EXPECT_FALSE(L->isResolved());
614 typedef MetadataTest GenericDebugNodeTest;
616 TEST_F(GenericDebugNodeTest, get) {
617 StringRef Header = "header";
618 auto *Empty = MDNode::get(Context, None);
619 Metadata *Ops1[] = {Empty};
620 auto *N = GenericDebugNode::get(Context, 15, Header, Ops1);
621 EXPECT_EQ(15u, N->getTag());
622 EXPECT_EQ(2u, N->getNumOperands());
623 EXPECT_EQ(Header, N->getHeader());
624 EXPECT_EQ(MDString::get(Context, Header), N->getOperand(0));
625 EXPECT_EQ(1u, N->getNumDwarfOperands());
626 EXPECT_EQ(Empty, N->getDwarfOperand(0));
627 EXPECT_EQ(Empty, N->getOperand(1));
628 ASSERT_TRUE(N->isUniqued());
630 EXPECT_EQ(N, GenericDebugNode::get(Context, 15, Header, Ops1));
632 N->replaceOperandWith(1, nullptr);
633 EXPECT_EQ(15u, N->getTag());
634 EXPECT_EQ(Header, N->getHeader());
635 EXPECT_EQ(nullptr, N->getDwarfOperand(0));
636 ASSERT_TRUE(N->isUniqued());
638 Metadata *Ops2[] = {nullptr};
639 EXPECT_EQ(N, GenericDebugNode::get(Context, 15, Header, Ops2));
641 N->replaceDwarfOperandWith(0, Empty);
642 EXPECT_EQ(15u, N->getTag());
643 EXPECT_EQ(Header, N->getHeader());
644 EXPECT_EQ(Empty, N->getDwarfOperand(0));
645 ASSERT_TRUE(N->isUniqued());
646 EXPECT_EQ(N, GenericDebugNode::get(Context, 15, Header, Ops1));
648 TempGenericDebugNode Temp = N->clone();
649 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
652 TEST_F(GenericDebugNodeTest, getEmptyHeader) {
653 // Canonicalize !"" to null.
654 auto *N = GenericDebugNode::get(Context, 15, StringRef(), None);
655 EXPECT_EQ(StringRef(), N->getHeader());
656 EXPECT_EQ(nullptr, N->getOperand(0));
659 typedef MetadataTest MDSubrangeTest;
661 TEST_F(MDSubrangeTest, get) {
662 auto *N = MDSubrange::get(Context, 5, 7);
663 EXPECT_EQ(dwarf::DW_TAG_subrange_type, N->getTag());
664 EXPECT_EQ(5, N->getCount());
665 EXPECT_EQ(7, N->getLo());
666 EXPECT_EQ(N, MDSubrange::get(Context, 5, 7));
667 EXPECT_EQ(MDSubrange::get(Context, 5, 0), MDSubrange::get(Context, 5));
669 TempMDSubrange Temp = N->clone();
670 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
673 TEST_F(MDSubrangeTest, getEmptyArray) {
674 auto *N = MDSubrange::get(Context, -1, 0);
675 EXPECT_EQ(dwarf::DW_TAG_subrange_type, N->getTag());
676 EXPECT_EQ(-1, N->getCount());
677 EXPECT_EQ(0, N->getLo());
678 EXPECT_EQ(N, MDSubrange::get(Context, -1, 0));
681 typedef MetadataTest MDEnumeratorTest;
683 TEST_F(MDEnumeratorTest, get) {
684 auto *N = MDEnumerator::get(Context, 7, "name");
685 EXPECT_EQ(dwarf::DW_TAG_enumerator, N->getTag());
686 EXPECT_EQ(7, N->getValue());
687 EXPECT_EQ("name", N->getName());
688 EXPECT_EQ(N, MDEnumerator::get(Context, 7, "name"));
690 EXPECT_NE(N, MDEnumerator::get(Context, 8, "name"));
691 EXPECT_NE(N, MDEnumerator::get(Context, 7, "nam"));
693 TempMDEnumerator Temp = N->clone();
694 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
697 typedef MetadataTest MDBasicTypeTest;
699 TEST_F(MDBasicTypeTest, get) {
701 MDBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 26, 7);
702 EXPECT_EQ(dwarf::DW_TAG_base_type, N->getTag());
703 EXPECT_EQ("special", N->getName());
704 EXPECT_EQ(33u, N->getSizeInBits());
705 EXPECT_EQ(26u, N->getAlignInBits());
706 EXPECT_EQ(7u, N->getEncoding());
707 EXPECT_EQ(0u, N->getLine());
708 EXPECT_EQ(N, MDBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33,
711 EXPECT_NE(N, MDBasicType::get(Context, dwarf::DW_TAG_unspecified_type,
712 "special", 33, 26, 7));
714 MDBasicType::get(Context, dwarf::DW_TAG_base_type, "s", 33, 26, 7));
715 EXPECT_NE(N, MDBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 32,
717 EXPECT_NE(N, MDBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33,
719 EXPECT_NE(N, MDBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33,
722 TempMDBasicType Temp = N->clone();
723 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
726 TEST_F(MDBasicTypeTest, getWithLargeValues) {
727 auto *N = MDBasicType::get(Context, dwarf::DW_TAG_base_type, "special",
728 UINT64_MAX, UINT64_MAX - 1, 7);
729 EXPECT_EQ(UINT64_MAX, N->getSizeInBits());
730 EXPECT_EQ(UINT64_MAX - 1, N->getAlignInBits());
733 typedef MetadataTest MDDerivedTypeTest;
735 TEST_F(MDDerivedTypeTest, get) {
736 Metadata *File = MDTuple::getDistinct(Context, None);
737 Metadata *Scope = MDTuple::getDistinct(Context, None);
738 Metadata *BaseType = MDTuple::getDistinct(Context, None);
739 Metadata *ExtraData = MDTuple::getDistinct(Context, None);
741 auto *N = MDDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "something",
742 File, 1, Scope, BaseType, 2, 3, 4, 5, ExtraData);
743 EXPECT_EQ(dwarf::DW_TAG_pointer_type, N->getTag());
744 EXPECT_EQ("something", N->getName());
745 EXPECT_EQ(File, N->getFile());
746 EXPECT_EQ(1u, N->getLine());
747 EXPECT_EQ(Scope, N->getScope());
748 EXPECT_EQ(BaseType, N->getBaseType());
749 EXPECT_EQ(2u, N->getSizeInBits());
750 EXPECT_EQ(3u, N->getAlignInBits());
751 EXPECT_EQ(4u, N->getOffsetInBits());
752 EXPECT_EQ(5u, N->getFlags());
753 EXPECT_EQ(ExtraData, N->getExtraData());
754 EXPECT_EQ(N, MDDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
755 "something", File, 1, Scope, BaseType, 2, 3,
758 EXPECT_NE(N, MDDerivedType::get(Context, dwarf::DW_TAG_reference_type,
759 "something", File, 1, Scope, BaseType, 2, 3,
761 EXPECT_NE(N, MDDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "else",
762 File, 1, Scope, BaseType, 2, 3, 4, 5,
764 EXPECT_NE(N, MDDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
765 "something", Scope, 1, Scope, BaseType, 2, 3,
767 EXPECT_NE(N, MDDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
768 "something", File, 2, Scope, BaseType, 2, 3,
771 MDDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "something",
772 File, 1, File, BaseType, 2, 3, 4, 5, ExtraData));
774 MDDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "something",
775 File, 1, Scope, File, 2, 3, 4, 5, ExtraData));
776 EXPECT_NE(N, MDDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
777 "something", File, 1, Scope, BaseType, 3, 3,
779 EXPECT_NE(N, MDDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
780 "something", File, 1, Scope, BaseType, 2, 2,
782 EXPECT_NE(N, MDDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
783 "something", File, 1, Scope, BaseType, 2, 3,
785 EXPECT_NE(N, MDDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
786 "something", File, 1, Scope, BaseType, 2, 3,
789 MDDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "something",
790 File, 1, Scope, BaseType, 2, 3, 4, 5, File));
792 TempMDDerivedType Temp = N->clone();
793 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
796 TEST_F(MDDerivedTypeTest, getWithLargeValues) {
797 Metadata *File = MDTuple::getDistinct(Context, None);
798 Metadata *Scope = MDTuple::getDistinct(Context, None);
799 Metadata *BaseType = MDTuple::getDistinct(Context, None);
800 Metadata *ExtraData = MDTuple::getDistinct(Context, None);
802 auto *N = MDDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "something",
803 File, 1, Scope, BaseType, UINT64_MAX,
804 UINT64_MAX - 1, UINT64_MAX - 2, 5, ExtraData);
805 EXPECT_EQ(UINT64_MAX, N->getSizeInBits());
806 EXPECT_EQ(UINT64_MAX - 1, N->getAlignInBits());
807 EXPECT_EQ(UINT64_MAX - 2, N->getOffsetInBits());
810 typedef MetadataTest MDCompositeTypeTest;
812 TEST_F(MDCompositeTypeTest, get) {
813 unsigned Tag = dwarf::DW_TAG_structure_type;
814 StringRef Name = "some name";
815 Metadata *File = MDTuple::getDistinct(Context, None);
817 Metadata *Scope = MDTuple::getDistinct(Context, None);
818 Metadata *BaseType = MDTuple::getDistinct(Context, None);
819 uint64_t SizeInBits = 2;
820 uint64_t AlignInBits = 3;
821 uint64_t OffsetInBits = 4;
823 Metadata *Elements = MDTuple::getDistinct(Context, None);
824 unsigned RuntimeLang = 6;
825 Metadata *VTableHolder = MDTuple::getDistinct(Context, None);
826 Metadata *TemplateParams = MDTuple::getDistinct(Context, None);
827 StringRef Identifier = "some id";
829 auto *N = MDCompositeType::get(Context, Tag, Name, File, Line, Scope,
830 BaseType, SizeInBits, AlignInBits,
831 OffsetInBits, Flags, Elements, RuntimeLang,
832 VTableHolder, TemplateParams, Identifier);
833 EXPECT_EQ(Tag, N->getTag());
834 EXPECT_EQ(Name, N->getName());
835 EXPECT_EQ(File, N->getFile());
836 EXPECT_EQ(Line, N->getLine());
837 EXPECT_EQ(Scope, N->getScope());
838 EXPECT_EQ(BaseType, N->getBaseType());
839 EXPECT_EQ(SizeInBits, N->getSizeInBits());
840 EXPECT_EQ(AlignInBits, N->getAlignInBits());
841 EXPECT_EQ(OffsetInBits, N->getOffsetInBits());
842 EXPECT_EQ(Flags, N->getFlags());
843 EXPECT_EQ(Elements, N->getElements());
844 EXPECT_EQ(RuntimeLang, N->getRuntimeLang());
845 EXPECT_EQ(VTableHolder, N->getVTableHolder());
846 EXPECT_EQ(TemplateParams, N->getTemplateParams());
847 EXPECT_EQ(Identifier, N->getIdentifier());
849 EXPECT_EQ(N, MDCompositeType::get(Context, Tag, Name, File, Line, Scope,
850 BaseType, SizeInBits, AlignInBits,
851 OffsetInBits, Flags, Elements, RuntimeLang,
852 VTableHolder, TemplateParams, Identifier));
854 EXPECT_NE(N, MDCompositeType::get(Context, Tag + 1, Name, File, Line, Scope,
855 BaseType, SizeInBits, AlignInBits,
856 OffsetInBits, Flags, Elements, RuntimeLang,
857 VTableHolder, TemplateParams, Identifier));
858 EXPECT_NE(N, MDCompositeType::get(Context, Tag, "abc", File, Line, Scope,
859 BaseType, SizeInBits, AlignInBits,
860 OffsetInBits, Flags, Elements, RuntimeLang,
861 VTableHolder, TemplateParams, Identifier));
862 EXPECT_NE(N, MDCompositeType::get(Context, Tag, Name, Scope, Line, Scope,
863 BaseType, SizeInBits, AlignInBits,
864 OffsetInBits, Flags, Elements, RuntimeLang,
865 VTableHolder, TemplateParams, Identifier));
866 EXPECT_NE(N, MDCompositeType::get(Context, Tag, Name, File, Line + 1, Scope,
867 BaseType, SizeInBits, AlignInBits,
868 OffsetInBits, Flags, Elements, RuntimeLang,
869 VTableHolder, TemplateParams, Identifier));
870 EXPECT_NE(N, MDCompositeType::get(Context, Tag, Name, File, Line, File,
871 BaseType, SizeInBits, AlignInBits,
872 OffsetInBits, Flags, Elements, RuntimeLang,
873 VTableHolder, TemplateParams, Identifier));
874 EXPECT_NE(N, MDCompositeType::get(Context, Tag, Name, File, Line, Scope, File,
875 SizeInBits, AlignInBits, OffsetInBits,
876 Flags, Elements, RuntimeLang, VTableHolder,
877 TemplateParams, Identifier));
878 EXPECT_NE(N, MDCompositeType::get(Context, Tag, Name, File, Line, Scope,
879 BaseType, SizeInBits + 1, AlignInBits,
880 OffsetInBits, Flags, Elements, RuntimeLang,
881 VTableHolder, TemplateParams, Identifier));
882 EXPECT_NE(N, MDCompositeType::get(Context, Tag, Name, File, Line, Scope,
883 BaseType, SizeInBits, AlignInBits + 1,
884 OffsetInBits, Flags, Elements, RuntimeLang,
885 VTableHolder, TemplateParams, Identifier));
886 EXPECT_NE(N, MDCompositeType::get(
887 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
888 AlignInBits, OffsetInBits + 1, Flags, Elements, RuntimeLang,
889 VTableHolder, TemplateParams, Identifier));
890 EXPECT_NE(N, MDCompositeType::get(
891 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
892 AlignInBits, OffsetInBits, Flags + 1, Elements, RuntimeLang,
893 VTableHolder, TemplateParams, Identifier));
894 EXPECT_NE(N, MDCompositeType::get(Context, Tag, Name, File, Line, Scope,
895 BaseType, SizeInBits, AlignInBits,
896 OffsetInBits, Flags, File, RuntimeLang,
897 VTableHolder, TemplateParams, Identifier));
898 EXPECT_NE(N, MDCompositeType::get(
899 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
900 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang + 1,
901 VTableHolder, TemplateParams, Identifier));
902 EXPECT_NE(N, MDCompositeType::get(Context, Tag, Name, File, Line, Scope,
903 BaseType, SizeInBits, AlignInBits,
904 OffsetInBits, Flags, Elements, RuntimeLang,
905 File, TemplateParams, Identifier));
906 EXPECT_NE(N, MDCompositeType::get(Context, Tag, Name, File, Line, Scope,
907 BaseType, SizeInBits, AlignInBits,
908 OffsetInBits, Flags, Elements, RuntimeLang,
909 VTableHolder, File, Identifier));
910 EXPECT_NE(N, MDCompositeType::get(Context, Tag, Name, File, Line, Scope,
911 BaseType, SizeInBits, AlignInBits,
912 OffsetInBits, Flags, Elements, RuntimeLang,
913 VTableHolder, TemplateParams, "other"));
915 // Be sure that missing identifiers get null pointers.
916 EXPECT_FALSE(MDCompositeType::get(
917 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
918 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
919 VTableHolder, TemplateParams, "")->getRawIdentifier());
920 EXPECT_FALSE(MDCompositeType::get(
921 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
922 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
923 VTableHolder, TemplateParams)->getRawIdentifier());
925 TempMDCompositeType Temp = N->clone();
926 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
929 TEST_F(MDCompositeTypeTest, getWithLargeValues) {
930 unsigned Tag = dwarf::DW_TAG_structure_type;
931 StringRef Name = "some name";
932 Metadata *File = MDTuple::getDistinct(Context, None);
934 Metadata *Scope = MDTuple::getDistinct(Context, None);
935 Metadata *BaseType = MDTuple::getDistinct(Context, None);
936 uint64_t SizeInBits = UINT64_MAX;
937 uint64_t AlignInBits = UINT64_MAX - 1;
938 uint64_t OffsetInBits = UINT64_MAX - 2;
940 Metadata *Elements = MDTuple::getDistinct(Context, None);
941 unsigned RuntimeLang = 6;
942 Metadata *VTableHolder = MDTuple::getDistinct(Context, None);
943 Metadata *TemplateParams = MDTuple::getDistinct(Context, None);
944 StringRef Identifier = "some id";
946 auto *N = MDCompositeType::get(Context, Tag, Name, File, Line, Scope,
947 BaseType, SizeInBits, AlignInBits,
948 OffsetInBits, Flags, Elements, RuntimeLang,
949 VTableHolder, TemplateParams, Identifier);
950 EXPECT_EQ(SizeInBits, N->getSizeInBits());
951 EXPECT_EQ(AlignInBits, N->getAlignInBits());
952 EXPECT_EQ(OffsetInBits, N->getOffsetInBits());
955 TEST_F(MDCompositeTypeTest, replaceOperands) {
956 unsigned Tag = dwarf::DW_TAG_structure_type;
957 StringRef Name = "some name";
958 Metadata *File = MDTuple::getDistinct(Context, None);
960 Metadata *Scope = MDTuple::getDistinct(Context, None);
961 Metadata *BaseType = MDTuple::getDistinct(Context, None);
962 uint64_t SizeInBits = 2;
963 uint64_t AlignInBits = 3;
964 uint64_t OffsetInBits = 4;
966 unsigned RuntimeLang = 6;
967 StringRef Identifier = "some id";
969 auto *N = MDCompositeType::get(Context, Tag, Name, File, Line, Scope,
970 BaseType, SizeInBits, AlignInBits,
971 OffsetInBits, Flags, nullptr, RuntimeLang,
972 nullptr, nullptr, Identifier);
974 auto *Elements = MDTuple::getDistinct(Context, None);
975 EXPECT_EQ(nullptr, N->getElements());
976 N->replaceElements(Elements);
977 EXPECT_EQ(Elements, N->getElements());
978 N->replaceElements(nullptr);
979 EXPECT_EQ(nullptr, N->getElements());
981 auto *VTableHolder = MDTuple::getDistinct(Context, None);
982 EXPECT_EQ(nullptr, N->getVTableHolder());
983 N->replaceVTableHolder(VTableHolder);
984 EXPECT_EQ(VTableHolder, N->getVTableHolder());
985 N->replaceVTableHolder(nullptr);
986 EXPECT_EQ(nullptr, N->getVTableHolder());
988 auto *TemplateParams = MDTuple::getDistinct(Context, None);
989 EXPECT_EQ(nullptr, N->getTemplateParams());
990 N->replaceTemplateParams(TemplateParams);
991 EXPECT_EQ(TemplateParams, N->getTemplateParams());
992 N->replaceTemplateParams(nullptr);
993 EXPECT_EQ(nullptr, N->getTemplateParams());
996 typedef MetadataTest MDSubroutineTypeTest;
998 TEST_F(MDSubroutineTypeTest, get) {
1000 Metadata *TypeArray = MDTuple::getDistinct(Context, None);
1002 auto *N = MDSubroutineType::get(Context, Flags, TypeArray);
1003 EXPECT_EQ(dwarf::DW_TAG_subroutine_type, N->getTag());
1004 EXPECT_EQ(Flags, N->getFlags());
1005 EXPECT_EQ(TypeArray, N->getTypeArray());
1006 EXPECT_EQ(N, MDSubroutineType::get(Context, Flags, TypeArray));
1008 EXPECT_NE(N, MDSubroutineType::get(Context, Flags + 1, TypeArray));
1009 EXPECT_NE(N, MDSubroutineType::get(Context, Flags,
1010 MDTuple::getDistinct(Context, None)));
1012 TempMDSubroutineType Temp = N->clone();
1013 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1015 // Test always-empty operands.
1016 EXPECT_EQ(nullptr, N->getScope());
1017 EXPECT_EQ(nullptr, N->getFile());
1018 EXPECT_EQ("", N->getName());
1019 EXPECT_EQ(nullptr, N->getBaseType());
1020 EXPECT_EQ(nullptr, N->getVTableHolder());
1021 EXPECT_EQ(nullptr, N->getTemplateParams());
1022 EXPECT_EQ("", N->getIdentifier());
1025 typedef MetadataTest MDFileTest;
1027 TEST_F(MDFileTest, get) {
1028 StringRef Filename = "file";
1029 StringRef Directory = "dir";
1030 auto *N = MDFile::get(Context, Filename, Directory);
1032 EXPECT_EQ(dwarf::DW_TAG_file_type, N->getTag());
1033 EXPECT_EQ(Filename, N->getFilename());
1034 EXPECT_EQ(Directory, N->getDirectory());
1035 EXPECT_EQ(N, MDFile::get(Context, Filename, Directory));
1037 EXPECT_NE(N, MDFile::get(Context, "other", Directory));
1038 EXPECT_NE(N, MDFile::get(Context, Filename, "other"));
1040 TempMDFile Temp = N->clone();
1041 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1044 TEST_F(MDFileTest, ScopeGetFile) {
1045 // Ensure that MDScope::getFile() returns itself.
1046 MDScope *N = MDFile::get(Context, "file", "dir");
1047 EXPECT_EQ(N, N->getFile());
1050 typedef MetadataTest MDCompileUnitTest;
1052 TEST_F(MDCompileUnitTest, get) {
1053 unsigned SourceLanguage = 1;
1054 Metadata *File = MDTuple::getDistinct(Context, None);
1055 StringRef Producer = "some producer";
1056 bool IsOptimized = false;
1057 StringRef Flags = "flag after flag";
1058 unsigned RuntimeVersion = 2;
1059 StringRef SplitDebugFilename = "another/file";
1060 unsigned EmissionKind = 3;
1061 Metadata *EnumTypes = MDTuple::getDistinct(Context, None);
1062 Metadata *RetainedTypes = MDTuple::getDistinct(Context, None);
1063 Metadata *Subprograms = MDTuple::getDistinct(Context, None);
1064 Metadata *GlobalVariables = MDTuple::getDistinct(Context, None);
1065 Metadata *ImportedEntities = MDTuple::getDistinct(Context, None);
1066 auto *N = MDCompileUnit::get(
1067 Context, SourceLanguage, File, Producer, IsOptimized, Flags,
1068 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes,
1069 RetainedTypes, Subprograms, GlobalVariables, ImportedEntities);
1071 EXPECT_EQ(dwarf::DW_TAG_compile_unit, N->getTag());
1072 EXPECT_EQ(SourceLanguage, N->getSourceLanguage());
1073 EXPECT_EQ(File, N->getFile());
1074 EXPECT_EQ(Producer, N->getProducer());
1075 EXPECT_EQ(IsOptimized, N->isOptimized());
1076 EXPECT_EQ(Flags, N->getFlags());
1077 EXPECT_EQ(RuntimeVersion, N->getRuntimeVersion());
1078 EXPECT_EQ(SplitDebugFilename, N->getSplitDebugFilename());
1079 EXPECT_EQ(EmissionKind, N->getEmissionKind());
1080 EXPECT_EQ(EnumTypes, N->getEnumTypes());
1081 EXPECT_EQ(RetainedTypes, N->getRetainedTypes());
1082 EXPECT_EQ(Subprograms, N->getSubprograms());
1083 EXPECT_EQ(GlobalVariables, N->getGlobalVariables());
1084 EXPECT_EQ(ImportedEntities, N->getImportedEntities());
1085 EXPECT_EQ(N, MDCompileUnit::get(Context, SourceLanguage, File, Producer,
1086 IsOptimized, Flags, RuntimeVersion,
1087 SplitDebugFilename, EmissionKind, EnumTypes,
1088 RetainedTypes, Subprograms, GlobalVariables,
1091 EXPECT_NE(N, MDCompileUnit::get(Context, SourceLanguage + 1, File, Producer,
1092 IsOptimized, Flags, RuntimeVersion,
1093 SplitDebugFilename, EmissionKind, EnumTypes,
1094 RetainedTypes, Subprograms, GlobalVariables,
1096 EXPECT_NE(N, MDCompileUnit::get(Context, SourceLanguage, EnumTypes, Producer,
1097 IsOptimized, Flags, RuntimeVersion,
1098 SplitDebugFilename, EmissionKind, EnumTypes,
1099 RetainedTypes, Subprograms, GlobalVariables,
1101 EXPECT_NE(N, MDCompileUnit::get(Context, SourceLanguage, File, "other",
1102 IsOptimized, Flags, RuntimeVersion,
1103 SplitDebugFilename, EmissionKind, EnumTypes,
1104 RetainedTypes, Subprograms, GlobalVariables,
1106 EXPECT_NE(N, MDCompileUnit::get(Context, SourceLanguage, File, Producer,
1107 !IsOptimized, Flags, RuntimeVersion,
1108 SplitDebugFilename, EmissionKind, EnumTypes,
1109 RetainedTypes, Subprograms, GlobalVariables,
1111 EXPECT_NE(N, MDCompileUnit::get(Context, SourceLanguage, File, Producer,
1112 IsOptimized, "other", RuntimeVersion,
1113 SplitDebugFilename, EmissionKind, EnumTypes,
1114 RetainedTypes, Subprograms, GlobalVariables,
1116 EXPECT_NE(N, MDCompileUnit::get(Context, SourceLanguage, File, Producer,
1117 IsOptimized, Flags, RuntimeVersion + 1,
1118 SplitDebugFilename, EmissionKind, EnumTypes,
1119 RetainedTypes, Subprograms, GlobalVariables,
1122 MDCompileUnit::get(Context, SourceLanguage, File, Producer,
1123 IsOptimized, Flags, RuntimeVersion, "other",
1124 EmissionKind, EnumTypes, RetainedTypes,
1125 Subprograms, GlobalVariables, ImportedEntities));
1126 EXPECT_NE(N, MDCompileUnit::get(Context, SourceLanguage, File, Producer,
1127 IsOptimized, Flags, RuntimeVersion,
1128 SplitDebugFilename, EmissionKind + 1,
1129 EnumTypes, RetainedTypes, Subprograms,
1130 GlobalVariables, ImportedEntities));
1131 EXPECT_NE(N, MDCompileUnit::get(Context, SourceLanguage, File, Producer,
1132 IsOptimized, Flags, RuntimeVersion,
1133 SplitDebugFilename, EmissionKind, File,
1134 RetainedTypes, Subprograms, GlobalVariables,
1136 EXPECT_NE(N, MDCompileUnit::get(
1137 Context, SourceLanguage, File, Producer, IsOptimized, Flags,
1138 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes,
1139 File, Subprograms, GlobalVariables, ImportedEntities));
1140 EXPECT_NE(N, MDCompileUnit::get(
1141 Context, SourceLanguage, File, Producer, IsOptimized, Flags,
1142 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes,
1143 RetainedTypes, File, GlobalVariables, ImportedEntities));
1144 EXPECT_NE(N, MDCompileUnit::get(
1145 Context, SourceLanguage, File, Producer, IsOptimized, Flags,
1146 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes,
1147 RetainedTypes, Subprograms, File, ImportedEntities));
1148 EXPECT_NE(N, MDCompileUnit::get(
1149 Context, SourceLanguage, File, Producer, IsOptimized, Flags,
1150 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes,
1151 RetainedTypes, Subprograms, GlobalVariables, File));
1153 TempMDCompileUnit Temp = N->clone();
1154 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1157 TEST_F(MDCompileUnitTest, replaceArrays) {
1158 unsigned SourceLanguage = 1;
1159 Metadata *File = MDTuple::getDistinct(Context, None);
1160 StringRef Producer = "some producer";
1161 bool IsOptimized = false;
1162 StringRef Flags = "flag after flag";
1163 unsigned RuntimeVersion = 2;
1164 StringRef SplitDebugFilename = "another/file";
1165 unsigned EmissionKind = 3;
1166 Metadata *EnumTypes = MDTuple::getDistinct(Context, None);
1167 Metadata *RetainedTypes = MDTuple::getDistinct(Context, None);
1168 Metadata *ImportedEntities = MDTuple::getDistinct(Context, None);
1169 auto *N = MDCompileUnit::get(
1170 Context, SourceLanguage, File, Producer, IsOptimized, Flags,
1171 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes,
1172 RetainedTypes, nullptr, nullptr, ImportedEntities);
1174 auto *Subprograms = MDTuple::getDistinct(Context, None);
1175 EXPECT_EQ(nullptr, N->getSubprograms());
1176 N->replaceSubprograms(Subprograms);
1177 EXPECT_EQ(Subprograms, N->getSubprograms());
1178 N->replaceSubprograms(nullptr);
1179 EXPECT_EQ(nullptr, N->getSubprograms());
1181 auto *GlobalVariables = MDTuple::getDistinct(Context, None);
1182 EXPECT_EQ(nullptr, N->getGlobalVariables());
1183 N->replaceGlobalVariables(GlobalVariables);
1184 EXPECT_EQ(GlobalVariables, N->getGlobalVariables());
1185 N->replaceGlobalVariables(nullptr);
1186 EXPECT_EQ(nullptr, N->getGlobalVariables());
1189 typedef MetadataTest MDSubprogramTest;
1191 TEST_F(MDSubprogramTest, get) {
1192 Metadata *Scope = MDTuple::getDistinct(Context, None);
1193 StringRef Name = "name";
1194 StringRef LinkageName = "linkage";
1195 Metadata *File = MDTuple::getDistinct(Context, None);
1197 Metadata *Type = MDTuple::getDistinct(Context, None);
1198 bool IsLocalToUnit = false;
1199 bool IsDefinition = true;
1200 unsigned ScopeLine = 3;
1201 Metadata *ContainingType = MDTuple::getDistinct(Context, None);
1202 unsigned Virtuality = 4;
1203 unsigned VirtualIndex = 5;
1205 bool IsOptimized = false;
1206 Metadata *Function = MDTuple::getDistinct(Context, None);
1207 Metadata *TemplateParams = MDTuple::getDistinct(Context, None);
1208 Metadata *Declaration = MDTuple::getDistinct(Context, None);
1209 Metadata *Variables = MDTuple::getDistinct(Context, None);
1211 auto *N = MDSubprogram::get(
1212 Context, Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1213 IsDefinition, ScopeLine, ContainingType, Virtuality, VirtualIndex, Flags,
1214 IsOptimized, Function, TemplateParams, Declaration, Variables);
1216 EXPECT_EQ(dwarf::DW_TAG_subprogram, N->getTag());
1217 EXPECT_EQ(Scope, N->getScope());
1218 EXPECT_EQ(Name, N->getName());
1219 EXPECT_EQ(LinkageName, N->getLinkageName());
1220 EXPECT_EQ(File, N->getFile());
1221 EXPECT_EQ(Line, N->getLine());
1222 EXPECT_EQ(Type, N->getType());
1223 EXPECT_EQ(IsLocalToUnit, N->isLocalToUnit());
1224 EXPECT_EQ(IsDefinition, N->isDefinition());
1225 EXPECT_EQ(ScopeLine, N->getScopeLine());
1226 EXPECT_EQ(ContainingType, N->getContainingType());
1227 EXPECT_EQ(Virtuality, N->getVirtuality());
1228 EXPECT_EQ(VirtualIndex, N->getVirtualIndex());
1229 EXPECT_EQ(Flags, N->getFlags());
1230 EXPECT_EQ(IsOptimized, N->isOptimized());
1231 EXPECT_EQ(Function, N->getFunction());
1232 EXPECT_EQ(TemplateParams, N->getTemplateParams());
1233 EXPECT_EQ(Declaration, N->getDeclaration());
1234 EXPECT_EQ(Variables, N->getVariables());
1235 EXPECT_EQ(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1236 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1237 ContainingType, Virtuality, VirtualIndex,
1238 Flags, IsOptimized, Function, TemplateParams,
1239 Declaration, Variables));
1241 EXPECT_NE(N, MDSubprogram::get(Context, File, Name, LinkageName, File, Line,
1242 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1243 ContainingType, Virtuality, VirtualIndex,
1244 Flags, IsOptimized, Function, TemplateParams,
1245 Declaration, Variables));
1246 EXPECT_NE(N, MDSubprogram::get(Context, Scope, "other", LinkageName, File,
1247 Line, Type, IsLocalToUnit, IsDefinition,
1248 ScopeLine, ContainingType, Virtuality,
1249 VirtualIndex, Flags, IsOptimized, Function,
1250 TemplateParams, Declaration, Variables));
1251 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, "other", File, Line,
1252 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1253 ContainingType, Virtuality, VirtualIndex,
1254 Flags, IsOptimized, Function, TemplateParams,
1255 Declaration, Variables));
1256 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, Scope, Line,
1257 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1258 ContainingType, Virtuality, VirtualIndex,
1259 Flags, IsOptimized, Function, TemplateParams,
1260 Declaration, Variables));
1261 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File,
1262 Line + 1, Type, IsLocalToUnit, IsDefinition,
1263 ScopeLine, ContainingType, Virtuality,
1264 VirtualIndex, Flags, IsOptimized, Function,
1265 TemplateParams, Declaration, Variables));
1266 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1267 Scope, IsLocalToUnit, IsDefinition, ScopeLine,
1268 ContainingType, Virtuality, VirtualIndex,
1269 Flags, IsOptimized, Function, TemplateParams,
1270 Declaration, Variables));
1271 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1272 Type, !IsLocalToUnit, IsDefinition, ScopeLine,
1273 ContainingType, Virtuality, VirtualIndex,
1274 Flags, IsOptimized, Function, TemplateParams,
1275 Declaration, Variables));
1276 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1277 Type, IsLocalToUnit, !IsDefinition, ScopeLine,
1278 ContainingType, Virtuality, VirtualIndex,
1279 Flags, IsOptimized, Function, TemplateParams,
1280 Declaration, Variables));
1281 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1282 Type, IsLocalToUnit, IsDefinition,
1283 ScopeLine + 1, ContainingType, Virtuality,
1284 VirtualIndex, Flags, IsOptimized, Function,
1285 TemplateParams, Declaration, Variables));
1286 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1287 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1288 Type, Virtuality, VirtualIndex, Flags,
1289 IsOptimized, Function, TemplateParams,
1290 Declaration, Variables));
1291 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1292 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1293 ContainingType, Virtuality + 1, VirtualIndex,
1294 Flags, IsOptimized, Function, TemplateParams,
1295 Declaration, Variables));
1296 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1297 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1298 ContainingType, Virtuality, VirtualIndex + 1,
1299 Flags, IsOptimized, Function, TemplateParams,
1300 Declaration, Variables));
1301 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1302 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1303 ContainingType, Virtuality, VirtualIndex,
1304 ~Flags, IsOptimized, Function, TemplateParams,
1305 Declaration, Variables));
1306 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1307 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1308 ContainingType, Virtuality, VirtualIndex,
1309 Flags, !IsOptimized, Function, TemplateParams,
1310 Declaration, Variables));
1311 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1312 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1313 ContainingType, Virtuality, VirtualIndex,
1314 Flags, IsOptimized, Type, TemplateParams,
1315 Declaration, Variables));
1316 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1317 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1318 ContainingType, Virtuality, VirtualIndex,
1319 Flags, IsOptimized, Function, Type,
1320 Declaration, Variables));
1321 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1322 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1323 ContainingType, Virtuality, VirtualIndex,
1324 Flags, IsOptimized, Function, TemplateParams,
1326 EXPECT_NE(N, MDSubprogram::get(Context, Scope, Name, LinkageName, File, Line,
1327 Type, IsLocalToUnit, IsDefinition, ScopeLine,
1328 ContainingType, Virtuality, VirtualIndex,
1329 Flags, IsOptimized, Function, TemplateParams,
1330 Declaration, Type));
1332 TempMDSubprogram Temp = N->clone();
1333 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1336 TEST_F(MDSubprogramTest, replaceFunction) {
1337 Metadata *Scope = MDTuple::getDistinct(Context, None);
1338 StringRef Name = "name";
1339 StringRef LinkageName = "linkage";
1340 Metadata *File = MDTuple::getDistinct(Context, None);
1342 Metadata *Type = MDTuple::getDistinct(Context, None);
1343 bool IsLocalToUnit = false;
1344 bool IsDefinition = true;
1345 unsigned ScopeLine = 3;
1346 Metadata *ContainingType = MDTuple::getDistinct(Context, None);
1347 unsigned Virtuality = 4;
1348 unsigned VirtualIndex = 5;
1350 bool IsOptimized = false;
1351 Metadata *TemplateParams = MDTuple::getDistinct(Context, None);
1352 Metadata *Declaration = MDTuple::getDistinct(Context, None);
1353 Metadata *Variables = MDTuple::getDistinct(Context, None);
1355 auto *N = MDSubprogram::get(
1356 Context, Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1357 IsDefinition, ScopeLine, ContainingType, Virtuality, VirtualIndex, Flags,
1358 IsOptimized, nullptr, TemplateParams, Declaration, Variables);
1360 EXPECT_EQ(nullptr, N->getFunction());
1362 std::unique_ptr<Function> F(
1363 Function::Create(FunctionType::get(Type::getVoidTy(Context), false),
1364 GlobalValue::ExternalLinkage));
1365 N->replaceFunction(F.get());
1366 EXPECT_EQ(ConstantAsMetadata::get(F.get()), N->getFunction());
1368 N->replaceFunction(nullptr);
1369 EXPECT_EQ(nullptr, N->getFunction());
1372 typedef MetadataTest MDLexicalBlockTest;
1374 TEST_F(MDLexicalBlockTest, get) {
1375 Metadata *Scope = MDTuple::getDistinct(Context, None);
1376 Metadata *File = MDTuple::getDistinct(Context, None);
1378 unsigned Column = 8;
1380 auto *N = MDLexicalBlock::get(Context, Scope, File, Line, Column);
1382 EXPECT_EQ(dwarf::DW_TAG_lexical_block, N->getTag());
1383 EXPECT_EQ(Scope, N->getScope());
1384 EXPECT_EQ(File, N->getFile());
1385 EXPECT_EQ(Line, N->getLine());
1386 EXPECT_EQ(Column, N->getColumn());
1387 EXPECT_EQ(N, MDLexicalBlock::get(Context, Scope, File, Line, Column));
1389 EXPECT_NE(N, MDLexicalBlock::get(Context, File, File, Line, Column));
1390 EXPECT_NE(N, MDLexicalBlock::get(Context, Scope, Scope, Line, Column));
1391 EXPECT_NE(N, MDLexicalBlock::get(Context, Scope, File, Line + 1, Column));
1392 EXPECT_NE(N, MDLexicalBlock::get(Context, Scope, File, Line, Column + 1));
1394 TempMDLexicalBlock Temp = N->clone();
1395 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1398 typedef MetadataTest MDLexicalBlockFileTest;
1400 TEST_F(MDLexicalBlockFileTest, get) {
1401 Metadata *Scope = MDTuple::getDistinct(Context, None);
1402 Metadata *File = MDTuple::getDistinct(Context, None);
1403 unsigned Discriminator = 5;
1405 auto *N = MDLexicalBlockFile::get(Context, Scope, File, Discriminator);
1407 EXPECT_EQ(dwarf::DW_TAG_lexical_block, N->getTag());
1408 EXPECT_EQ(Scope, N->getScope());
1409 EXPECT_EQ(File, N->getFile());
1410 EXPECT_EQ(Discriminator, N->getDiscriminator());
1411 EXPECT_EQ(N, MDLexicalBlockFile::get(Context, Scope, File, Discriminator));
1413 EXPECT_NE(N, MDLexicalBlockFile::get(Context, File, File, Discriminator));
1414 EXPECT_NE(N, MDLexicalBlockFile::get(Context, Scope, Scope, Discriminator));
1416 MDLexicalBlockFile::get(Context, Scope, File, Discriminator + 1));
1418 TempMDLexicalBlockFile Temp = N->clone();
1419 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1422 typedef MetadataTest MDNamespaceTest;
1424 TEST_F(MDNamespaceTest, get) {
1425 Metadata *Scope = MDTuple::getDistinct(Context, None);
1426 Metadata *File = MDTuple::getDistinct(Context, None);
1427 StringRef Name = "namespace";
1430 auto *N = MDNamespace::get(Context, Scope, File, Name, Line);
1432 EXPECT_EQ(dwarf::DW_TAG_namespace, N->getTag());
1433 EXPECT_EQ(Scope, N->getScope());
1434 EXPECT_EQ(File, N->getFile());
1435 EXPECT_EQ(Name, N->getName());
1436 EXPECT_EQ(Line, N->getLine());
1437 EXPECT_EQ(N, MDNamespace::get(Context, Scope, File, Name, Line));
1439 EXPECT_NE(N, MDNamespace::get(Context, File, File, Name, Line));
1440 EXPECT_NE(N, MDNamespace::get(Context, Scope, Scope, Name, Line));
1441 EXPECT_NE(N, MDNamespace::get(Context, Scope, File, "other", Line));
1442 EXPECT_NE(N, MDNamespace::get(Context, Scope, File, Name, Line + 1));
1444 TempMDNamespace Temp = N->clone();
1445 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1448 typedef MetadataTest MDTemplateTypeParameterTest;
1450 TEST_F(MDTemplateTypeParameterTest, get) {
1451 StringRef Name = "template";
1452 Metadata *Type = MDTuple::getDistinct(Context, None);
1453 Metadata *Other = MDTuple::getDistinct(Context, None);
1455 auto *N = MDTemplateTypeParameter::get(Context, Name, Type);
1457 EXPECT_EQ(dwarf::DW_TAG_template_type_parameter, N->getTag());
1458 EXPECT_EQ(Name, N->getName());
1459 EXPECT_EQ(Type, N->getType());
1460 EXPECT_EQ(N, MDTemplateTypeParameter::get(Context, Name, Type));
1462 EXPECT_NE(N, MDTemplateTypeParameter::get(Context, "other", Type));
1463 EXPECT_NE(N, MDTemplateTypeParameter::get(Context, Name, Other));
1465 TempMDTemplateTypeParameter Temp = N->clone();
1466 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1469 typedef MetadataTest MDTemplateValueParameterTest;
1471 TEST_F(MDTemplateValueParameterTest, get) {
1472 unsigned Tag = dwarf::DW_TAG_template_value_parameter;
1473 StringRef Name = "template";
1474 Metadata *Type = MDTuple::getDistinct(Context, None);
1475 Metadata *Value = MDTuple::getDistinct(Context, None);
1476 Metadata *Other = MDTuple::getDistinct(Context, None);
1478 auto *N = MDTemplateValueParameter::get(Context, Tag, Name, Type, Value);
1479 EXPECT_EQ(Tag, N->getTag());
1480 EXPECT_EQ(Name, N->getName());
1481 EXPECT_EQ(Type, N->getType());
1482 EXPECT_EQ(Value, N->getValue());
1483 EXPECT_EQ(N, MDTemplateValueParameter::get(Context, Tag, Name, Type, Value));
1485 EXPECT_NE(N, MDTemplateValueParameter::get(
1486 Context, dwarf::DW_TAG_GNU_template_template_param, Name,
1488 EXPECT_NE(N, MDTemplateValueParameter::get(Context, Tag, "other", Type,
1490 EXPECT_NE(N, MDTemplateValueParameter::get(Context, Tag, Name, Other,
1492 EXPECT_NE(N, MDTemplateValueParameter::get(Context, Tag, Name, Type, Other));
1494 TempMDTemplateValueParameter Temp = N->clone();
1495 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1498 typedef MetadataTest MDGlobalVariableTest;
1500 TEST_F(MDGlobalVariableTest, get) {
1501 Metadata *Scope = MDTuple::getDistinct(Context, None);
1502 StringRef Name = "name";
1503 StringRef LinkageName = "linkage";
1504 Metadata *File = MDTuple::getDistinct(Context, None);
1506 Metadata *Type = MDTuple::getDistinct(Context, None);
1507 bool IsLocalToUnit = false;
1508 bool IsDefinition = true;
1509 Metadata *Variable = MDTuple::getDistinct(Context, None);
1510 Metadata *StaticDataMemberDeclaration = MDTuple::getDistinct(Context, None);
1512 auto *N = MDGlobalVariable::get(Context, Scope, Name, LinkageName, File, Line,
1513 Type, IsLocalToUnit, IsDefinition, Variable,
1514 StaticDataMemberDeclaration);
1515 EXPECT_EQ(dwarf::DW_TAG_variable, N->getTag());
1516 EXPECT_EQ(Scope, N->getScope());
1517 EXPECT_EQ(Name, N->getName());
1518 EXPECT_EQ(LinkageName, N->getLinkageName());
1519 EXPECT_EQ(File, N->getFile());
1520 EXPECT_EQ(Line, N->getLine());
1521 EXPECT_EQ(Type, N->getType());
1522 EXPECT_EQ(IsLocalToUnit, N->isLocalToUnit());
1523 EXPECT_EQ(IsDefinition, N->isDefinition());
1524 EXPECT_EQ(Variable, N->getVariable());
1525 EXPECT_EQ(StaticDataMemberDeclaration, N->getStaticDataMemberDeclaration());
1526 EXPECT_EQ(N, MDGlobalVariable::get(Context, Scope, Name, LinkageName, File,
1527 Line, Type, IsLocalToUnit, IsDefinition,
1528 Variable, StaticDataMemberDeclaration));
1530 EXPECT_NE(N, MDGlobalVariable::get(Context, File, Name, LinkageName, File,
1531 Line, Type, IsLocalToUnit, IsDefinition,
1532 Variable, StaticDataMemberDeclaration));
1533 EXPECT_NE(N, MDGlobalVariable::get(Context, Scope, "other", LinkageName, File,
1534 Line, Type, IsLocalToUnit, IsDefinition,
1535 Variable, StaticDataMemberDeclaration));
1536 EXPECT_NE(N, MDGlobalVariable::get(Context, Scope, Name, "other", File, Line,
1537 Type, IsLocalToUnit, IsDefinition,
1538 Variable, StaticDataMemberDeclaration));
1539 EXPECT_NE(N, MDGlobalVariable::get(Context, Scope, Name, LinkageName, Scope,
1540 Line, Type, IsLocalToUnit, IsDefinition,
1541 Variable, StaticDataMemberDeclaration));
1543 MDGlobalVariable::get(Context, Scope, Name, LinkageName, File,
1544 Line + 1, Type, IsLocalToUnit, IsDefinition,
1545 Variable, StaticDataMemberDeclaration));
1546 EXPECT_NE(N, MDGlobalVariable::get(Context, Scope, Name, LinkageName, File,
1547 Line, Scope, IsLocalToUnit, IsDefinition,
1548 Variable, StaticDataMemberDeclaration));
1549 EXPECT_NE(N, MDGlobalVariable::get(Context, Scope, Name, LinkageName, File,
1550 Line, Type, !IsLocalToUnit, IsDefinition,
1551 Variable, StaticDataMemberDeclaration));
1552 EXPECT_NE(N, MDGlobalVariable::get(Context, Scope, Name, LinkageName, File,
1553 Line, Type, IsLocalToUnit, !IsDefinition,
1554 Variable, StaticDataMemberDeclaration));
1555 EXPECT_NE(N, MDGlobalVariable::get(Context, Scope, Name, LinkageName, File,
1556 Line, Type, IsLocalToUnit, IsDefinition,
1557 Type, StaticDataMemberDeclaration));
1558 EXPECT_NE(N, MDGlobalVariable::get(Context, Scope, Name, LinkageName, File,
1559 Line, Type, IsLocalToUnit, IsDefinition,
1562 TempMDGlobalVariable Temp = N->clone();
1563 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1566 typedef MetadataTest MDLocalVariableTest;
1568 TEST_F(MDLocalVariableTest, get) {
1569 unsigned Tag = dwarf::DW_TAG_arg_variable;
1570 Metadata *Scope = MDTuple::getDistinct(Context, None);
1571 StringRef Name = "name";
1572 Metadata *File = MDTuple::getDistinct(Context, None);
1574 Metadata *Type = MDTuple::getDistinct(Context, None);
1577 Metadata *InlinedAt = MDTuple::getDistinct(Context, None);
1579 auto *N = MDLocalVariable::get(Context, Tag, Scope, Name, File, Line, Type,
1580 Arg, Flags, InlinedAt);
1581 EXPECT_EQ(Tag, N->getTag());
1582 EXPECT_EQ(Scope, N->getScope());
1583 EXPECT_EQ(Name, N->getName());
1584 EXPECT_EQ(File, N->getFile());
1585 EXPECT_EQ(Line, N->getLine());
1586 EXPECT_EQ(Type, N->getType());
1587 EXPECT_EQ(Arg, N->getArg());
1588 EXPECT_EQ(Flags, N->getFlags());
1589 EXPECT_EQ(InlinedAt, N->getInlinedAt());
1590 EXPECT_EQ(N, MDLocalVariable::get(Context, Tag, Scope, Name, File, Line, Type,
1591 Arg, Flags, InlinedAt));
1593 EXPECT_NE(N, MDLocalVariable::get(Context, dwarf::DW_TAG_auto_variable, Scope,
1594 Name, File, Line, Type, Arg, Flags,
1596 EXPECT_NE(N, MDLocalVariable::get(Context, Tag, File, Name, File, Line,
1597 Type, Arg, Flags, InlinedAt));
1598 EXPECT_NE(N, MDLocalVariable::get(Context, Tag, Scope, "other", File, Line,
1599 Type, Arg, Flags, InlinedAt));
1600 EXPECT_NE(N, MDLocalVariable::get(Context, Tag, Scope, Name, Scope, Line,
1601 Type, Arg, Flags, InlinedAt));
1602 EXPECT_NE(N, MDLocalVariable::get(Context, Tag, Scope, Name, File, Line + 1,
1603 Type, Arg, Flags, InlinedAt));
1604 EXPECT_NE(N, MDLocalVariable::get(Context, Tag, Scope, Name, File, Line,
1605 Scope, Arg, Flags, InlinedAt));
1606 EXPECT_NE(N, MDLocalVariable::get(Context, Tag, Scope, Name, File, Line, Type,
1607 Arg + 1, Flags, InlinedAt));
1608 EXPECT_NE(N, MDLocalVariable::get(Context, Tag, Scope, Name, File, Line, Type,
1609 Arg, ~Flags, InlinedAt));
1610 EXPECT_NE(N, MDLocalVariable::get(Context, Tag, Scope, Name, File, Line, Type,
1611 Arg, Flags, Scope));
1613 TempMDLocalVariable Temp = N->clone();
1614 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1617 typedef MetadataTest MDExpressionTest;
1619 TEST_F(MDExpressionTest, get) {
1620 uint64_t Elements[] = {2, 6, 9, 78, 0};
1621 auto *N = MDExpression::get(Context, Elements);
1622 EXPECT_EQ(makeArrayRef(Elements), N->getElements());
1623 EXPECT_EQ(N, MDExpression::get(Context, Elements));
1625 EXPECT_EQ(5u, N->getNumElements());
1626 EXPECT_EQ(2u, N->getElement(0));
1627 EXPECT_EQ(6u, N->getElement(1));
1628 EXPECT_EQ(9u, N->getElement(2));
1629 EXPECT_EQ(78u, N->getElement(3));
1630 EXPECT_EQ(0u, N->getElement(4));
1632 TempMDExpression Temp = N->clone();
1633 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1636 TEST_F(MDExpressionTest, isValid) {
1637 #define EXPECT_VALID(...) \
1639 uint64_t Elements[] = {__VA_ARGS__}; \
1640 EXPECT_TRUE(MDExpression::get(Context, Elements)->isValid()); \
1642 #define EXPECT_INVALID(...) \
1644 uint64_t Elements[] = {__VA_ARGS__}; \
1645 EXPECT_FALSE(MDExpression::get(Context, Elements)->isValid()); \
1648 // Empty expression should be valid.
1649 EXPECT_TRUE(MDExpression::get(Context, None));
1651 // Valid constructions.
1652 EXPECT_VALID(dwarf::DW_OP_plus, 6);
1653 EXPECT_VALID(dwarf::DW_OP_deref);
1654 EXPECT_VALID(dwarf::DW_OP_bit_piece, 3, 7);
1655 EXPECT_VALID(dwarf::DW_OP_plus, 6, dwarf::DW_OP_deref);
1656 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_plus, 6);
1657 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_bit_piece, 3, 7);
1658 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_plus, 6, dwarf::DW_OP_bit_piece, 3, 7);
1660 // Invalid constructions.
1661 EXPECT_INVALID(~0u);
1662 EXPECT_INVALID(dwarf::DW_OP_plus);
1663 EXPECT_INVALID(dwarf::DW_OP_bit_piece);
1664 EXPECT_INVALID(dwarf::DW_OP_bit_piece, 3);
1665 EXPECT_INVALID(dwarf::DW_OP_bit_piece, 3, 7, dwarf::DW_OP_plus, 3);
1666 EXPECT_INVALID(dwarf::DW_OP_bit_piece, 3, 7, dwarf::DW_OP_deref);
1669 #undef EXPECT_INVALID
1672 typedef MetadataTest MDObjCPropertyTest;
1674 TEST_F(MDObjCPropertyTest, get) {
1675 StringRef Name = "name";
1676 Metadata *File = MDTuple::getDistinct(Context, None);
1678 StringRef GetterName = "getter";
1679 StringRef SetterName = "setter";
1680 unsigned Attributes = 7;
1681 Metadata *Type = MDTuple::getDistinct(Context, None);
1683 auto *N = MDObjCProperty::get(Context, Name, File, Line, GetterName,
1684 SetterName, Attributes, Type);
1686 EXPECT_EQ(dwarf::DW_TAG_APPLE_property, N->getTag());
1687 EXPECT_EQ(Name, N->getName());
1688 EXPECT_EQ(File, N->getFile());
1689 EXPECT_EQ(Line, N->getLine());
1690 EXPECT_EQ(GetterName, N->getGetterName());
1691 EXPECT_EQ(SetterName, N->getSetterName());
1692 EXPECT_EQ(Attributes, N->getAttributes());
1693 EXPECT_EQ(Type, N->getType());
1694 EXPECT_EQ(N, MDObjCProperty::get(Context, Name, File, Line, GetterName,
1695 SetterName, Attributes, Type));
1697 EXPECT_NE(N, MDObjCProperty::get(Context, "other", File, Line, GetterName,
1698 SetterName, Attributes, Type));
1699 EXPECT_NE(N, MDObjCProperty::get(Context, Name, Type, Line, GetterName,
1700 SetterName, Attributes, Type));
1701 EXPECT_NE(N, MDObjCProperty::get(Context, Name, File, Line + 1, GetterName,
1702 SetterName, Attributes, Type));
1703 EXPECT_NE(N, MDObjCProperty::get(Context, Name, File, Line, "other",
1704 SetterName, Attributes, Type));
1705 EXPECT_NE(N, MDObjCProperty::get(Context, Name, File, Line, GetterName,
1706 "other", Attributes, Type));
1707 EXPECT_NE(N, MDObjCProperty::get(Context, Name, File, Line, GetterName,
1708 SetterName, Attributes + 1, Type));
1709 EXPECT_NE(N, MDObjCProperty::get(Context, Name, File, Line, GetterName,
1710 SetterName, Attributes, File));
1712 TempMDObjCProperty Temp = N->clone();
1713 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1716 typedef MetadataTest MDImportedEntityTest;
1718 TEST_F(MDImportedEntityTest, get) {
1719 unsigned Tag = dwarf::DW_TAG_imported_module;
1720 Metadata *Scope = MDTuple::getDistinct(Context, None);
1721 Metadata *Entity = MDTuple::getDistinct(Context, None);
1723 StringRef Name = "name";
1725 auto *N = MDImportedEntity::get(Context, Tag, Scope, Entity, Line, Name);
1727 EXPECT_EQ(Tag, N->getTag());
1728 EXPECT_EQ(Scope, N->getScope());
1729 EXPECT_EQ(Entity, N->getEntity());
1730 EXPECT_EQ(Line, N->getLine());
1731 EXPECT_EQ(Name, N->getName());
1732 EXPECT_EQ(N, MDImportedEntity::get(Context, Tag, Scope, Entity, Line, Name));
1735 MDImportedEntity::get(Context, dwarf::DW_TAG_imported_declaration,
1736 Scope, Entity, Line, Name));
1737 EXPECT_NE(N, MDImportedEntity::get(Context, Tag, Entity, Entity, Line, Name));
1738 EXPECT_NE(N, MDImportedEntity::get(Context, Tag, Scope, Scope, Line, Name));
1740 MDImportedEntity::get(Context, Tag, Scope, Entity, Line + 1, Name));
1742 MDImportedEntity::get(Context, Tag, Scope, Entity, Line, "other"));
1744 TempMDImportedEntity Temp = N->clone();
1745 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1748 typedef MetadataTest MetadataAsValueTest;
1750 TEST_F(MetadataAsValueTest, MDNode) {
1751 MDNode *N = MDNode::get(Context, None);
1752 auto *V = MetadataAsValue::get(Context, N);
1753 EXPECT_TRUE(V->getType()->isMetadataTy());
1754 EXPECT_EQ(N, V->getMetadata());
1756 auto *V2 = MetadataAsValue::get(Context, N);
1760 TEST_F(MetadataAsValueTest, MDNodeMDNode) {
1761 MDNode *N = MDNode::get(Context, None);
1762 Metadata *Ops[] = {N};
1763 MDNode *N2 = MDNode::get(Context, Ops);
1764 auto *V = MetadataAsValue::get(Context, N2);
1765 EXPECT_TRUE(V->getType()->isMetadataTy());
1766 EXPECT_EQ(N2, V->getMetadata());
1768 auto *V2 = MetadataAsValue::get(Context, N2);
1771 auto *V3 = MetadataAsValue::get(Context, N);
1772 EXPECT_TRUE(V3->getType()->isMetadataTy());
1774 EXPECT_EQ(N, V3->getMetadata());
1777 TEST_F(MetadataAsValueTest, MDNodeConstant) {
1778 auto *C = ConstantInt::getTrue(Context);
1779 auto *MD = ConstantAsMetadata::get(C);
1780 Metadata *Ops[] = {MD};
1781 auto *N = MDNode::get(Context, Ops);
1783 auto *V = MetadataAsValue::get(Context, MD);
1784 EXPECT_TRUE(V->getType()->isMetadataTy());
1785 EXPECT_EQ(MD, V->getMetadata());
1787 auto *V2 = MetadataAsValue::get(Context, N);
1788 EXPECT_EQ(MD, V2->getMetadata());
1792 typedef MetadataTest ValueAsMetadataTest;
1794 TEST_F(ValueAsMetadataTest, UpdatesOnRAUW) {
1795 Type *Ty = Type::getInt1PtrTy(Context);
1796 std::unique_ptr<GlobalVariable> GV0(
1797 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
1798 auto *MD = ValueAsMetadata::get(GV0.get());
1799 EXPECT_TRUE(MD->getValue() == GV0.get());
1800 ASSERT_TRUE(GV0->use_empty());
1802 std::unique_ptr<GlobalVariable> GV1(
1803 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
1804 GV0->replaceAllUsesWith(GV1.get());
1805 EXPECT_TRUE(MD->getValue() == GV1.get());
1808 TEST_F(ValueAsMetadataTest, CollidingDoubleUpdates) {
1809 // Create a constant.
1810 ConstantAsMetadata *CI = ConstantAsMetadata::get(
1811 ConstantInt::get(getGlobalContext(), APInt(8, 0)));
1813 // Create a temporary to prevent nodes from resolving.
1814 auto Temp = MDTuple::getTemporary(Context, None);
1816 // When the first operand of N1 gets reset to nullptr, it'll collide with N2.
1817 Metadata *Ops1[] = {CI, CI, Temp.get()};
1818 Metadata *Ops2[] = {nullptr, CI, Temp.get()};
1820 auto *N1 = MDTuple::get(Context, Ops1);
1821 auto *N2 = MDTuple::get(Context, Ops2);
1824 // Tell metadata that the constant is getting deleted.
1826 // After this, N1 will be invalid, so don't touch it.
1827 ValueAsMetadata::handleDeletion(CI->getValue());
1828 EXPECT_EQ(nullptr, N2->getOperand(0));
1829 EXPECT_EQ(nullptr, N2->getOperand(1));
1830 EXPECT_EQ(Temp.get(), N2->getOperand(2));
1832 // Clean up Temp for teardown.
1833 Temp->replaceAllUsesWith(nullptr);
1836 typedef MetadataTest TrackingMDRefTest;
1838 TEST_F(TrackingMDRefTest, UpdatesOnRAUW) {
1839 Type *Ty = Type::getInt1PtrTy(Context);
1840 std::unique_ptr<GlobalVariable> GV0(
1841 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
1842 TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV0.get()));
1843 EXPECT_TRUE(MD->getValue() == GV0.get());
1844 ASSERT_TRUE(GV0->use_empty());
1846 std::unique_ptr<GlobalVariable> GV1(
1847 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
1848 GV0->replaceAllUsesWith(GV1.get());
1849 EXPECT_TRUE(MD->getValue() == GV1.get());
1851 // Reset it, so we don't inadvertently test deletion.
1855 TEST_F(TrackingMDRefTest, UpdatesOnDeletion) {
1856 Type *Ty = Type::getInt1PtrTy(Context);
1857 std::unique_ptr<GlobalVariable> GV(
1858 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
1859 TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV.get()));
1860 EXPECT_TRUE(MD->getValue() == GV.get());
1861 ASSERT_TRUE(GV->use_empty());
1867 TEST(NamedMDNodeTest, Search) {
1868 LLVMContext Context;
1869 ConstantAsMetadata *C =
1870 ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 1));
1871 ConstantAsMetadata *C2 =
1872 ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 2));
1874 Metadata *const V = C;
1875 Metadata *const V2 = C2;
1876 MDNode *n = MDNode::get(Context, V);
1877 MDNode *n2 = MDNode::get(Context, V2);
1879 Module M("MyModule", Context);
1880 const char *Name = "llvm.NMD1";
1881 NamedMDNode *NMD = M.getOrInsertNamedMetadata(Name);
1883 NMD->addOperand(n2);
1886 raw_string_ostream oss(Str);
1888 EXPECT_STREQ("!llvm.NMD1 = !{!0, !1}\n",