Debian Codegraph @

llvm-project/llvm/unittests/IR/MetadataTest.cpp

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