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