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