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/DIBuilder.h"
14 #include "llvm/IR/DebugInfo.h"
15 #include "llvm/IR/DebugInfoMetadata.h"
16 #include "llvm/IR/Function.h"
17 #include "llvm/IR/Instructions.h"
18 #include "llvm/IR/LLVMContext.h"
19 #include "llvm/IR/Module.h"
20 #include "llvm/IR/ModuleSlotTracker.h"
21 #include "llvm/IR/Type.h"
22 #include "llvm/IR/Verifier.h"
23 #include "llvm/Support/raw_ostream.h"
24 #include "gtest/gtest.h"
25 using namespace llvm;
26
27 namespace {
28
TEST(ContextAndReplaceableUsesTest,FromContext)29 TEST(ContextAndReplaceableUsesTest, FromContext) {
30 LLVMContext Context;
31 ContextAndReplaceableUses CRU(Context);
32 EXPECT_EQ(&Context, &CRU.getContext());
33 EXPECT_FALSE(CRU.hasReplaceableUses());
34 EXPECT_FALSE(CRU.getReplaceableUses());
35 }
36
TEST(ContextAndReplaceableUsesTest,FromReplaceableUses)37 TEST(ContextAndReplaceableUsesTest, FromReplaceableUses) {
38 LLVMContext Context;
39 ContextAndReplaceableUses CRU(std::make_unique<ReplaceableMetadataImpl>(Context));
40 EXPECT_EQ(&Context, &CRU.getContext());
41 EXPECT_TRUE(CRU.hasReplaceableUses());
42 EXPECT_TRUE(CRU.getReplaceableUses());
43 }
44
TEST(ContextAndReplaceableUsesTest,makeReplaceable)45 TEST(ContextAndReplaceableUsesTest, makeReplaceable) {
46 LLVMContext Context;
47 ContextAndReplaceableUses CRU(Context);
48 CRU.makeReplaceable(std::make_unique<ReplaceableMetadataImpl>(Context));
49 EXPECT_EQ(&Context, &CRU.getContext());
50 EXPECT_TRUE(CRU.hasReplaceableUses());
51 EXPECT_TRUE(CRU.getReplaceableUses());
52 }
53
TEST(ContextAndReplaceableUsesTest,takeReplaceableUses)54 TEST(ContextAndReplaceableUsesTest, takeReplaceableUses) {
55 LLVMContext Context;
56 auto ReplaceableUses = std::make_unique<ReplaceableMetadataImpl>(Context);
57 auto *Ptr = ReplaceableUses.get();
58 ContextAndReplaceableUses CRU(std::move(ReplaceableUses));
59 ReplaceableUses = CRU.takeReplaceableUses();
60 EXPECT_EQ(&Context, &CRU.getContext());
61 EXPECT_FALSE(CRU.hasReplaceableUses());
62 EXPECT_FALSE(CRU.getReplaceableUses());
63 EXPECT_EQ(Ptr, ReplaceableUses.get());
64 }
65
66 class MetadataTest : public testing::Test {
67 public:
MetadataTest()68 MetadataTest() : M("test", Context), Counter(0) {}
69
70 protected:
71 LLVMContext Context;
72 Module M;
73 int Counter;
74
getNode()75 MDNode *getNode() { return MDNode::get(Context, None); }
getNode(Metadata * MD)76 MDNode *getNode(Metadata *MD) { return MDNode::get(Context, MD); }
getNode(Metadata * MD1,Metadata * MD2)77 MDNode *getNode(Metadata *MD1, Metadata *MD2) {
78 Metadata *MDs[] = {MD1, MD2};
79 return MDNode::get(Context, MDs);
80 }
81
getTuple()82 MDTuple *getTuple() { return MDTuple::getDistinct(Context, None); }
getSubroutineType()83 DISubroutineType *getSubroutineType() {
84 return DISubroutineType::getDistinct(Context, DINode::FlagZero, 0,
85 getNode(nullptr));
86 }
getSubprogram()87 DISubprogram *getSubprogram() {
88 return DISubprogram::getDistinct(
89 Context, nullptr, "", "", nullptr, 0, nullptr, 0, nullptr, 0, 0,
90 DINode::FlagZero, DISubprogram::SPFlagZero, nullptr);
91 }
getFile()92 DIFile *getFile() {
93 return DIFile::getDistinct(Context, "file.c", "/path/to/dir");
94 }
getUnit()95 DICompileUnit *getUnit() {
96 return DICompileUnit::getDistinct(
97 Context, 1, getFile(), "clang", false, "-g", 2, "",
98 DICompileUnit::FullDebug, getTuple(), getTuple(), getTuple(),
99 getTuple(), getTuple(), 0, true, false,
100 DICompileUnit::DebugNameTableKind::Default, false, "/", "");
101 }
getBasicType(StringRef Name)102 DIType *getBasicType(StringRef Name) {
103 return DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type, Name);
104 }
getDerivedType()105 DIType *getDerivedType() {
106 return DIDerivedType::getDistinct(
107 Context, dwarf::DW_TAG_pointer_type, "", nullptr, 0, nullptr,
108 getBasicType("basictype"), 1, 2, 0, None, DINode::FlagZero);
109 }
getConstant()110 Constant *getConstant() {
111 return ConstantInt::get(Type::getInt32Ty(Context), Counter++);
112 }
getConstantAsMetadata()113 ConstantAsMetadata *getConstantAsMetadata() {
114 return ConstantAsMetadata::get(getConstant());
115 }
getCompositeType()116 DIType *getCompositeType() {
117 return DICompositeType::getDistinct(
118 Context, dwarf::DW_TAG_structure_type, "", nullptr, 0, nullptr, nullptr,
119 32, 32, 0, DINode::FlagZero, nullptr, 0, nullptr, nullptr, "");
120 }
getFunction(StringRef Name)121 Function *getFunction(StringRef Name) {
122 return Function::Create(
123 FunctionType::get(Type::getVoidTy(Context), None, false),
124 Function::ExternalLinkage, Name, M);
125 }
126 };
127 typedef MetadataTest MDStringTest;
128
129 // Test that construction of MDString with different value produces different
130 // MDString objects, even with the same string pointer and nulls in the string.
TEST_F(MDStringTest,CreateDifferent)131 TEST_F(MDStringTest, CreateDifferent) {
132 char x[3] = { 'f', 0, 'A' };
133 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
134 x[2] = 'B';
135 MDString *s2 = MDString::get(Context, StringRef(&x[0], 3));
136 EXPECT_NE(s1, s2);
137 }
138
139 // Test that creation of MDStrings with the same string contents produces the
140 // same MDString object, even with different pointers.
TEST_F(MDStringTest,CreateSame)141 TEST_F(MDStringTest, CreateSame) {
142 char x[4] = { 'a', 'b', 'c', 'X' };
143 char y[4] = { 'a', 'b', 'c', 'Y' };
144
145 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
146 MDString *s2 = MDString::get(Context, StringRef(&y[0], 3));
147 EXPECT_EQ(s1, s2);
148 }
149
150 // Test that MDString prints out the string we fed it.
TEST_F(MDStringTest,PrintingSimple)151 TEST_F(MDStringTest, PrintingSimple) {
152 char str[14] = "testing 1 2 3";
153 MDString *s = MDString::get(Context, StringRef(&str[0], 13));
154 strncpy(str, "aaaaaaaaaaaaa", 14);
155
156 std::string Str;
157 raw_string_ostream oss(Str);
158 s->print(oss);
159 EXPECT_STREQ("!\"testing 1 2 3\"", oss.str().c_str());
160 }
161
162 // Test printing of MDString with non-printable characters.
TEST_F(MDStringTest,PrintingComplex)163 TEST_F(MDStringTest, PrintingComplex) {
164 char str[5] = {0, '\n', '"', '\\', (char)-1};
165 MDString *s = MDString::get(Context, StringRef(str+0, 5));
166 std::string Str;
167 raw_string_ostream oss(Str);
168 s->print(oss);
169 EXPECT_STREQ("!\"\\00\\0A\\22\\\\\\FF\"", oss.str().c_str());
170 }
171
172 typedef MetadataTest MDNodeTest;
173
174 // Test the two constructors, and containing other Constants.
TEST_F(MDNodeTest,Simple)175 TEST_F(MDNodeTest, Simple) {
176 char x[3] = { 'a', 'b', 'c' };
177 char y[3] = { '1', '2', '3' };
178
179 MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
180 MDString *s2 = MDString::get(Context, StringRef(&y[0], 3));
181 ConstantAsMetadata *CI =
182 ConstantAsMetadata::get(ConstantInt::get(Context, APInt(8, 0)));
183
184 std::vector<Metadata *> V;
185 V.push_back(s1);
186 V.push_back(CI);
187 V.push_back(s2);
188
189 MDNode *n1 = MDNode::get(Context, V);
190 Metadata *const c1 = n1;
191 MDNode *n2 = MDNode::get(Context, c1);
192 Metadata *const c2 = n2;
193 MDNode *n3 = MDNode::get(Context, V);
194 MDNode *n4 = MDNode::getIfExists(Context, V);
195 MDNode *n5 = MDNode::getIfExists(Context, c1);
196 MDNode *n6 = MDNode::getIfExists(Context, c2);
197 EXPECT_NE(n1, n2);
198 EXPECT_EQ(n1, n3);
199 EXPECT_EQ(n4, n1);
200 EXPECT_EQ(n5, n2);
201 EXPECT_EQ(n6, (Metadata *)nullptr);
202
203 EXPECT_EQ(3u, n1->getNumOperands());
204 EXPECT_EQ(s1, n1->getOperand(0));
205 EXPECT_EQ(CI, n1->getOperand(1));
206 EXPECT_EQ(s2, n1->getOperand(2));
207
208 EXPECT_EQ(1u, n2->getNumOperands());
209 EXPECT_EQ(n1, n2->getOperand(0));
210 }
211
TEST_F(MDNodeTest,Delete)212 TEST_F(MDNodeTest, Delete) {
213 Constant *C = ConstantInt::get(Type::getInt32Ty(Context), 1);
214 Instruction *I = new BitCastInst(C, Type::getInt32Ty(Context));
215
216 Metadata *const V = LocalAsMetadata::get(I);
217 MDNode *n = MDNode::get(Context, V);
218 TrackingMDRef wvh(n);
219
220 EXPECT_EQ(n, wvh);
221
222 I->deleteValue();
223 }
224
TEST_F(MDNodeTest,SelfReference)225 TEST_F(MDNodeTest, SelfReference) {
226 // !0 = !{!0}
227 // !1 = !{!0}
228 {
229 auto Temp = MDNode::getTemporary(Context, None);
230 Metadata *Args[] = {Temp.get()};
231 MDNode *Self = MDNode::get(Context, Args);
232 Self->replaceOperandWith(0, Self);
233 ASSERT_EQ(Self, Self->getOperand(0));
234
235 // Self-references should be distinct, so MDNode::get() should grab a
236 // uniqued node that references Self, not Self.
237 Args[0] = Self;
238 MDNode *Ref1 = MDNode::get(Context, Args);
239 MDNode *Ref2 = MDNode::get(Context, Args);
240 EXPECT_NE(Self, Ref1);
241 EXPECT_EQ(Ref1, Ref2);
242 }
243
244 // !0 = !{!0, !{}}
245 // !1 = !{!0, !{}}
246 {
247 auto Temp = MDNode::getTemporary(Context, None);
248 Metadata *Args[] = {Temp.get(), MDNode::get(Context, None)};
249 MDNode *Self = MDNode::get(Context, Args);
250 Self->replaceOperandWith(0, Self);
251 ASSERT_EQ(Self, Self->getOperand(0));
252
253 // Self-references should be distinct, so MDNode::get() should grab a
254 // uniqued node that references Self, not Self itself.
255 Args[0] = Self;
256 MDNode *Ref1 = MDNode::get(Context, Args);
257 MDNode *Ref2 = MDNode::get(Context, Args);
258 EXPECT_NE(Self, Ref1);
259 EXPECT_EQ(Ref1, Ref2);
260 }
261 }
262
TEST_F(MDNodeTest,Print)263 TEST_F(MDNodeTest, Print) {
264 Constant *C = ConstantInt::get(Type::getInt32Ty(Context), 7);
265 MDString *S = MDString::get(Context, "foo");
266 MDNode *N0 = getNode();
267 MDNode *N1 = getNode(N0);
268 MDNode *N2 = getNode(N0, N1);
269
270 Metadata *Args[] = {ConstantAsMetadata::get(C), S, nullptr, N0, N1, N2};
271 MDNode *N = MDNode::get(Context, Args);
272
273 std::string Expected;
274 {
275 raw_string_ostream OS(Expected);
276 OS << "<" << (void *)N << "> = !{";
277 C->printAsOperand(OS);
278 OS << ", ";
279 S->printAsOperand(OS);
280 OS << ", null";
281 MDNode *Nodes[] = {N0, N1, N2};
282 for (auto *Node : Nodes)
283 OS << ", <" << (void *)Node << ">";
284 OS << "}";
285 }
286
287 std::string Actual;
288 {
289 raw_string_ostream OS(Actual);
290 N->print(OS);
291 }
292
293 EXPECT_EQ(Expected, Actual);
294 }
295
296 #define EXPECT_PRINTER_EQ(EXPECTED, PRINT) \
297 do { \
298 std::string Actual_; \
299 raw_string_ostream OS(Actual_); \
300 PRINT; \
301 OS.flush(); \
302 std::string Expected_(EXPECTED); \
303 EXPECT_EQ(Expected_, Actual_); \
304 } while (false)
305
TEST_F(MDNodeTest,PrintTemporary)306 TEST_F(MDNodeTest, PrintTemporary) {
307 MDNode *Arg = getNode();
308 TempMDNode Temp = MDNode::getTemporary(Context, Arg);
309 MDNode *N = getNode(Temp.get());
310 Module M("test", Context);
311 NamedMDNode *NMD = M.getOrInsertNamedMetadata("named");
312 NMD->addOperand(N);
313
314 EXPECT_PRINTER_EQ("!0 = !{!1}", N->print(OS, &M));
315 EXPECT_PRINTER_EQ("!1 = <temporary!> !{!2}", Temp->print(OS, &M));
316 EXPECT_PRINTER_EQ("!2 = !{}", Arg->print(OS, &M));
317
318 // Cleanup.
319 Temp->replaceAllUsesWith(Arg);
320 }
321
TEST_F(MDNodeTest,PrintFromModule)322 TEST_F(MDNodeTest, PrintFromModule) {
323 Constant *C = ConstantInt::get(Type::getInt32Ty(Context), 7);
324 MDString *S = MDString::get(Context, "foo");
325 MDNode *N0 = getNode();
326 MDNode *N1 = getNode(N0);
327 MDNode *N2 = getNode(N0, N1);
328
329 Metadata *Args[] = {ConstantAsMetadata::get(C), S, nullptr, N0, N1, N2};
330 MDNode *N = MDNode::get(Context, Args);
331 Module M("test", Context);
332 NamedMDNode *NMD = M.getOrInsertNamedMetadata("named");
333 NMD->addOperand(N);
334
335 std::string Expected;
336 {
337 raw_string_ostream OS(Expected);
338 OS << "!0 = !{";
339 C->printAsOperand(OS);
340 OS << ", ";
341 S->printAsOperand(OS);
342 OS << ", null, !1, !2, !3}";
343 }
344
345 EXPECT_PRINTER_EQ(Expected, N->print(OS, &M));
346 }
347
TEST_F(MDNodeTest,PrintFromFunction)348 TEST_F(MDNodeTest, PrintFromFunction) {
349 Module M("test", Context);
350 auto *FTy = FunctionType::get(Type::getVoidTy(Context), false);
351 auto *F0 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F0", &M);
352 auto *F1 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F1", &M);
353 auto *BB0 = BasicBlock::Create(Context, "entry", F0);
354 auto *BB1 = BasicBlock::Create(Context, "entry", F1);
355 auto *R0 = ReturnInst::Create(Context, BB0);
356 auto *R1 = ReturnInst::Create(Context, BB1);
357 auto *N0 = MDNode::getDistinct(Context, None);
358 auto *N1 = MDNode::getDistinct(Context, None);
359 R0->setMetadata("md", N0);
360 R1->setMetadata("md", N1);
361
362 EXPECT_PRINTER_EQ("!0 = distinct !{}", N0->print(OS, &M));
363 EXPECT_PRINTER_EQ("!1 = distinct !{}", N1->print(OS, &M));
364
365 ModuleSlotTracker MST(&M);
366 EXPECT_PRINTER_EQ("!0 = distinct !{}", N0->print(OS, MST));
367 EXPECT_PRINTER_EQ("!1 = distinct !{}", N1->print(OS, MST));
368 }
369
TEST_F(MDNodeTest,PrintFromMetadataAsValue)370 TEST_F(MDNodeTest, PrintFromMetadataAsValue) {
371 Module M("test", Context);
372
373 auto *Intrinsic =
374 Function::Create(FunctionType::get(Type::getVoidTy(Context),
375 Type::getMetadataTy(Context), false),
376 GlobalValue::ExternalLinkage, "llvm.intrinsic", &M);
377
378 auto *FTy = FunctionType::get(Type::getVoidTy(Context), false);
379 auto *F0 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F0", &M);
380 auto *F1 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F1", &M);
381 auto *BB0 = BasicBlock::Create(Context, "entry", F0);
382 auto *BB1 = BasicBlock::Create(Context, "entry", F1);
383 auto *N0 = MDNode::getDistinct(Context, None);
384 auto *N1 = MDNode::getDistinct(Context, None);
385 auto *MAV0 = MetadataAsValue::get(Context, N0);
386 auto *MAV1 = MetadataAsValue::get(Context, N1);
387 CallInst::Create(Intrinsic, MAV0, "", BB0);
388 CallInst::Create(Intrinsic, MAV1, "", BB1);
389
390 EXPECT_PRINTER_EQ("!0 = distinct !{}", MAV0->print(OS));
391 EXPECT_PRINTER_EQ("!1 = distinct !{}", MAV1->print(OS));
392 EXPECT_PRINTER_EQ("!0", MAV0->printAsOperand(OS, false));
393 EXPECT_PRINTER_EQ("!1", MAV1->printAsOperand(OS, false));
394 EXPECT_PRINTER_EQ("metadata !0", MAV0->printAsOperand(OS, true));
395 EXPECT_PRINTER_EQ("metadata !1", MAV1->printAsOperand(OS, true));
396
397 ModuleSlotTracker MST(&M);
398 EXPECT_PRINTER_EQ("!0 = distinct !{}", MAV0->print(OS, MST));
399 EXPECT_PRINTER_EQ("!1 = distinct !{}", MAV1->print(OS, MST));
400 EXPECT_PRINTER_EQ("!0", MAV0->printAsOperand(OS, false, MST));
401 EXPECT_PRINTER_EQ("!1", MAV1->printAsOperand(OS, false, MST));
402 EXPECT_PRINTER_EQ("metadata !0", MAV0->printAsOperand(OS, true, MST));
403 EXPECT_PRINTER_EQ("metadata !1", MAV1->printAsOperand(OS, true, MST));
404 }
405
TEST_F(MDNodeTest,PrintWithDroppedCallOperand)406 TEST_F(MDNodeTest, PrintWithDroppedCallOperand) {
407 Module M("test", Context);
408
409 auto *FTy = FunctionType::get(Type::getVoidTy(Context), false);
410 auto *F0 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F0", &M);
411 auto *F1 = Function::Create(FTy, GlobalValue::ExternalLinkage, "F1", &M);
412 auto *BB0 = BasicBlock::Create(Context, "entry", F0);
413
414 CallInst *CI0 = CallInst::Create(F1, "", BB0);
415 CI0->dropAllReferences();
416
417 auto *R0 = ReturnInst::Create(Context, BB0);
418 auto *N0 = MDNode::getDistinct(Context, None);
419 R0->setMetadata("md", N0);
420
421 // Printing the metadata node would previously result in a failed assertion
422 // due to the call instruction's dropped function operand.
423 ModuleSlotTracker MST(&M);
424 EXPECT_PRINTER_EQ("!0 = distinct !{}", N0->print(OS, MST));
425 }
426
TEST_F(MDNodeTest,PrintTree)427 TEST_F(MDNodeTest, PrintTree) {
428 DILocalScope *Scope = getSubprogram();
429 DIFile *File = getFile();
430 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7);
431 {
432 DIType *Type = getDerivedType();
433 auto *Var = DILocalVariable::get(Context, Scope, "foo", File,
434 /*LineNo=*/8, Type, /*ArgNo=*/2, Flags,
435 /*Align=*/8, nullptr);
436 std::string Expected;
437 {
438 raw_string_ostream SS(Expected);
439 Var->print(SS);
440 // indent level 1
441 Scope->print((SS << "\n").indent(2));
442 File->print((SS << "\n").indent(2));
443 Type->print((SS << "\n").indent(2));
444 // indent level 2
445 auto *BaseType = cast<DIDerivedType>(Type)->getBaseType();
446 BaseType->print((SS << "\n").indent(4));
447 }
448
449 EXPECT_PRINTER_EQ(Expected, Var->printTree(OS));
450 }
451
452 {
453 // Test if printTree works correctly when there is
454 // a cycle in the MDNode and its dependencies.
455 //
456 // We're trying to create type like this:
457 // struct LinkedList {
458 // LinkedList *Head;
459 // };
460 auto *StructTy = cast<DICompositeType>(getCompositeType());
461 DIType *PointerTy = DIDerivedType::getDistinct(
462 Context, dwarf::DW_TAG_pointer_type, "", nullptr, 0, nullptr, StructTy,
463 1, 2, 0, None, DINode::FlagZero);
464 StructTy->replaceElements(MDTuple::get(Context, PointerTy));
465
466 auto *Var = DILocalVariable::get(Context, Scope, "foo", File,
467 /*LineNo=*/8, StructTy, /*ArgNo=*/2, Flags,
468 /*Align=*/8, nullptr);
469 std::string Expected;
470 {
471 raw_string_ostream SS(Expected);
472 Var->print(SS);
473 // indent level 1
474 Scope->print((SS << "\n").indent(2));
475 File->print((SS << "\n").indent(2));
476 StructTy->print((SS << "\n").indent(2));
477 // indent level 2
478 StructTy->getRawElements()->print((SS << "\n").indent(4));
479 // indent level 3
480 auto Elements = StructTy->getElements();
481 Elements[0]->print((SS << "\n").indent(6));
482 }
483
484 EXPECT_PRINTER_EQ(Expected, Var->printTree(OS));
485 }
486 }
487 #undef EXPECT_PRINTER_EQ
488
TEST_F(MDNodeTest,NullOperand)489 TEST_F(MDNodeTest, NullOperand) {
490 // metadata !{}
491 MDNode *Empty = MDNode::get(Context, None);
492
493 // metadata !{metadata !{}}
494 Metadata *Ops[] = {Empty};
495 MDNode *N = MDNode::get(Context, Ops);
496 ASSERT_EQ(Empty, N->getOperand(0));
497
498 // metadata !{metadata !{}} => metadata !{null}
499 N->replaceOperandWith(0, nullptr);
500 ASSERT_EQ(nullptr, N->getOperand(0));
501
502 // metadata !{null}
503 Ops[0] = nullptr;
504 MDNode *NullOp = MDNode::get(Context, Ops);
505 ASSERT_EQ(nullptr, NullOp->getOperand(0));
506 EXPECT_EQ(N, NullOp);
507 }
508
TEST_F(MDNodeTest,DistinctOnUniquingCollision)509 TEST_F(MDNodeTest, DistinctOnUniquingCollision) {
510 // !{}
511 MDNode *Empty = MDNode::get(Context, None);
512 ASSERT_TRUE(Empty->isResolved());
513 EXPECT_FALSE(Empty->isDistinct());
514
515 // !{!{}}
516 Metadata *Wrapped1Ops[] = {Empty};
517 MDNode *Wrapped1 = MDNode::get(Context, Wrapped1Ops);
518 ASSERT_EQ(Empty, Wrapped1->getOperand(0));
519 ASSERT_TRUE(Wrapped1->isResolved());
520 EXPECT_FALSE(Wrapped1->isDistinct());
521
522 // !{!{!{}}}
523 Metadata *Wrapped2Ops[] = {Wrapped1};
524 MDNode *Wrapped2 = MDNode::get(Context, Wrapped2Ops);
525 ASSERT_EQ(Wrapped1, Wrapped2->getOperand(0));
526 ASSERT_TRUE(Wrapped2->isResolved());
527 EXPECT_FALSE(Wrapped2->isDistinct());
528
529 // !{!{!{}}} => !{!{}}
530 Wrapped2->replaceOperandWith(0, Empty);
531 ASSERT_EQ(Empty, Wrapped2->getOperand(0));
532 EXPECT_TRUE(Wrapped2->isDistinct());
533 EXPECT_FALSE(Wrapped1->isDistinct());
534 }
535
TEST_F(MDNodeTest,UniquedOnDeletedOperand)536 TEST_F(MDNodeTest, UniquedOnDeletedOperand) {
537 // temp !{}
538 TempMDTuple T = MDTuple::getTemporary(Context, None);
539
540 // !{temp !{}}
541 Metadata *Ops[] = {T.get()};
542 MDTuple *N = MDTuple::get(Context, Ops);
543
544 // !{temp !{}} => !{null}
545 T.reset();
546 ASSERT_TRUE(N->isUniqued());
547 Metadata *NullOps[] = {nullptr};
548 ASSERT_EQ(N, MDTuple::get(Context, NullOps));
549 }
550
TEST_F(MDNodeTest,DistinctOnDeletedValueOperand)551 TEST_F(MDNodeTest, DistinctOnDeletedValueOperand) {
552 // i1* @GV
553 Type *Ty = Type::getInt1PtrTy(Context);
554 std::unique_ptr<GlobalVariable> GV(
555 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
556 ConstantAsMetadata *Op = ConstantAsMetadata::get(GV.get());
557
558 // !{i1* @GV}
559 Metadata *Ops[] = {Op};
560 MDTuple *N = MDTuple::get(Context, Ops);
561
562 // !{i1* @GV} => !{null}
563 GV.reset();
564 ASSERT_TRUE(N->isDistinct());
565 ASSERT_EQ(nullptr, N->getOperand(0));
566 Metadata *NullOps[] = {nullptr};
567 ASSERT_NE(N, MDTuple::get(Context, NullOps));
568 }
569
TEST_F(MDNodeTest,getDistinct)570 TEST_F(MDNodeTest, getDistinct) {
571 // !{}
572 MDNode *Empty = MDNode::get(Context, None);
573 ASSERT_TRUE(Empty->isResolved());
574 ASSERT_FALSE(Empty->isDistinct());
575 ASSERT_EQ(Empty, MDNode::get(Context, None));
576
577 // distinct !{}
578 MDNode *Distinct1 = MDNode::getDistinct(Context, None);
579 MDNode *Distinct2 = MDNode::getDistinct(Context, None);
580 EXPECT_TRUE(Distinct1->isResolved());
581 EXPECT_TRUE(Distinct2->isDistinct());
582 EXPECT_NE(Empty, Distinct1);
583 EXPECT_NE(Empty, Distinct2);
584 EXPECT_NE(Distinct1, Distinct2);
585
586 // !{}
587 ASSERT_EQ(Empty, MDNode::get(Context, None));
588 }
589
TEST_F(MDNodeTest,isUniqued)590 TEST_F(MDNodeTest, isUniqued) {
591 MDNode *U = MDTuple::get(Context, None);
592 MDNode *D = MDTuple::getDistinct(Context, None);
593 auto T = MDTuple::getTemporary(Context, None);
594 EXPECT_TRUE(U->isUniqued());
595 EXPECT_FALSE(D->isUniqued());
596 EXPECT_FALSE(T->isUniqued());
597 }
598
TEST_F(MDNodeTest,isDistinct)599 TEST_F(MDNodeTest, isDistinct) {
600 MDNode *U = MDTuple::get(Context, None);
601 MDNode *D = MDTuple::getDistinct(Context, None);
602 auto T = MDTuple::getTemporary(Context, None);
603 EXPECT_FALSE(U->isDistinct());
604 EXPECT_TRUE(D->isDistinct());
605 EXPECT_FALSE(T->isDistinct());
606 }
607
TEST_F(MDNodeTest,isTemporary)608 TEST_F(MDNodeTest, isTemporary) {
609 MDNode *U = MDTuple::get(Context, None);
610 MDNode *D = MDTuple::getDistinct(Context, None);
611 auto T = MDTuple::getTemporary(Context, None);
612 EXPECT_FALSE(U->isTemporary());
613 EXPECT_FALSE(D->isTemporary());
614 EXPECT_TRUE(T->isTemporary());
615 }
616
TEST_F(MDNodeTest,getDistinctWithUnresolvedOperands)617 TEST_F(MDNodeTest, getDistinctWithUnresolvedOperands) {
618 // temporary !{}
619 auto Temp = MDTuple::getTemporary(Context, None);
620 ASSERT_FALSE(Temp->isResolved());
621
622 // distinct !{temporary !{}}
623 Metadata *Ops[] = {Temp.get()};
624 MDNode *Distinct = MDNode::getDistinct(Context, Ops);
625 EXPECT_TRUE(Distinct->isResolved());
626 EXPECT_EQ(Temp.get(), Distinct->getOperand(0));
627
628 // temporary !{} => !{}
629 MDNode *Empty = MDNode::get(Context, None);
630 Temp->replaceAllUsesWith(Empty);
631 EXPECT_EQ(Empty, Distinct->getOperand(0));
632 }
633
TEST_F(MDNodeTest,handleChangedOperandRecursion)634 TEST_F(MDNodeTest, handleChangedOperandRecursion) {
635 // !0 = !{}
636 MDNode *N0 = MDNode::get(Context, None);
637
638 // !1 = !{!3, null}
639 auto Temp3 = MDTuple::getTemporary(Context, None);
640 Metadata *Ops1[] = {Temp3.get(), nullptr};
641 MDNode *N1 = MDNode::get(Context, Ops1);
642
643 // !2 = !{!3, !0}
644 Metadata *Ops2[] = {Temp3.get(), N0};
645 MDNode *N2 = MDNode::get(Context, Ops2);
646
647 // !3 = !{!2}
648 Metadata *Ops3[] = {N2};
649 MDNode *N3 = MDNode::get(Context, Ops3);
650 Temp3->replaceAllUsesWith(N3);
651
652 // !4 = !{!1}
653 Metadata *Ops4[] = {N1};
654 MDNode *N4 = MDNode::get(Context, Ops4);
655
656 // Confirm that the cycle prevented RAUW from getting dropped.
657 EXPECT_TRUE(N0->isResolved());
658 EXPECT_FALSE(N1->isResolved());
659 EXPECT_FALSE(N2->isResolved());
660 EXPECT_FALSE(N3->isResolved());
661 EXPECT_FALSE(N4->isResolved());
662
663 // Create a couple of distinct nodes to observe what's going on.
664 //
665 // !5 = distinct !{!2}
666 // !6 = distinct !{!3}
667 Metadata *Ops5[] = {N2};
668 MDNode *N5 = MDNode::getDistinct(Context, Ops5);
669 Metadata *Ops6[] = {N3};
670 MDNode *N6 = MDNode::getDistinct(Context, Ops6);
671
672 // Mutate !2 to look like !1, causing a uniquing collision (and an RAUW).
673 // This will ripple up, with !3 colliding with !4, and RAUWing. Since !2
674 // references !3, this can cause a re-entry of handleChangedOperand() when !3
675 // is not ready for it.
676 //
677 // !2->replaceOperandWith(1, nullptr)
678 // !2: !{!3, !0} => !{!3, null}
679 // !2->replaceAllUsesWith(!1)
680 // !3: !{!2] => !{!1}
681 // !3->replaceAllUsesWith(!4)
682 N2->replaceOperandWith(1, nullptr);
683
684 // If all has gone well, N2 and N3 will have been RAUW'ed and deleted from
685 // under us. Just check that the other nodes are sane.
686 //
687 // !1 = !{!4, null}
688 // !4 = !{!1}
689 // !5 = distinct !{!1}
690 // !6 = distinct !{!4}
691 EXPECT_EQ(N4, N1->getOperand(0));
692 EXPECT_EQ(N1, N4->getOperand(0));
693 EXPECT_EQ(N1, N5->getOperand(0));
694 EXPECT_EQ(N4, N6->getOperand(0));
695 }
696
TEST_F(MDNodeTest,replaceResolvedOperand)697 TEST_F(MDNodeTest, replaceResolvedOperand) {
698 // Check code for replacing one resolved operand with another. If doing this
699 // directly (via replaceOperandWith()) becomes illegal, change the operand to
700 // a global value that gets RAUW'ed.
701 //
702 // Use a temporary node to keep N from being resolved.
703 auto Temp = MDTuple::getTemporary(Context, None);
704 Metadata *Ops[] = {nullptr, Temp.get()};
705
706 MDNode *Empty = MDTuple::get(Context, ArrayRef<Metadata *>());
707 MDNode *N = MDTuple::get(Context, Ops);
708 EXPECT_EQ(nullptr, N->getOperand(0));
709 ASSERT_FALSE(N->isResolved());
710
711 // Check code for replacing resolved nodes.
712 N->replaceOperandWith(0, Empty);
713 EXPECT_EQ(Empty, N->getOperand(0));
714
715 // Check code for adding another unresolved operand.
716 N->replaceOperandWith(0, Temp.get());
717 EXPECT_EQ(Temp.get(), N->getOperand(0));
718
719 // Remove the references to Temp; required for teardown.
720 Temp->replaceAllUsesWith(nullptr);
721 }
722
TEST_F(MDNodeTest,replaceWithUniqued)723 TEST_F(MDNodeTest, replaceWithUniqued) {
724 auto *Empty = MDTuple::get(Context, None);
725 MDTuple *FirstUniqued;
726 {
727 Metadata *Ops[] = {Empty};
728 auto Temp = MDTuple::getTemporary(Context, Ops);
729 EXPECT_TRUE(Temp->isTemporary());
730
731 // Don't expect a collision.
732 auto *Current = Temp.get();
733 FirstUniqued = MDNode::replaceWithUniqued(std::move(Temp));
734 EXPECT_TRUE(FirstUniqued->isUniqued());
735 EXPECT_TRUE(FirstUniqued->isResolved());
736 EXPECT_EQ(Current, FirstUniqued);
737 }
738 {
739 Metadata *Ops[] = {Empty};
740 auto Temp = MDTuple::getTemporary(Context, Ops);
741 EXPECT_TRUE(Temp->isTemporary());
742
743 // Should collide with Uniqued above this time.
744 auto *Uniqued = MDNode::replaceWithUniqued(std::move(Temp));
745 EXPECT_TRUE(Uniqued->isUniqued());
746 EXPECT_TRUE(Uniqued->isResolved());
747 EXPECT_EQ(FirstUniqued, Uniqued);
748 }
749 {
750 auto Unresolved = MDTuple::getTemporary(Context, None);
751 Metadata *Ops[] = {Unresolved.get()};
752 auto Temp = MDTuple::getTemporary(Context, Ops);
753 EXPECT_TRUE(Temp->isTemporary());
754
755 // Shouldn't be resolved.
756 auto *Uniqued = MDNode::replaceWithUniqued(std::move(Temp));
757 EXPECT_TRUE(Uniqued->isUniqued());
758 EXPECT_FALSE(Uniqued->isResolved());
759
760 // Should be a different node.
761 EXPECT_NE(FirstUniqued, Uniqued);
762
763 // Should resolve when we update its node (note: be careful to avoid a
764 // collision with any other nodes above).
765 Uniqued->replaceOperandWith(0, nullptr);
766 EXPECT_TRUE(Uniqued->isResolved());
767 }
768 }
769
TEST_F(MDNodeTest,replaceWithUniquedResolvingOperand)770 TEST_F(MDNodeTest, replaceWithUniquedResolvingOperand) {
771 // temp !{}
772 MDTuple *Op = MDTuple::getTemporary(Context, None).release();
773 EXPECT_FALSE(Op->isResolved());
774
775 // temp !{temp !{}}
776 Metadata *Ops[] = {Op};
777 MDTuple *N = MDTuple::getTemporary(Context, Ops).release();
778 EXPECT_FALSE(N->isResolved());
779
780 // temp !{temp !{}} => !{temp !{}}
781 ASSERT_EQ(N, MDNode::replaceWithUniqued(TempMDTuple(N)));
782 EXPECT_FALSE(N->isResolved());
783
784 // !{temp !{}} => !{!{}}
785 ASSERT_EQ(Op, MDNode::replaceWithUniqued(TempMDTuple(Op)));
786 EXPECT_TRUE(Op->isResolved());
787 EXPECT_TRUE(N->isResolved());
788 }
789
TEST_F(MDNodeTest,replaceWithUniquedDeletedOperand)790 TEST_F(MDNodeTest, replaceWithUniquedDeletedOperand) {
791 // i1* @GV
792 Type *Ty = Type::getInt1PtrTy(Context);
793 std::unique_ptr<GlobalVariable> GV(
794 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
795 ConstantAsMetadata *Op = ConstantAsMetadata::get(GV.get());
796
797 // temp !{i1* @GV}
798 Metadata *Ops[] = {Op};
799 MDTuple *N = MDTuple::getTemporary(Context, Ops).release();
800
801 // temp !{i1* @GV} => !{i1* @GV}
802 ASSERT_EQ(N, MDNode::replaceWithUniqued(TempMDTuple(N)));
803 ASSERT_TRUE(N->isUniqued());
804
805 // !{i1* @GV} => !{null}
806 GV.reset();
807 ASSERT_TRUE(N->isDistinct());
808 ASSERT_EQ(nullptr, N->getOperand(0));
809 Metadata *NullOps[] = {nullptr};
810 ASSERT_NE(N, MDTuple::get(Context, NullOps));
811 }
812
TEST_F(MDNodeTest,replaceWithUniquedChangedOperand)813 TEST_F(MDNodeTest, replaceWithUniquedChangedOperand) {
814 // i1* @GV
815 Type *Ty = Type::getInt1PtrTy(Context);
816 std::unique_ptr<GlobalVariable> GV(
817 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
818 ConstantAsMetadata *Op = ConstantAsMetadata::get(GV.get());
819
820 // temp !{i1* @GV}
821 Metadata *Ops[] = {Op};
822 MDTuple *N = MDTuple::getTemporary(Context, Ops).release();
823
824 // temp !{i1* @GV} => !{i1* @GV}
825 ASSERT_EQ(N, MDNode::replaceWithUniqued(TempMDTuple(N)));
826 ASSERT_TRUE(N->isUniqued());
827
828 // !{i1* @GV} => !{i1* @GV2}
829 std::unique_ptr<GlobalVariable> GV2(
830 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
831 GV->replaceAllUsesWith(GV2.get());
832 ASSERT_TRUE(N->isUniqued());
833 Metadata *NullOps[] = {ConstantAsMetadata::get(GV2.get())};
834 ASSERT_EQ(N, MDTuple::get(Context, NullOps));
835 }
836
TEST_F(MDNodeTest,replaceWithDistinct)837 TEST_F(MDNodeTest, replaceWithDistinct) {
838 {
839 auto *Empty = MDTuple::get(Context, None);
840 Metadata *Ops[] = {Empty};
841 auto Temp = MDTuple::getTemporary(Context, Ops);
842 EXPECT_TRUE(Temp->isTemporary());
843
844 // Don't expect a collision.
845 auto *Current = Temp.get();
846 auto *Distinct = MDNode::replaceWithDistinct(std::move(Temp));
847 EXPECT_TRUE(Distinct->isDistinct());
848 EXPECT_TRUE(Distinct->isResolved());
849 EXPECT_EQ(Current, Distinct);
850 }
851 {
852 auto Unresolved = MDTuple::getTemporary(Context, None);
853 Metadata *Ops[] = {Unresolved.get()};
854 auto Temp = MDTuple::getTemporary(Context, Ops);
855 EXPECT_TRUE(Temp->isTemporary());
856
857 // Don't expect a collision.
858 auto *Current = Temp.get();
859 auto *Distinct = MDNode::replaceWithDistinct(std::move(Temp));
860 EXPECT_TRUE(Distinct->isDistinct());
861 EXPECT_TRUE(Distinct->isResolved());
862 EXPECT_EQ(Current, Distinct);
863
864 // Cleanup; required for teardown.
865 Unresolved->replaceAllUsesWith(nullptr);
866 }
867 }
868
TEST_F(MDNodeTest,replaceWithPermanent)869 TEST_F(MDNodeTest, replaceWithPermanent) {
870 Metadata *Ops[] = {nullptr};
871 auto Temp = MDTuple::getTemporary(Context, Ops);
872 auto *T = Temp.get();
873
874 // U is a normal, uniqued node that references T.
875 auto *U = MDTuple::get(Context, T);
876 EXPECT_TRUE(U->isUniqued());
877
878 // Make Temp self-referencing.
879 Temp->replaceOperandWith(0, T);
880
881 // Try to uniquify Temp. This should, despite the name in the API, give a
882 // 'distinct' node, since self-references aren't allowed to be uniqued.
883 //
884 // Since it's distinct, N should have the same address as when it was a
885 // temporary (i.e., be equal to T not U).
886 auto *N = MDNode::replaceWithPermanent(std::move(Temp));
887 EXPECT_EQ(N, T);
888 EXPECT_TRUE(N->isDistinct());
889
890 // U should be the canonical unique node with N as the argument.
891 EXPECT_EQ(U, MDTuple::get(Context, N));
892 EXPECT_TRUE(U->isUniqued());
893
894 // This temporary should collide with U when replaced, but it should still be
895 // uniqued.
896 EXPECT_EQ(U, MDNode::replaceWithPermanent(MDTuple::getTemporary(Context, N)));
897 EXPECT_TRUE(U->isUniqued());
898
899 // This temporary should become a new uniqued node.
900 auto Temp2 = MDTuple::getTemporary(Context, U);
901 auto *V = Temp2.get();
902 EXPECT_EQ(V, MDNode::replaceWithPermanent(std::move(Temp2)));
903 EXPECT_TRUE(V->isUniqued());
904 EXPECT_EQ(U, V->getOperand(0));
905 }
906
TEST_F(MDNodeTest,deleteTemporaryWithTrackingRef)907 TEST_F(MDNodeTest, deleteTemporaryWithTrackingRef) {
908 TrackingMDRef Ref;
909 EXPECT_EQ(nullptr, Ref.get());
910 {
911 auto Temp = MDTuple::getTemporary(Context, None);
912 Ref.reset(Temp.get());
913 EXPECT_EQ(Temp.get(), Ref.get());
914 }
915 EXPECT_EQ(nullptr, Ref.get());
916 }
917
918 typedef MetadataTest DILocationTest;
919
TEST_F(DILocationTest,Overflow)920 TEST_F(DILocationTest, Overflow) {
921 DISubprogram *N = getSubprogram();
922 {
923 DILocation *L = DILocation::get(Context, 2, 7, N);
924 EXPECT_EQ(2u, L->getLine());
925 EXPECT_EQ(7u, L->getColumn());
926 }
927 unsigned U16 = 1u << 16;
928 {
929 DILocation *L = DILocation::get(Context, UINT32_MAX, U16 - 1, N);
930 EXPECT_EQ(UINT32_MAX, L->getLine());
931 EXPECT_EQ(U16 - 1, L->getColumn());
932 }
933 {
934 DILocation *L = DILocation::get(Context, UINT32_MAX, U16, N);
935 EXPECT_EQ(UINT32_MAX, L->getLine());
936 EXPECT_EQ(0u, L->getColumn());
937 }
938 {
939 DILocation *L = DILocation::get(Context, UINT32_MAX, U16 + 1, N);
940 EXPECT_EQ(UINT32_MAX, L->getLine());
941 EXPECT_EQ(0u, L->getColumn());
942 }
943 }
944
TEST_F(DILocationTest,Merge)945 TEST_F(DILocationTest, Merge) {
946 DISubprogram *N = getSubprogram();
947 DIScope *S = DILexicalBlock::get(Context, N, getFile(), 3, 4);
948
949 {
950 // Identical.
951 auto *A = DILocation::get(Context, 2, 7, N);
952 auto *B = DILocation::get(Context, 2, 7, N);
953 auto *M = DILocation::getMergedLocation(A, B);
954 EXPECT_EQ(2u, M->getLine());
955 EXPECT_EQ(7u, M->getColumn());
956 EXPECT_EQ(N, M->getScope());
957 }
958
959 {
960 // Identical, different scopes.
961 auto *A = DILocation::get(Context, 2, 7, N);
962 auto *B = DILocation::get(Context, 2, 7, S);
963 auto *M = DILocation::getMergedLocation(A, B);
964 EXPECT_EQ(0u, M->getLine()); // FIXME: Should this be 2?
965 EXPECT_EQ(0u, M->getColumn()); // FIXME: Should this be 7?
966 EXPECT_EQ(N, M->getScope());
967 }
968
969 {
970 // Different lines, same scopes.
971 auto *A = DILocation::get(Context, 1, 6, N);
972 auto *B = DILocation::get(Context, 2, 7, N);
973 auto *M = DILocation::getMergedLocation(A, B);
974 EXPECT_EQ(0u, M->getLine());
975 EXPECT_EQ(0u, M->getColumn());
976 EXPECT_EQ(N, M->getScope());
977 }
978
979 {
980 // Twisty locations, all different, same function.
981 auto *A = DILocation::get(Context, 1, 6, N);
982 auto *B = DILocation::get(Context, 2, 7, S);
983 auto *M = DILocation::getMergedLocation(A, B);
984 EXPECT_EQ(0u, M->getLine());
985 EXPECT_EQ(0u, M->getColumn());
986 EXPECT_EQ(N, M->getScope());
987 }
988
989 {
990 // Different function, same inlined-at.
991 auto *F = getFile();
992 auto *SP1 = DISubprogram::getDistinct(Context, F, "a", "a", F, 0, nullptr,
993 0, nullptr, 0, 0, DINode::FlagZero,
994 DISubprogram::SPFlagZero, nullptr);
995 auto *SP2 = DISubprogram::getDistinct(Context, F, "b", "b", F, 0, nullptr,
996 0, nullptr, 0, 0, DINode::FlagZero,
997 DISubprogram::SPFlagZero, nullptr);
998
999 auto *I = DILocation::get(Context, 2, 7, N);
1000 auto *A = DILocation::get(Context, 1, 6, SP1, I);
1001 auto *B = DILocation::get(Context, 2, 7, SP2, I);
1002 auto *M = DILocation::getMergedLocation(A, B);
1003 EXPECT_EQ(0u, M->getLine());
1004 EXPECT_EQ(0u, M->getColumn());
1005 EXPECT_TRUE(isa<DILocalScope>(M->getScope()));
1006 EXPECT_EQ(I, M->getInlinedAt());
1007 }
1008
1009 {
1010 // Completely different.
1011 auto *I = DILocation::get(Context, 2, 7, N);
1012 auto *A = DILocation::get(Context, 1, 6, S, I);
1013 auto *B = DILocation::get(Context, 2, 7, getSubprogram());
1014 auto *M = DILocation::getMergedLocation(A, B);
1015 EXPECT_EQ(0u, M->getLine());
1016 EXPECT_EQ(0u, M->getColumn());
1017 EXPECT_TRUE(isa<DILocalScope>(M->getScope()));
1018 EXPECT_EQ(S, M->getScope());
1019 EXPECT_EQ(nullptr, M->getInlinedAt());
1020 }
1021 }
1022
TEST_F(DILocationTest,getDistinct)1023 TEST_F(DILocationTest, getDistinct) {
1024 MDNode *N = getSubprogram();
1025 DILocation *L0 = DILocation::getDistinct(Context, 2, 7, N);
1026 EXPECT_TRUE(L0->isDistinct());
1027 DILocation *L1 = DILocation::get(Context, 2, 7, N);
1028 EXPECT_FALSE(L1->isDistinct());
1029 EXPECT_EQ(L1, DILocation::get(Context, 2, 7, N));
1030 }
1031
TEST_F(DILocationTest,getTemporary)1032 TEST_F(DILocationTest, getTemporary) {
1033 MDNode *N = MDNode::get(Context, None);
1034 auto L = DILocation::getTemporary(Context, 2, 7, N);
1035 EXPECT_TRUE(L->isTemporary());
1036 EXPECT_FALSE(L->isResolved());
1037 }
1038
TEST_F(DILocationTest,cloneTemporary)1039 TEST_F(DILocationTest, cloneTemporary) {
1040 MDNode *N = MDNode::get(Context, None);
1041 auto L = DILocation::getTemporary(Context, 2, 7, N);
1042 EXPECT_TRUE(L->isTemporary());
1043 auto L2 = L->clone();
1044 EXPECT_TRUE(L2->isTemporary());
1045 }
1046
TEST_F(DILocationTest,discriminatorEncoding)1047 TEST_F(DILocationTest, discriminatorEncoding) {
1048 EXPECT_EQ(0U, DILocation::encodeDiscriminator(0, 0, 0).value());
1049
1050 // Encode base discriminator as a component: lsb is 0, then the value.
1051 // The other components are all absent, so we leave all the other bits 0.
1052 EXPECT_EQ(2U, DILocation::encodeDiscriminator(1, 0, 0).value());
1053
1054 // Base discriminator component is empty, so lsb is 1. Next component is not
1055 // empty, so its lsb is 0, then its value (1). Next component is empty.
1056 // So the bit pattern is 101.
1057 EXPECT_EQ(5U, DILocation::encodeDiscriminator(0, 1, 0).value());
1058
1059 // First 2 components are empty, so the bit pattern is 11. Then the
1060 // next component - ending up with 1011.
1061 EXPECT_EQ(0xbU, DILocation::encodeDiscriminator(0, 0, 1).value());
1062
1063 // The bit pattern for the first 2 components is 11. The next bit is 0,
1064 // because the last component is not empty. We have 29 bits usable for
1065 // encoding, but we cap it at 12 bits uniformously for all components. We
1066 // encode the last component over 14 bits.
1067 EXPECT_EQ(0xfffbU, DILocation::encodeDiscriminator(0, 0, 0xfff).value());
1068
1069 EXPECT_EQ(0x102U, DILocation::encodeDiscriminator(1, 1, 0).value());
1070
1071 EXPECT_EQ(0x13eU, DILocation::encodeDiscriminator(0x1f, 1, 0).value());
1072
1073 EXPECT_EQ(0x87feU, DILocation::encodeDiscriminator(0x1ff, 1, 0).value());
1074
1075 EXPECT_EQ(0x1f3eU, DILocation::encodeDiscriminator(0x1f, 0x1f, 0).value());
1076
1077 EXPECT_EQ(0x3ff3eU, DILocation::encodeDiscriminator(0x1f, 0x1ff, 0).value());
1078
1079 EXPECT_EQ(0x1ff87feU,
1080 DILocation::encodeDiscriminator(0x1ff, 0x1ff, 0).value());
1081
1082 EXPECT_EQ(0xfff9f3eU,
1083 DILocation::encodeDiscriminator(0x1f, 0x1f, 0xfff).value());
1084
1085 EXPECT_EQ(0xffc3ff3eU,
1086 DILocation::encodeDiscriminator(0x1f, 0x1ff, 0x1ff).value());
1087
1088 EXPECT_EQ(0xffcf87feU,
1089 DILocation::encodeDiscriminator(0x1ff, 0x1f, 0x1ff).value());
1090
1091 EXPECT_EQ(0xe1ff87feU,
1092 DILocation::encodeDiscriminator(0x1ff, 0x1ff, 7).value());
1093 }
1094
TEST_F(DILocationTest,discriminatorEncodingNegativeTests)1095 TEST_F(DILocationTest, discriminatorEncodingNegativeTests) {
1096 EXPECT_EQ(None, DILocation::encodeDiscriminator(0, 0, 0x1000));
1097 EXPECT_EQ(None, DILocation::encodeDiscriminator(0x1000, 0, 0));
1098 EXPECT_EQ(None, DILocation::encodeDiscriminator(0, 0x1000, 0));
1099 EXPECT_EQ(None, DILocation::encodeDiscriminator(0, 0, 0x1000));
1100 EXPECT_EQ(None, DILocation::encodeDiscriminator(0x1ff, 0x1ff, 8));
1101 EXPECT_EQ(None,
1102 DILocation::encodeDiscriminator(std::numeric_limits<uint32_t>::max(),
1103 std::numeric_limits<uint32_t>::max(),
1104 0));
1105 }
1106
TEST_F(DILocationTest,discriminatorSpecialCases)1107 TEST_F(DILocationTest, discriminatorSpecialCases) {
1108 // We don't test getCopyIdentifier here because the only way
1109 // to set it is by constructing an encoded discriminator using
1110 // encodeDiscriminator, which is already tested.
1111 auto L1 = DILocation::get(Context, 1, 2, getSubprogram());
1112 EXPECT_EQ(0U, L1->getBaseDiscriminator());
1113 EXPECT_EQ(1U, L1->getDuplicationFactor());
1114
1115 EXPECT_EQ(L1, L1->cloneWithBaseDiscriminator(0).value());
1116 EXPECT_EQ(L1, L1->cloneByMultiplyingDuplicationFactor(0).value());
1117 EXPECT_EQ(L1, L1->cloneByMultiplyingDuplicationFactor(1).value());
1118
1119 auto L2 = L1->cloneWithBaseDiscriminator(1).value();
1120 EXPECT_EQ(0U, L1->getBaseDiscriminator());
1121 EXPECT_EQ(1U, L1->getDuplicationFactor());
1122
1123 EXPECT_EQ(1U, L2->getBaseDiscriminator());
1124 EXPECT_EQ(1U, L2->getDuplicationFactor());
1125
1126 auto L3 = L2->cloneByMultiplyingDuplicationFactor(2).value();
1127 EXPECT_EQ(1U, L3->getBaseDiscriminator());
1128 EXPECT_EQ(2U, L3->getDuplicationFactor());
1129
1130 EXPECT_EQ(L2, L2->cloneByMultiplyingDuplicationFactor(1).value());
1131
1132 auto L4 = L3->cloneByMultiplyingDuplicationFactor(4).value();
1133 EXPECT_EQ(1U, L4->getBaseDiscriminator());
1134 EXPECT_EQ(8U, L4->getDuplicationFactor());
1135
1136 auto L5 = L4->cloneWithBaseDiscriminator(2).value();
1137 EXPECT_EQ(2U, L5->getBaseDiscriminator());
1138 EXPECT_EQ(8U, L5->getDuplicationFactor());
1139
1140 // Check extreme cases
1141 auto L6 = L1->cloneWithBaseDiscriminator(0xfff).value();
1142 EXPECT_EQ(0xfffU, L6->getBaseDiscriminator());
1143 EXPECT_EQ(0xfffU, L6->cloneByMultiplyingDuplicationFactor(0xfff)
1144 .value()
1145 ->getDuplicationFactor());
1146
1147 // Check we return None for unencodable cases.
1148 EXPECT_EQ(None, L4->cloneWithBaseDiscriminator(0x1000));
1149 EXPECT_EQ(None, L4->cloneByMultiplyingDuplicationFactor(0x1000));
1150 }
1151
1152
1153 typedef MetadataTest GenericDINodeTest;
1154
TEST_F(GenericDINodeTest,get)1155 TEST_F(GenericDINodeTest, get) {
1156 StringRef Header = "header";
1157 auto *Empty = MDNode::get(Context, None);
1158 Metadata *Ops1[] = {Empty};
1159 auto *N = GenericDINode::get(Context, 15, Header, Ops1);
1160 EXPECT_EQ(15u, N->getTag());
1161 EXPECT_EQ(2u, N->getNumOperands());
1162 EXPECT_EQ(Header, N->getHeader());
1163 EXPECT_EQ(MDString::get(Context, Header), N->getOperand(0));
1164 EXPECT_EQ(1u, N->getNumDwarfOperands());
1165 EXPECT_EQ(Empty, N->getDwarfOperand(0));
1166 EXPECT_EQ(Empty, N->getOperand(1));
1167 ASSERT_TRUE(N->isUniqued());
1168
1169 EXPECT_EQ(N, GenericDINode::get(Context, 15, Header, Ops1));
1170
1171 N->replaceOperandWith(1, nullptr);
1172 EXPECT_EQ(15u, N->getTag());
1173 EXPECT_EQ(Header, N->getHeader());
1174 EXPECT_EQ(nullptr, N->getDwarfOperand(0));
1175 ASSERT_TRUE(N->isUniqued());
1176
1177 Metadata *Ops2[] = {nullptr};
1178 EXPECT_EQ(N, GenericDINode::get(Context, 15, Header, Ops2));
1179
1180 N->replaceDwarfOperandWith(0, Empty);
1181 EXPECT_EQ(15u, N->getTag());
1182 EXPECT_EQ(Header, N->getHeader());
1183 EXPECT_EQ(Empty, N->getDwarfOperand(0));
1184 ASSERT_TRUE(N->isUniqued());
1185 EXPECT_EQ(N, GenericDINode::get(Context, 15, Header, Ops1));
1186
1187 TempGenericDINode Temp = N->clone();
1188 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1189 }
1190
TEST_F(GenericDINodeTest,getEmptyHeader)1191 TEST_F(GenericDINodeTest, getEmptyHeader) {
1192 // Canonicalize !"" to null.
1193 auto *N = GenericDINode::get(Context, 15, StringRef(), None);
1194 EXPECT_EQ(StringRef(), N->getHeader());
1195 EXPECT_EQ(nullptr, N->getOperand(0));
1196 }
1197
1198 typedef MetadataTest DISubrangeTest;
1199
TEST_F(DISubrangeTest,get)1200 TEST_F(DISubrangeTest, get) {
1201 auto *N = DISubrange::get(Context, 5, 7);
1202 auto Count = N->getCount();
1203 auto Lower = N->getLowerBound();
1204 EXPECT_EQ(dwarf::DW_TAG_subrange_type, N->getTag());
1205 ASSERT_TRUE(Count);
1206 ASSERT_TRUE(Count.is<ConstantInt*>());
1207 EXPECT_EQ(5, Count.get<ConstantInt*>()->getSExtValue());
1208 EXPECT_EQ(7, Lower.get<ConstantInt *>()->getSExtValue());
1209 EXPECT_EQ(N, DISubrange::get(Context, 5, 7));
1210 EXPECT_EQ(DISubrange::get(Context, 5, 0), DISubrange::get(Context, 5));
1211
1212 TempDISubrange Temp = N->clone();
1213 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1214 }
1215
TEST_F(DISubrangeTest,getEmptyArray)1216 TEST_F(DISubrangeTest, getEmptyArray) {
1217 auto *N = DISubrange::get(Context, -1, 0);
1218 auto Count = N->getCount();
1219 auto Lower = N->getLowerBound();
1220 EXPECT_EQ(dwarf::DW_TAG_subrange_type, N->getTag());
1221 ASSERT_TRUE(Count);
1222 ASSERT_TRUE(Count.is<ConstantInt*>());
1223 EXPECT_EQ(-1, Count.get<ConstantInt*>()->getSExtValue());
1224 EXPECT_EQ(0, Lower.get<ConstantInt *>()->getSExtValue());
1225 EXPECT_EQ(N, DISubrange::get(Context, -1, 0));
1226 }
1227
TEST_F(DISubrangeTest,getVariableCount)1228 TEST_F(DISubrangeTest, getVariableCount) {
1229 DILocalScope *Scope = getSubprogram();
1230 DIFile *File = getFile();
1231 DIType *Type = getDerivedType();
1232 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7);
1233 auto *VlaExpr = DILocalVariable::get(Context, Scope, "vla_expr", File, 8,
1234 Type, 2, Flags, 8, nullptr);
1235
1236 auto *N = DISubrange::get(Context, VlaExpr, 0);
1237 auto Count = N->getCount();
1238 auto Lower = N->getLowerBound();
1239 ASSERT_TRUE(Count);
1240 ASSERT_TRUE(Count.is<DIVariable*>());
1241 EXPECT_EQ(VlaExpr, Count.get<DIVariable*>());
1242 ASSERT_TRUE(isa<DIVariable>(N->getRawCountNode()));
1243 EXPECT_EQ(0, Lower.get<ConstantInt *>()->getSExtValue());
1244 EXPECT_EQ("vla_expr", Count.get<DIVariable*>()->getName());
1245 EXPECT_EQ(N, DISubrange::get(Context, VlaExpr, 0));
1246 }
1247
TEST_F(DISubrangeTest,fortranAllocatableInt)1248 TEST_F(DISubrangeTest, fortranAllocatableInt) {
1249 DILocalScope *Scope = getSubprogram();
1250 DIFile *File = getFile();
1251 DIType *Type = getDerivedType();
1252 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7);
1253 auto *LI = ConstantAsMetadata::get(
1254 ConstantInt::getSigned(Type::getInt64Ty(Context), -10));
1255 auto *UI = ConstantAsMetadata::get(
1256 ConstantInt::getSigned(Type::getInt64Ty(Context), 10));
1257 auto *SI = ConstantAsMetadata::get(
1258 ConstantInt::getSigned(Type::getInt64Ty(Context), 4));
1259 auto *UIother = ConstantAsMetadata::get(
1260 ConstantInt::getSigned(Type::getInt64Ty(Context), 20));
1261 auto *UVother = DILocalVariable::get(Context, Scope, "ubother", File, 8, Type,
1262 2, Flags, 8, nullptr);
1263 auto *UEother = DIExpression::get(Context, {5, 6});
1264 auto *LIZero = ConstantAsMetadata::get(
1265 ConstantInt::getSigned(Type::getInt64Ty(Context), 0));
1266 auto *UIZero = ConstantAsMetadata::get(
1267 ConstantInt::getSigned(Type::getInt64Ty(Context), 0));
1268
1269 auto *N = DISubrange::get(Context, nullptr, LI, UI, SI);
1270
1271 auto Lower = N->getLowerBound();
1272 ASSERT_TRUE(Lower);
1273 ASSERT_TRUE(Lower.is<ConstantInt *>());
1274 EXPECT_EQ(cast<ConstantInt>(LI->getValue()), Lower.get<ConstantInt *>());
1275
1276 auto Upper = N->getUpperBound();
1277 ASSERT_TRUE(Upper);
1278 ASSERT_TRUE(Upper.is<ConstantInt *>());
1279 EXPECT_EQ(cast<ConstantInt>(UI->getValue()), Upper.get<ConstantInt *>());
1280
1281 auto Stride = N->getStride();
1282 ASSERT_TRUE(Stride);
1283 ASSERT_TRUE(Stride.is<ConstantInt *>());
1284 EXPECT_EQ(cast<ConstantInt>(SI->getValue()), Stride.get<ConstantInt *>());
1285
1286 EXPECT_EQ(N, DISubrange::get(Context, nullptr, LI, UI, SI));
1287
1288 EXPECT_NE(N, DISubrange::get(Context, nullptr, LI, UIother, SI));
1289 EXPECT_NE(N, DISubrange::get(Context, nullptr, LI, UEother, SI));
1290 EXPECT_NE(N, DISubrange::get(Context, nullptr, LI, UVother, SI));
1291
1292 auto *NZeroLower = DISubrange::get(Context, nullptr, LIZero, UI, SI);
1293 EXPECT_NE(NZeroLower, DISubrange::get(Context, nullptr, nullptr, UI, SI));
1294
1295 auto *NZeroUpper = DISubrange::get(Context, nullptr, LI, UIZero, SI);
1296 EXPECT_NE(NZeroUpper, DISubrange::get(Context, nullptr, LI, nullptr, SI));
1297 }
1298
TEST_F(DISubrangeTest,fortranAllocatableVar)1299 TEST_F(DISubrangeTest, fortranAllocatableVar) {
1300 DILocalScope *Scope = getSubprogram();
1301 DIFile *File = getFile();
1302 DIType *Type = getDerivedType();
1303 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7);
1304 auto *LV =
1305 DILocalVariable::get(Context, Scope, "lb", File, 8, Type, 2, Flags, 8,
1306 nullptr);
1307 auto *UV =
1308 DILocalVariable::get(Context, Scope, "ub", File, 8, Type, 2, Flags, 8,
1309 nullptr);
1310 auto *SV =
1311 DILocalVariable::get(Context, Scope, "st", File, 8, Type, 2, Flags, 8,
1312 nullptr);
1313 auto *SVother = DILocalVariable::get(Context, Scope, "stother", File, 8, Type,
1314 2, Flags, 8, nullptr);
1315 auto *SIother = ConstantAsMetadata::get(
1316 ConstantInt::getSigned(Type::getInt64Ty(Context), 20));
1317 auto *SEother = DIExpression::get(Context, {5, 6});
1318
1319 auto *N = DISubrange::get(Context, nullptr, LV, UV, SV);
1320
1321 auto Lower = N->getLowerBound();
1322 ASSERT_TRUE(Lower);
1323 ASSERT_TRUE(Lower.is<DIVariable *>());
1324 EXPECT_EQ(LV, Lower.get<DIVariable *>());
1325
1326 auto Upper = N->getUpperBound();
1327 ASSERT_TRUE(Upper);
1328 ASSERT_TRUE(Upper.is<DIVariable *>());
1329 EXPECT_EQ(UV, Upper.get<DIVariable *>());
1330
1331 auto Stride = N->getStride();
1332 ASSERT_TRUE(Stride);
1333 ASSERT_TRUE(Stride.is<DIVariable *>());
1334 EXPECT_EQ(SV, Stride.get<DIVariable *>());
1335
1336 EXPECT_EQ(N, DISubrange::get(Context, nullptr, LV, UV, SV));
1337
1338 EXPECT_NE(N, DISubrange::get(Context, nullptr, LV, UV, SVother));
1339 EXPECT_NE(N, DISubrange::get(Context, nullptr, LV, UV, SEother));
1340 EXPECT_NE(N, DISubrange::get(Context, nullptr, LV, UV, SIother));
1341 }
1342
TEST_F(DISubrangeTest,fortranAllocatableExpr)1343 TEST_F(DISubrangeTest, fortranAllocatableExpr) {
1344 DILocalScope *Scope = getSubprogram();
1345 DIFile *File = getFile();
1346 DIType *Type = getDerivedType();
1347 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7);
1348 auto *LE = DIExpression::get(Context, {1, 2});
1349 auto *UE = DIExpression::get(Context, {2, 3});
1350 auto *SE = DIExpression::get(Context, {3, 4});
1351 auto *LEother = DIExpression::get(Context, {5, 6});
1352 auto *LIother = ConstantAsMetadata::get(
1353 ConstantInt::getSigned(Type::getInt64Ty(Context), 20));
1354 auto *LVother = DILocalVariable::get(Context, Scope, "lbother", File, 8, Type,
1355 2, Flags, 8, nullptr);
1356
1357 auto *N = DISubrange::get(Context, nullptr, LE, UE, SE);
1358
1359 auto Lower = N->getLowerBound();
1360 ASSERT_TRUE(Lower);
1361 ASSERT_TRUE(Lower.is<DIExpression *>());
1362 EXPECT_EQ(LE, Lower.get<DIExpression *>());
1363
1364 auto Upper = N->getUpperBound();
1365 ASSERT_TRUE(Upper);
1366 ASSERT_TRUE(Upper.is<DIExpression *>());
1367 EXPECT_EQ(UE, Upper.get<DIExpression *>());
1368
1369 auto Stride = N->getStride();
1370 ASSERT_TRUE(Stride);
1371 ASSERT_TRUE(Stride.is<DIExpression *>());
1372 EXPECT_EQ(SE, Stride.get<DIExpression *>());
1373
1374 EXPECT_EQ(N, DISubrange::get(Context, nullptr, LE, UE, SE));
1375
1376 EXPECT_NE(N, DISubrange::get(Context, nullptr, LEother, UE, SE));
1377 EXPECT_NE(N, DISubrange::get(Context, nullptr, LIother, UE, SE));
1378 EXPECT_NE(N, DISubrange::get(Context, nullptr, LVother, UE, SE));
1379 }
1380
1381 typedef MetadataTest DIGenericSubrangeTest;
1382
TEST_F(DIGenericSubrangeTest,fortranAssumedRankInt)1383 TEST_F(DIGenericSubrangeTest, fortranAssumedRankInt) {
1384 DILocalScope *Scope = getSubprogram();
1385 DIFile *File = getFile();
1386 DIType *Type = getDerivedType();
1387 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7);
1388 auto *LI = DIExpression::get(
1389 Context, {dwarf::DW_OP_consts, static_cast<uint64_t>(-10)});
1390 auto *UI = DIExpression::get(Context, {dwarf::DW_OP_consts, 10});
1391 auto *SI = DIExpression::get(Context, {dwarf::DW_OP_consts, 4});
1392 auto *UIother = DIExpression::get(Context, {dwarf::DW_OP_consts, 20});
1393 auto *UVother = DILocalVariable::get(Context, Scope, "ubother", File, 8, Type,
1394 2, Flags, 8, nullptr);
1395 auto *UEother = DIExpression::get(Context, {5, 6});
1396 auto *LIZero = DIExpression::get(Context, {dwarf::DW_OP_consts, 0});
1397 auto *UIZero = DIExpression::get(Context, {dwarf::DW_OP_consts, 0});
1398
1399 auto *N = DIGenericSubrange::get(Context, nullptr, LI, UI, SI);
1400
1401 auto Lower = N->getLowerBound();
1402 ASSERT_TRUE(Lower);
1403 ASSERT_TRUE(Lower.is<DIExpression *>());
1404 EXPECT_EQ(dyn_cast_or_null<DIExpression>(LI), Lower.get<DIExpression *>());
1405
1406 auto Upper = N->getUpperBound();
1407 ASSERT_TRUE(Upper);
1408 ASSERT_TRUE(Upper.is<DIExpression *>());
1409 EXPECT_EQ(dyn_cast_or_null<DIExpression>(UI), Upper.get<DIExpression *>());
1410
1411 auto Stride = N->getStride();
1412 ASSERT_TRUE(Stride);
1413 ASSERT_TRUE(Stride.is<DIExpression *>());
1414 EXPECT_EQ(dyn_cast_or_null<DIExpression>(SI), Stride.get<DIExpression *>());
1415
1416 EXPECT_EQ(N, DIGenericSubrange::get(Context, nullptr, LI, UI, SI));
1417
1418 EXPECT_NE(N, DIGenericSubrange::get(Context, nullptr, LI, UIother, SI));
1419 EXPECT_NE(N, DIGenericSubrange::get(Context, nullptr, LI, UEother, SI));
1420 EXPECT_NE(N, DIGenericSubrange::get(Context, nullptr, LI, UVother, SI));
1421
1422 auto *NZeroLower = DIGenericSubrange::get(Context, nullptr, LIZero, UI, SI);
1423 EXPECT_NE(NZeroLower,
1424 DIGenericSubrange::get(Context, nullptr, nullptr, UI, SI));
1425
1426 auto *NZeroUpper = DIGenericSubrange::get(Context, nullptr, LI, UIZero, SI);
1427 EXPECT_NE(NZeroUpper,
1428 DIGenericSubrange::get(Context, nullptr, LI, nullptr, SI));
1429 }
1430
TEST_F(DIGenericSubrangeTest,fortranAssumedRankVar)1431 TEST_F(DIGenericSubrangeTest, fortranAssumedRankVar) {
1432 DILocalScope *Scope = getSubprogram();
1433 DIFile *File = getFile();
1434 DIType *Type = getDerivedType();
1435 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7);
1436 auto *LV =
1437 DILocalVariable::get(Context, Scope, "lb", File, 8, Type, 2, Flags, 8,
1438 nullptr);
1439 auto *UV =
1440 DILocalVariable::get(Context, Scope, "ub", File, 8, Type, 2, Flags, 8,
1441 nullptr);
1442 auto *SV =
1443 DILocalVariable::get(Context, Scope, "st", File, 8, Type, 2, Flags, 8,
1444 nullptr);
1445 auto *SVother = DILocalVariable::get(Context, Scope, "stother", File, 8, Type,
1446 2, Flags, 8, nullptr);
1447 auto *SIother = DIExpression::get(
1448 Context, {dwarf::DW_OP_consts, static_cast<uint64_t>(-1)});
1449 auto *SEother = DIExpression::get(Context, {5, 6});
1450
1451 auto *N = DIGenericSubrange::get(Context, nullptr, LV, UV, SV);
1452
1453 auto Lower = N->getLowerBound();
1454 ASSERT_TRUE(Lower);
1455 ASSERT_TRUE(Lower.is<DIVariable *>());
1456 EXPECT_EQ(LV, Lower.get<DIVariable *>());
1457
1458 auto Upper = N->getUpperBound();
1459 ASSERT_TRUE(Upper);
1460 ASSERT_TRUE(Upper.is<DIVariable *>());
1461 EXPECT_EQ(UV, Upper.get<DIVariable *>());
1462
1463 auto Stride = N->getStride();
1464 ASSERT_TRUE(Stride);
1465 ASSERT_TRUE(Stride.is<DIVariable *>());
1466 EXPECT_EQ(SV, Stride.get<DIVariable *>());
1467
1468 EXPECT_EQ(N, DIGenericSubrange::get(Context, nullptr, LV, UV, SV));
1469
1470 EXPECT_NE(N, DIGenericSubrange::get(Context, nullptr, LV, UV, SVother));
1471 EXPECT_NE(N, DIGenericSubrange::get(Context, nullptr, LV, UV, SEother));
1472 EXPECT_NE(N, DIGenericSubrange::get(Context, nullptr, LV, UV, SIother));
1473 }
1474
TEST_F(DIGenericSubrangeTest,useDIBuilder)1475 TEST_F(DIGenericSubrangeTest, useDIBuilder) {
1476 DILocalScope *Scope = getSubprogram();
1477 DIFile *File = getFile();
1478 DIType *Type = getDerivedType();
1479 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7);
1480 auto *LV =
1481 DILocalVariable::get(Context, Scope, "lb", File, 8, Type, 2, Flags, 8, nullptr);
1482 auto *UE = DIExpression::get(Context, {2, 3});
1483 auto *SE = DIExpression::get(Context, {3, 4});
1484
1485 auto *LVother = DILocalVariable::get(Context, Scope, "lbother", File, 8, Type,
1486 2, Flags, 8, nullptr);
1487 auto *LIother = DIExpression::get(
1488 Context, {dwarf::DW_OP_consts, static_cast<uint64_t>(-1)});
1489
1490 Module M("M", Context);
1491 DIBuilder DIB(M);
1492
1493 auto *N = DIB.getOrCreateGenericSubrange(
1494 DIGenericSubrange::BoundType(nullptr), DIGenericSubrange::BoundType(LV),
1495 DIGenericSubrange::BoundType(UE), DIGenericSubrange::BoundType(SE));
1496
1497 auto Lower = N->getLowerBound();
1498 ASSERT_TRUE(Lower);
1499 ASSERT_TRUE(Lower.is<DIVariable *>());
1500 EXPECT_EQ(LV, Lower.get<DIVariable *>());
1501
1502 auto Upper = N->getUpperBound();
1503 ASSERT_TRUE(Upper);
1504 ASSERT_TRUE(Upper.is<DIExpression *>());
1505 EXPECT_EQ(UE, Upper.get<DIExpression *>());
1506
1507 auto Stride = N->getStride();
1508 ASSERT_TRUE(Stride);
1509 ASSERT_TRUE(Stride.is<DIExpression *>());
1510 EXPECT_EQ(SE, Stride.get<DIExpression *>());
1511
1512 EXPECT_EQ(
1513 N, DIB.getOrCreateGenericSubrange(DIGenericSubrange::BoundType(nullptr),
1514 DIGenericSubrange::BoundType(LV),
1515 DIGenericSubrange::BoundType(UE),
1516 DIGenericSubrange::BoundType(SE)));
1517
1518 EXPECT_NE(
1519 N, DIB.getOrCreateGenericSubrange(DIGenericSubrange::BoundType(nullptr),
1520 DIGenericSubrange::BoundType(LVother),
1521 DIGenericSubrange::BoundType(UE),
1522 DIGenericSubrange::BoundType(SE)));
1523 EXPECT_NE(
1524 N, DIB.getOrCreateGenericSubrange(DIGenericSubrange::BoundType(nullptr),
1525 DIGenericSubrange::BoundType(LIother),
1526 DIGenericSubrange::BoundType(UE),
1527 DIGenericSubrange::BoundType(SE)));
1528 }
1529 typedef MetadataTest DIEnumeratorTest;
1530
TEST_F(DIEnumeratorTest,get)1531 TEST_F(DIEnumeratorTest, get) {
1532 auto *N = DIEnumerator::get(Context, 7, false, "name");
1533 EXPECT_EQ(dwarf::DW_TAG_enumerator, N->getTag());
1534 EXPECT_EQ(7, N->getValue().getSExtValue());
1535 EXPECT_FALSE(N->isUnsigned());
1536 EXPECT_EQ("name", N->getName());
1537 EXPECT_EQ(N, DIEnumerator::get(Context, 7, false, "name"));
1538
1539 EXPECT_NE(N, DIEnumerator::get(Context, 7, true, "name"));
1540 EXPECT_NE(N, DIEnumerator::get(Context, 8, false, "name"));
1541 EXPECT_NE(N, DIEnumerator::get(Context, 7, false, "nam"));
1542
1543 TempDIEnumerator Temp = N->clone();
1544 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1545 }
1546
TEST_F(DIEnumeratorTest,getWithLargeValues)1547 TEST_F(DIEnumeratorTest, getWithLargeValues) {
1548 auto *N = DIEnumerator::get(Context, APInt::getMaxValue(128), false, "val");
1549 EXPECT_EQ(128U, N->getValue().countPopulation());
1550 EXPECT_EQ(N,
1551 DIEnumerator::get(Context, APInt::getMaxValue(128), false, "val"));
1552 EXPECT_NE(N,
1553 DIEnumerator::get(Context, APInt::getMinValue(128), false, "val"));
1554 }
1555
1556 typedef MetadataTest DIBasicTypeTest;
1557
TEST_F(DIBasicTypeTest,get)1558 TEST_F(DIBasicTypeTest, get) {
1559 auto *N =
1560 DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33, 26, 7,
1561 DINode::FlagZero);
1562 EXPECT_EQ(dwarf::DW_TAG_base_type, N->getTag());
1563 EXPECT_EQ("special", N->getName());
1564 EXPECT_EQ(33u, N->getSizeInBits());
1565 EXPECT_EQ(26u, N->getAlignInBits());
1566 EXPECT_EQ(7u, N->getEncoding());
1567 EXPECT_EQ(0u, N->getLine());
1568 EXPECT_EQ(DINode::FlagZero, N->getFlags());
1569 EXPECT_EQ(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33,
1570 26, 7, DINode::FlagZero));
1571
1572 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type,
1573 "special", 33, 26, 7, DINode::FlagZero));
1574 EXPECT_NE(N,
1575 DIBasicType::get(Context, dwarf::DW_TAG_base_type, "s", 33, 26, 7,
1576 DINode::FlagZero));
1577 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 32,
1578 26, 7, DINode::FlagZero));
1579 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33,
1580 25, 7, DINode::FlagZero));
1581 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33,
1582 26, 6, DINode::FlagZero));
1583 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33,
1584 26, 7, DINode::FlagBigEndian));
1585 EXPECT_NE(N, DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special", 33,
1586 26, 7, DINode::FlagLittleEndian));
1587
1588 TempDIBasicType Temp = N->clone();
1589 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1590 }
1591
TEST_F(DIBasicTypeTest,getWithLargeValues)1592 TEST_F(DIBasicTypeTest, getWithLargeValues) {
1593 auto *N = DIBasicType::get(Context, dwarf::DW_TAG_base_type, "special",
1594 UINT64_MAX, UINT32_MAX - 1, 7, DINode::FlagZero);
1595 EXPECT_EQ(UINT64_MAX, N->getSizeInBits());
1596 EXPECT_EQ(UINT32_MAX - 1, N->getAlignInBits());
1597 }
1598
TEST_F(DIBasicTypeTest,getUnspecified)1599 TEST_F(DIBasicTypeTest, getUnspecified) {
1600 auto *N =
1601 DIBasicType::get(Context, dwarf::DW_TAG_unspecified_type, "unspecified");
1602 EXPECT_EQ(dwarf::DW_TAG_unspecified_type, N->getTag());
1603 EXPECT_EQ("unspecified", N->getName());
1604 EXPECT_EQ(0u, N->getSizeInBits());
1605 EXPECT_EQ(0u, N->getAlignInBits());
1606 EXPECT_EQ(0u, N->getEncoding());
1607 EXPECT_EQ(0u, N->getLine());
1608 EXPECT_EQ(DINode::FlagZero, N->getFlags());
1609 }
1610
1611 typedef MetadataTest DITypeTest;
1612
TEST_F(DITypeTest,clone)1613 TEST_F(DITypeTest, clone) {
1614 // Check that DIType has a specialized clone that returns TempDIType.
1615 DIType *N = DIBasicType::get(Context, dwarf::DW_TAG_base_type, "int", 32, 32,
1616 dwarf::DW_ATE_signed, DINode::FlagZero);
1617
1618 TempDIType Temp = N->clone();
1619 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1620 }
1621
TEST_F(DITypeTest,cloneWithFlags)1622 TEST_F(DITypeTest, cloneWithFlags) {
1623 // void (void)
1624 Metadata *TypesOps[] = {nullptr};
1625 Metadata *Types = MDTuple::get(Context, TypesOps);
1626
1627 DIType *D =
1628 DISubroutineType::getDistinct(Context, DINode::FlagZero, 0, Types);
1629 EXPECT_EQ(DINode::FlagZero, D->getFlags());
1630 TempDIType D2 = D->cloneWithFlags(DINode::FlagRValueReference);
1631 EXPECT_EQ(DINode::FlagRValueReference, D2->getFlags());
1632 EXPECT_EQ(DINode::FlagZero, D->getFlags());
1633
1634 TempDIType T =
1635 DISubroutineType::getTemporary(Context, DINode::FlagZero, 0, Types);
1636 EXPECT_EQ(DINode::FlagZero, T->getFlags());
1637 TempDIType T2 = T->cloneWithFlags(DINode::FlagRValueReference);
1638 EXPECT_EQ(DINode::FlagRValueReference, T2->getFlags());
1639 EXPECT_EQ(DINode::FlagZero, T->getFlags());
1640 }
1641
1642 typedef MetadataTest DIDerivedTypeTest;
1643
TEST_F(DIDerivedTypeTest,get)1644 TEST_F(DIDerivedTypeTest, get) {
1645 DIFile *File = getFile();
1646 DIScope *Scope = getSubprogram();
1647 DIType *BaseType = getBasicType("basic");
1648 MDTuple *ExtraData = getTuple();
1649 unsigned DWARFAddressSpace = 8;
1650 DINode::DIFlags Flags5 = static_cast<DINode::DIFlags>(5);
1651 DINode::DIFlags Flags4 = static_cast<DINode::DIFlags>(4);
1652
1653 auto *N =
1654 DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "something", File,
1655 1, Scope, BaseType, 2, 3, 4, DWARFAddressSpace, Flags5,
1656 ExtraData);
1657 EXPECT_EQ(dwarf::DW_TAG_pointer_type, N->getTag());
1658 EXPECT_EQ("something", N->getName());
1659 EXPECT_EQ(File, N->getFile());
1660 EXPECT_EQ(1u, N->getLine());
1661 EXPECT_EQ(Scope, N->getScope());
1662 EXPECT_EQ(BaseType, N->getBaseType());
1663 EXPECT_EQ(2u, N->getSizeInBits());
1664 EXPECT_EQ(3u, N->getAlignInBits());
1665 EXPECT_EQ(4u, N->getOffsetInBits());
1666 EXPECT_EQ(DWARFAddressSpace, *N->getDWARFAddressSpace());
1667 EXPECT_EQ(5u, N->getFlags());
1668 EXPECT_EQ(ExtraData, N->getExtraData());
1669 EXPECT_EQ(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1670 "something", File, 1, Scope, BaseType, 2, 3,
1671 4, DWARFAddressSpace, Flags5, ExtraData));
1672
1673 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_reference_type,
1674 "something", File, 1, Scope, BaseType, 2, 3,
1675 4, DWARFAddressSpace, Flags5, ExtraData));
1676 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type, "else",
1677 File, 1, Scope, BaseType, 2, 3,
1678 4, DWARFAddressSpace, Flags5, ExtraData));
1679 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1680 "something", getFile(), 1, Scope, BaseType, 2,
1681 3, 4, DWARFAddressSpace, Flags5, ExtraData));
1682 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1683 "something", File, 2, Scope, BaseType, 2, 3,
1684 4, DWARFAddressSpace, Flags5, ExtraData));
1685 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1686 "something", File, 1, getSubprogram(),
1687 BaseType, 2, 3, 4, DWARFAddressSpace, Flags5,
1688 ExtraData));
1689 EXPECT_NE(N, DIDerivedType::get(
1690 Context, dwarf::DW_TAG_pointer_type, "something", File, 1,
1691 Scope, getBasicType("basic2"), 2, 3, 4, DWARFAddressSpace,
1692 Flags5, ExtraData));
1693 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1694 "something", File, 1, Scope, BaseType, 3, 3,
1695 4, DWARFAddressSpace, Flags5, ExtraData));
1696 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1697 "something", File, 1, Scope, BaseType, 2, 2,
1698 4, DWARFAddressSpace, Flags5, ExtraData));
1699 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1700 "something", File, 1, Scope, BaseType, 2, 3,
1701 5, DWARFAddressSpace, Flags5, ExtraData));
1702 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1703 "something", File, 1, Scope, BaseType, 2, 3,
1704 4, DWARFAddressSpace + 1, Flags5, ExtraData));
1705 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1706 "something", File, 1, Scope, BaseType, 2, 3,
1707 4, DWARFAddressSpace, Flags4, ExtraData));
1708 EXPECT_NE(N, DIDerivedType::get(Context, dwarf::DW_TAG_pointer_type,
1709 "something", File, 1, Scope, BaseType, 2, 3,
1710 4, DWARFAddressSpace, Flags5, getTuple()));
1711
1712 TempDIDerivedType Temp = N->clone();
1713 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1714 }
1715
TEST_F(DIDerivedTypeTest,getWithLargeValues)1716 TEST_F(DIDerivedTypeTest, getWithLargeValues) {
1717 DIFile *File = getFile();
1718 DIScope *Scope = getSubprogram();
1719 DIType *BaseType = getBasicType("basic");
1720 MDTuple *ExtraData = getTuple();
1721 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5);
1722
1723 auto *N = DIDerivedType::get(
1724 Context, dwarf::DW_TAG_pointer_type, "something", File, 1, Scope,
1725 BaseType, UINT64_MAX, UINT32_MAX - 1, UINT64_MAX - 2, UINT32_MAX - 3,
1726 Flags, ExtraData);
1727 EXPECT_EQ(UINT64_MAX, N->getSizeInBits());
1728 EXPECT_EQ(UINT32_MAX - 1, N->getAlignInBits());
1729 EXPECT_EQ(UINT64_MAX - 2, N->getOffsetInBits());
1730 EXPECT_EQ(UINT32_MAX - 3, *N->getDWARFAddressSpace());
1731 }
1732
1733 typedef MetadataTest DICompositeTypeTest;
1734
TEST_F(DICompositeTypeTest,get)1735 TEST_F(DICompositeTypeTest, get) {
1736 unsigned Tag = dwarf::DW_TAG_structure_type;
1737 StringRef Name = "some name";
1738 DIFile *File = getFile();
1739 unsigned Line = 1;
1740 DIScope *Scope = getSubprogram();
1741 DIType *BaseType = getCompositeType();
1742 uint64_t SizeInBits = 2;
1743 uint32_t AlignInBits = 3;
1744 uint64_t OffsetInBits = 4;
1745 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5);
1746 MDTuple *Elements = getTuple();
1747 unsigned RuntimeLang = 6;
1748 DIType *VTableHolder = getCompositeType();
1749 MDTuple *TemplateParams = getTuple();
1750 StringRef Identifier = "some id";
1751
1752 auto *N = DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1753 BaseType, SizeInBits, AlignInBits,
1754 OffsetInBits, Flags, Elements, RuntimeLang,
1755 VTableHolder, TemplateParams, Identifier);
1756 EXPECT_EQ(Tag, N->getTag());
1757 EXPECT_EQ(Name, N->getName());
1758 EXPECT_EQ(File, N->getFile());
1759 EXPECT_EQ(Line, N->getLine());
1760 EXPECT_EQ(Scope, N->getScope());
1761 EXPECT_EQ(BaseType, N->getBaseType());
1762 EXPECT_EQ(SizeInBits, N->getSizeInBits());
1763 EXPECT_EQ(AlignInBits, N->getAlignInBits());
1764 EXPECT_EQ(OffsetInBits, N->getOffsetInBits());
1765 EXPECT_EQ(Flags, N->getFlags());
1766 EXPECT_EQ(Elements, N->getElements().get());
1767 EXPECT_EQ(RuntimeLang, N->getRuntimeLang());
1768 EXPECT_EQ(VTableHolder, N->getVTableHolder());
1769 EXPECT_EQ(TemplateParams, N->getTemplateParams().get());
1770 EXPECT_EQ(Identifier, N->getIdentifier());
1771
1772 EXPECT_EQ(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1773 BaseType, SizeInBits, AlignInBits,
1774 OffsetInBits, Flags, Elements, RuntimeLang,
1775 VTableHolder, TemplateParams, Identifier));
1776
1777 EXPECT_NE(N, DICompositeType::get(Context, Tag + 1, Name, File, Line, Scope,
1778 BaseType, SizeInBits, AlignInBits,
1779 OffsetInBits, Flags, Elements, RuntimeLang,
1780 VTableHolder, TemplateParams, Identifier));
1781 EXPECT_NE(N, DICompositeType::get(Context, Tag, "abc", File, Line, Scope,
1782 BaseType, SizeInBits, AlignInBits,
1783 OffsetInBits, Flags, Elements, RuntimeLang,
1784 VTableHolder, TemplateParams, Identifier));
1785 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, getFile(), Line, Scope,
1786 BaseType, SizeInBits, AlignInBits,
1787 OffsetInBits, Flags, Elements, RuntimeLang,
1788 VTableHolder, TemplateParams, Identifier));
1789 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line + 1, Scope,
1790 BaseType, SizeInBits, AlignInBits,
1791 OffsetInBits, Flags, Elements, RuntimeLang,
1792 VTableHolder, TemplateParams, Identifier));
1793 EXPECT_NE(N, DICompositeType::get(
1794 Context, Tag, Name, File, Line, getSubprogram(), BaseType,
1795 SizeInBits, AlignInBits, OffsetInBits, Flags, Elements,
1796 RuntimeLang, VTableHolder, TemplateParams, Identifier));
1797 EXPECT_NE(N, DICompositeType::get(
1798 Context, Tag, Name, File, Line, Scope, getBasicType("other"),
1799 SizeInBits, AlignInBits, OffsetInBits, Flags, Elements,
1800 RuntimeLang, VTableHolder, TemplateParams, Identifier));
1801 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1802 BaseType, SizeInBits + 1, AlignInBits,
1803 OffsetInBits, Flags, Elements, RuntimeLang,
1804 VTableHolder, TemplateParams, Identifier));
1805 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1806 BaseType, SizeInBits, AlignInBits + 1,
1807 OffsetInBits, Flags, Elements, RuntimeLang,
1808 VTableHolder, TemplateParams, Identifier));
1809 EXPECT_NE(N, DICompositeType::get(
1810 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
1811 AlignInBits, OffsetInBits + 1, Flags, Elements, RuntimeLang,
1812 VTableHolder, TemplateParams, Identifier));
1813 DINode::DIFlags FlagsPOne = static_cast<DINode::DIFlags>(Flags + 1);
1814 EXPECT_NE(N, DICompositeType::get(
1815 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
1816 AlignInBits, OffsetInBits, FlagsPOne, Elements, RuntimeLang,
1817 VTableHolder, TemplateParams, Identifier));
1818 EXPECT_NE(N, DICompositeType::get(
1819 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
1820 AlignInBits, OffsetInBits, Flags, getTuple(), RuntimeLang,
1821 VTableHolder, TemplateParams, Identifier));
1822 EXPECT_NE(N, DICompositeType::get(
1823 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
1824 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang + 1,
1825 VTableHolder, TemplateParams, Identifier));
1826 EXPECT_NE(N, DICompositeType::get(
1827 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
1828 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
1829 getCompositeType(), TemplateParams, Identifier));
1830 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1831 BaseType, SizeInBits, AlignInBits,
1832 OffsetInBits, Flags, Elements, RuntimeLang,
1833 VTableHolder, getTuple(), Identifier));
1834 EXPECT_NE(N, DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1835 BaseType, SizeInBits, AlignInBits,
1836 OffsetInBits, Flags, Elements, RuntimeLang,
1837 VTableHolder, TemplateParams, "other"));
1838
1839 // Be sure that missing identifiers get null pointers.
1840 EXPECT_FALSE(DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1841 BaseType, SizeInBits, AlignInBits,
1842 OffsetInBits, Flags, Elements, RuntimeLang,
1843 VTableHolder, TemplateParams, "")
1844 ->getRawIdentifier());
1845 EXPECT_FALSE(DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1846 BaseType, SizeInBits, AlignInBits,
1847 OffsetInBits, Flags, Elements, RuntimeLang,
1848 VTableHolder, TemplateParams)
1849 ->getRawIdentifier());
1850
1851 TempDICompositeType Temp = N->clone();
1852 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
1853 }
1854
TEST_F(DICompositeTypeTest,getWithLargeValues)1855 TEST_F(DICompositeTypeTest, getWithLargeValues) {
1856 unsigned Tag = dwarf::DW_TAG_structure_type;
1857 StringRef Name = "some name";
1858 DIFile *File = getFile();
1859 unsigned Line = 1;
1860 DIScope *Scope = getSubprogram();
1861 DIType *BaseType = getCompositeType();
1862 uint64_t SizeInBits = UINT64_MAX;
1863 uint32_t AlignInBits = UINT32_MAX - 1;
1864 uint64_t OffsetInBits = UINT64_MAX - 2;
1865 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5);
1866 MDTuple *Elements = getTuple();
1867 unsigned RuntimeLang = 6;
1868 DIType *VTableHolder = getCompositeType();
1869 MDTuple *TemplateParams = getTuple();
1870 StringRef Identifier = "some id";
1871
1872 auto *N = DICompositeType::get(Context, Tag, Name, File, Line, Scope,
1873 BaseType, SizeInBits, AlignInBits,
1874 OffsetInBits, Flags, Elements, RuntimeLang,
1875 VTableHolder, TemplateParams, Identifier);
1876 EXPECT_EQ(SizeInBits, N->getSizeInBits());
1877 EXPECT_EQ(AlignInBits, N->getAlignInBits());
1878 EXPECT_EQ(OffsetInBits, N->getOffsetInBits());
1879 }
1880
TEST_F(DICompositeTypeTest,replaceOperands)1881 TEST_F(DICompositeTypeTest, replaceOperands) {
1882 unsigned Tag = dwarf::DW_TAG_structure_type;
1883 StringRef Name = "some name";
1884 DIFile *File = getFile();
1885 unsigned Line = 1;
1886 DIScope *Scope = getSubprogram();
1887 DIType *BaseType = getCompositeType();
1888 uint64_t SizeInBits = 2;
1889 uint32_t AlignInBits = 3;
1890 uint64_t OffsetInBits = 4;
1891 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5);
1892 unsigned RuntimeLang = 6;
1893 StringRef Identifier = "some id";
1894
1895 auto *N = DICompositeType::get(
1896 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
1897 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier);
1898
1899 auto *Elements = MDTuple::getDistinct(Context, None);
1900 EXPECT_EQ(nullptr, N->getElements().get());
1901 N->replaceElements(Elements);
1902 EXPECT_EQ(Elements, N->getElements().get());
1903 N->replaceElements(nullptr);
1904 EXPECT_EQ(nullptr, N->getElements().get());
1905
1906 DIType *VTableHolder = getCompositeType();
1907 EXPECT_EQ(nullptr, N->getVTableHolder());
1908 N->replaceVTableHolder(VTableHolder);
1909 EXPECT_EQ(VTableHolder, N->getVTableHolder());
1910 // As an extension, the containing type can be anything. This is
1911 // used by Rust to associate vtables with their concrete type.
1912 DIType *BasicType = getBasicType("basic");
1913 N->replaceVTableHolder(BasicType);
1914 EXPECT_EQ(BasicType, N->getVTableHolder());
1915 N->replaceVTableHolder(nullptr);
1916 EXPECT_EQ(nullptr, N->getVTableHolder());
1917
1918 auto *TemplateParams = MDTuple::getDistinct(Context, None);
1919 EXPECT_EQ(nullptr, N->getTemplateParams().get());
1920 N->replaceTemplateParams(TemplateParams);
1921 EXPECT_EQ(TemplateParams, N->getTemplateParams().get());
1922 N->replaceTemplateParams(nullptr);
1923 EXPECT_EQ(nullptr, N->getTemplateParams().get());
1924 }
1925
TEST_F(DICompositeTypeTest,variant_part)1926 TEST_F(DICompositeTypeTest, variant_part) {
1927 unsigned Tag = dwarf::DW_TAG_variant_part;
1928 StringRef Name = "some name";
1929 DIFile *File = getFile();
1930 unsigned Line = 1;
1931 DIScope *Scope = getSubprogram();
1932 DIType *BaseType = getCompositeType();
1933 uint64_t SizeInBits = 2;
1934 uint32_t AlignInBits = 3;
1935 uint64_t OffsetInBits = 4;
1936 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(5);
1937 unsigned RuntimeLang = 6;
1938 StringRef Identifier = "some id";
1939 DIDerivedType *Discriminator = cast<DIDerivedType>(getDerivedType());
1940 DIDerivedType *Discriminator2 = cast<DIDerivedType>(getDerivedType());
1941
1942 EXPECT_NE(Discriminator, Discriminator2);
1943
1944 auto *N = DICompositeType::get(
1945 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
1946 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
1947 Discriminator);
1948
1949 // Test the hashing.
1950 auto *Same = DICompositeType::get(
1951 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
1952 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
1953 Discriminator);
1954 auto *Other = DICompositeType::get(
1955 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
1956 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
1957 Discriminator2);
1958 auto *NoDisc = DICompositeType::get(
1959 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
1960 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
1961 nullptr);
1962
1963 EXPECT_EQ(N, Same);
1964 EXPECT_NE(Same, Other);
1965 EXPECT_NE(Same, NoDisc);
1966 EXPECT_NE(Other, NoDisc);
1967
1968 EXPECT_EQ(N->getDiscriminator(), Discriminator);
1969 }
1970
TEST_F(DICompositeTypeTest,dynamicArray)1971 TEST_F(DICompositeTypeTest, dynamicArray) {
1972 unsigned Tag = dwarf::DW_TAG_array_type;
1973 StringRef Name = "some name";
1974 DIFile *File = getFile();
1975 unsigned Line = 1;
1976 DILocalScope *Scope = getSubprogram();
1977 DIType *BaseType = getCompositeType();
1978 uint64_t SizeInBits = 32;
1979 uint32_t AlignInBits = 32;
1980 uint64_t OffsetInBits = 4;
1981 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(3);
1982 unsigned RuntimeLang = 6;
1983 StringRef Identifier = "some id";
1984 DIType *Type = getDerivedType();
1985 Metadata *DlVar1 = DILocalVariable::get(Context, Scope, "dl_var1", File, 8,
1986 Type, 2, Flags, 8, nullptr);
1987 Metadata *DlVar2 = DILocalVariable::get(Context, Scope, "dl_var2", File, 8,
1988 Type, 2, Flags, 8, nullptr);
1989 uint64_t Elements1[] = {dwarf::DW_OP_push_object_address, dwarf::DW_OP_deref};
1990 Metadata *DataLocation1 = DIExpression::get(Context, Elements1);
1991
1992 uint64_t Elements2[] = {dwarf::DW_OP_constu, 0};
1993 Metadata *DataLocation2 = DIExpression::get(Context, Elements2);
1994
1995 uint64_t Elements3[] = {dwarf::DW_OP_constu, 3};
1996 Metadata *Rank1 = DIExpression::get(Context, Elements3);
1997
1998 uint64_t Elements4[] = {dwarf::DW_OP_constu, 4};
1999 Metadata *Rank2 = DIExpression::get(Context, Elements4);
2000
2001 ConstantInt *RankInt1 = ConstantInt::get(Context, APInt(7, 0));
2002 ConstantAsMetadata *RankConst1 = ConstantAsMetadata::get(RankInt1);
2003 ConstantInt *RankInt2 = ConstantInt::get(Context, APInt(6, 0));
2004 ConstantAsMetadata *RankConst2 = ConstantAsMetadata::get(RankInt2);
2005 auto *N1 = DICompositeType::get(
2006 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
2007 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
2008 nullptr, DlVar1);
2009
2010 auto *Same1 = DICompositeType::get(
2011 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
2012 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
2013 nullptr, DlVar1);
2014
2015 auto *Other1 = DICompositeType::get(
2016 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
2017 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
2018 nullptr, DlVar2);
2019
2020 EXPECT_EQ(N1, Same1);
2021 EXPECT_NE(Same1, Other1);
2022 EXPECT_EQ(N1->getDataLocation(), DlVar1);
2023
2024 auto *N2 = DICompositeType::get(
2025 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
2026 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
2027 nullptr, DataLocation1);
2028
2029 auto *Same2 = DICompositeType::get(
2030 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
2031 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
2032 nullptr, DataLocation1);
2033
2034 auto *Other2 = DICompositeType::get(
2035 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
2036 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
2037 nullptr, DataLocation2);
2038
2039 EXPECT_EQ(N2, Same2);
2040 EXPECT_NE(Same2, Other2);
2041 EXPECT_EQ(N2->getDataLocationExp(), DataLocation1);
2042
2043 auto *N3 = DICompositeType::get(
2044 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
2045 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
2046 nullptr, DataLocation1, nullptr, nullptr, Rank1);
2047
2048 auto *Same3 = DICompositeType::get(
2049 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
2050 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
2051 nullptr, DataLocation1, nullptr, nullptr, Rank1);
2052
2053 auto *Other3 = DICompositeType::get(
2054 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
2055 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
2056 nullptr, DataLocation1, nullptr, nullptr, Rank2);
2057
2058 EXPECT_EQ(N3, Same3);
2059 EXPECT_NE(Same3, Other3);
2060 EXPECT_EQ(N3->getRankExp(), Rank1);
2061
2062 auto *N4 = DICompositeType::get(
2063 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
2064 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
2065 nullptr, DataLocation1, nullptr, nullptr, RankConst1);
2066
2067 auto *Same4 = DICompositeType::get(
2068 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
2069 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
2070 nullptr, DataLocation1, nullptr, nullptr, RankConst1);
2071
2072 auto *Other4 = DICompositeType::get(
2073 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
2074 OffsetInBits, Flags, nullptr, RuntimeLang, nullptr, nullptr, Identifier,
2075 nullptr, DataLocation1, nullptr, nullptr, RankConst2);
2076
2077 EXPECT_EQ(N4, Same4);
2078 EXPECT_NE(Same4, Other4);
2079 EXPECT_EQ(N4->getRankConst(), RankInt1);
2080 }
2081
2082 typedef MetadataTest DISubroutineTypeTest;
2083
TEST_F(DISubroutineTypeTest,get)2084 TEST_F(DISubroutineTypeTest, get) {
2085 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(1);
2086 DINode::DIFlags FlagsPOne = static_cast<DINode::DIFlags>(Flags + 1);
2087 MDTuple *TypeArray = getTuple();
2088
2089 auto *N = DISubroutineType::get(Context, Flags, 0, TypeArray);
2090 EXPECT_EQ(dwarf::DW_TAG_subroutine_type, N->getTag());
2091 EXPECT_EQ(Flags, N->getFlags());
2092 EXPECT_EQ(TypeArray, N->getTypeArray().get());
2093 EXPECT_EQ(N, DISubroutineType::get(Context, Flags, 0, TypeArray));
2094
2095 EXPECT_NE(N, DISubroutineType::get(Context, FlagsPOne, 0, TypeArray));
2096 EXPECT_NE(N, DISubroutineType::get(Context, Flags, 0, getTuple()));
2097
2098 // Test the hashing of calling conventions.
2099 auto *Fast = DISubroutineType::get(
2100 Context, Flags, dwarf::DW_CC_BORLAND_msfastcall, TypeArray);
2101 auto *Std = DISubroutineType::get(Context, Flags,
2102 dwarf::DW_CC_BORLAND_stdcall, TypeArray);
2103 EXPECT_EQ(Fast,
2104 DISubroutineType::get(Context, Flags,
2105 dwarf::DW_CC_BORLAND_msfastcall, TypeArray));
2106 EXPECT_EQ(Std, DISubroutineType::get(
2107 Context, Flags, dwarf::DW_CC_BORLAND_stdcall, TypeArray));
2108
2109 EXPECT_NE(N, Fast);
2110 EXPECT_NE(N, Std);
2111 EXPECT_NE(Fast, Std);
2112
2113 TempDISubroutineType Temp = N->clone();
2114 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
2115
2116 // Test always-empty operands.
2117 EXPECT_EQ(nullptr, N->getScope());
2118 EXPECT_EQ(nullptr, N->getFile());
2119 EXPECT_EQ("", N->getName());
2120 }
2121
2122 typedef MetadataTest DIFileTest;
2123
TEST_F(DIFileTest,get)2124 TEST_F(DIFileTest, get) {
2125 StringRef Filename = "file";
2126 StringRef Directory = "dir";
2127 DIFile::ChecksumKind CSKind = DIFile::ChecksumKind::CSK_MD5;
2128 StringRef ChecksumString = "000102030405060708090a0b0c0d0e0f";
2129 DIFile::ChecksumInfo<StringRef> Checksum(CSKind, ChecksumString);
2130 StringRef Source = "source";
2131 auto *N = DIFile::get(Context, Filename, Directory, Checksum, Source);
2132
2133 EXPECT_EQ(dwarf::DW_TAG_file_type, N->getTag());
2134 EXPECT_EQ(Filename, N->getFilename());
2135 EXPECT_EQ(Directory, N->getDirectory());
2136 EXPECT_EQ(Checksum, N->getChecksum());
2137 EXPECT_EQ(Source, N->getSource());
2138 EXPECT_EQ(N, DIFile::get(Context, Filename, Directory, Checksum, Source));
2139
2140 EXPECT_NE(N, DIFile::get(Context, "other", Directory, Checksum, Source));
2141 EXPECT_NE(N, DIFile::get(Context, Filename, "other", Checksum, Source));
2142 DIFile::ChecksumInfo<StringRef> OtherChecksum(DIFile::ChecksumKind::CSK_SHA1, ChecksumString);
2143 EXPECT_NE(
2144 N, DIFile::get(Context, Filename, Directory, OtherChecksum));
2145 StringRef OtherSource = "other";
2146 EXPECT_NE(N, DIFile::get(Context, Filename, Directory, Checksum, OtherSource));
2147 EXPECT_NE(N, DIFile::get(Context, Filename, Directory, Checksum));
2148 EXPECT_NE(N, DIFile::get(Context, Filename, Directory));
2149
2150 TempDIFile Temp = N->clone();
2151 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
2152 }
2153
TEST_F(DIFileTest,ScopeGetFile)2154 TEST_F(DIFileTest, ScopeGetFile) {
2155 // Ensure that DIScope::getFile() returns itself.
2156 DIScope *N = DIFile::get(Context, "file", "dir");
2157 EXPECT_EQ(N, N->getFile());
2158 }
2159
2160 typedef MetadataTest DICompileUnitTest;
2161
TEST_F(DICompileUnitTest,get)2162 TEST_F(DICompileUnitTest, get) {
2163 unsigned SourceLanguage = 1;
2164 DIFile *File = getFile();
2165 StringRef Producer = "some producer";
2166 bool IsOptimized = false;
2167 StringRef Flags = "flag after flag";
2168 unsigned RuntimeVersion = 2;
2169 StringRef SplitDebugFilename = "another/file";
2170 auto EmissionKind = DICompileUnit::FullDebug;
2171 MDTuple *EnumTypes = getTuple();
2172 MDTuple *RetainedTypes = getTuple();
2173 MDTuple *GlobalVariables = getTuple();
2174 MDTuple *ImportedEntities = getTuple();
2175 uint64_t DWOId = 0x10000000c0ffee;
2176 MDTuple *Macros = getTuple();
2177 StringRef SysRoot = "/";
2178 StringRef SDK = "MacOSX.sdk";
2179 auto *N = DICompileUnit::getDistinct(
2180 Context, SourceLanguage, File, Producer, IsOptimized, Flags,
2181 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes,
2182 RetainedTypes, GlobalVariables, ImportedEntities, Macros, DWOId, true,
2183 false, DICompileUnit::DebugNameTableKind::Default, false, SysRoot, SDK);
2184
2185 EXPECT_EQ(dwarf::DW_TAG_compile_unit, N->getTag());
2186 EXPECT_EQ(SourceLanguage, N->getSourceLanguage());
2187 EXPECT_EQ(File, N->getFile());
2188 EXPECT_EQ(Producer, N->getProducer());
2189 EXPECT_EQ(IsOptimized, N->isOptimized());
2190 EXPECT_EQ(Flags, N->getFlags());
2191 EXPECT_EQ(RuntimeVersion, N->getRuntimeVersion());
2192 EXPECT_EQ(SplitDebugFilename, N->getSplitDebugFilename());
2193 EXPECT_EQ(EmissionKind, N->getEmissionKind());
2194 EXPECT_EQ(EnumTypes, N->getEnumTypes().get());
2195 EXPECT_EQ(RetainedTypes, N->getRetainedTypes().get());
2196 EXPECT_EQ(GlobalVariables, N->getGlobalVariables().get());
2197 EXPECT_EQ(ImportedEntities, N->getImportedEntities().get());
2198 EXPECT_EQ(Macros, N->getMacros().get());
2199 EXPECT_EQ(DWOId, N->getDWOId());
2200 EXPECT_EQ(SysRoot, N->getSysRoot());
2201 EXPECT_EQ(SDK, N->getSDK());
2202
2203 TempDICompileUnit Temp = N->clone();
2204 EXPECT_EQ(dwarf::DW_TAG_compile_unit, Temp->getTag());
2205 EXPECT_EQ(SourceLanguage, Temp->getSourceLanguage());
2206 EXPECT_EQ(File, Temp->getFile());
2207 EXPECT_EQ(Producer, Temp->getProducer());
2208 EXPECT_EQ(IsOptimized, Temp->isOptimized());
2209 EXPECT_EQ(Flags, Temp->getFlags());
2210 EXPECT_EQ(RuntimeVersion, Temp->getRuntimeVersion());
2211 EXPECT_EQ(SplitDebugFilename, Temp->getSplitDebugFilename());
2212 EXPECT_EQ(EmissionKind, Temp->getEmissionKind());
2213 EXPECT_EQ(EnumTypes, Temp->getEnumTypes().get());
2214 EXPECT_EQ(RetainedTypes, Temp->getRetainedTypes().get());
2215 EXPECT_EQ(GlobalVariables, Temp->getGlobalVariables().get());
2216 EXPECT_EQ(ImportedEntities, Temp->getImportedEntities().get());
2217 EXPECT_EQ(Macros, Temp->getMacros().get());
2218 EXPECT_EQ(SysRoot, Temp->getSysRoot());
2219 EXPECT_EQ(SDK, Temp->getSDK());
2220
2221 auto *TempAddress = Temp.get();
2222 auto *Clone = MDNode::replaceWithPermanent(std::move(Temp));
2223 EXPECT_TRUE(Clone->isDistinct());
2224 EXPECT_EQ(TempAddress, Clone);
2225 }
2226
TEST_F(DICompileUnitTest,replaceArrays)2227 TEST_F(DICompileUnitTest, replaceArrays) {
2228 unsigned SourceLanguage = 1;
2229 DIFile *File = getFile();
2230 StringRef Producer = "some producer";
2231 bool IsOptimized = false;
2232 StringRef Flags = "flag after flag";
2233 unsigned RuntimeVersion = 2;
2234 StringRef SplitDebugFilename = "another/file";
2235 auto EmissionKind = DICompileUnit::FullDebug;
2236 MDTuple *EnumTypes = MDTuple::getDistinct(Context, None);
2237 MDTuple *RetainedTypes = MDTuple::getDistinct(Context, None);
2238 MDTuple *ImportedEntities = MDTuple::getDistinct(Context, None);
2239 uint64_t DWOId = 0xc0ffee;
2240 StringRef SysRoot = "/";
2241 StringRef SDK = "MacOSX.sdk";
2242 auto *N = DICompileUnit::getDistinct(
2243 Context, SourceLanguage, File, Producer, IsOptimized, Flags,
2244 RuntimeVersion, SplitDebugFilename, EmissionKind, EnumTypes,
2245 RetainedTypes, nullptr, ImportedEntities, nullptr, DWOId, true, false,
2246 DICompileUnit::DebugNameTableKind::Default, false, SysRoot, SDK);
2247
2248 auto *GlobalVariables = MDTuple::getDistinct(Context, None);
2249 EXPECT_EQ(nullptr, N->getGlobalVariables().get());
2250 N->replaceGlobalVariables(GlobalVariables);
2251 EXPECT_EQ(GlobalVariables, N->getGlobalVariables().get());
2252 N->replaceGlobalVariables(nullptr);
2253 EXPECT_EQ(nullptr, N->getGlobalVariables().get());
2254
2255 auto *Macros = MDTuple::getDistinct(Context, None);
2256 EXPECT_EQ(nullptr, N->getMacros().get());
2257 N->replaceMacros(Macros);
2258 EXPECT_EQ(Macros, N->getMacros().get());
2259 N->replaceMacros(nullptr);
2260 EXPECT_EQ(nullptr, N->getMacros().get());
2261 }
2262
2263 typedef MetadataTest DISubprogramTest;
2264
TEST_F(DISubprogramTest,get)2265 TEST_F(DISubprogramTest, get) {
2266 DIScope *Scope = getCompositeType();
2267 StringRef Name = "name";
2268 StringRef LinkageName = "linkage";
2269 DIFile *File = getFile();
2270 unsigned Line = 2;
2271 DISubroutineType *Type = getSubroutineType();
2272 bool IsLocalToUnit = false;
2273 bool IsDefinition = true;
2274 unsigned ScopeLine = 3;
2275 DIType *ContainingType = getCompositeType();
2276 unsigned Virtuality = 2;
2277 unsigned VirtualIndex = 5;
2278 int ThisAdjustment = -3;
2279 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(6);
2280 bool IsOptimized = false;
2281 MDTuple *TemplateParams = getTuple();
2282 DISubprogram *Declaration = getSubprogram();
2283 MDTuple *RetainedNodes = getTuple();
2284 MDTuple *ThrownTypes = getTuple();
2285 MDTuple *Annotations = getTuple();
2286 StringRef TargetFuncName = "target";
2287 DICompileUnit *Unit = getUnit();
2288 DISubprogram::DISPFlags SPFlags =
2289 static_cast<DISubprogram::DISPFlags>(Virtuality);
2290 assert(!IsLocalToUnit && IsDefinition && !IsOptimized &&
2291 "bools and SPFlags have to match");
2292 SPFlags |= DISubprogram::SPFlagDefinition;
2293
2294 auto *N = DISubprogram::get(
2295 Context, Scope, Name, LinkageName, File, Line, Type, ScopeLine,
2296 ContainingType, VirtualIndex, ThisAdjustment, Flags, SPFlags, Unit,
2297 TemplateParams, Declaration, RetainedNodes, ThrownTypes, Annotations,
2298 TargetFuncName);
2299
2300 EXPECT_EQ(dwarf::DW_TAG_subprogram, N->getTag());
2301 EXPECT_EQ(Scope, N->getScope());
2302 EXPECT_EQ(Name, N->getName());
2303 EXPECT_EQ(LinkageName, N->getLinkageName());
2304 EXPECT_EQ(File, N->getFile());
2305 EXPECT_EQ(Line, N->getLine());
2306 EXPECT_EQ(Type, N->getType());
2307 EXPECT_EQ(IsLocalToUnit, N->isLocalToUnit());
2308 EXPECT_EQ(IsDefinition, N->isDefinition());
2309 EXPECT_EQ(ScopeLine, N->getScopeLine());
2310 EXPECT_EQ(ContainingType, N->getContainingType());
2311 EXPECT_EQ(Virtuality, N->getVirtuality());
2312 EXPECT_EQ(VirtualIndex, N->getVirtualIndex());
2313 EXPECT_EQ(ThisAdjustment, N->getThisAdjustment());
2314 EXPECT_EQ(Flags, N->getFlags());
2315 EXPECT_EQ(IsOptimized, N->isOptimized());
2316 EXPECT_EQ(Unit, N->getUnit());
2317 EXPECT_EQ(TemplateParams, N->getTemplateParams().get());
2318 EXPECT_EQ(Declaration, N->getDeclaration());
2319 EXPECT_EQ(RetainedNodes, N->getRetainedNodes().get());
2320 EXPECT_EQ(ThrownTypes, N->getThrownTypes().get());
2321 EXPECT_EQ(Annotations, N->getAnnotations().get());
2322 EXPECT_EQ(TargetFuncName, N->getTargetFuncName());
2323 EXPECT_EQ(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
2324 Type, ScopeLine, ContainingType, VirtualIndex,
2325 ThisAdjustment, Flags, SPFlags, Unit,
2326 TemplateParams, Declaration, RetainedNodes,
2327 ThrownTypes, Annotations, TargetFuncName));
2328
2329 EXPECT_NE(N, DISubprogram::get(Context, getCompositeType(), Name, LinkageName,
2330 File, Line, Type, ScopeLine, ContainingType,
2331 VirtualIndex, ThisAdjustment, Flags, SPFlags,
2332 Unit, TemplateParams, Declaration,
2333 RetainedNodes, ThrownTypes, Annotations,
2334 TargetFuncName));
2335 EXPECT_NE(N, DISubprogram::get(Context, Scope, "other", LinkageName, File,
2336 Line, Type, ScopeLine, ContainingType,
2337 VirtualIndex, ThisAdjustment, Flags, SPFlags,
2338 Unit, TemplateParams, Declaration,
2339 RetainedNodes, ThrownTypes, Annotations,
2340 TargetFuncName));
2341 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, "other", File, Line,
2342 Type, ScopeLine, ContainingType, VirtualIndex,
2343 ThisAdjustment, Flags, SPFlags, Unit,
2344 TemplateParams, Declaration, RetainedNodes,
2345 ThrownTypes, Annotations, TargetFuncName));
2346 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, getFile(),
2347 Line, Type, ScopeLine, ContainingType,
2348 VirtualIndex, ThisAdjustment, Flags, SPFlags,
2349 Unit, TemplateParams, Declaration,
2350 RetainedNodes, ThrownTypes, Annotations,
2351 TargetFuncName));
2352 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File,
2353 Line + 1, Type, ScopeLine, ContainingType,
2354 VirtualIndex, ThisAdjustment, Flags, SPFlags,
2355 Unit, TemplateParams, Declaration,
2356 RetainedNodes, ThrownTypes, Annotations,
2357 TargetFuncName));
2358 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
2359 getSubroutineType(), ScopeLine, ContainingType,
2360 VirtualIndex, ThisAdjustment, Flags, SPFlags,
2361 Unit, TemplateParams, Declaration,
2362 RetainedNodes, ThrownTypes, Annotations,
2363 TargetFuncName));
2364 EXPECT_NE(N, DISubprogram::get(
2365 Context, Scope, Name, LinkageName, File, Line, Type,
2366 ScopeLine, ContainingType, VirtualIndex, ThisAdjustment,
2367 Flags, SPFlags ^ DISubprogram::SPFlagLocalToUnit, Unit,
2368 TemplateParams, Declaration, RetainedNodes, ThrownTypes,
2369 Annotations, TargetFuncName));
2370 EXPECT_NE(N, DISubprogram::get(
2371 Context, Scope, Name, LinkageName, File, Line, Type,
2372 ScopeLine, ContainingType, VirtualIndex, ThisAdjustment,
2373 Flags, SPFlags ^ DISubprogram::SPFlagDefinition, Unit,
2374 TemplateParams, Declaration, RetainedNodes, ThrownTypes,
2375 Annotations, TargetFuncName));
2376 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
2377 Type, ScopeLine + 1, ContainingType,
2378 VirtualIndex, ThisAdjustment, Flags, SPFlags,
2379 Unit, TemplateParams, Declaration,
2380 RetainedNodes, ThrownTypes, Annotations,
2381 TargetFuncName));
2382 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
2383 Type, ScopeLine, getCompositeType(),
2384 VirtualIndex, ThisAdjustment, Flags, SPFlags,
2385 Unit, TemplateParams, Declaration,
2386 RetainedNodes, ThrownTypes, Annotations,
2387 TargetFuncName));
2388 EXPECT_NE(N, DISubprogram::get(
2389 Context, Scope, Name, LinkageName, File, Line, Type,
2390 ScopeLine, ContainingType, VirtualIndex, ThisAdjustment,
2391 Flags, SPFlags ^ DISubprogram::SPFlagVirtual, Unit,
2392 TemplateParams, Declaration, RetainedNodes, ThrownTypes,
2393 Annotations, TargetFuncName));
2394 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
2395 Type, ScopeLine, ContainingType,
2396 VirtualIndex + 1, ThisAdjustment, Flags,
2397 SPFlags, Unit, TemplateParams, Declaration,
2398 RetainedNodes, ThrownTypes, Annotations,
2399 TargetFuncName));
2400 EXPECT_NE(N, DISubprogram::get(
2401 Context, Scope, Name, LinkageName, File, Line, Type,
2402 ScopeLine, ContainingType, VirtualIndex, ThisAdjustment,
2403 Flags, SPFlags ^ DISubprogram::SPFlagOptimized, Unit,
2404 TemplateParams, Declaration, RetainedNodes, ThrownTypes,
2405 Annotations, TargetFuncName));
2406 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
2407 Type, ScopeLine, ContainingType, VirtualIndex,
2408 ThisAdjustment, Flags, SPFlags, nullptr,
2409 TemplateParams, Declaration, RetainedNodes,
2410 ThrownTypes, Annotations, TargetFuncName));
2411 EXPECT_NE(N,
2412 DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
2413 Type, ScopeLine, ContainingType, VirtualIndex,
2414 ThisAdjustment, Flags, SPFlags, Unit, getTuple(),
2415 Declaration, RetainedNodes, ThrownTypes,
2416 Annotations, TargetFuncName));
2417 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
2418 Type, ScopeLine, ContainingType, VirtualIndex,
2419 ThisAdjustment, Flags, SPFlags, Unit,
2420 TemplateParams, getSubprogram(), RetainedNodes,
2421 ThrownTypes, Annotations, TargetFuncName));
2422 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
2423 Type, ScopeLine, ContainingType, VirtualIndex,
2424 ThisAdjustment, Flags, SPFlags, Unit,
2425 TemplateParams, Declaration, getTuple(),
2426 ThrownTypes, Annotations, TargetFuncName));
2427 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
2428 Type, ScopeLine, ContainingType, VirtualIndex,
2429 ThisAdjustment, Flags, SPFlags, Unit,
2430 TemplateParams, Declaration, RetainedNodes,
2431 getTuple(), Annotations, TargetFuncName));
2432 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
2433 Type, ScopeLine, ContainingType, VirtualIndex,
2434 ThisAdjustment, Flags, SPFlags, Unit,
2435 TemplateParams, Declaration, RetainedNodes,
2436 ThrownTypes, getTuple(), TargetFuncName));
2437 EXPECT_NE(N, DISubprogram::get(Context, Scope, Name, LinkageName, File, Line,
2438 Type, ScopeLine, ContainingType, VirtualIndex,
2439 ThisAdjustment, Flags, SPFlags, Unit,
2440 TemplateParams, Declaration, RetainedNodes,
2441 ThrownTypes, Annotations, "other"));
2442
2443 TempDISubprogram Temp = N->clone();
2444 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
2445 }
2446
2447 typedef MetadataTest DILexicalBlockTest;
2448
TEST_F(DILexicalBlockTest,get)2449 TEST_F(DILexicalBlockTest, get) {
2450 DILocalScope *Scope = getSubprogram();
2451 DIFile *File = getFile();
2452 unsigned Line = 5;
2453 unsigned Column = 8;
2454
2455 auto *N = DILexicalBlock::get(Context, Scope, File, Line, Column);
2456
2457 EXPECT_EQ(dwarf::DW_TAG_lexical_block, N->getTag());
2458 EXPECT_EQ(Scope, N->getScope());
2459 EXPECT_EQ(File, N->getFile());
2460 EXPECT_EQ(Line, N->getLine());
2461 EXPECT_EQ(Column, N->getColumn());
2462 EXPECT_EQ(N, DILexicalBlock::get(Context, Scope, File, Line, Column));
2463
2464 EXPECT_NE(N,
2465 DILexicalBlock::get(Context, getSubprogram(), File, Line, Column));
2466 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, getFile(), Line, Column));
2467 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, File, Line + 1, Column));
2468 EXPECT_NE(N, DILexicalBlock::get(Context, Scope, File, Line, Column + 1));
2469
2470 TempDILexicalBlock Temp = N->clone();
2471 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
2472 }
2473
TEST_F(DILexicalBlockTest,Overflow)2474 TEST_F(DILexicalBlockTest, Overflow) {
2475 DISubprogram *SP = getSubprogram();
2476 DIFile *F = getFile();
2477 {
2478 auto *LB = DILexicalBlock::get(Context, SP, F, 2, 7);
2479 EXPECT_EQ(2u, LB->getLine());
2480 EXPECT_EQ(7u, LB->getColumn());
2481 }
2482 unsigned U16 = 1u << 16;
2483 {
2484 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16 - 1);
2485 EXPECT_EQ(UINT32_MAX, LB->getLine());
2486 EXPECT_EQ(U16 - 1, LB->getColumn());
2487 }
2488 {
2489 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16);
2490 EXPECT_EQ(UINT32_MAX, LB->getLine());
2491 EXPECT_EQ(0u, LB->getColumn());
2492 }
2493 {
2494 auto *LB = DILexicalBlock::get(Context, SP, F, UINT32_MAX, U16 + 1);
2495 EXPECT_EQ(UINT32_MAX, LB->getLine());
2496 EXPECT_EQ(0u, LB->getColumn());
2497 }
2498 }
2499
2500 typedef MetadataTest DILexicalBlockFileTest;
2501
TEST_F(DILexicalBlockFileTest,get)2502 TEST_F(DILexicalBlockFileTest, get) {
2503 DILocalScope *Scope = getSubprogram();
2504 DIFile *File = getFile();
2505 unsigned Discriminator = 5;
2506
2507 auto *N = DILexicalBlockFile::get(Context, Scope, File, Discriminator);
2508
2509 EXPECT_EQ(dwarf::DW_TAG_lexical_block, N->getTag());
2510 EXPECT_EQ(Scope, N->getScope());
2511 EXPECT_EQ(File, N->getFile());
2512 EXPECT_EQ(Discriminator, N->getDiscriminator());
2513 EXPECT_EQ(N, DILexicalBlockFile::get(Context, Scope, File, Discriminator));
2514
2515 EXPECT_NE(N, DILexicalBlockFile::get(Context, getSubprogram(), File,
2516 Discriminator));
2517 EXPECT_NE(N,
2518 DILexicalBlockFile::get(Context, Scope, getFile(), Discriminator));
2519 EXPECT_NE(N,
2520 DILexicalBlockFile::get(Context, Scope, File, Discriminator + 1));
2521
2522 TempDILexicalBlockFile Temp = N->clone();
2523 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
2524 }
2525
2526 typedef MetadataTest DINamespaceTest;
2527
TEST_F(DINamespaceTest,get)2528 TEST_F(DINamespaceTest, get) {
2529 DIScope *Scope = getFile();
2530 StringRef Name = "namespace";
2531 bool ExportSymbols = true;
2532
2533 auto *N = DINamespace::get(Context, Scope, Name, ExportSymbols);
2534
2535 EXPECT_EQ(dwarf::DW_TAG_namespace, N->getTag());
2536 EXPECT_EQ(Scope, N->getScope());
2537 EXPECT_EQ(Name, N->getName());
2538 EXPECT_EQ(N, DINamespace::get(Context, Scope, Name, ExportSymbols));
2539 EXPECT_NE(N, DINamespace::get(Context, getFile(), Name, ExportSymbols));
2540 EXPECT_NE(N, DINamespace::get(Context, Scope, "other", ExportSymbols));
2541 EXPECT_NE(N, DINamespace::get(Context, Scope, Name, !ExportSymbols));
2542
2543 TempDINamespace Temp = N->clone();
2544 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
2545 }
2546
2547 typedef MetadataTest DIModuleTest;
2548
TEST_F(DIModuleTest,get)2549 TEST_F(DIModuleTest, get) {
2550 DIFile *File = getFile();
2551 DIScope *Scope = getFile();
2552 StringRef Name = "module";
2553 StringRef ConfigMacro = "-DNDEBUG";
2554 StringRef Includes = "-I.";
2555 StringRef APINotes = "/tmp/m.apinotes";
2556 unsigned LineNo = 4;
2557 bool IsDecl = true;
2558
2559 auto *N = DIModule::get(Context, File, Scope, Name, ConfigMacro, Includes,
2560 APINotes, LineNo, IsDecl);
2561
2562 EXPECT_EQ(dwarf::DW_TAG_module, N->getTag());
2563 EXPECT_EQ(File, N->getFile());
2564 EXPECT_EQ(Scope, N->getScope());
2565 EXPECT_EQ(Name, N->getName());
2566 EXPECT_EQ(ConfigMacro, N->getConfigurationMacros());
2567 EXPECT_EQ(Includes, N->getIncludePath());
2568 EXPECT_EQ(APINotes, N->getAPINotesFile());
2569 EXPECT_EQ(LineNo, N->getLineNo());
2570 EXPECT_EQ(IsDecl, N->getIsDecl());
2571 EXPECT_EQ(N, DIModule::get(Context, File, Scope, Name, ConfigMacro, Includes,
2572 APINotes, LineNo, IsDecl));
2573 EXPECT_NE(N, DIModule::get(Context, getFile(), getFile(), Name, ConfigMacro,
2574 Includes, APINotes, LineNo, IsDecl));
2575 EXPECT_NE(N, DIModule::get(Context, File, Scope, "other", ConfigMacro,
2576 Includes, APINotes, LineNo, IsDecl));
2577 EXPECT_NE(N, DIModule::get(Context, File, Scope, Name, "other", Includes,
2578 APINotes, LineNo, IsDecl));
2579 EXPECT_NE(N, DIModule::get(Context, File, Scope, Name, ConfigMacro, "other",
2580 APINotes, LineNo, IsDecl));
2581 EXPECT_NE(N, DIModule::get(Context, File, Scope, Name, ConfigMacro, Includes,
2582 "other", LineNo, IsDecl));
2583 EXPECT_NE(N, DIModule::get(Context, getFile(), Scope, Name, ConfigMacro,
2584 Includes, APINotes, LineNo, IsDecl));
2585 EXPECT_NE(N, DIModule::get(Context, File, Scope, Name, ConfigMacro, Includes,
2586 APINotes, 5, IsDecl));
2587 EXPECT_NE(N, DIModule::get(Context, File, Scope, Name, ConfigMacro, Includes,
2588 APINotes, LineNo, false));
2589
2590 TempDIModule Temp = N->clone();
2591 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
2592 }
2593
2594 typedef MetadataTest DITemplateTypeParameterTest;
2595
TEST_F(DITemplateTypeParameterTest,get)2596 TEST_F(DITemplateTypeParameterTest, get) {
2597 StringRef Name = "template";
2598 DIType *Type = getBasicType("basic");
2599 bool defaulted = false;
2600
2601 auto *N = DITemplateTypeParameter::get(Context, Name, Type, defaulted);
2602
2603 EXPECT_EQ(dwarf::DW_TAG_template_type_parameter, N->getTag());
2604 EXPECT_EQ(Name, N->getName());
2605 EXPECT_EQ(Type, N->getType());
2606 EXPECT_EQ(N, DITemplateTypeParameter::get(Context, Name, Type, defaulted));
2607
2608 EXPECT_NE(N, DITemplateTypeParameter::get(Context, "other", Type, defaulted));
2609 EXPECT_NE(N, DITemplateTypeParameter::get(Context, Name,
2610 getBasicType("other"), defaulted));
2611 EXPECT_NE(N, DITemplateTypeParameter::get(Context, Name, Type, true));
2612
2613 TempDITemplateTypeParameter Temp = N->clone();
2614 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
2615 }
2616
2617 typedef MetadataTest DITemplateValueParameterTest;
2618
TEST_F(DITemplateValueParameterTest,get)2619 TEST_F(DITemplateValueParameterTest, get) {
2620 unsigned Tag = dwarf::DW_TAG_template_value_parameter;
2621 StringRef Name = "template";
2622 DIType *Type = getBasicType("basic");
2623 bool defaulted = false;
2624 Metadata *Value = getConstantAsMetadata();
2625
2626 auto *N =
2627 DITemplateValueParameter::get(Context, Tag, Name, Type, defaulted, Value);
2628 EXPECT_EQ(Tag, N->getTag());
2629 EXPECT_EQ(Name, N->getName());
2630 EXPECT_EQ(Type, N->getType());
2631 EXPECT_EQ(Value, N->getValue());
2632 EXPECT_EQ(N, DITemplateValueParameter::get(Context, Tag, Name, Type,
2633 defaulted, Value));
2634
2635 EXPECT_NE(N, DITemplateValueParameter::get(
2636 Context, dwarf::DW_TAG_GNU_template_template_param, Name,
2637 Type, defaulted, Value));
2638 EXPECT_NE(N, DITemplateValueParameter::get(Context, Tag, "other", Type,
2639 defaulted, Value));
2640 EXPECT_NE(N, DITemplateValueParameter::get(Context, Tag, Name,
2641 getBasicType("other"), defaulted,
2642 Value));
2643 EXPECT_NE(N,
2644 DITemplateValueParameter::get(Context, Tag, Name, Type, defaulted,
2645 getConstantAsMetadata()));
2646 EXPECT_NE(
2647 N, DITemplateValueParameter::get(Context, Tag, Name, Type, true, Value));
2648
2649 TempDITemplateValueParameter Temp = N->clone();
2650 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
2651 }
2652
2653 typedef MetadataTest DIGlobalVariableTest;
2654
TEST_F(DIGlobalVariableTest,get)2655 TEST_F(DIGlobalVariableTest, get) {
2656 DIScope *Scope = getSubprogram();
2657 StringRef Name = "name";
2658 StringRef LinkageName = "linkage";
2659 DIFile *File = getFile();
2660 unsigned Line = 5;
2661 DIType *Type = getDerivedType();
2662 bool IsLocalToUnit = false;
2663 bool IsDefinition = true;
2664 MDTuple *templateParams = getTuple();
2665 DIDerivedType *StaticDataMemberDeclaration =
2666 cast<DIDerivedType>(getDerivedType());
2667
2668 uint32_t AlignInBits = 8;
2669
2670 auto *N = DIGlobalVariable::get(
2671 Context, Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
2672 IsDefinition, StaticDataMemberDeclaration, templateParams, AlignInBits,
2673 nullptr);
2674
2675 EXPECT_EQ(dwarf::DW_TAG_variable, N->getTag());
2676 EXPECT_EQ(Scope, N->getScope());
2677 EXPECT_EQ(Name, N->getName());
2678 EXPECT_EQ(LinkageName, N->getLinkageName());
2679 EXPECT_EQ(File, N->getFile());
2680 EXPECT_EQ(Line, N->getLine());
2681 EXPECT_EQ(Type, N->getType());
2682 EXPECT_EQ(IsLocalToUnit, N->isLocalToUnit());
2683 EXPECT_EQ(IsDefinition, N->isDefinition());
2684 EXPECT_EQ(StaticDataMemberDeclaration, N->getStaticDataMemberDeclaration());
2685 EXPECT_EQ(templateParams, N->getTemplateParams());
2686 EXPECT_EQ(AlignInBits, N->getAlignInBits());
2687 EXPECT_EQ(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File,
2688 Line, Type, IsLocalToUnit, IsDefinition,
2689 StaticDataMemberDeclaration,
2690 templateParams, AlignInBits, nullptr));
2691
2692 EXPECT_NE(N, DIGlobalVariable::get(
2693 Context, getSubprogram(), Name, LinkageName, File, Line,
2694 Type, IsLocalToUnit, IsDefinition,
2695 StaticDataMemberDeclaration, templateParams, AlignInBits,
2696 nullptr));
2697 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, "other", LinkageName, File,
2698 Line, Type, IsLocalToUnit, IsDefinition,
2699 StaticDataMemberDeclaration,
2700 templateParams, AlignInBits, nullptr));
2701 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, "other", File, Line,
2702 Type, IsLocalToUnit, IsDefinition,
2703 StaticDataMemberDeclaration,
2704 templateParams, AlignInBits, nullptr));
2705 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName,
2706 getFile(), Line, Type, IsLocalToUnit,
2707 IsDefinition, StaticDataMemberDeclaration,
2708 templateParams, AlignInBits, nullptr));
2709 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File,
2710 Line + 1, Type, IsLocalToUnit,
2711 IsDefinition, StaticDataMemberDeclaration,
2712 templateParams, AlignInBits, nullptr));
2713 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File,
2714 Line, getDerivedType(), IsLocalToUnit,
2715 IsDefinition, StaticDataMemberDeclaration,
2716 templateParams, AlignInBits, nullptr));
2717 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File,
2718 Line, Type, !IsLocalToUnit, IsDefinition,
2719 StaticDataMemberDeclaration,
2720 templateParams, AlignInBits, nullptr));
2721 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File,
2722 Line, Type, IsLocalToUnit, !IsDefinition,
2723 StaticDataMemberDeclaration,
2724 templateParams, AlignInBits, nullptr));
2725 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File,
2726 Line, Type, IsLocalToUnit, IsDefinition,
2727 cast<DIDerivedType>(getDerivedType()),
2728 templateParams, AlignInBits, nullptr));
2729 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File,
2730 Line, Type, IsLocalToUnit, IsDefinition,
2731 StaticDataMemberDeclaration, nullptr,
2732 AlignInBits, nullptr));
2733 EXPECT_NE(N, DIGlobalVariable::get(Context, Scope, Name, LinkageName, File,
2734 Line, Type, IsLocalToUnit, IsDefinition,
2735 StaticDataMemberDeclaration,
2736 templateParams, (AlignInBits << 1),
2737 nullptr));
2738
2739 TempDIGlobalVariable Temp = N->clone();
2740 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
2741 }
2742
2743 typedef MetadataTest DIGlobalVariableExpressionTest;
2744
TEST_F(DIGlobalVariableExpressionTest,get)2745 TEST_F(DIGlobalVariableExpressionTest, get) {
2746 DIScope *Scope = getSubprogram();
2747 StringRef Name = "name";
2748 StringRef LinkageName = "linkage";
2749 DIFile *File = getFile();
2750 unsigned Line = 5;
2751 DIType *Type = getDerivedType();
2752 bool IsLocalToUnit = false;
2753 bool IsDefinition = true;
2754 MDTuple *templateParams = getTuple();
2755 auto *Expr = DIExpression::get(Context, {1, 2});
2756 auto *Expr2 = DIExpression::get(Context, {1, 2, 3});
2757 DIDerivedType *StaticDataMemberDeclaration =
2758 cast<DIDerivedType>(getDerivedType());
2759 uint32_t AlignInBits = 8;
2760
2761 auto *Var = DIGlobalVariable::get(
2762 Context, Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
2763 IsDefinition, StaticDataMemberDeclaration, templateParams, AlignInBits,
2764 nullptr);
2765 auto *Var2 = DIGlobalVariable::get(
2766 Context, Scope, "other", LinkageName, File, Line, Type, IsLocalToUnit,
2767 IsDefinition, StaticDataMemberDeclaration, templateParams, AlignInBits,
2768 nullptr);
2769 auto *N = DIGlobalVariableExpression::get(Context, Var, Expr);
2770
2771 EXPECT_EQ(Var, N->getVariable());
2772 EXPECT_EQ(Expr, N->getExpression());
2773 EXPECT_EQ(N, DIGlobalVariableExpression::get(Context, Var, Expr));
2774 EXPECT_NE(N, DIGlobalVariableExpression::get(Context, Var2, Expr));
2775 EXPECT_NE(N, DIGlobalVariableExpression::get(Context, Var, Expr2));
2776
2777 TempDIGlobalVariableExpression Temp = N->clone();
2778 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
2779 }
2780
2781 typedef MetadataTest DILocalVariableTest;
2782
TEST_F(DILocalVariableTest,get)2783 TEST_F(DILocalVariableTest, get) {
2784 DILocalScope *Scope = getSubprogram();
2785 StringRef Name = "name";
2786 DIFile *File = getFile();
2787 unsigned Line = 5;
2788 DIType *Type = getDerivedType();
2789 unsigned Arg = 6;
2790 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7);
2791 uint32_t AlignInBits = 8;
2792
2793 auto *N =
2794 DILocalVariable::get(Context, Scope, Name, File, Line, Type, Arg, Flags,
2795 AlignInBits, nullptr);
2796 EXPECT_TRUE(N->isParameter());
2797 EXPECT_EQ(Scope, N->getScope());
2798 EXPECT_EQ(Name, N->getName());
2799 EXPECT_EQ(File, N->getFile());
2800 EXPECT_EQ(Line, N->getLine());
2801 EXPECT_EQ(Type, N->getType());
2802 EXPECT_EQ(Arg, N->getArg());
2803 EXPECT_EQ(Flags, N->getFlags());
2804 EXPECT_EQ(AlignInBits, N->getAlignInBits());
2805 EXPECT_EQ(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type, Arg,
2806 Flags, AlignInBits, nullptr));
2807
2808 EXPECT_FALSE(
2809 DILocalVariable::get(Context, Scope, Name, File, Line, Type, 0, Flags,
2810 AlignInBits, nullptr)->isParameter());
2811 EXPECT_NE(N, DILocalVariable::get(Context, getSubprogram(), Name, File, Line,
2812 Type, Arg, Flags, AlignInBits, nullptr));
2813 EXPECT_NE(N, DILocalVariable::get(Context, Scope, "other", File, Line, Type,
2814 Arg, Flags, AlignInBits, nullptr));
2815 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, getFile(), Line, Type,
2816 Arg, Flags, AlignInBits, nullptr));
2817 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line + 1, Type,
2818 Arg, Flags, AlignInBits, nullptr));
2819 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line,
2820 getDerivedType(), Arg, Flags, AlignInBits,
2821 nullptr));
2822 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type,
2823 Arg + 1, Flags, AlignInBits, nullptr));
2824 EXPECT_NE(N, DILocalVariable::get(Context, Scope, Name, File, Line, Type,
2825 Arg, Flags, (AlignInBits << 1), nullptr));
2826
2827 TempDILocalVariable Temp = N->clone();
2828 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
2829 }
2830
TEST_F(DILocalVariableTest,getArg256)2831 TEST_F(DILocalVariableTest, getArg256) {
2832 EXPECT_EQ(255u, DILocalVariable::get(Context, getSubprogram(), "", getFile(),
2833 0, nullptr, 255, DINode::FlagZero, 0,
2834 nullptr)
2835 ->getArg());
2836 EXPECT_EQ(256u, DILocalVariable::get(Context, getSubprogram(), "", getFile(),
2837 0, nullptr, 256, DINode::FlagZero, 0,
2838 nullptr)
2839 ->getArg());
2840 EXPECT_EQ(257u, DILocalVariable::get(Context, getSubprogram(), "", getFile(),
2841 0, nullptr, 257, DINode::FlagZero, 0,
2842 nullptr)
2843 ->getArg());
2844 unsigned Max = UINT16_MAX;
2845 EXPECT_EQ(Max, DILocalVariable::get(Context, getSubprogram(), "", getFile(),
2846 0, nullptr, Max, DINode::FlagZero, 0,
2847 nullptr)
2848 ->getArg());
2849 }
2850
2851 typedef MetadataTest DIExpressionTest;
2852
TEST_F(DIExpressionTest,get)2853 TEST_F(DIExpressionTest, get) {
2854 uint64_t Elements[] = {2, 6, 9, 78, 0};
2855 auto *N = DIExpression::get(Context, Elements);
2856 EXPECT_EQ(makeArrayRef(Elements), N->getElements());
2857 EXPECT_EQ(N, DIExpression::get(Context, Elements));
2858
2859 EXPECT_EQ(5u, N->getNumElements());
2860 EXPECT_EQ(2u, N->getElement(0));
2861 EXPECT_EQ(6u, N->getElement(1));
2862 EXPECT_EQ(9u, N->getElement(2));
2863 EXPECT_EQ(78u, N->getElement(3));
2864 EXPECT_EQ(0u, N->getElement(4));
2865
2866 TempDIExpression Temp = N->clone();
2867 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
2868
2869 // Test DIExpression::prepend().
2870 uint64_t Elts0[] = {dwarf::DW_OP_LLVM_fragment, 0, 32};
2871 auto *N0 = DIExpression::get(Context, Elts0);
2872 uint8_t DIExprFlags = DIExpression::ApplyOffset;
2873 DIExprFlags |= DIExpression::DerefBefore;
2874 DIExprFlags |= DIExpression::DerefAfter;
2875 DIExprFlags |= DIExpression::StackValue;
2876 auto *N0WithPrependedOps = DIExpression::prepend(N0, DIExprFlags, 64);
2877 uint64_t Elts1[] = {dwarf::DW_OP_deref,
2878 dwarf::DW_OP_plus_uconst, 64,
2879 dwarf::DW_OP_deref,
2880 dwarf::DW_OP_stack_value,
2881 dwarf::DW_OP_LLVM_fragment, 0, 32};
2882 auto *N1 = DIExpression::get(Context, Elts1);
2883 EXPECT_EQ(N0WithPrependedOps, N1);
2884
2885 // Test DIExpression::append().
2886 uint64_t Elts2[] = {dwarf::DW_OP_deref, dwarf::DW_OP_plus_uconst, 64,
2887 dwarf::DW_OP_deref, dwarf::DW_OP_stack_value};
2888 auto *N2 = DIExpression::append(N0, Elts2);
2889 EXPECT_EQ(N0WithPrependedOps, N2);
2890 }
2891
TEST_F(DIExpressionTest,isValid)2892 TEST_F(DIExpressionTest, isValid) {
2893 #define EXPECT_VALID(...) \
2894 do { \
2895 uint64_t Elements[] = {__VA_ARGS__}; \
2896 EXPECT_TRUE(DIExpression::get(Context, Elements)->isValid()); \
2897 } while (false)
2898 #define EXPECT_INVALID(...) \
2899 do { \
2900 uint64_t Elements[] = {__VA_ARGS__}; \
2901 EXPECT_FALSE(DIExpression::get(Context, Elements)->isValid()); \
2902 } while (false)
2903
2904 // Empty expression should be valid.
2905 EXPECT_TRUE(DIExpression::get(Context, None));
2906
2907 // Valid constructions.
2908 EXPECT_VALID(dwarf::DW_OP_plus_uconst, 6);
2909 EXPECT_VALID(dwarf::DW_OP_constu, 6, dwarf::DW_OP_plus);
2910 EXPECT_VALID(dwarf::DW_OP_deref);
2911 EXPECT_VALID(dwarf::DW_OP_LLVM_fragment, 3, 7);
2912 EXPECT_VALID(dwarf::DW_OP_plus_uconst, 6, dwarf::DW_OP_deref);
2913 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_plus_uconst, 6);
2914 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_LLVM_fragment, 3, 7);
2915 EXPECT_VALID(dwarf::DW_OP_deref, dwarf::DW_OP_plus_uconst, 6,
2916 dwarf::DW_OP_LLVM_fragment, 3, 7);
2917
2918 // Invalid constructions.
2919 EXPECT_INVALID(~0u);
2920 EXPECT_INVALID(dwarf::DW_OP_plus, 0);
2921 EXPECT_INVALID(dwarf::DW_OP_plus_uconst);
2922 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment);
2923 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment, 3);
2924 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment, 3, 7, dwarf::DW_OP_plus_uconst, 3);
2925 EXPECT_INVALID(dwarf::DW_OP_LLVM_fragment, 3, 7, dwarf::DW_OP_deref);
2926
2927 #undef EXPECT_VALID
2928 #undef EXPECT_INVALID
2929 }
2930
TEST_F(DIExpressionTest,createFragmentExpression)2931 TEST_F(DIExpressionTest, createFragmentExpression) {
2932 #define EXPECT_VALID_FRAGMENT(Offset, Size, ...) \
2933 do { \
2934 uint64_t Elements[] = {__VA_ARGS__}; \
2935 DIExpression *Expression = DIExpression::get(Context, Elements); \
2936 EXPECT_TRUE( \
2937 DIExpression::createFragmentExpression(Expression, Offset, Size) \
2938 .has_value()); \
2939 } while (false)
2940 #define EXPECT_INVALID_FRAGMENT(Offset, Size, ...) \
2941 do { \
2942 uint64_t Elements[] = {__VA_ARGS__}; \
2943 DIExpression *Expression = DIExpression::get(Context, Elements); \
2944 EXPECT_FALSE( \
2945 DIExpression::createFragmentExpression(Expression, Offset, Size) \
2946 .has_value()); \
2947 } while (false)
2948
2949 // createFragmentExpression adds correct ops.
2950 Optional<DIExpression*> R = DIExpression::createFragmentExpression(
2951 DIExpression::get(Context, {}), 0, 32);
2952 EXPECT_EQ(R.has_value(), true);
2953 EXPECT_EQ(3u, (*R)->getNumElements());
2954 EXPECT_EQ(dwarf::DW_OP_LLVM_fragment, (*R)->getElement(0));
2955 EXPECT_EQ(0u, (*R)->getElement(1));
2956 EXPECT_EQ(32u, (*R)->getElement(2));
2957
2958 // Valid fragment expressions.
2959 EXPECT_VALID_FRAGMENT(0, 32, {});
2960 EXPECT_VALID_FRAGMENT(0, 32, dwarf::DW_OP_deref);
2961 EXPECT_VALID_FRAGMENT(0, 32, dwarf::DW_OP_LLVM_fragment, 0, 32);
2962 EXPECT_VALID_FRAGMENT(16, 16, dwarf::DW_OP_LLVM_fragment, 0, 32);
2963
2964 // Invalid fragment expressions (incompatible ops).
2965 EXPECT_INVALID_FRAGMENT(0, 32, dwarf::DW_OP_constu, 6, dwarf::DW_OP_plus);
2966 EXPECT_INVALID_FRAGMENT(0, 32, dwarf::DW_OP_constu, 14, dwarf::DW_OP_minus);
2967 EXPECT_INVALID_FRAGMENT(0, 32, dwarf::DW_OP_constu, 16, dwarf::DW_OP_shr);
2968 EXPECT_INVALID_FRAGMENT(0, 32, dwarf::DW_OP_constu, 16, dwarf::DW_OP_shl);
2969 EXPECT_INVALID_FRAGMENT(0, 32, dwarf::DW_OP_constu, 16, dwarf::DW_OP_shra);
2970 EXPECT_INVALID_FRAGMENT(0, 32, dwarf::DW_OP_plus_uconst, 6);
2971
2972 #undef EXPECT_VALID_FRAGMENT
2973 #undef EXPECT_INVALID_FRAGMENT
2974 }
2975
TEST_F(DIExpressionTest,replaceArg)2976 TEST_F(DIExpressionTest, replaceArg) {
2977 #define EXPECT_REPLACE_ARG_EQ(Expr, OldArg, NewArg, ...) \
2978 do { \
2979 uint64_t Elements[] = {__VA_ARGS__}; \
2980 ArrayRef<uint64_t> Expected = Elements; \
2981 DIExpression *Expression = DIExpression::replaceArg(Expr, OldArg, NewArg); \
2982 EXPECT_EQ(Expression->getElements(), Expected); \
2983 } while (false)
2984
2985 auto N = DIExpression::get(
2986 Context, {dwarf::DW_OP_LLVM_arg, 0, dwarf::DW_OP_LLVM_arg, 1,
2987 dwarf::DW_OP_plus, dwarf::DW_OP_LLVM_arg, 2, dwarf::DW_OP_mul});
2988 EXPECT_REPLACE_ARG_EQ(N, 0, 1, dwarf::DW_OP_LLVM_arg, 0,
2989 dwarf::DW_OP_LLVM_arg, 0, dwarf::DW_OP_plus,
2990 dwarf::DW_OP_LLVM_arg, 1, dwarf::DW_OP_mul);
2991 EXPECT_REPLACE_ARG_EQ(N, 0, 2, dwarf::DW_OP_LLVM_arg, 1,
2992 dwarf::DW_OP_LLVM_arg, 0, dwarf::DW_OP_plus,
2993 dwarf::DW_OP_LLVM_arg, 1, dwarf::DW_OP_mul);
2994 EXPECT_REPLACE_ARG_EQ(N, 2, 0, dwarf::DW_OP_LLVM_arg, 0,
2995 dwarf::DW_OP_LLVM_arg, 1, dwarf::DW_OP_plus,
2996 dwarf::DW_OP_LLVM_arg, 0, dwarf::DW_OP_mul);
2997 EXPECT_REPLACE_ARG_EQ(N, 2, 1, dwarf::DW_OP_LLVM_arg, 0,
2998 dwarf::DW_OP_LLVM_arg, 1, dwarf::DW_OP_plus,
2999 dwarf::DW_OP_LLVM_arg, 1, dwarf::DW_OP_mul);
3000
3001 #undef EXPECT_REPLACE_ARG_EQ
3002 }
3003
TEST_F(DIExpressionTest,foldConstant)3004 TEST_F(DIExpressionTest, foldConstant) {
3005 const ConstantInt *Int;
3006 const ConstantInt *NewInt;
3007 DIExpression *Expr;
3008 DIExpression *NewExpr;
3009
3010 #define EXPECT_FOLD_CONST(StartWidth, StartValue, EndWidth, EndValue, NumElts) \
3011 Int = ConstantInt::get(Context, APInt(StartWidth, StartValue)); \
3012 std::tie(NewExpr, NewInt) = Expr->constantFold(Int); \
3013 ASSERT_EQ(NewInt->getBitWidth(), EndWidth##u); \
3014 EXPECT_EQ(NewInt->getValue(), APInt(EndWidth, EndValue)); \
3015 EXPECT_EQ(NewExpr->getNumElements(), NumElts##u)
3016
3017 // Unfoldable expression should return the original unmodified Int/Expr.
3018 Expr = DIExpression::get(Context, {dwarf::DW_OP_deref});
3019 EXPECT_FOLD_CONST(32, 117, 32, 117, 1);
3020 EXPECT_EQ(NewExpr, Expr);
3021 EXPECT_EQ(NewInt, Int);
3022 EXPECT_TRUE(NewExpr->startsWithDeref());
3023
3024 // One unsigned bit-width conversion.
3025 Expr = DIExpression::get(
3026 Context, {dwarf::DW_OP_LLVM_convert, 72, dwarf::DW_ATE_unsigned});
3027 EXPECT_FOLD_CONST(8, 12, 72, 12, 0);
3028
3029 // Two unsigned bit-width conversions (mask truncation).
3030 Expr = DIExpression::get(
3031 Context, {dwarf::DW_OP_LLVM_convert, 8, dwarf::DW_ATE_unsigned,
3032 dwarf::DW_OP_LLVM_convert, 16, dwarf::DW_ATE_unsigned});
3033 EXPECT_FOLD_CONST(32, -1, 16, 0xff, 0);
3034
3035 // Sign extension.
3036 Expr = DIExpression::get(
3037 Context, {dwarf::DW_OP_LLVM_convert, 32, dwarf::DW_ATE_signed});
3038 EXPECT_FOLD_CONST(16, -1, 32, -1, 0);
3039
3040 // Get non-foldable operations back in the new Expr.
3041 uint64_t Elements[] = {dwarf::DW_OP_deref, dwarf::DW_OP_stack_value};
3042 ArrayRef<uint64_t> Expected = Elements;
3043 Expr = DIExpression::get(
3044 Context, {dwarf::DW_OP_LLVM_convert, 32, dwarf::DW_ATE_signed});
3045 Expr = DIExpression::append(Expr, Expected);
3046 ASSERT_EQ(Expr->getNumElements(), 5u);
3047 EXPECT_FOLD_CONST(16, -1, 32, -1, 2);
3048 EXPECT_EQ(NewExpr->getElements(), Expected);
3049
3050 #undef EXPECT_FOLD_CONST
3051 }
3052
3053 typedef MetadataTest DIObjCPropertyTest;
3054
TEST_F(DIObjCPropertyTest,get)3055 TEST_F(DIObjCPropertyTest, get) {
3056 StringRef Name = "name";
3057 DIFile *File = getFile();
3058 unsigned Line = 5;
3059 StringRef GetterName = "getter";
3060 StringRef SetterName = "setter";
3061 unsigned Attributes = 7;
3062 DIType *Type = getBasicType("basic");
3063
3064 auto *N = DIObjCProperty::get(Context, Name, File, Line, GetterName,
3065 SetterName, Attributes, Type);
3066
3067 EXPECT_EQ(dwarf::DW_TAG_APPLE_property, N->getTag());
3068 EXPECT_EQ(Name, N->getName());
3069 EXPECT_EQ(File, N->getFile());
3070 EXPECT_EQ(Line, N->getLine());
3071 EXPECT_EQ(GetterName, N->getGetterName());
3072 EXPECT_EQ(SetterName, N->getSetterName());
3073 EXPECT_EQ(Attributes, N->getAttributes());
3074 EXPECT_EQ(Type, N->getType());
3075 EXPECT_EQ(N, DIObjCProperty::get(Context, Name, File, Line, GetterName,
3076 SetterName, Attributes, Type));
3077
3078 EXPECT_NE(N, DIObjCProperty::get(Context, "other", File, Line, GetterName,
3079 SetterName, Attributes, Type));
3080 EXPECT_NE(N, DIObjCProperty::get(Context, Name, getFile(), Line, GetterName,
3081 SetterName, Attributes, Type));
3082 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line + 1, GetterName,
3083 SetterName, Attributes, Type));
3084 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, "other",
3085 SetterName, Attributes, Type));
3086 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName,
3087 "other", Attributes, Type));
3088 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName,
3089 SetterName, Attributes + 1, Type));
3090 EXPECT_NE(N, DIObjCProperty::get(Context, Name, File, Line, GetterName,
3091 SetterName, Attributes,
3092 getBasicType("other")));
3093
3094 TempDIObjCProperty Temp = N->clone();
3095 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
3096 }
3097
3098 typedef MetadataTest DIImportedEntityTest;
3099
TEST_F(DIImportedEntityTest,get)3100 TEST_F(DIImportedEntityTest, get) {
3101 unsigned Tag = dwarf::DW_TAG_imported_module;
3102 DIScope *Scope = getSubprogram();
3103 DINode *Entity = getCompositeType();
3104 DIFile *File = getFile();
3105 unsigned Line = 5;
3106 StringRef Name = "name";
3107
3108 auto *N =
3109 DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line, Name);
3110
3111 EXPECT_EQ(Tag, N->getTag());
3112 EXPECT_EQ(Scope, N->getScope());
3113 EXPECT_EQ(Entity, N->getEntity());
3114 EXPECT_EQ(File, N->getFile());
3115 EXPECT_EQ(Line, N->getLine());
3116 EXPECT_EQ(Name, N->getName());
3117 EXPECT_EQ(
3118 N, DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line, Name));
3119
3120 EXPECT_NE(N,
3121 DIImportedEntity::get(Context, dwarf::DW_TAG_imported_declaration,
3122 Scope, Entity, File, Line, Name));
3123 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, getSubprogram(), Entity,
3124 File, Line, Name));
3125 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, getCompositeType(),
3126 File, Line, Name));
3127 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, Entity, nullptr, Line,
3128 Name));
3129 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, Entity, File,
3130 Line + 1, Name));
3131 EXPECT_NE(N, DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line,
3132 "other"));
3133
3134 TempDIImportedEntity Temp = N->clone();
3135 EXPECT_EQ(N, MDNode::replaceWithUniqued(std::move(Temp)));
3136
3137 MDTuple *Elements1 = getTuple();
3138 MDTuple *Elements2 = getTuple();
3139 auto *Ne = DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line,
3140 Name, Elements1);
3141
3142 EXPECT_EQ(Elements1, Ne->getElements().get());
3143
3144 EXPECT_EQ(Ne, DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line,
3145 Name, Elements1));
3146 EXPECT_NE(Ne, DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line,
3147 "ModOther", Elements1));
3148 EXPECT_NE(Ne, DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line,
3149 Name, Elements2));
3150 EXPECT_NE(
3151 Ne, DIImportedEntity::get(Context, Tag, Scope, Entity, File, Line, Name));
3152
3153 TempDIImportedEntity Tempe = Ne->clone();
3154 EXPECT_EQ(Ne, MDNode::replaceWithUniqued(std::move(Tempe)));
3155 }
3156
3157 typedef MetadataTest MetadataAsValueTest;
3158
TEST_F(MetadataAsValueTest,MDNode)3159 TEST_F(MetadataAsValueTest, MDNode) {
3160 MDNode *N = MDNode::get(Context, None);
3161 auto *V = MetadataAsValue::get(Context, N);
3162 EXPECT_TRUE(V->getType()->isMetadataTy());
3163 EXPECT_EQ(N, V->getMetadata());
3164
3165 auto *V2 = MetadataAsValue::get(Context, N);
3166 EXPECT_EQ(V, V2);
3167 }
3168
TEST_F(MetadataAsValueTest,MDNodeMDNode)3169 TEST_F(MetadataAsValueTest, MDNodeMDNode) {
3170 MDNode *N = MDNode::get(Context, None);
3171 Metadata *Ops[] = {N};
3172 MDNode *N2 = MDNode::get(Context, Ops);
3173 auto *V = MetadataAsValue::get(Context, N2);
3174 EXPECT_TRUE(V->getType()->isMetadataTy());
3175 EXPECT_EQ(N2, V->getMetadata());
3176
3177 auto *V2 = MetadataAsValue::get(Context, N2);
3178 EXPECT_EQ(V, V2);
3179
3180 auto *V3 = MetadataAsValue::get(Context, N);
3181 EXPECT_TRUE(V3->getType()->isMetadataTy());
3182 EXPECT_NE(V, V3);
3183 EXPECT_EQ(N, V3->getMetadata());
3184 }
3185
TEST_F(MetadataAsValueTest,MDNodeConstant)3186 TEST_F(MetadataAsValueTest, MDNodeConstant) {
3187 auto *C = ConstantInt::getTrue(Context);
3188 auto *MD = ConstantAsMetadata::get(C);
3189 Metadata *Ops[] = {MD};
3190 auto *N = MDNode::get(Context, Ops);
3191
3192 auto *V = MetadataAsValue::get(Context, MD);
3193 EXPECT_TRUE(V->getType()->isMetadataTy());
3194 EXPECT_EQ(MD, V->getMetadata());
3195
3196 auto *V2 = MetadataAsValue::get(Context, N);
3197 EXPECT_EQ(MD, V2->getMetadata());
3198 EXPECT_EQ(V, V2);
3199 }
3200
3201 typedef MetadataTest ValueAsMetadataTest;
3202
TEST_F(ValueAsMetadataTest,UpdatesOnRAUW)3203 TEST_F(ValueAsMetadataTest, UpdatesOnRAUW) {
3204 Type *Ty = Type::getInt1PtrTy(Context);
3205 std::unique_ptr<GlobalVariable> GV0(
3206 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
3207 auto *MD = ValueAsMetadata::get(GV0.get());
3208 EXPECT_TRUE(MD->getValue() == GV0.get());
3209 ASSERT_TRUE(GV0->use_empty());
3210
3211 std::unique_ptr<GlobalVariable> GV1(
3212 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
3213 GV0->replaceAllUsesWith(GV1.get());
3214 EXPECT_TRUE(MD->getValue() == GV1.get());
3215 }
3216
TEST_F(ValueAsMetadataTest,TempTempReplacement)3217 TEST_F(ValueAsMetadataTest, TempTempReplacement) {
3218 // Create a constant.
3219 ConstantAsMetadata *CI =
3220 ConstantAsMetadata::get(ConstantInt::get(Context, APInt(8, 0)));
3221
3222 auto Temp1 = MDTuple::getTemporary(Context, None);
3223 auto Temp2 = MDTuple::getTemporary(Context, {CI});
3224 auto *N = MDTuple::get(Context, {Temp1.get()});
3225
3226 // Test replacing a temporary node with another temporary node.
3227 Temp1->replaceAllUsesWith(Temp2.get());
3228 EXPECT_EQ(N->getOperand(0), Temp2.get());
3229
3230 // Clean up Temp2 for teardown.
3231 Temp2->replaceAllUsesWith(nullptr);
3232 }
3233
TEST_F(ValueAsMetadataTest,CollidingDoubleUpdates)3234 TEST_F(ValueAsMetadataTest, CollidingDoubleUpdates) {
3235 // Create a constant.
3236 ConstantAsMetadata *CI =
3237 ConstantAsMetadata::get(ConstantInt::get(Context, APInt(8, 0)));
3238
3239 // Create a temporary to prevent nodes from resolving.
3240 auto Temp = MDTuple::getTemporary(Context, None);
3241
3242 // When the first operand of N1 gets reset to nullptr, it'll collide with N2.
3243 Metadata *Ops1[] = {CI, CI, Temp.get()};
3244 Metadata *Ops2[] = {nullptr, CI, Temp.get()};
3245
3246 auto *N1 = MDTuple::get(Context, Ops1);
3247 auto *N2 = MDTuple::get(Context, Ops2);
3248 ASSERT_NE(N1, N2);
3249
3250 // Tell metadata that the constant is getting deleted.
3251 //
3252 // After this, N1 will be invalid, so don't touch it.
3253 ValueAsMetadata::handleDeletion(CI->getValue());
3254 EXPECT_EQ(nullptr, N2->getOperand(0));
3255 EXPECT_EQ(nullptr, N2->getOperand(1));
3256 EXPECT_EQ(Temp.get(), N2->getOperand(2));
3257
3258 // Clean up Temp for teardown.
3259 Temp->replaceAllUsesWith(nullptr);
3260 }
3261
3262 typedef MetadataTest DIArgListTest;
3263
TEST_F(DIArgListTest,get)3264 TEST_F(DIArgListTest, get) {
3265 SmallVector<ValueAsMetadata *, 2> VMs;
3266 VMs.push_back(
3267 ConstantAsMetadata::get(ConstantInt::get(Context, APInt(8, 0))));
3268 VMs.push_back(
3269 ConstantAsMetadata::get(ConstantInt::get(Context, APInt(2, 0))));
3270 DIArgList *DV0 = DIArgList::get(Context, VMs);
3271 DIArgList *DV1 = DIArgList::get(Context, VMs);
3272 EXPECT_EQ(DV0, DV1);
3273 }
3274
TEST_F(DIArgListTest,UpdatesOnRAUW)3275 TEST_F(DIArgListTest, UpdatesOnRAUW) {
3276 Type *Ty = Type::getInt1PtrTy(Context);
3277 ConstantAsMetadata *CI =
3278 ConstantAsMetadata::get(ConstantInt::get(Context, APInt(8, 0)));
3279 std::unique_ptr<GlobalVariable> GV0(
3280 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
3281 auto *MD0 = ValueAsMetadata::get(GV0.get());
3282
3283 SmallVector<ValueAsMetadata *, 2> VMs;
3284 VMs.push_back(CI);
3285 VMs.push_back(MD0);
3286 auto *AL = DIArgList::get(Context, VMs);
3287 EXPECT_EQ(AL->getArgs()[0], CI);
3288 EXPECT_EQ(AL->getArgs()[1], MD0);
3289
3290 std::unique_ptr<GlobalVariable> GV1(
3291 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
3292 auto *MD1 = ValueAsMetadata::get(GV1.get());
3293 GV0->replaceAllUsesWith(GV1.get());
3294 EXPECT_EQ(AL->getArgs()[0], CI);
3295 EXPECT_EQ(AL->getArgs()[1], MD1);
3296 }
3297
3298 typedef MetadataTest TrackingMDRefTest;
3299
TEST_F(TrackingMDRefTest,UpdatesOnRAUW)3300 TEST_F(TrackingMDRefTest, UpdatesOnRAUW) {
3301 Type *Ty = Type::getInt1PtrTy(Context);
3302 std::unique_ptr<GlobalVariable> GV0(
3303 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
3304 TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV0.get()));
3305 EXPECT_TRUE(MD->getValue() == GV0.get());
3306 ASSERT_TRUE(GV0->use_empty());
3307
3308 std::unique_ptr<GlobalVariable> GV1(
3309 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
3310 GV0->replaceAllUsesWith(GV1.get());
3311 EXPECT_TRUE(MD->getValue() == GV1.get());
3312
3313 // Reset it, so we don't inadvertently test deletion.
3314 MD.reset();
3315 }
3316
TEST_F(TrackingMDRefTest,UpdatesOnDeletion)3317 TEST_F(TrackingMDRefTest, UpdatesOnDeletion) {
3318 Type *Ty = Type::getInt1PtrTy(Context);
3319 std::unique_ptr<GlobalVariable> GV(
3320 new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
3321 TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV.get()));
3322 EXPECT_TRUE(MD->getValue() == GV.get());
3323 ASSERT_TRUE(GV->use_empty());
3324
3325 GV.reset();
3326 EXPECT_TRUE(!MD);
3327 }
3328
TEST(NamedMDNodeTest,Search)3329 TEST(NamedMDNodeTest, Search) {
3330 LLVMContext Context;
3331 ConstantAsMetadata *C =
3332 ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 1));
3333 ConstantAsMetadata *C2 =
3334 ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 2));
3335
3336 Metadata *const V = C;
3337 Metadata *const V2 = C2;
3338 MDNode *n = MDNode::get(Context, V);
3339 MDNode *n2 = MDNode::get(Context, V2);
3340
3341 Module M("MyModule", Context);
3342 const char *Name = "llvm.NMD1";
3343 NamedMDNode *NMD = M.getOrInsertNamedMetadata(Name);
3344 NMD->addOperand(n);
3345 NMD->addOperand(n2);
3346
3347 std::string Str;
3348 raw_string_ostream oss(Str);
3349 NMD->print(oss);
3350 EXPECT_STREQ("!llvm.NMD1 = !{!0, !1}\n",
3351 oss.str().c_str());
3352 }
3353
3354 typedef MetadataTest FunctionAttachmentTest;
TEST_F(FunctionAttachmentTest,setMetadata)3355 TEST_F(FunctionAttachmentTest, setMetadata) {
3356 Function *F = getFunction("foo");
3357 ASSERT_FALSE(F->hasMetadata());
3358 EXPECT_EQ(nullptr, F->getMetadata(LLVMContext::MD_dbg));
3359 EXPECT_EQ(nullptr, F->getMetadata("dbg"));
3360 EXPECT_EQ(nullptr, F->getMetadata("other"));
3361
3362 DISubprogram *SP1 = getSubprogram();
3363 DISubprogram *SP2 = getSubprogram();
3364 ASSERT_NE(SP1, SP2);
3365
3366 F->setMetadata("dbg", SP1);
3367 EXPECT_TRUE(F->hasMetadata());
3368 EXPECT_EQ(SP1, F->getMetadata(LLVMContext::MD_dbg));
3369 EXPECT_EQ(SP1, F->getMetadata("dbg"));
3370 EXPECT_EQ(nullptr, F->getMetadata("other"));
3371
3372 F->setMetadata(LLVMContext::MD_dbg, SP2);
3373 EXPECT_TRUE(F->hasMetadata());
3374 EXPECT_EQ(SP2, F->getMetadata(LLVMContext::MD_dbg));
3375 EXPECT_EQ(SP2, F->getMetadata("dbg"));
3376 EXPECT_EQ(nullptr, F->getMetadata("other"));
3377
3378 F->setMetadata("dbg", nullptr);
3379 EXPECT_FALSE(F->hasMetadata());
3380 EXPECT_EQ(nullptr, F->getMetadata(LLVMContext::MD_dbg));
3381 EXPECT_EQ(nullptr, F->getMetadata("dbg"));
3382 EXPECT_EQ(nullptr, F->getMetadata("other"));
3383
3384 MDTuple *T1 = getTuple();
3385 MDTuple *T2 = getTuple();
3386 ASSERT_NE(T1, T2);
3387
3388 F->setMetadata("other1", T1);
3389 F->setMetadata("other2", T2);
3390 EXPECT_TRUE(F->hasMetadata());
3391 EXPECT_EQ(T1, F->getMetadata("other1"));
3392 EXPECT_EQ(T2, F->getMetadata("other2"));
3393 EXPECT_EQ(nullptr, F->getMetadata("dbg"));
3394
3395 F->setMetadata("other1", T2);
3396 F->setMetadata("other2", T1);
3397 EXPECT_EQ(T2, F->getMetadata("other1"));
3398 EXPECT_EQ(T1, F->getMetadata("other2"));
3399
3400 F->setMetadata("other1", nullptr);
3401 F->setMetadata("other2", nullptr);
3402 EXPECT_FALSE(F->hasMetadata());
3403 EXPECT_EQ(nullptr, F->getMetadata("other1"));
3404 EXPECT_EQ(nullptr, F->getMetadata("other2"));
3405 }
3406
TEST_F(FunctionAttachmentTest,getAll)3407 TEST_F(FunctionAttachmentTest, getAll) {
3408 Function *F = getFunction("foo");
3409
3410 MDTuple *T1 = getTuple();
3411 MDTuple *T2 = getTuple();
3412 MDTuple *P = getTuple();
3413 DISubprogram *SP = getSubprogram();
3414
3415 F->setMetadata("other1", T2);
3416 F->setMetadata(LLVMContext::MD_dbg, SP);
3417 F->setMetadata("other2", T1);
3418 F->setMetadata(LLVMContext::MD_prof, P);
3419 F->setMetadata("other2", T2);
3420 F->setMetadata("other1", T1);
3421
3422 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
3423 F->getAllMetadata(MDs);
3424 ASSERT_EQ(4u, MDs.size());
3425 EXPECT_EQ(LLVMContext::MD_dbg, MDs[0].first);
3426 EXPECT_EQ(LLVMContext::MD_prof, MDs[1].first);
3427 EXPECT_EQ(Context.getMDKindID("other1"), MDs[2].first);
3428 EXPECT_EQ(Context.getMDKindID("other2"), MDs[3].first);
3429 EXPECT_EQ(SP, MDs[0].second);
3430 EXPECT_EQ(P, MDs[1].second);
3431 EXPECT_EQ(T1, MDs[2].second);
3432 EXPECT_EQ(T2, MDs[3].second);
3433 }
3434
TEST_F(FunctionAttachmentTest,Verifier)3435 TEST_F(FunctionAttachmentTest, Verifier) {
3436 Function *F = getFunction("foo");
3437 F->setMetadata("attach", getTuple());
3438 F->setIsMaterializable(true);
3439
3440 // Confirm this is materializable.
3441 ASSERT_TRUE(F->isMaterializable());
3442
3443 // Materializable functions cannot have metadata attachments.
3444 EXPECT_TRUE(verifyFunction(*F));
3445
3446 // Function declarations can.
3447 F->setIsMaterializable(false);
3448 EXPECT_FALSE(verifyModule(*F->getParent()));
3449 EXPECT_FALSE(verifyFunction(*F));
3450
3451 // So can definitions.
3452 (void)new UnreachableInst(Context, BasicBlock::Create(Context, "bb", F));
3453 EXPECT_FALSE(verifyModule(*F->getParent()));
3454 EXPECT_FALSE(verifyFunction(*F));
3455 }
3456
TEST_F(FunctionAttachmentTest,RealEntryCount)3457 TEST_F(FunctionAttachmentTest, RealEntryCount) {
3458 Function *F = getFunction("foo");
3459 EXPECT_FALSE(F->getEntryCount().has_value());
3460 F->setEntryCount(12304, Function::PCT_Real);
3461 auto Count = F->getEntryCount();
3462 EXPECT_TRUE(Count.has_value());
3463 EXPECT_EQ(12304u, Count->getCount());
3464 EXPECT_EQ(Function::PCT_Real, Count->getType());
3465 }
3466
TEST_F(FunctionAttachmentTest,SyntheticEntryCount)3467 TEST_F(FunctionAttachmentTest, SyntheticEntryCount) {
3468 Function *F = getFunction("bar");
3469 EXPECT_FALSE(F->getEntryCount().has_value());
3470 F->setEntryCount(123, Function::PCT_Synthetic);
3471 auto Count = F->getEntryCount(true /*allow synthetic*/);
3472 EXPECT_TRUE(Count.has_value());
3473 EXPECT_EQ(123u, Count->getCount());
3474 EXPECT_EQ(Function::PCT_Synthetic, Count->getType());
3475 }
3476
TEST_F(FunctionAttachmentTest,SubprogramAttachment)3477 TEST_F(FunctionAttachmentTest, SubprogramAttachment) {
3478 Function *F = getFunction("foo");
3479 DISubprogram *SP = getSubprogram();
3480 F->setSubprogram(SP);
3481
3482 // Note that the static_cast confirms that F->getSubprogram() actually
3483 // returns an DISubprogram.
3484 EXPECT_EQ(SP, static_cast<DISubprogram *>(F->getSubprogram()));
3485 EXPECT_EQ(SP, F->getMetadata("dbg"));
3486 EXPECT_EQ(SP, F->getMetadata(LLVMContext::MD_dbg));
3487 }
3488
3489 typedef MetadataTest DistinctMDOperandPlaceholderTest;
TEST_F(DistinctMDOperandPlaceholderTest,getID)3490 TEST_F(DistinctMDOperandPlaceholderTest, getID) {
3491 EXPECT_EQ(7u, DistinctMDOperandPlaceholder(7).getID());
3492 }
3493
TEST_F(DistinctMDOperandPlaceholderTest,replaceUseWith)3494 TEST_F(DistinctMDOperandPlaceholderTest, replaceUseWith) {
3495 // Set up some placeholders.
3496 DistinctMDOperandPlaceholder PH0(7);
3497 DistinctMDOperandPlaceholder PH1(3);
3498 DistinctMDOperandPlaceholder PH2(0);
3499 Metadata *Ops[] = {&PH0, &PH1, &PH2};
3500 auto *D = MDTuple::getDistinct(Context, Ops);
3501 ASSERT_EQ(&PH0, D->getOperand(0));
3502 ASSERT_EQ(&PH1, D->getOperand(1));
3503 ASSERT_EQ(&PH2, D->getOperand(2));
3504
3505 // Replace them.
3506 auto *N0 = MDTuple::get(Context, None);
3507 auto *N1 = MDTuple::get(Context, N0);
3508 PH0.replaceUseWith(N0);
3509 PH1.replaceUseWith(N1);
3510 PH2.replaceUseWith(nullptr);
3511 EXPECT_EQ(N0, D->getOperand(0));
3512 EXPECT_EQ(N1, D->getOperand(1));
3513 EXPECT_EQ(nullptr, D->getOperand(2));
3514 }
3515
TEST_F(DistinctMDOperandPlaceholderTest,replaceUseWithNoUser)3516 TEST_F(DistinctMDOperandPlaceholderTest, replaceUseWithNoUser) {
3517 // There is no user, but we can still call replace.
3518 DistinctMDOperandPlaceholder(7).replaceUseWith(MDTuple::get(Context, None));
3519 }
3520
3521 // Test various assertions in metadata tracking. Don't run these tests if gtest
3522 // will use SEH to recover from them. Two of these tests get halfway through
3523 // inserting metadata into DenseMaps for tracking purposes, and then they
3524 // assert, and we attempt to destroy an LLVMContext with broken invariants,
3525 // leading to infinite loops.
3526 #if defined(GTEST_HAS_DEATH_TEST) && !defined(NDEBUG) && !defined(GTEST_HAS_SEH)
TEST_F(DistinctMDOperandPlaceholderTest,MetadataAsValue)3527 TEST_F(DistinctMDOperandPlaceholderTest, MetadataAsValue) {
3528 // This shouldn't crash.
3529 DistinctMDOperandPlaceholder PH(7);
3530 EXPECT_DEATH(MetadataAsValue::get(Context, &PH),
3531 "Unexpected callback to owner");
3532 }
3533
TEST_F(DistinctMDOperandPlaceholderTest,UniquedMDNode)3534 TEST_F(DistinctMDOperandPlaceholderTest, UniquedMDNode) {
3535 // This shouldn't crash.
3536 DistinctMDOperandPlaceholder PH(7);
3537 EXPECT_DEATH(MDTuple::get(Context, &PH), "Unexpected callback to owner");
3538 }
3539
TEST_F(DistinctMDOperandPlaceholderTest,SecondDistinctMDNode)3540 TEST_F(DistinctMDOperandPlaceholderTest, SecondDistinctMDNode) {
3541 // This shouldn't crash.
3542 DistinctMDOperandPlaceholder PH(7);
3543 MDTuple::getDistinct(Context, &PH);
3544 EXPECT_DEATH(MDTuple::getDistinct(Context, &PH),
3545 "Placeholders can only be used once");
3546 }
3547
TEST_F(DistinctMDOperandPlaceholderTest,TrackingMDRefAndDistinctMDNode)3548 TEST_F(DistinctMDOperandPlaceholderTest, TrackingMDRefAndDistinctMDNode) {
3549 // TrackingMDRef doesn't install an owner callback, so it can't be detected
3550 // as an invalid use. However, using a placeholder in a TrackingMDRef *and*
3551 // a distinct node isn't possible and we should assert.
3552 //
3553 // (There's no positive test for using TrackingMDRef because it's not a
3554 // useful thing to do.)
3555 {
3556 DistinctMDOperandPlaceholder PH(7);
3557 MDTuple::getDistinct(Context, &PH);
3558 EXPECT_DEATH(TrackingMDRef Ref(&PH), "Placeholders can only be used once");
3559 }
3560 {
3561 DistinctMDOperandPlaceholder PH(7);
3562 TrackingMDRef Ref(&PH);
3563 EXPECT_DEATH(MDTuple::getDistinct(Context, &PH),
3564 "Placeholders can only be used once");
3565 }
3566 }
3567 #endif
3568
3569 typedef MetadataTest DebugVariableTest;
TEST_F(DebugVariableTest,DenseMap)3570 TEST_F(DebugVariableTest, DenseMap) {
3571 DenseMap<DebugVariable, uint64_t> DebugVariableMap;
3572
3573 DILocalScope *Scope = getSubprogram();
3574 DIFile *File = getFile();
3575 DIType *Type = getDerivedType();
3576 DINode::DIFlags Flags = static_cast<DINode::DIFlags>(7);
3577
3578 DILocation *InlinedLoc = DILocation::get(Context, 2, 7, Scope);
3579
3580 DILocalVariable *VarA =
3581 DILocalVariable::get(Context, Scope, "A", File, 5, Type, 2, Flags, 8, nullptr);
3582 DILocalVariable *VarB =
3583 DILocalVariable::get(Context, Scope, "B", File, 7, Type, 3, Flags, 8, nullptr);
3584
3585 DebugVariable DebugVariableA(VarA, NoneType(), nullptr);
3586 DebugVariable DebugVariableInlineA(VarA, NoneType(), InlinedLoc);
3587 DebugVariable DebugVariableB(VarB, NoneType(), nullptr);
3588 DebugVariable DebugVariableFragB(VarB, {{16, 16}}, nullptr);
3589
3590 DebugVariableMap.insert({DebugVariableA, 2});
3591 DebugVariableMap.insert({DebugVariableInlineA, 3});
3592 DebugVariableMap.insert({DebugVariableB, 6});
3593 DebugVariableMap.insert({DebugVariableFragB, 12});
3594
3595 EXPECT_EQ(DebugVariableMap.count(DebugVariableA), 1u);
3596 EXPECT_EQ(DebugVariableMap.count(DebugVariableInlineA), 1u);
3597 EXPECT_EQ(DebugVariableMap.count(DebugVariableB), 1u);
3598 EXPECT_EQ(DebugVariableMap.count(DebugVariableFragB), 1u);
3599
3600 EXPECT_EQ(DebugVariableMap.find(DebugVariableA)->second, 2u);
3601 EXPECT_EQ(DebugVariableMap.find(DebugVariableInlineA)->second, 3u);
3602 EXPECT_EQ(DebugVariableMap.find(DebugVariableB)->second, 6u);
3603 EXPECT_EQ(DebugVariableMap.find(DebugVariableFragB)->second, 12u);
3604 }
3605
3606 typedef MetadataTest MDTupleAllocationTest;
TEST_F(MDTupleAllocationTest,Tracking)3607 TEST_F(MDTupleAllocationTest, Tracking) {
3608 // Make sure that the move constructor and move assignment op
3609 // for MDOperand correctly adjust tracking information.
3610 auto *Value1 = getConstantAsMetadata();
3611 MDTuple *A = MDTuple::getDistinct(Context, {Value1, Value1});
3612 EXPECT_EQ(A->getOperand(0), Value1);
3613 EXPECT_EQ(A->getOperand(1), Value1);
3614
3615 MDNode::op_range Ops = A->operands();
3616
3617 MDOperand NewOps1;
3618 // Move assignment operator.
3619 NewOps1 = std::move(*const_cast<MDOperand *>(Ops.begin()));
3620 // Move constructor.
3621 MDOperand NewOps2(std::move(*const_cast<MDOperand *>(Ops.begin() + 1)));
3622
3623 EXPECT_EQ(NewOps1.get(), static_cast<Metadata *>(Value1));
3624 EXPECT_EQ(NewOps2.get(), static_cast<Metadata *>(Value1));
3625
3626 auto *Value2 = getConstantAsMetadata();
3627 Value *V1 = Value1->getValue();
3628 Value *V2 = Value2->getValue();
3629 ValueAsMetadata::handleRAUW(V1, V2);
3630
3631 EXPECT_EQ(NewOps1.get(), static_cast<Metadata *>(Value2));
3632 EXPECT_EQ(NewOps2.get(), static_cast<Metadata *>(Value2));
3633 }
3634
TEST_F(MDTupleAllocationTest,Resize)3635 TEST_F(MDTupleAllocationTest, Resize) {
3636 MDTuple *A = getTuple();
3637 Metadata *Value1 = getConstantAsMetadata();
3638 Metadata *Value2 = getConstantAsMetadata();
3639 Metadata *Value3 = getConstantAsMetadata();
3640
3641 EXPECT_EQ(A->getNumOperands(), 0u);
3642
3643 // Add a couple of elements to it, which resizes the node.
3644 A->push_back(Value1);
3645 EXPECT_EQ(A->getNumOperands(), 1u);
3646 EXPECT_EQ(A->getOperand(0), Value1);
3647
3648 A->push_back(Value2);
3649 EXPECT_EQ(A->getNumOperands(), 2u);
3650 EXPECT_EQ(A->getOperand(0), Value1);
3651 EXPECT_EQ(A->getOperand(1), Value2);
3652
3653 // Append another element, which should resize the node
3654 // to a "large" node, though not detectable by the user.
3655 A->push_back(Value3);
3656 EXPECT_EQ(A->getNumOperands(), 3u);
3657 EXPECT_EQ(A->getOperand(0), Value1);
3658 EXPECT_EQ(A->getOperand(1), Value2);
3659 EXPECT_EQ(A->getOperand(2), Value3);
3660
3661 // Remove the last element
3662 A->pop_back();
3663 EXPECT_EQ(A->getNumOperands(), 2u);
3664 EXPECT_EQ(A->getOperand(1), Value2);
3665
3666 // Allocate a node with 4 operands.
3667 Metadata *Value4 = getConstantAsMetadata();
3668 Metadata *Value5 = getConstantAsMetadata();
3669
3670 Metadata *Ops[] = {Value1, Value2, Value3, Value4};
3671 MDTuple *B = MDTuple::getDistinct(Context, Ops);
3672
3673 EXPECT_EQ(B->getNumOperands(), 4u);
3674 B->pop_back();
3675 EXPECT_EQ(B->getNumOperands(), 3u);
3676 B->push_back(Value5);
3677 EXPECT_EQ(B->getNumOperands(), 4u);
3678 EXPECT_EQ(B->getOperand(0), Value1);
3679 EXPECT_EQ(B->getOperand(1), Value2);
3680 EXPECT_EQ(B->getOperand(2), Value3);
3681 EXPECT_EQ(B->getOperand(3), Value5);
3682
3683 // Check that we can resize temporary nodes as well.
3684 auto Temp1 = MDTuple::getTemporary(Context, None);
3685 EXPECT_EQ(Temp1->getNumOperands(), 0u);
3686
3687 Temp1->push_back(Value1);
3688 EXPECT_EQ(Temp1->getNumOperands(), 1u);
3689 EXPECT_EQ(Temp1->getOperand(0), Value1);
3690
3691 for (int i = 0; i < 11; i++)
3692 Temp1->push_back(Value2);
3693 EXPECT_EQ(Temp1->getNumOperands(), 12u);
3694 EXPECT_EQ(Temp1->getOperand(2), Value2);
3695 EXPECT_EQ(Temp1->getOperand(11), Value2);
3696
3697 // Allocate a node that starts off as a large one.
3698 Metadata *OpsLarge[] = {Value1, Value2, Value3, Value4,
3699 Value1, Value2, Value3, Value4,
3700 Value1, Value2, Value3, Value4,
3701 Value1, Value2, Value3, Value4,
3702 Value1, Value2, Value3, Value4};
3703 MDTuple *C = MDTuple::getDistinct(Context, OpsLarge);
3704 EXPECT_EQ(C->getNumOperands(), 20u);
3705 EXPECT_EQ(C->getOperand(7), Value4);
3706 EXPECT_EQ(C->getOperand(13), Value2);
3707
3708 C->push_back(Value1);
3709 C->push_back(Value2);
3710 EXPECT_EQ(C->getNumOperands(), 22u);
3711 EXPECT_EQ(C->getOperand(21), Value2);
3712 C->pop_back();
3713 EXPECT_EQ(C->getNumOperands(), 21u);
3714 EXPECT_EQ(C->getOperand(20), Value1);
3715 }
3716
TEST_F(MDTupleAllocationTest,Tracking2)3717 TEST_F(MDTupleAllocationTest, Tracking2) {
3718 // Resize a tuple and check that we can still RAUW one of its operands.
3719 auto *Value1 = getConstantAsMetadata();
3720 MDTuple *A = getTuple();
3721 A->push_back(Value1);
3722 A->push_back(Value1);
3723 A->push_back(Value1); // Causes a resize to large.
3724 EXPECT_EQ(A->getOperand(0), Value1);
3725 EXPECT_EQ(A->getOperand(1), Value1);
3726 EXPECT_EQ(A->getOperand(2), Value1);
3727
3728 auto *Value2 = getConstantAsMetadata();
3729 Value *V1 = Value1->getValue();
3730 Value *V2 = Value2->getValue();
3731 ValueAsMetadata::handleRAUW(V1, V2);
3732
3733 EXPECT_EQ(A->getOperand(0), Value2);
3734 EXPECT_EQ(A->getOperand(1), Value2);
3735 EXPECT_EQ(A->getOperand(2), Value2);
3736 }
3737
3738 #if defined(GTEST_HAS_DEATH_TEST) && !defined(NDEBUG) && !defined(GTEST_HAS_SEH)
3739 typedef MetadataTest MDTupleAllocationDeathTest;
TEST_F(MDTupleAllocationDeathTest,ResizeRejected)3740 TEST_F(MDTupleAllocationDeathTest, ResizeRejected) {
3741 MDTuple *A = MDTuple::get(Context, None);
3742 auto *Value1 = getConstantAsMetadata();
3743 EXPECT_DEATH(A->push_back(Value1),
3744 "Resizing is not supported for uniqued nodes");
3745
3746 // Check that a node, which has been allocated as a temporary,
3747 // cannot be resized after it has been uniqued.
3748 auto *Value2 = getConstantAsMetadata();
3749 auto B = MDTuple::getTemporary(Context, {Value2});
3750 B->push_back(Value2);
3751 MDTuple *BUniqued = MDNode::replaceWithUniqued(std::move(B));
3752 EXPECT_EQ(BUniqued->getNumOperands(), 2u);
3753 EXPECT_EQ(BUniqued->getOperand(1), Value2);
3754 EXPECT_DEATH(BUniqued->push_back(Value2),
3755 "Resizing is not supported for uniqued nodes");
3756 }
3757 #endif
3758
3759 } // end namespace
3760