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