LLVM 19.0.0git
DebugInfoMetadata.cpp
Go to the documentation of this file.
1//===- DebugInfoMetadata.cpp - Implement debug info metadata --------------===//
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// This file implements the debug info Metadata classes.
10//
11//===----------------------------------------------------------------------===//
12
14#include "LLVMContextImpl.h"
15#include "MetadataImpl.h"
20#include "llvm/IR/Function.h"
22#include "llvm/IR/Type.h"
23#include "llvm/IR/Value.h"
24
25#include <numeric>
26#include <optional>
27
28using namespace llvm;
29
30namespace llvm {
31// Use FS-AFDO discriminator.
33 "enable-fs-discriminator", cl::Hidden,
34 cl::desc("Enable adding flow sensitive discriminators"));
35} // namespace llvm
36
38 return (getTag() == dwarf::DW_TAG_LLVM_ptrauth_type ? 0 : SubclassData32);
39}
40
41const DIExpression::FragmentInfo DebugVariable::DefaultFragment = {
42 std::numeric_limits<uint64_t>::max(), std::numeric_limits<uint64_t>::min()};
43
45 : Variable(DII->getVariable()),
46 Fragment(DII->getExpression()->getFragmentInfo()),
47 InlinedAt(DII->getDebugLoc().getInlinedAt()) {}
48
50 : Variable(DVR->getVariable()),
51 Fragment(DVR->getExpression()->getFragmentInfo()),
52 InlinedAt(DVR->getDebugLoc().getInlinedAt()) {}
53
55 : DebugVariable(DVI->getVariable(), std::nullopt,
56 DVI->getDebugLoc()->getInlinedAt()) {}
57
58DILocation::DILocation(LLVMContext &C, StorageType Storage, unsigned Line,
59 unsigned Column, ArrayRef<Metadata *> MDs,
60 bool ImplicitCode)
61 : MDNode(C, DILocationKind, Storage, MDs) {
62 assert((MDs.size() == 1 || MDs.size() == 2) &&
63 "Expected a scope and optional inlined-at");
64
65 // Set line and column.
66 assert(Column < (1u << 16) && "Expected 16-bit column");
67
68 SubclassData32 = Line;
69 SubclassData16 = Column;
70
71 setImplicitCode(ImplicitCode);
72}
73
74static void adjustColumn(unsigned &Column) {
75 // Set to unknown on overflow. We only have 16 bits to play with here.
76 if (Column >= (1u << 16))
77 Column = 0;
78}
79
80DILocation *DILocation::getImpl(LLVMContext &Context, unsigned Line,
81 unsigned Column, Metadata *Scope,
82 Metadata *InlinedAt, bool ImplicitCode,
83 StorageType Storage, bool ShouldCreate) {
84 // Fixup column.
86
87 if (Storage == Uniqued) {
88 if (auto *N = getUniqued(Context.pImpl->DILocations,
89 DILocationInfo::KeyTy(Line, Column, Scope,
91 return N;
92 if (!ShouldCreate)
93 return nullptr;
94 } else {
95 assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
96 }
97
99 Ops.push_back(Scope);
100 if (InlinedAt)
101 Ops.push_back(InlinedAt);
102 return storeImpl(new (Ops.size(), Storage) DILocation(
103 Context, Storage, Line, Column, Ops, ImplicitCode),
104 Storage, Context.pImpl->DILocations);
105}
106
108 if (Locs.empty())
109 return nullptr;
110 if (Locs.size() == 1)
111 return Locs[0];
112 auto *Merged = Locs[0];
113 for (DILocation *L : llvm::drop_begin(Locs)) {
114 Merged = getMergedLocation(Merged, L);
115 if (Merged == nullptr)
116 break;
117 }
118 return Merged;
119}
120
122 if (!LocA || !LocB)
123 return nullptr;
124
125 if (LocA == LocB)
126 return LocA;
127
128 LLVMContext &C = LocA->getContext();
129
130 using LocVec = SmallVector<const DILocation *>;
131 LocVec ALocs;
132 LocVec BLocs;
134 4>
135 ALookup;
136
137 // Walk through LocA and its inlined-at locations, populate them in ALocs and
138 // save the index for the subprogram and inlined-at pair, which we use to find
139 // a matching starting location in LocB's chain.
140 for (auto [L, I] = std::make_pair(LocA, 0U); L; L = L->getInlinedAt(), I++) {
141 ALocs.push_back(L);
142 auto Res = ALookup.try_emplace(
143 {L->getScope()->getSubprogram(), L->getInlinedAt()}, I);
144 assert(Res.second && "Multiple <SP, InlinedAt> pairs in a location chain?");
145 (void)Res;
146 }
147
148 LocVec::reverse_iterator ARIt = ALocs.rend();
149 LocVec::reverse_iterator BRIt = BLocs.rend();
150
151 // Populate BLocs and look for a matching starting location, the first
152 // location with the same subprogram and inlined-at location as in LocA's
153 // chain. Since the two locations have the same inlined-at location we do
154 // not need to look at those parts of the chains.
155 for (auto [L, I] = std::make_pair(LocB, 0U); L; L = L->getInlinedAt(), I++) {
156 BLocs.push_back(L);
157
158 if (ARIt != ALocs.rend())
159 // We have already found a matching starting location.
160 continue;
161
162 auto IT = ALookup.find({L->getScope()->getSubprogram(), L->getInlinedAt()});
163 if (IT == ALookup.end())
164 continue;
165
166 // The + 1 is to account for the &*rev_it = &(it - 1) relationship.
167 ARIt = LocVec::reverse_iterator(ALocs.begin() + IT->second + 1);
168 BRIt = LocVec::reverse_iterator(BLocs.begin() + I + 1);
169
170 // If we have found a matching starting location we do not need to add more
171 // locations to BLocs, since we will only look at location pairs preceding
172 // the matching starting location, and adding more elements to BLocs could
173 // invalidate the iterator that we initialized here.
174 break;
175 }
176
177 // Merge the two locations if possible, using the supplied
178 // inlined-at location for the created location.
179 auto MergeLocPair = [&C](const DILocation *L1, const DILocation *L2,
181 if (L1 == L2)
182 return DILocation::get(C, L1->getLine(), L1->getColumn(), L1->getScope(),
183 InlinedAt);
184
185 // If the locations originate from different subprograms we can't produce
186 // a common location.
187 if (L1->getScope()->getSubprogram() != L2->getScope()->getSubprogram())
188 return nullptr;
189
190 // Return the nearest common scope inside a subprogram.
191 auto GetNearestCommonScope = [](DIScope *S1, DIScope *S2) -> DIScope * {
193 for (; S1; S1 = S1->getScope()) {
194 Scopes.insert(S1);
195 if (isa<DISubprogram>(S1))
196 break;
197 }
198
199 for (; S2; S2 = S2->getScope()) {
200 if (Scopes.count(S2))
201 return S2;
202 if (isa<DISubprogram>(S2))
203 break;
204 }
205
206 return nullptr;
207 };
208
209 auto Scope = GetNearestCommonScope(L1->getScope(), L2->getScope());
210 assert(Scope && "No common scope in the same subprogram?");
211
212 bool SameLine = L1->getLine() == L2->getLine();
213 bool SameCol = L1->getColumn() == L2->getColumn();
214 unsigned Line = SameLine ? L1->getLine() : 0;
215 unsigned Col = SameLine && SameCol ? L1->getColumn() : 0;
216
217 return DILocation::get(C, Line, Col, Scope, InlinedAt);
218 };
219
220 DILocation *Result = ARIt != ALocs.rend() ? (*ARIt)->getInlinedAt() : nullptr;
221
222 // If we have found a common starting location, walk up the inlined-at chains
223 // and try to produce common locations.
224 for (; ARIt != ALocs.rend() && BRIt != BLocs.rend(); ++ARIt, ++BRIt) {
225 DILocation *Tmp = MergeLocPair(*ARIt, *BRIt, Result);
226
227 if (!Tmp)
228 // We have walked up to a point in the chains where the two locations
229 // are irreconsilable. At this point Result contains the nearest common
230 // location in the inlined-at chains of LocA and LocB, so we break here.
231 break;
232
233 Result = Tmp;
234 }
235
236 if (Result)
237 return Result;
238
239 // We ended up with LocA and LocB as irreconsilable locations. Produce a
240 // location at 0:0 with one of the locations' scope. The function has
241 // historically picked A's scope, and a nullptr inlined-at location, so that
242 // behavior is mimicked here but I am not sure if this is always the correct
243 // way to handle this.
244 return DILocation::get(C, 0, 0, LocA->getScope(), nullptr);
245}
246
247std::optional<unsigned>
248DILocation::encodeDiscriminator(unsigned BD, unsigned DF, unsigned CI) {
249 std::array<unsigned, 3> Components = {BD, DF, CI};
250 uint64_t RemainingWork = 0U;
251 // We use RemainingWork to figure out if we have no remaining components to
252 // encode. For example: if BD != 0 but DF == 0 && CI == 0, we don't need to
253 // encode anything for the latter 2.
254 // Since any of the input components is at most 32 bits, their sum will be
255 // less than 34 bits, and thus RemainingWork won't overflow.
256 RemainingWork =
257 std::accumulate(Components.begin(), Components.end(), RemainingWork);
258
259 int I = 0;
260 unsigned Ret = 0;
261 unsigned NextBitInsertionIndex = 0;
262 while (RemainingWork > 0) {
263 unsigned C = Components[I++];
264 RemainingWork -= C;
265 unsigned EC = encodeComponent(C);
266 Ret |= (EC << NextBitInsertionIndex);
267 NextBitInsertionIndex += encodingBits(C);
268 }
269
270 // Encoding may be unsuccessful because of overflow. We determine success by
271 // checking equivalence of components before & after encoding. Alternatively,
272 // we could determine Success during encoding, but the current alternative is
273 // simpler.
274 unsigned TBD, TDF, TCI = 0;
275 decodeDiscriminator(Ret, TBD, TDF, TCI);
276 if (TBD == BD && TDF == DF && TCI == CI)
277 return Ret;
278 return std::nullopt;
279}
280
281void DILocation::decodeDiscriminator(unsigned D, unsigned &BD, unsigned &DF,
282 unsigned &CI) {
287}
289
291 return StringSwitch<DIFlags>(Flag)
292#define HANDLE_DI_FLAG(ID, NAME) .Case("DIFlag" #NAME, Flag##NAME)
293#include "llvm/IR/DebugInfoFlags.def"
294 .Default(DINode::FlagZero);
295}
296
298 switch (Flag) {
299#define HANDLE_DI_FLAG(ID, NAME) \
300 case Flag##NAME: \
301 return "DIFlag" #NAME;
302#include "llvm/IR/DebugInfoFlags.def"
303 }
304 return "";
305}
306
308 SmallVectorImpl<DIFlags> &SplitFlags) {
309 // Flags that are packed together need to be specially handled, so
310 // that, for example, we emit "DIFlagPublic" and not
311 // "DIFlagPrivate | DIFlagProtected".
312 if (DIFlags A = Flags & FlagAccessibility) {
313 if (A == FlagPrivate)
314 SplitFlags.push_back(FlagPrivate);
315 else if (A == FlagProtected)
316 SplitFlags.push_back(FlagProtected);
317 else
318 SplitFlags.push_back(FlagPublic);
319 Flags &= ~A;
320 }
321 if (DIFlags R = Flags & FlagPtrToMemberRep) {
322 if (R == FlagSingleInheritance)
323 SplitFlags.push_back(FlagSingleInheritance);
324 else if (R == FlagMultipleInheritance)
325 SplitFlags.push_back(FlagMultipleInheritance);
326 else
327 SplitFlags.push_back(FlagVirtualInheritance);
328 Flags &= ~R;
329 }
330 if ((Flags & FlagIndirectVirtualBase) == FlagIndirectVirtualBase) {
331 Flags &= ~FlagIndirectVirtualBase;
332 SplitFlags.push_back(FlagIndirectVirtualBase);
333 }
334
335#define HANDLE_DI_FLAG(ID, NAME) \
336 if (DIFlags Bit = Flags & Flag##NAME) { \
337 SplitFlags.push_back(Bit); \
338 Flags &= ~Bit; \
339 }
340#include "llvm/IR/DebugInfoFlags.def"
341 return Flags;
342}
343
345 if (auto *T = dyn_cast<DIType>(this))
346 return T->getScope();
347
348 if (auto *SP = dyn_cast<DISubprogram>(this))
349 return SP->getScope();
350
351 if (auto *LB = dyn_cast<DILexicalBlockBase>(this))
352 return LB->getScope();
353
354 if (auto *NS = dyn_cast<DINamespace>(this))
355 return NS->getScope();
356
357 if (auto *CB = dyn_cast<DICommonBlock>(this))
358 return CB->getScope();
359
360 if (auto *M = dyn_cast<DIModule>(this))
361 return M->getScope();
362
363 assert((isa<DIFile>(this) || isa<DICompileUnit>(this)) &&
364 "Unhandled type of scope.");
365 return nullptr;
366}
367
369 if (auto *T = dyn_cast<DIType>(this))
370 return T->getName();
371 if (auto *SP = dyn_cast<DISubprogram>(this))
372 return SP->getName();
373 if (auto *NS = dyn_cast<DINamespace>(this))
374 return NS->getName();
375 if (auto *CB = dyn_cast<DICommonBlock>(this))
376 return CB->getName();
377 if (auto *M = dyn_cast<DIModule>(this))
378 return M->getName();
379 assert((isa<DILexicalBlockBase>(this) || isa<DIFile>(this) ||
380 isa<DICompileUnit>(this)) &&
381 "Unhandled type of scope.");
382 return "";
383}
384
385#ifndef NDEBUG
386static bool isCanonical(const MDString *S) {
387 return !S || !S->getString().empty();
388}
389#endif
390
392GenericDINode *GenericDINode::getImpl(LLVMContext &Context, unsigned Tag,
393 MDString *Header,
394 ArrayRef<Metadata *> DwarfOps,
395 StorageType Storage, bool ShouldCreate) {
396 unsigned Hash = 0;
397 if (Storage == Uniqued) {
398 GenericDINodeInfo::KeyTy Key(Tag, Header, DwarfOps);
399 if (auto *N = getUniqued(Context.pImpl->GenericDINodes, Key))
400 return N;
401 if (!ShouldCreate)
402 return nullptr;
403 Hash = Key.getHash();
404 } else {
405 assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
406 }
407
408 // Use a nullptr for empty headers.
409 assert(isCanonical(Header) && "Expected canonical MDString");
410 Metadata *PreOps[] = {Header};
411 return storeImpl(new (DwarfOps.size() + 1, Storage) GenericDINode(
412 Context, Storage, Hash, Tag, PreOps, DwarfOps),
413 Storage, Context.pImpl->GenericDINodes);
414}
415
416void GenericDINode::recalculateHash() {
417 setHash(GenericDINodeInfo::KeyTy::calculateHash(this));
418}
419
420#define UNWRAP_ARGS_IMPL(...) __VA_ARGS__
421#define UNWRAP_ARGS(ARGS) UNWRAP_ARGS_IMPL ARGS
422#define DEFINE_GETIMPL_LOOKUP(CLASS, ARGS) \
423 do { \
424 if (Storage == Uniqued) { \
425 if (auto *N = getUniqued(Context.pImpl->CLASS##s, \
426 CLASS##Info::KeyTy(UNWRAP_ARGS(ARGS)))) \
427 return N; \
428 if (!ShouldCreate) \
429 return nullptr; \
430 } else { \
431 assert(ShouldCreate && \
432 "Expected non-uniqued nodes to always be created"); \
433 } \
434 } while (false)
435#define DEFINE_GETIMPL_STORE(CLASS, ARGS, OPS) \
436 return storeImpl(new (std::size(OPS), Storage) \
437 CLASS(Context, Storage, UNWRAP_ARGS(ARGS), OPS), \
438 Storage, Context.pImpl->CLASS##s)
439#define DEFINE_GETIMPL_STORE_NO_OPS(CLASS, ARGS) \
440 return storeImpl(new (0u, Storage) \
441 CLASS(Context, Storage, UNWRAP_ARGS(ARGS)), \
442 Storage, Context.pImpl->CLASS##s)
443#define DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(CLASS, OPS) \
444 return storeImpl(new (std::size(OPS), Storage) CLASS(Context, Storage, OPS), \
445 Storage, Context.pImpl->CLASS##s)
446#define DEFINE_GETIMPL_STORE_N(CLASS, ARGS, OPS, NUM_OPS) \
447 return storeImpl(new (NUM_OPS, Storage) \
448 CLASS(Context, Storage, UNWRAP_ARGS(ARGS), OPS), \
449 Storage, Context.pImpl->CLASS##s)
450
451DISubrange::DISubrange(LLVMContext &C, StorageType Storage,
453 : DINode(C, DISubrangeKind, Storage, dwarf::DW_TAG_subrange_type, Ops) {}
454DISubrange *DISubrange::getImpl(LLVMContext &Context, int64_t Count, int64_t Lo,
455 StorageType Storage, bool ShouldCreate) {
458 auto *LB = ConstantAsMetadata::get(
460 return getImpl(Context, CountNode, LB, nullptr, nullptr, Storage,
461 ShouldCreate);
462}
463
464DISubrange *DISubrange::getImpl(LLVMContext &Context, Metadata *CountNode,
465 int64_t Lo, StorageType Storage,
466 bool ShouldCreate) {
467 auto *LB = ConstantAsMetadata::get(
469 return getImpl(Context, CountNode, LB, nullptr, nullptr, Storage,
470 ShouldCreate);
471}
472
473DISubrange *DISubrange::getImpl(LLVMContext &Context, Metadata *CountNode,
474 Metadata *LB, Metadata *UB, Metadata *Stride,
475 StorageType Storage, bool ShouldCreate) {
476 DEFINE_GETIMPL_LOOKUP(DISubrange, (CountNode, LB, UB, Stride));
477 Metadata *Ops[] = {CountNode, LB, UB, Stride};
479}
480
481DISubrange::BoundType DISubrange::getCount() const {
482 Metadata *CB = getRawCountNode();
483 if (!CB)
484 return BoundType();
485
486 assert((isa<ConstantAsMetadata>(CB) || isa<DIVariable>(CB) ||
487 isa<DIExpression>(CB)) &&
488 "Count must be signed constant or DIVariable or DIExpression");
489
490 if (auto *MD = dyn_cast<ConstantAsMetadata>(CB))
491 return BoundType(cast<ConstantInt>(MD->getValue()));
492
493 if (auto *MD = dyn_cast<DIVariable>(CB))
494 return BoundType(MD);
495
496 if (auto *MD = dyn_cast<DIExpression>(CB))
497 return BoundType(MD);
498
499 return BoundType();
500}
501
502DISubrange::BoundType DISubrange::getLowerBound() const {
503 Metadata *LB = getRawLowerBound();
504 if (!LB)
505 return BoundType();
506
507 assert((isa<ConstantAsMetadata>(LB) || isa<DIVariable>(LB) ||
508 isa<DIExpression>(LB)) &&
509 "LowerBound must be signed constant or DIVariable or DIExpression");
510
511 if (auto *MD = dyn_cast<ConstantAsMetadata>(LB))
512 return BoundType(cast<ConstantInt>(MD->getValue()));
513
514 if (auto *MD = dyn_cast<DIVariable>(LB))
515 return BoundType(MD);
516
517 if (auto *MD = dyn_cast<DIExpression>(LB))
518 return BoundType(MD);
519
520 return BoundType();
521}
522
523DISubrange::BoundType DISubrange::getUpperBound() const {
524 Metadata *UB = getRawUpperBound();
525 if (!UB)
526 return BoundType();
527
528 assert((isa<ConstantAsMetadata>(UB) || isa<DIVariable>(UB) ||
529 isa<DIExpression>(UB)) &&
530 "UpperBound must be signed constant or DIVariable or DIExpression");
531
532 if (auto *MD = dyn_cast<ConstantAsMetadata>(UB))
533 return BoundType(cast<ConstantInt>(MD->getValue()));
534
535 if (auto *MD = dyn_cast<DIVariable>(UB))
536 return BoundType(MD);
537
538 if (auto *MD = dyn_cast<DIExpression>(UB))
539 return BoundType(MD);
540
541 return BoundType();
542}
543
544DISubrange::BoundType DISubrange::getStride() const {
545 Metadata *ST = getRawStride();
546 if (!ST)
547 return BoundType();
548
549 assert((isa<ConstantAsMetadata>(ST) || isa<DIVariable>(ST) ||
550 isa<DIExpression>(ST)) &&
551 "Stride must be signed constant or DIVariable or DIExpression");
552
553 if (auto *MD = dyn_cast<ConstantAsMetadata>(ST))
554 return BoundType(cast<ConstantInt>(MD->getValue()));
555
556 if (auto *MD = dyn_cast<DIVariable>(ST))
557 return BoundType(MD);
558
559 if (auto *MD = dyn_cast<DIExpression>(ST))
560 return BoundType(MD);
561
562 return BoundType();
563}
564DIGenericSubrange::DIGenericSubrange(LLVMContext &C, StorageType Storage,
566 : DINode(C, DIGenericSubrangeKind, Storage, dwarf::DW_TAG_generic_subrange,
567 Ops) {}
568
569DIGenericSubrange *DIGenericSubrange::getImpl(LLVMContext &Context,
570 Metadata *CountNode, Metadata *LB,
571 Metadata *UB, Metadata *Stride,
572 StorageType Storage,
573 bool ShouldCreate) {
574 DEFINE_GETIMPL_LOOKUP(DIGenericSubrange, (CountNode, LB, UB, Stride));
575 Metadata *Ops[] = {CountNode, LB, UB, Stride};
577}
578
581 if (!CB)
582 return BoundType();
583
584 assert((isa<DIVariable>(CB) || isa<DIExpression>(CB)) &&
585 "Count must be signed constant or DIVariable or DIExpression");
586
587 if (auto *MD = dyn_cast<DIVariable>(CB))
588 return BoundType(MD);
589
590 if (auto *MD = dyn_cast<DIExpression>(CB))
591 return BoundType(MD);
592
593 return BoundType();
594}
595
598 if (!LB)
599 return BoundType();
600
601 assert((isa<DIVariable>(LB) || isa<DIExpression>(LB)) &&
602 "LowerBound must be signed constant or DIVariable or DIExpression");
603
604 if (auto *MD = dyn_cast<DIVariable>(LB))
605 return BoundType(MD);
606
607 if (auto *MD = dyn_cast<DIExpression>(LB))
608 return BoundType(MD);
609
610 return BoundType();
611}
612
615 if (!UB)
616 return BoundType();
617
618 assert((isa<DIVariable>(UB) || isa<DIExpression>(UB)) &&
619 "UpperBound must be signed constant or DIVariable or DIExpression");
620
621 if (auto *MD = dyn_cast<DIVariable>(UB))
622 return BoundType(MD);
623
624 if (auto *MD = dyn_cast<DIExpression>(UB))
625 return BoundType(MD);
626
627 return BoundType();
628}
629
631 Metadata *ST = getRawStride();
632 if (!ST)
633 return BoundType();
634
635 assert((isa<DIVariable>(ST) || isa<DIExpression>(ST)) &&
636 "Stride must be signed constant or DIVariable or DIExpression");
637
638 if (auto *MD = dyn_cast<DIVariable>(ST))
639 return BoundType(MD);
640
641 if (auto *MD = dyn_cast<DIExpression>(ST))
642 return BoundType(MD);
643
644 return BoundType();
645}
646
647DIEnumerator::DIEnumerator(LLVMContext &C, StorageType Storage,
648 const APInt &Value, bool IsUnsigned,
650 : DINode(C, DIEnumeratorKind, Storage, dwarf::DW_TAG_enumerator, Ops),
651 Value(Value) {
652 SubclassData32 = IsUnsigned;
653}
654DIEnumerator *DIEnumerator::getImpl(LLVMContext &Context, const APInt &Value,
655 bool IsUnsigned, MDString *Name,
656 StorageType Storage, bool ShouldCreate) {
657 assert(isCanonical(Name) && "Expected canonical MDString");
659 Metadata *Ops[] = {Name};
661}
662
663DIBasicType *DIBasicType::getImpl(LLVMContext &Context, unsigned Tag,
664 MDString *Name, uint64_t SizeInBits,
665 uint32_t AlignInBits, unsigned Encoding,
666 DIFlags Flags, StorageType Storage,
667 bool ShouldCreate) {
668 assert(isCanonical(Name) && "Expected canonical MDString");
670 (Tag, Name, SizeInBits, AlignInBits, Encoding, Flags));
671 Metadata *Ops[] = {nullptr, nullptr, Name};
673 (Tag, SizeInBits, AlignInBits, Encoding, Flags), Ops);
674}
675
676std::optional<DIBasicType::Signedness> DIBasicType::getSignedness() const {
677 switch (getEncoding()) {
678 case dwarf::DW_ATE_signed:
679 case dwarf::DW_ATE_signed_char:
680 return Signedness::Signed;
681 case dwarf::DW_ATE_unsigned:
682 case dwarf::DW_ATE_unsigned_char:
684 default:
685 return std::nullopt;
686 }
687}
688
689DIStringType *DIStringType::getImpl(LLVMContext &Context, unsigned Tag,
690 MDString *Name, Metadata *StringLength,
691 Metadata *StringLengthExp,
692 Metadata *StringLocationExp,
693 uint64_t SizeInBits, uint32_t AlignInBits,
694 unsigned Encoding, StorageType Storage,
695 bool ShouldCreate) {
696 assert(isCanonical(Name) && "Expected canonical MDString");
700 Metadata *Ops[] = {nullptr, nullptr, Name,
703 Ops);
704}
706 assert(getTag() == dwarf::DW_TAG_ptr_to_member_type);
707 return cast_or_null<DIType>(getExtraData());
708}
710 assert(getTag() == dwarf::DW_TAG_inheritance);
711 if (auto *CM = cast_or_null<ConstantAsMetadata>(getExtraData()))
712 if (auto *CI = dyn_cast_or_null<ConstantInt>(CM->getValue()))
713 return static_cast<uint32_t>(CI->getZExtValue());
714 return 0;
715}
717 assert(getTag() == dwarf::DW_TAG_member && isBitField());
718 if (auto *C = cast_or_null<ConstantAsMetadata>(getExtraData()))
719 return C->getValue();
720 return nullptr;
721}
722
724 assert((getTag() == dwarf::DW_TAG_member ||
725 getTag() == dwarf::DW_TAG_variable) &&
727 if (auto *C = cast_or_null<ConstantAsMetadata>(getExtraData()))
728 return C->getValue();
729 return nullptr;
730}
732 assert(getTag() == dwarf::DW_TAG_member && !isStaticMember());
733 if (auto *C = cast_or_null<ConstantAsMetadata>(getExtraData()))
734 return C->getValue();
735 return nullptr;
736}
737
738DIDerivedType *DIDerivedType::getImpl(
739 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File,
740 unsigned Line, Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
741 uint32_t AlignInBits, uint64_t OffsetInBits,
742 std::optional<unsigned> DWARFAddressSpace,
743 std::optional<PtrAuthData> PtrAuthData, DIFlags Flags, Metadata *ExtraData,
744 Metadata *Annotations, StorageType Storage, bool ShouldCreate) {
745 assert(isCanonical(Name) && "Expected canonical MDString");
748 AlignInBits, OffsetInBits, DWARFAddressSpace,
749 PtrAuthData, Flags, ExtraData, Annotations));
753 DWARFAddressSpace, PtrAuthData, Flags),
754 Ops);
755}
756
757std::optional<DIDerivedType::PtrAuthData>
758DIDerivedType::getPtrAuthData() const {
759 return getTag() == dwarf::DW_TAG_LLVM_ptrauth_type
760 ? std::optional<PtrAuthData>(PtrAuthData(SubclassData32))
761 : std::nullopt;
762}
763
764DICompositeType *DICompositeType::getImpl(
765 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File,
766 unsigned Line, Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
767 uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags,
768 Metadata *Elements, unsigned RuntimeLang, Metadata *VTableHolder,
769 Metadata *TemplateParams, MDString *Identifier, Metadata *Discriminator,
770 Metadata *DataLocation, Metadata *Associated, Metadata *Allocated,
771 Metadata *Rank, Metadata *Annotations, StorageType Storage,
772 bool ShouldCreate) {
773 assert(isCanonical(Name) && "Expected canonical MDString");
774
775 // Keep this in sync with buildODRType.
781 Rank, Annotations));
782 Metadata *Ops[] = {File, Scope, Name, BaseType,
788 (Tag, Line, RuntimeLang, SizeInBits, AlignInBits, OffsetInBits, Flags),
789 Ops);
790}
791
793 LLVMContext &Context, MDString &Identifier, unsigned Tag, MDString *Name,
794 Metadata *File, unsigned Line, Metadata *Scope, Metadata *BaseType,
795 uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits,
796 DIFlags Flags, Metadata *Elements, unsigned RuntimeLang,
797 Metadata *VTableHolder, Metadata *TemplateParams, Metadata *Discriminator,
798 Metadata *DataLocation, Metadata *Associated, Metadata *Allocated,
799 Metadata *Rank, Metadata *Annotations) {
800 assert(!Identifier.getString().empty() && "Expected valid identifier");
801 if (!Context.isODRUniquingDebugTypes())
802 return nullptr;
803 auto *&CT = (*Context.pImpl->DITypeMap)[&Identifier];
804 if (!CT)
806 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
807 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
810
811 if (CT->getTag() != Tag)
812 return nullptr;
813
814 // Only mutate CT if it's a forward declaration and the new operands aren't.
815 assert(CT->getRawIdentifier() == &Identifier && "Wrong ODR identifier?");
816 if (!CT->isForwardDecl() || (Flags & DINode::FlagFwdDecl))
817 return CT;
818
819 // Mutate CT in place. Keep this in sync with getImpl.
820 CT->mutate(Tag, Line, RuntimeLang, SizeInBits, AlignInBits, OffsetInBits,
821 Flags);
822 Metadata *Ops[] = {File, Scope, Name, BaseType,
826 assert((std::end(Ops) - std::begin(Ops)) == (int)CT->getNumOperands() &&
827 "Mismatched number of operands");
828 for (unsigned I = 0, E = CT->getNumOperands(); I != E; ++I)
829 if (Ops[I] != CT->getOperand(I))
830 CT->setOperand(I, Ops[I]);
831 return CT;
832}
833
834DICompositeType *DICompositeType::getODRType(
835 LLVMContext &Context, MDString &Identifier, unsigned Tag, MDString *Name,
836 Metadata *File, unsigned Line, Metadata *Scope, Metadata *BaseType,
837 uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits,
838 DIFlags Flags, Metadata *Elements, unsigned RuntimeLang,
839 Metadata *VTableHolder, Metadata *TemplateParams, Metadata *Discriminator,
840 Metadata *DataLocation, Metadata *Associated, Metadata *Allocated,
841 Metadata *Rank, Metadata *Annotations) {
842 assert(!Identifier.getString().empty() && "Expected valid identifier");
843 if (!Context.isODRUniquingDebugTypes())
844 return nullptr;
845 auto *&CT = (*Context.pImpl->DITypeMap)[&Identifier];
846 if (!CT) {
848 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
852 } else {
853 if (CT->getTag() != Tag)
854 return nullptr;
855 }
856 return CT;
857}
858
860 MDString &Identifier) {
861 assert(!Identifier.getString().empty() && "Expected valid identifier");
862 if (!Context.isODRUniquingDebugTypes())
863 return nullptr;
864 return Context.pImpl->DITypeMap->lookup(&Identifier);
865}
866DISubroutineType::DISubroutineType(LLVMContext &C, StorageType Storage,
867 DIFlags Flags, uint8_t CC,
869 : DIType(C, DISubroutineTypeKind, Storage, dwarf::DW_TAG_subroutine_type, 0,
870 0, 0, 0, Flags, Ops),
871 CC(CC) {}
872
873DISubroutineType *DISubroutineType::getImpl(LLVMContext &Context, DIFlags Flags,
874 uint8_t CC, Metadata *TypeArray,
875 StorageType Storage,
876 bool ShouldCreate) {
878 Metadata *Ops[] = {nullptr, nullptr, nullptr, TypeArray};
880}
881
882DIFile::DIFile(LLVMContext &C, StorageType Storage,
883 std::optional<ChecksumInfo<MDString *>> CS, MDString *Src,
885 : DIScope(C, DIFileKind, Storage, dwarf::DW_TAG_file_type, Ops),
886 Checksum(CS), Source(Src) {}
887
888// FIXME: Implement this string-enum correspondence with a .def file and macros,
889// so that the association is explicit rather than implied.
890static const char *ChecksumKindName[DIFile::CSK_Last] = {
891 "CSK_MD5",
892 "CSK_SHA1",
893 "CSK_SHA256",
894};
895
896StringRef DIFile::getChecksumKindAsString(ChecksumKind CSKind) {
897 assert(CSKind <= DIFile::CSK_Last && "Invalid checksum kind");
898 // The first space was originally the CSK_None variant, which is now
899 // obsolete, but the space is still reserved in ChecksumKind, so we account
900 // for it here.
901 return ChecksumKindName[CSKind - 1];
902}
903
904std::optional<DIFile::ChecksumKind>
907 .Case("CSK_MD5", DIFile::CSK_MD5)
908 .Case("CSK_SHA1", DIFile::CSK_SHA1)
909 .Case("CSK_SHA256", DIFile::CSK_SHA256)
910 .Default(std::nullopt);
911}
912
913DIFile *DIFile::getImpl(LLVMContext &Context, MDString *Filename,
914 MDString *Directory,
915 std::optional<DIFile::ChecksumInfo<MDString *>> CS,
916 MDString *Source, StorageType Storage,
917 bool ShouldCreate) {
918 assert(isCanonical(Filename) && "Expected canonical MDString");
919 assert(isCanonical(Directory) && "Expected canonical MDString");
920 assert((!CS || isCanonical(CS->Value)) && "Expected canonical MDString");
921 // We do *NOT* expect Source to be a canonical MDString because nullptr
922 // means none, so we need something to represent the empty file.
924 Metadata *Ops[] = {Filename, Directory, CS ? CS->Value : nullptr, Source};
925 DEFINE_GETIMPL_STORE(DIFile, (CS, Source), Ops);
926}
927DICompileUnit::DICompileUnit(LLVMContext &C, StorageType Storage,
928 unsigned SourceLanguage, bool IsOptimized,
929 unsigned RuntimeVersion, unsigned EmissionKind,
930 uint64_t DWOId, bool SplitDebugInlining,
931 bool DebugInfoForProfiling, unsigned NameTableKind,
932 bool RangesBaseAddress, ArrayRef<Metadata *> Ops)
933 : DIScope(C, DICompileUnitKind, Storage, dwarf::DW_TAG_compile_unit, Ops),
934 SourceLanguage(SourceLanguage), RuntimeVersion(RuntimeVersion),
936 IsOptimized(IsOptimized), SplitDebugInlining(SplitDebugInlining),
937 DebugInfoForProfiling(DebugInfoForProfiling),
938 RangesBaseAddress(RangesBaseAddress) {
940}
941
942DICompileUnit *DICompileUnit::getImpl(
943 LLVMContext &Context, unsigned SourceLanguage, Metadata *File,
944 MDString *Producer, bool IsOptimized, MDString *Flags,
945 unsigned RuntimeVersion, MDString *SplitDebugFilename,
946 unsigned EmissionKind, Metadata *EnumTypes, Metadata *RetainedTypes,
947 Metadata *GlobalVariables, Metadata *ImportedEntities, Metadata *Macros,
948 uint64_t DWOId, bool SplitDebugInlining, bool DebugInfoForProfiling,
949 unsigned NameTableKind, bool RangesBaseAddress, MDString *SysRoot,
950 MDString *SDK, StorageType Storage, bool ShouldCreate) {
951 assert(Storage != Uniqued && "Cannot unique DICompileUnit");
952 assert(isCanonical(Producer) && "Expected canonical MDString");
953 assert(isCanonical(Flags) && "Expected canonical MDString");
954 assert(isCanonical(SplitDebugFilename) && "Expected canonical MDString");
955
956 Metadata *Ops[] = {File,
957 Producer,
958 Flags,
960 EnumTypes,
964 Macros,
965 SysRoot,
966 SDK};
967 return storeImpl(new (std::size(Ops), Storage) DICompileUnit(
968 Context, Storage, SourceLanguage, IsOptimized,
969 RuntimeVersion, EmissionKind, DWOId, SplitDebugInlining,
970 DebugInfoForProfiling, NameTableKind, RangesBaseAddress,
971 Ops),
972 Storage);
973}
974
975std::optional<DICompileUnit::DebugEmissionKind>
978 .Case("NoDebug", NoDebug)
979 .Case("FullDebug", FullDebug)
980 .Case("LineTablesOnly", LineTablesOnly)
981 .Case("DebugDirectivesOnly", DebugDirectivesOnly)
982 .Default(std::nullopt);
983}
984
985std::optional<DICompileUnit::DebugNameTableKind>
988 .Case("Default", DebugNameTableKind::Default)
992 .Default(std::nullopt);
993}
994
996 switch (EK) {
997 case NoDebug:
998 return "NoDebug";
999 case FullDebug:
1000 return "FullDebug";
1001 case LineTablesOnly:
1002 return "LineTablesOnly";
1004 return "DebugDirectivesOnly";
1005 }
1006 return nullptr;
1007}
1008
1010 switch (NTK) {
1012 return nullptr;
1014 return "GNU";
1016 return "Apple";
1018 return "None";
1019 }
1020 return nullptr;
1021}
1022DISubprogram::DISubprogram(LLVMContext &C, StorageType Storage, unsigned Line,
1023 unsigned ScopeLine, unsigned VirtualIndex,
1024 int ThisAdjustment, DIFlags Flags, DISPFlags SPFlags,
1026 : DILocalScope(C, DISubprogramKind, Storage, dwarf::DW_TAG_subprogram, Ops),
1027 Line(Line), ScopeLine(ScopeLine), VirtualIndex(VirtualIndex),
1028 ThisAdjustment(ThisAdjustment), Flags(Flags), SPFlags(SPFlags) {
1029 static_assert(dwarf::DW_VIRTUALITY_max < 4, "Virtuality out of range");
1030}
1032DISubprogram::toSPFlags(bool IsLocalToUnit, bool IsDefinition, bool IsOptimized,
1033 unsigned Virtuality, bool IsMainSubprogram) {
1034 // We're assuming virtuality is the low-order field.
1035 static_assert(int(SPFlagVirtual) == int(dwarf::DW_VIRTUALITY_virtual) &&
1036 int(SPFlagPureVirtual) ==
1037 int(dwarf::DW_VIRTUALITY_pure_virtual),
1038 "Virtuality constant mismatch");
1039 return static_cast<DISPFlags>(
1040 (Virtuality & SPFlagVirtuality) |
1041 (IsLocalToUnit ? SPFlagLocalToUnit : SPFlagZero) |
1042 (IsDefinition ? SPFlagDefinition : SPFlagZero) |
1043 (IsOptimized ? SPFlagOptimized : SPFlagZero) |
1044 (IsMainSubprogram ? SPFlagMainSubprogram : SPFlagZero));
1045}
1046
1048 if (auto *Block = dyn_cast<DILexicalBlockBase>(this))
1049 return Block->getScope()->getSubprogram();
1050 return const_cast<DISubprogram *>(cast<DISubprogram>(this));
1051}
1052
1054 if (auto *File = dyn_cast<DILexicalBlockFile>(this))
1055 return File->getScope()->getNonLexicalBlockFileScope();
1056 return const_cast<DILocalScope *>(this);
1057}
1058
1060 DILocalScope &RootScope, DISubprogram &NewSP, LLVMContext &Ctx,
1062 SmallVector<DIScope *> ScopeChain;
1063 DIScope *CachedResult = nullptr;
1064
1065 for (DIScope *Scope = &RootScope; !isa<DISubprogram>(Scope);
1066 Scope = Scope->getScope()) {
1067 if (auto It = Cache.find(Scope); It != Cache.end()) {
1068 CachedResult = cast<DIScope>(It->second);
1069 break;
1070 }
1071 ScopeChain.push_back(Scope);
1072 }
1073
1074 // Recreate the scope chain, bottom-up, starting at the new subprogram (or a
1075 // cached result).
1076 DIScope *UpdatedScope = CachedResult ? CachedResult : &NewSP;
1077 for (DIScope *ScopeToUpdate : reverse(ScopeChain)) {
1078 TempMDNode ClonedScope = ScopeToUpdate->clone();
1079 cast<DILexicalBlockBase>(*ClonedScope).replaceScope(UpdatedScope);
1080 UpdatedScope =
1081 cast<DIScope>(MDNode::replaceWithUniqued(std::move(ClonedScope)));
1082 Cache[ScopeToUpdate] = UpdatedScope;
1083 }
1084
1085 return cast<DILocalScope>(UpdatedScope);
1086}
1087
1089 return StringSwitch<DISPFlags>(Flag)
1090#define HANDLE_DISP_FLAG(ID, NAME) .Case("DISPFlag" #NAME, SPFlag##NAME)
1091#include "llvm/IR/DebugInfoFlags.def"
1092 .Default(SPFlagZero);
1093}
1094
1096 switch (Flag) {
1097 // Appease a warning.
1098 case SPFlagVirtuality:
1099 return "";
1100#define HANDLE_DISP_FLAG(ID, NAME) \
1101 case SPFlag##NAME: \
1102 return "DISPFlag" #NAME;
1103#include "llvm/IR/DebugInfoFlags.def"
1104 }
1105 return "";
1106}
1107
1110 SmallVectorImpl<DISPFlags> &SplitFlags) {
1111 // Multi-bit fields can require special handling. In our case, however, the
1112 // only multi-bit field is virtuality, and all its values happen to be
1113 // single-bit values, so the right behavior just falls out.
1114#define HANDLE_DISP_FLAG(ID, NAME) \
1115 if (DISPFlags Bit = Flags & SPFlag##NAME) { \
1116 SplitFlags.push_back(Bit); \
1117 Flags &= ~Bit; \
1118 }
1119#include "llvm/IR/DebugInfoFlags.def"
1120 return Flags;
1121}
1122
1123DISubprogram *DISubprogram::getImpl(
1124 LLVMContext &Context, Metadata *Scope, MDString *Name,
1125 MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
1126 unsigned ScopeLine, Metadata *ContainingType, unsigned VirtualIndex,
1127 int ThisAdjustment, DIFlags Flags, DISPFlags SPFlags, Metadata *Unit,
1128 Metadata *TemplateParams, Metadata *Declaration, Metadata *RetainedNodes,
1129 Metadata *ThrownTypes, Metadata *Annotations, MDString *TargetFuncName,
1130 StorageType Storage, bool ShouldCreate) {
1131 assert(isCanonical(Name) && "Expected canonical MDString");
1132 assert(isCanonical(LinkageName) && "Expected canonical MDString");
1133 assert(isCanonical(TargetFuncName) && "Expected canonical MDString");
1135 (Scope, Name, LinkageName, File, Line, Type, ScopeLine,
1136 ContainingType, VirtualIndex, ThisAdjustment, Flags,
1137 SPFlags, Unit, TemplateParams, Declaration,
1145 if (!TargetFuncName) {
1146 Ops.pop_back();
1147 if (!Annotations) {
1148 Ops.pop_back();
1149 if (!ThrownTypes) {
1150 Ops.pop_back();
1151 if (!TemplateParams) {
1152 Ops.pop_back();
1153 if (!ContainingType)
1154 Ops.pop_back();
1155 }
1156 }
1157 }
1158 }
1161 (Line, ScopeLine, VirtualIndex, ThisAdjustment, Flags, SPFlags), Ops,
1162 Ops.size());
1163}
1164
1165bool DISubprogram::describes(const Function *F) const {
1166 assert(F && "Invalid function");
1167 return F->getSubprogram() == this;
1168}
1170 StorageType Storage,
1172 : DILocalScope(C, ID, Storage, dwarf::DW_TAG_lexical_block, Ops) {}
1173
1174DILexicalBlock *DILexicalBlock::getImpl(LLVMContext &Context, Metadata *Scope,
1175 Metadata *File, unsigned Line,
1176 unsigned Column, StorageType Storage,
1177 bool ShouldCreate) {
1178 // Fixup column.
1179 adjustColumn(Column);
1180
1181 assert(Scope && "Expected scope");
1183 Metadata *Ops[] = {File, Scope};
1184 DEFINE_GETIMPL_STORE(DILexicalBlock, (Line, Column), Ops);
1185}
1186
1187DILexicalBlockFile *DILexicalBlockFile::getImpl(LLVMContext &Context,
1188 Metadata *Scope, Metadata *File,
1189 unsigned Discriminator,
1190 StorageType Storage,
1191 bool ShouldCreate) {
1192 assert(Scope && "Expected scope");
1194 Metadata *Ops[] = {File, Scope};
1196}
1197
1198DINamespace::DINamespace(LLVMContext &Context, StorageType Storage,
1199 bool ExportSymbols, ArrayRef<Metadata *> Ops)
1200 : DIScope(Context, DINamespaceKind, Storage, dwarf::DW_TAG_namespace, Ops) {
1201 SubclassData1 = ExportSymbols;
1202}
1203DINamespace *DINamespace::getImpl(LLVMContext &Context, Metadata *Scope,
1204 MDString *Name, bool ExportSymbols,
1205 StorageType Storage, bool ShouldCreate) {
1206 assert(isCanonical(Name) && "Expected canonical MDString");
1208 // The nullptr is for DIScope's File operand. This should be refactored.
1209 Metadata *Ops[] = {nullptr, Scope, Name};
1211}
1212
1213DICommonBlock::DICommonBlock(LLVMContext &Context, StorageType Storage,
1214 unsigned LineNo, ArrayRef<Metadata *> Ops)
1215 : DIScope(Context, DICommonBlockKind, Storage, dwarf::DW_TAG_common_block,
1216 Ops) {
1217 SubclassData32 = LineNo;
1218}
1219DICommonBlock *DICommonBlock::getImpl(LLVMContext &Context, Metadata *Scope,
1220 Metadata *Decl, MDString *Name,
1221 Metadata *File, unsigned LineNo,
1222 StorageType Storage, bool ShouldCreate) {
1223 assert(isCanonical(Name) && "Expected canonical MDString");
1225 // The nullptr is for DIScope's File operand. This should be refactored.
1226 Metadata *Ops[] = {Scope, Decl, Name, File};
1228}
1229
1230DIModule::DIModule(LLVMContext &Context, StorageType Storage, unsigned LineNo,
1231 bool IsDecl, ArrayRef<Metadata *> Ops)
1232 : DIScope(Context, DIModuleKind, Storage, dwarf::DW_TAG_module, Ops) {
1233 SubclassData1 = IsDecl;
1234 SubclassData32 = LineNo;
1235}
1236DIModule *DIModule::getImpl(LLVMContext &Context, Metadata *File,
1237 Metadata *Scope, MDString *Name,
1238 MDString *ConfigurationMacros,
1239 MDString *IncludePath, MDString *APINotesFile,
1240 unsigned LineNo, bool IsDecl, StorageType Storage,
1241 bool ShouldCreate) {
1242 assert(isCanonical(Name) && "Expected canonical MDString");
1244 IncludePath, APINotesFile, LineNo, IsDecl));
1247 DEFINE_GETIMPL_STORE(DIModule, (LineNo, IsDecl), Ops);
1248}
1249DITemplateTypeParameter::DITemplateTypeParameter(LLVMContext &Context,
1250 StorageType Storage,
1251 bool IsDefault,
1253 : DITemplateParameter(Context, DITemplateTypeParameterKind, Storage,
1254 dwarf::DW_TAG_template_type_parameter, IsDefault,
1255 Ops) {}
1256
1258DITemplateTypeParameter::getImpl(LLVMContext &Context, MDString *Name,
1259 Metadata *Type, bool isDefault,
1260 StorageType Storage, bool ShouldCreate) {
1261 assert(isCanonical(Name) && "Expected canonical MDString");
1263 Metadata *Ops[] = {Name, Type};
1265}
1266
1267DITemplateValueParameter *DITemplateValueParameter::getImpl(
1268 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *Type,
1269 bool isDefault, Metadata *Value, StorageType Storage, bool ShouldCreate) {
1270 assert(isCanonical(Name) && "Expected canonical MDString");
1272 (Tag, Name, Type, isDefault, Value));
1273 Metadata *Ops[] = {Name, Type, Value};
1275}
1276
1278DIGlobalVariable::getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
1279 MDString *LinkageName, Metadata *File, unsigned Line,
1280 Metadata *Type, bool IsLocalToUnit, bool IsDefinition,
1281 Metadata *StaticDataMemberDeclaration,
1282 Metadata *TemplateParams, uint32_t AlignInBits,
1283 Metadata *Annotations, StorageType Storage,
1284 bool ShouldCreate) {
1285 assert(isCanonical(Name) && "Expected canonical MDString");
1286 assert(isCanonical(LinkageName) && "Expected canonical MDString");
1289 (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, IsDefinition,
1291 Metadata *Ops[] = {Scope,
1292 Name,
1293 File,
1294 Type,
1295 Name,
1299 Annotations};
1301 (Line, IsLocalToUnit, IsDefinition, AlignInBits), Ops);
1302}
1303
1305DILocalVariable::getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
1306 Metadata *File, unsigned Line, Metadata *Type,
1307 unsigned Arg, DIFlags Flags, uint32_t AlignInBits,
1308 Metadata *Annotations, StorageType Storage,
1309 bool ShouldCreate) {
1310 // 64K ought to be enough for any frontend.
1311 assert(Arg <= UINT16_MAX && "Expected argument number to fit in 16-bits");
1312
1313 assert(Scope && "Expected scope");
1314 assert(isCanonical(Name) && "Expected canonical MDString");
1316 Flags, AlignInBits, Annotations));
1317 Metadata *Ops[] = {Scope, Name, File, Type, Annotations};
1319}
1320
1322 signed Line, ArrayRef<Metadata *> Ops,
1323 uint32_t AlignInBits)
1324 : DINode(C, ID, Storage, dwarf::DW_TAG_variable, Ops), Line(Line) {
1325 SubclassData32 = AlignInBits;
1326}
1327std::optional<uint64_t> DIVariable::getSizeInBits() const {
1328 // This is used by the Verifier so be mindful of broken types.
1329 const Metadata *RawType = getRawType();
1330 while (RawType) {
1331 // Try to get the size directly.
1332 if (auto *T = dyn_cast<DIType>(RawType))
1333 if (uint64_t Size = T->getSizeInBits())
1334 return Size;
1335
1336 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
1337 // Look at the base type.
1338 RawType = DT->getRawBaseType();
1339 continue;
1340 }
1341
1342 // Missing type or size.
1343 break;
1344 }
1345
1346 // Fail gracefully.
1347 return std::nullopt;
1348}
1349
1350DILabel::DILabel(LLVMContext &C, StorageType Storage, unsigned Line,
1352 : DINode(C, DILabelKind, Storage, dwarf::DW_TAG_label, Ops) {
1353 SubclassData32 = Line;
1354}
1355DILabel *DILabel::getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
1356 Metadata *File, unsigned Line, StorageType Storage,
1357 bool ShouldCreate) {
1358 assert(Scope && "Expected scope");
1359 assert(isCanonical(Name) && "Expected canonical MDString");
1361 Metadata *Ops[] = {Scope, Name, File};
1363}
1364
1365DIExpression *DIExpression::getImpl(LLVMContext &Context,
1366 ArrayRef<uint64_t> Elements,
1367 StorageType Storage, bool ShouldCreate) {
1370}
1372 if (auto singleLocElts = getSingleLocationExpressionElements()) {
1373 return singleLocElts->size() > 0 &&
1374 (*singleLocElts)[0] == dwarf::DW_OP_LLVM_entry_value;
1375 }
1376 return false;
1377}
1379 if (auto singleLocElts = getSingleLocationExpressionElements())
1380 return singleLocElts->size() > 0 &&
1381 (*singleLocElts)[0] == dwarf::DW_OP_deref;
1382 return false;
1383}
1385 if (auto singleLocElts = getSingleLocationExpressionElements())
1386 return singleLocElts->size() == 1 &&
1387 (*singleLocElts)[0] == dwarf::DW_OP_deref;
1388 return false;
1389}
1390
1391DIAssignID *DIAssignID::getImpl(LLVMContext &Context, StorageType Storage,
1392 bool ShouldCreate) {
1393 // Uniqued DIAssignID are not supported as the instance address *is* the ID.
1394 assert(Storage != StorageType::Uniqued && "uniqued DIAssignID unsupported");
1395 return storeImpl(new (0u, Storage) DIAssignID(Context, Storage), Storage);
1396}
1397
1399 uint64_t Op = getOp();
1400
1401 if (Op >= dwarf::DW_OP_breg0 && Op <= dwarf::DW_OP_breg31)
1402 return 2;
1403
1404 switch (Op) {
1409 case dwarf::DW_OP_bregx:
1410 return 3;
1411 case dwarf::DW_OP_constu:
1412 case dwarf::DW_OP_consts:
1413 case dwarf::DW_OP_deref_size:
1414 case dwarf::DW_OP_plus_uconst:
1418 case dwarf::DW_OP_regx:
1419 return 2;
1420 default:
1421 return 1;
1422 }
1423}
1424
1426 for (auto I = expr_op_begin(), E = expr_op_end(); I != E; ++I) {
1427 // Check that there's space for the operand.
1428 if (I->get() + I->getSize() > E->get())
1429 return false;
1430
1431 uint64_t Op = I->getOp();
1432 if ((Op >= dwarf::DW_OP_reg0 && Op <= dwarf::DW_OP_reg31) ||
1433 (Op >= dwarf::DW_OP_breg0 && Op <= dwarf::DW_OP_breg31))
1434 return true;
1435
1436 // Check that the operand is valid.
1437 switch (Op) {
1438 default:
1439 return false;
1441 // A fragment operator must appear at the end.
1442 return I->get() + I->getSize() == E->get();
1443 case dwarf::DW_OP_stack_value: {
1444 // Must be the last one or followed by a DW_OP_LLVM_fragment.
1445 if (I->get() + I->getSize() == E->get())
1446 break;
1447 auto J = I;
1448 if ((++J)->getOp() != dwarf::DW_OP_LLVM_fragment)
1449 return false;
1450 break;
1451 }
1452 case dwarf::DW_OP_swap: {
1453 // Must be more than one implicit element on the stack.
1454
1455 // FIXME: A better way to implement this would be to add a local variable
1456 // that keeps track of the stack depth and introduce something like a
1457 // DW_LLVM_OP_implicit_location as a placeholder for the location this
1458 // DIExpression is attached to, or else pass the number of implicit stack
1459 // elements into isValid.
1460 if (getNumElements() == 1)
1461 return false;
1462 break;
1463 }
1465 // An entry value operator must appear at the beginning or immediately
1466 // following `DW_OP_LLVM_arg 0`, and the number of operations it cover can
1467 // currently only be 1, because we support only entry values of a simple
1468 // register location. One reason for this is that we currently can't
1469 // calculate the size of the resulting DWARF block for other expressions.
1470 auto FirstOp = expr_op_begin();
1471 if (FirstOp->getOp() == dwarf::DW_OP_LLVM_arg && FirstOp->getArg(0) == 0)
1472 ++FirstOp;
1473 return I->get() == FirstOp->get() && I->getArg(0) == 1;
1474 }
1481 case dwarf::DW_OP_constu:
1482 case dwarf::DW_OP_plus_uconst:
1483 case dwarf::DW_OP_plus:
1484 case dwarf::DW_OP_minus:
1485 case dwarf::DW_OP_mul:
1486 case dwarf::DW_OP_div:
1487 case dwarf::DW_OP_mod:
1488 case dwarf::DW_OP_or:
1489 case dwarf::DW_OP_and:
1490 case dwarf::DW_OP_xor:
1491 case dwarf::DW_OP_shl:
1492 case dwarf::DW_OP_shr:
1493 case dwarf::DW_OP_shra:
1494 case dwarf::DW_OP_deref:
1495 case dwarf::DW_OP_deref_size:
1496 case dwarf::DW_OP_xderef:
1497 case dwarf::DW_OP_lit0:
1498 case dwarf::DW_OP_not:
1499 case dwarf::DW_OP_dup:
1500 case dwarf::DW_OP_regx:
1501 case dwarf::DW_OP_bregx:
1502 case dwarf::DW_OP_push_object_address:
1503 case dwarf::DW_OP_over:
1504 case dwarf::DW_OP_consts:
1505 case dwarf::DW_OP_eq:
1506 case dwarf::DW_OP_ne:
1507 case dwarf::DW_OP_gt:
1508 case dwarf::DW_OP_ge:
1509 case dwarf::DW_OP_lt:
1510 case dwarf::DW_OP_le:
1511 break;
1512 }
1513 }
1514 return true;
1515}
1516
1518 if (!isValid())
1519 return false;
1520
1521 if (getNumElements() == 0)
1522 return false;
1523
1524 for (const auto &It : expr_ops()) {
1525 switch (It.getOp()) {
1526 default:
1527 break;
1528 case dwarf::DW_OP_stack_value:
1529 return true;
1530 }
1531 }
1532
1533 return false;
1534}
1535
1537 if (!isValid())
1538 return false;
1539
1540 if (getNumElements() == 0)
1541 return false;
1542
1543 // If there are any elements other than fragment or tag_offset, then some
1544 // kind of complex computation occurs.
1545 for (const auto &It : expr_ops()) {
1546 switch (It.getOp()) {
1550 continue;
1551 default:
1552 return true;
1553 }
1554 }
1555
1556 return false;
1557}
1558
1560 if (!isValid())
1561 return false;
1562
1563 if (getNumElements() == 0)
1564 return true;
1565
1566 auto ExprOpBegin = expr_ops().begin();
1567 auto ExprOpEnd = expr_ops().end();
1568 if (ExprOpBegin->getOp() == dwarf::DW_OP_LLVM_arg) {
1569 if (ExprOpBegin->getArg(0) != 0)
1570 return false;
1571 ++ExprOpBegin;
1572 }
1573
1574 return !std::any_of(ExprOpBegin, ExprOpEnd, [](auto Op) {
1575 return Op.getOp() == dwarf::DW_OP_LLVM_arg;
1576 });
1577}
1578
1579std::optional<ArrayRef<uint64_t>>
1581 // Check for `isValid` covered by `isSingleLocationExpression`.
1583 return std::nullopt;
1584
1585 // An empty expression is already non-variadic.
1586 if (!getNumElements())
1587 return ArrayRef<uint64_t>();
1588
1589 // If Expr does not have a leading DW_OP_LLVM_arg then we don't need to do
1590 // anything.
1592 return getElements().drop_front(2);
1593 return getElements();
1594}
1595
1596const DIExpression *
1598 SmallVector<uint64_t, 3> UndefOps;
1599 if (auto FragmentInfo = Expr->getFragmentInfo()) {
1602 }
1603 return DIExpression::get(Expr->getContext(), UndefOps);
1604}
1605
1606const DIExpression *
1608 if (any_of(Expr->expr_ops(), [](auto ExprOp) {
1609 return ExprOp.getOp() == dwarf::DW_OP_LLVM_arg;
1610 }))
1611 return Expr;
1612 SmallVector<uint64_t> NewOps;
1613 NewOps.reserve(Expr->getNumElements() + 2);
1614 NewOps.append({dwarf::DW_OP_LLVM_arg, 0});
1615 NewOps.append(Expr->elements_begin(), Expr->elements_end());
1616 return DIExpression::get(Expr->getContext(), NewOps);
1617}
1618
1619std::optional<const DIExpression *>
1621 if (!Expr)
1622 return std::nullopt;
1623
1624 if (auto Elts = Expr->getSingleLocationExpressionElements())
1625 return DIExpression::get(Expr->getContext(), *Elts);
1626
1627 return std::nullopt;
1628}
1629
1631 const DIExpression *Expr,
1632 bool IsIndirect) {
1633 // If Expr is not already variadic, insert the implied `DW_OP_LLVM_arg 0`
1634 // to the existing expression ops.
1635 if (none_of(Expr->expr_ops(), [](auto ExprOp) {
1636 return ExprOp.getOp() == dwarf::DW_OP_LLVM_arg;
1637 }))
1638 Ops.append({dwarf::DW_OP_LLVM_arg, 0});
1639 // If Expr is not indirect, we only need to insert the expression elements and
1640 // we're done.
1641 if (!IsIndirect) {
1642 Ops.append(Expr->elements_begin(), Expr->elements_end());
1643 return;
1644 }
1645 // If Expr is indirect, insert the implied DW_OP_deref at the end of the
1646 // expression but before DW_OP_{stack_value, LLVM_fragment} if they are
1647 // present.
1648 for (auto Op : Expr->expr_ops()) {
1649 if (Op.getOp() == dwarf::DW_OP_stack_value ||
1650 Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
1651 Ops.push_back(dwarf::DW_OP_deref);
1652 IsIndirect = false;
1653 }
1654 Op.appendToVector(Ops);
1655 }
1656 if (IsIndirect)
1657 Ops.push_back(dwarf::DW_OP_deref);
1658}
1659
1661 bool FirstIndirect,
1662 const DIExpression *SecondExpr,
1663 bool SecondIndirect) {
1664 SmallVector<uint64_t> FirstOps;
1665 DIExpression::canonicalizeExpressionOps(FirstOps, FirstExpr, FirstIndirect);
1666 SmallVector<uint64_t> SecondOps;
1667 DIExpression::canonicalizeExpressionOps(SecondOps, SecondExpr,
1668 SecondIndirect);
1669 return FirstOps == SecondOps;
1670}
1671
1672std::optional<DIExpression::FragmentInfo>
1674 for (auto I = Start; I != End; ++I)
1675 if (I->getOp() == dwarf::DW_OP_LLVM_fragment) {
1676 DIExpression::FragmentInfo Info = {I->getArg(1), I->getArg(0)};
1677 return Info;
1678 }
1679 return std::nullopt;
1680}
1681
1683 int64_t Offset) {
1684 if (Offset > 0) {
1685 Ops.push_back(dwarf::DW_OP_plus_uconst);
1686 Ops.push_back(Offset);
1687 } else if (Offset < 0) {
1688 Ops.push_back(dwarf::DW_OP_constu);
1689 // Avoid UB when encountering LLONG_MIN, because in 2's complement
1690 // abs(LLONG_MIN) is LLONG_MAX+1.
1691 uint64_t AbsMinusOne = -(Offset+1);
1692 Ops.push_back(AbsMinusOne + 1);
1693 Ops.push_back(dwarf::DW_OP_minus);
1694 }
1695}
1696
1698 auto SingleLocEltsOpt = getSingleLocationExpressionElements();
1699 if (!SingleLocEltsOpt)
1700 return false;
1701 auto SingleLocElts = *SingleLocEltsOpt;
1702
1703 if (SingleLocElts.size() == 0) {
1704 Offset = 0;
1705 return true;
1706 }
1707
1708 if (SingleLocElts.size() == 2 &&
1709 SingleLocElts[0] == dwarf::DW_OP_plus_uconst) {
1710 Offset = SingleLocElts[1];
1711 return true;
1712 }
1713
1714 if (SingleLocElts.size() == 3 && SingleLocElts[0] == dwarf::DW_OP_constu) {
1715 if (SingleLocElts[2] == dwarf::DW_OP_plus) {
1716 Offset = SingleLocElts[1];
1717 return true;
1718 }
1719 if (SingleLocElts[2] == dwarf::DW_OP_minus) {
1720 Offset = -SingleLocElts[1];
1721 return true;
1722 }
1723 }
1724
1725 return false;
1726}
1727
1730 for (auto ExprOp : expr_ops())
1731 if (ExprOp.getOp() == dwarf::DW_OP_LLVM_arg)
1732 SeenOps.insert(ExprOp.getArg(0));
1733 for (uint64_t Idx = 0; Idx < N; ++Idx)
1734 if (!SeenOps.contains(Idx))
1735 return false;
1736 return true;
1737}
1738
1740 unsigned &AddrClass) {
1741 // FIXME: This seems fragile. Nothing that verifies that these elements
1742 // actually map to ops and not operands.
1743 auto SingleLocEltsOpt = Expr->getSingleLocationExpressionElements();
1744 if (!SingleLocEltsOpt)
1745 return nullptr;
1746 auto SingleLocElts = *SingleLocEltsOpt;
1747
1748 const unsigned PatternSize = 4;
1749 if (SingleLocElts.size() >= PatternSize &&
1750 SingleLocElts[PatternSize - 4] == dwarf::DW_OP_constu &&
1751 SingleLocElts[PatternSize - 2] == dwarf::DW_OP_swap &&
1752 SingleLocElts[PatternSize - 1] == dwarf::DW_OP_xderef) {
1753 AddrClass = SingleLocElts[PatternSize - 3];
1754
1755 if (SingleLocElts.size() == PatternSize)
1756 return nullptr;
1757 return DIExpression::get(
1758 Expr->getContext(),
1759 ArrayRef(&*SingleLocElts.begin(), SingleLocElts.size() - PatternSize));
1760 }
1761 return Expr;
1762}
1763
1765 int64_t Offset) {
1767 if (Flags & DIExpression::DerefBefore)
1768 Ops.push_back(dwarf::DW_OP_deref);
1769
1770 appendOffset(Ops, Offset);
1771 if (Flags & DIExpression::DerefAfter)
1772 Ops.push_back(dwarf::DW_OP_deref);
1773
1774 bool StackValue = Flags & DIExpression::StackValue;
1775 bool EntryValue = Flags & DIExpression::EntryValue;
1776
1777 return prependOpcodes(Expr, Ops, StackValue, EntryValue);
1778}
1779
1782 unsigned ArgNo, bool StackValue) {
1783 assert(Expr && "Can't add ops to this expression");
1784
1785 // Handle non-variadic intrinsics by prepending the opcodes.
1786 if (!any_of(Expr->expr_ops(),
1787 [](auto Op) { return Op.getOp() == dwarf::DW_OP_LLVM_arg; })) {
1788 assert(ArgNo == 0 &&
1789 "Location Index must be 0 for a non-variadic expression.");
1790 SmallVector<uint64_t, 8> NewOps(Ops.begin(), Ops.end());
1791 return DIExpression::prependOpcodes(Expr, NewOps, StackValue);
1792 }
1793
1795 for (auto Op : Expr->expr_ops()) {
1796 // A DW_OP_stack_value comes at the end, but before a DW_OP_LLVM_fragment.
1797 if (StackValue) {
1798 if (Op.getOp() == dwarf::DW_OP_stack_value)
1799 StackValue = false;
1800 else if (Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
1801 NewOps.push_back(dwarf::DW_OP_stack_value);
1802 StackValue = false;
1803 }
1804 }
1805 Op.appendToVector(NewOps);
1806 if (Op.getOp() == dwarf::DW_OP_LLVM_arg && Op.getArg(0) == ArgNo)
1807 NewOps.insert(NewOps.end(), Ops.begin(), Ops.end());
1808 }
1809 if (StackValue)
1810 NewOps.push_back(dwarf::DW_OP_stack_value);
1811
1812 return DIExpression::get(Expr->getContext(), NewOps);
1813}
1814
1816 uint64_t OldArg, uint64_t NewArg) {
1817 assert(Expr && "Can't replace args in this expression");
1818
1820
1821 for (auto Op : Expr->expr_ops()) {
1822 if (Op.getOp() != dwarf::DW_OP_LLVM_arg || Op.getArg(0) < OldArg) {
1823 Op.appendToVector(NewOps);
1824 continue;
1825 }
1827 uint64_t Arg = Op.getArg(0) == OldArg ? NewArg : Op.getArg(0);
1828 // OldArg has been deleted from the Op list, so decrement all indices
1829 // greater than it.
1830 if (Arg > OldArg)
1831 --Arg;
1832 NewOps.push_back(Arg);
1833 }
1834 return DIExpression::get(Expr->getContext(), NewOps);
1835}
1836
1839 bool StackValue, bool EntryValue) {
1840 assert(Expr && "Can't prepend ops to this expression");
1841
1842 if (EntryValue) {
1844 // Use a block size of 1 for the target register operand. The
1845 // DWARF backend currently cannot emit entry values with a block
1846 // size > 1.
1847 Ops.push_back(1);
1848 }
1849
1850 // If there are no ops to prepend, do not even add the DW_OP_stack_value.
1851 if (Ops.empty())
1852 StackValue = false;
1853 for (auto Op : Expr->expr_ops()) {
1854 // A DW_OP_stack_value comes at the end, but before a DW_OP_LLVM_fragment.
1855 if (StackValue) {
1856 if (Op.getOp() == dwarf::DW_OP_stack_value)
1857 StackValue = false;
1858 else if (Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
1859 Ops.push_back(dwarf::DW_OP_stack_value);
1860 StackValue = false;
1861 }
1862 }
1863 Op.appendToVector(Ops);
1864 }
1865 if (StackValue)
1866 Ops.push_back(dwarf::DW_OP_stack_value);
1867 return DIExpression::get(Expr->getContext(), Ops);
1868}
1869
1871 ArrayRef<uint64_t> Ops) {
1872 assert(Expr && !Ops.empty() && "Can't append ops to this expression");
1873
1874 // Copy Expr's current op list.
1876 for (auto Op : Expr->expr_ops()) {
1877 // Append new opcodes before DW_OP_{stack_value, LLVM_fragment}.
1878 if (Op.getOp() == dwarf::DW_OP_stack_value ||
1879 Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
1880 NewOps.append(Ops.begin(), Ops.end());
1881
1882 // Ensure that the new opcodes are only appended once.
1883 Ops = std::nullopt;
1884 }
1885 Op.appendToVector(NewOps);
1886 }
1887 NewOps.append(Ops.begin(), Ops.end());
1888 auto *result =
1889 DIExpression::get(Expr->getContext(), NewOps)->foldConstantMath();
1890 assert(result->isValid() && "concatenated expression is not valid");
1891 return result;
1892}
1893
1895 ArrayRef<uint64_t> Ops) {
1896 assert(Expr && !Ops.empty() && "Can't append ops to this expression");
1897 assert(std::none_of(expr_op_iterator(Ops.begin()),
1898 expr_op_iterator(Ops.end()),
1899 [](auto Op) {
1900 return Op.getOp() == dwarf::DW_OP_stack_value ||
1901 Op.getOp() == dwarf::DW_OP_LLVM_fragment;
1902 }) &&
1903 "Can't append this op");
1904
1905 // Append a DW_OP_deref after Expr's current op list if it's non-empty and
1906 // has no DW_OP_stack_value.
1907 //
1908 // Match .* DW_OP_stack_value (DW_OP_LLVM_fragment A B)?.
1909 std::optional<FragmentInfo> FI = Expr->getFragmentInfo();
1910 unsigned DropUntilStackValue = FI ? 3 : 0;
1911 ArrayRef<uint64_t> ExprOpsBeforeFragment =
1912 Expr->getElements().drop_back(DropUntilStackValue);
1913 bool NeedsDeref = (Expr->getNumElements() > DropUntilStackValue) &&
1914 (ExprOpsBeforeFragment.back() != dwarf::DW_OP_stack_value);
1915 bool NeedsStackValue = NeedsDeref || ExprOpsBeforeFragment.empty();
1916
1917 // Append a DW_OP_deref after Expr's current op list if needed, then append
1918 // the new ops, and finally ensure that a single DW_OP_stack_value is present.
1920 if (NeedsDeref)
1921 NewOps.push_back(dwarf::DW_OP_deref);
1922 NewOps.append(Ops.begin(), Ops.end());
1923 if (NeedsStackValue)
1924 NewOps.push_back(dwarf::DW_OP_stack_value);
1925 return DIExpression::append(Expr, NewOps);
1926}
1927
1928std::optional<DIExpression *> DIExpression::createFragmentExpression(
1929 const DIExpression *Expr, unsigned OffsetInBits, unsigned SizeInBits) {
1931 // Track whether it's safe to split the value at the top of the DWARF stack,
1932 // assuming that it'll be used as an implicit location value.
1933 bool CanSplitValue = true;
1934 // Copy over the expression, but leave off any trailing DW_OP_LLVM_fragment.
1935 if (Expr) {
1936 for (auto Op : Expr->expr_ops()) {
1937 switch (Op.getOp()) {
1938 default:
1939 break;
1940 case dwarf::DW_OP_shr:
1941 case dwarf::DW_OP_shra:
1942 case dwarf::DW_OP_shl:
1943 case dwarf::DW_OP_plus:
1944 case dwarf::DW_OP_plus_uconst:
1945 case dwarf::DW_OP_minus:
1946 // We can't safely split arithmetic or shift operations into multiple
1947 // fragments because we can't express carry-over between fragments.
1948 //
1949 // FIXME: We *could* preserve the lowest fragment of a constant offset
1950 // operation if the offset fits into SizeInBits.
1951 CanSplitValue = false;
1952 break;
1953 case dwarf::DW_OP_deref:
1954 case dwarf::DW_OP_deref_size:
1955 case dwarf::DW_OP_deref_type:
1956 case dwarf::DW_OP_xderef:
1957 case dwarf::DW_OP_xderef_size:
1958 case dwarf::DW_OP_xderef_type:
1959 // Preceeding arithmetic operations have been applied to compute an
1960 // address. It's okay to split the value loaded from that address.
1961 CanSplitValue = true;
1962 break;
1963 case dwarf::DW_OP_stack_value:
1964 // Bail if this expression computes a value that cannot be split.
1965 if (!CanSplitValue)
1966 return std::nullopt;
1967 break;
1969 // Make the new offset point into the existing fragment.
1970 uint64_t FragmentOffsetInBits = Op.getArg(0);
1971 uint64_t FragmentSizeInBits = Op.getArg(1);
1972 (void)FragmentSizeInBits;
1973 assert((OffsetInBits + SizeInBits <= FragmentSizeInBits) &&
1974 "new fragment outside of original fragment");
1975 OffsetInBits += FragmentOffsetInBits;
1976 continue;
1977 }
1978 }
1979 Op.appendToVector(Ops);
1980 }
1981 }
1982 assert((!Expr->isImplicit() || CanSplitValue) && "Expr can't be split");
1983 assert(Expr && "Unknown DIExpression");
1985 Ops.push_back(OffsetInBits);
1986 Ops.push_back(SizeInBits);
1987 return DIExpression::get(Expr->getContext(), Ops);
1988}
1989
1990std::pair<DIExpression *, const ConstantInt *>
1992 // Copy the APInt so we can modify it.
1993 APInt NewInt = CI->getValue();
1995
1996 // Fold operators only at the beginning of the expression.
1997 bool First = true;
1998 bool Changed = false;
1999 for (auto Op : expr_ops()) {
2000 switch (Op.getOp()) {
2001 default:
2002 // We fold only the leading part of the expression; if we get to a part
2003 // that we're going to copy unchanged, and haven't done any folding,
2004 // then the entire expression is unchanged and we can return early.
2005 if (!Changed)
2006 return {this, CI};
2007 First = false;
2008 break;
2010 if (!First)
2011 break;
2012 Changed = true;
2013 if (Op.getArg(1) == dwarf::DW_ATE_signed)
2014 NewInt = NewInt.sextOrTrunc(Op.getArg(0));
2015 else {
2016 assert(Op.getArg(1) == dwarf::DW_ATE_unsigned && "Unexpected operand");
2017 NewInt = NewInt.zextOrTrunc(Op.getArg(0));
2018 }
2019 continue;
2020 }
2021 Op.appendToVector(Ops);
2022 }
2023 if (!Changed)
2024 return {this, CI};
2025 return {DIExpression::get(getContext(), Ops),
2026 ConstantInt::get(getContext(), NewInt)};
2027}
2028
2030 uint64_t Result = 0;
2031 for (auto ExprOp : expr_ops())
2032 if (ExprOp.getOp() == dwarf::DW_OP_LLVM_arg)
2033 Result = std::max(Result, ExprOp.getArg(0) + 1);
2034 assert(hasAllLocationOps(Result) &&
2035 "Expression is missing one or more location operands.");
2036 return Result;
2037}
2038
2039std::optional<DIExpression::SignedOrUnsignedConstant>
2041
2042 // Recognize signed and unsigned constants.
2043 // An signed constants can be represented as DW_OP_consts C DW_OP_stack_value
2044 // (DW_OP_LLVM_fragment of Len).
2045 // An unsigned constant can be represented as
2046 // DW_OP_constu C DW_OP_stack_value (DW_OP_LLVM_fragment of Len).
2047
2048 if ((getNumElements() != 2 && getNumElements() != 3 &&
2049 getNumElements() != 6) ||
2050 (getElement(0) != dwarf::DW_OP_consts &&
2051 getElement(0) != dwarf::DW_OP_constu))
2052 return std::nullopt;
2053
2054 if (getNumElements() == 2 && getElement(0) == dwarf::DW_OP_consts)
2056
2057 if ((getNumElements() == 3 && getElement(2) != dwarf::DW_OP_stack_value) ||
2058 (getNumElements() == 6 && (getElement(2) != dwarf::DW_OP_stack_value ||
2060 return std::nullopt;
2061 return getElement(0) == dwarf::DW_OP_constu
2064}
2065
2066DIExpression::ExtOps DIExpression::getExtOps(unsigned FromSize, unsigned ToSize,
2067 bool Signed) {
2068 dwarf::TypeKind TK = Signed ? dwarf::DW_ATE_signed : dwarf::DW_ATE_unsigned;
2070 dwarf::DW_OP_LLVM_convert, ToSize, TK}};
2071 return Ops;
2072}
2073
2075 unsigned FromSize, unsigned ToSize,
2076 bool Signed) {
2077 return appendToStack(Expr, getExtOps(FromSize, ToSize, Signed));
2078}
2079
2081DIGlobalVariableExpression::getImpl(LLVMContext &Context, Metadata *Variable,
2083 bool ShouldCreate) {
2085 Metadata *Ops[] = {Variable, Expression};
2087}
2088DIObjCProperty::DIObjCProperty(LLVMContext &C, StorageType Storage,
2089 unsigned Line, unsigned Attributes,
2091 : DINode(C, DIObjCPropertyKind, Storage, dwarf::DW_TAG_APPLE_property, Ops),
2093
2094DIObjCProperty *DIObjCProperty::getImpl(
2095 LLVMContext &Context, MDString *Name, Metadata *File, unsigned Line,
2096 MDString *GetterName, MDString *SetterName, unsigned Attributes,
2097 Metadata *Type, StorageType Storage, bool ShouldCreate) {
2098 assert(isCanonical(Name) && "Expected canonical MDString");
2099 assert(isCanonical(GetterName) && "Expected canonical MDString");
2100 assert(isCanonical(SetterName) && "Expected canonical MDString");
2102 SetterName, Attributes, Type));
2103 Metadata *Ops[] = {Name, File, GetterName, SetterName, Type};
2104 DEFINE_GETIMPL_STORE(DIObjCProperty, (Line, Attributes), Ops);
2105}
2106
2107DIImportedEntity *DIImportedEntity::getImpl(LLVMContext &Context, unsigned Tag,
2108 Metadata *Scope, Metadata *Entity,
2109 Metadata *File, unsigned Line,
2110 MDString *Name, Metadata *Elements,
2111 StorageType Storage,
2112 bool ShouldCreate) {
2113 assert(isCanonical(Name) && "Expected canonical MDString");
2115 (Tag, Scope, Entity, File, Line, Name, Elements));
2116 Metadata *Ops[] = {Scope, Entity, Name, File, Elements};
2118}
2119
2120DIMacro *DIMacro::getImpl(LLVMContext &Context, unsigned MIType, unsigned Line,
2121 MDString *Name, MDString *Value, StorageType Storage,
2122 bool ShouldCreate) {
2123 assert(isCanonical(Name) && "Expected canonical MDString");
2125 Metadata *Ops[] = {Name, Value};
2127}
2128
2129DIMacroFile *DIMacroFile::getImpl(LLVMContext &Context, unsigned MIType,
2130 unsigned Line, Metadata *File,
2131 Metadata *Elements, StorageType Storage,
2132 bool ShouldCreate) {
2134 Metadata *Ops[] = {File, Elements};
2136}
2137
2140 auto ExistingIt = Context.pImpl->DIArgLists.find_as(DIArgListKeyInfo(Args));
2141 if (ExistingIt != Context.pImpl->DIArgLists.end())
2142 return *ExistingIt;
2143 DIArgList *NewArgList = new DIArgList(Context, Args);
2144 Context.pImpl->DIArgLists.insert(NewArgList);
2145 return NewArgList;
2146}
2147
2149 ValueAsMetadata **OldVMPtr = static_cast<ValueAsMetadata **>(Ref);
2150 assert((!New || isa<ValueAsMetadata>(New)) &&
2151 "DIArgList must be passed a ValueAsMetadata");
2152 untrack();
2153 // We need to update the set storage once the Args are updated since they
2154 // form the key to the DIArgLists store.
2155 getContext().pImpl->DIArgLists.erase(this);
2156 ValueAsMetadata *NewVM = cast_or_null<ValueAsMetadata>(New);
2157 for (ValueAsMetadata *&VM : Args) {
2158 if (&VM == OldVMPtr) {
2159 if (NewVM)
2160 VM = NewVM;
2161 else
2162 VM = ValueAsMetadata::get(PoisonValue::get(VM->getValue()->getType()));
2163 }
2164 }
2165 // We've changed the contents of this DIArgList, and the set storage may
2166 // already contain a DIArgList with our new set of args; if it does, then we
2167 // must RAUW this with the existing DIArgList, otherwise we simply insert this
2168 // back into the set storage.
2169 DIArgList *ExistingArgList = getUniqued(getContext().pImpl->DIArgLists, this);
2170 if (ExistingArgList) {
2171 replaceAllUsesWith(ExistingArgList);
2172 // Clear this here so we don't try to untrack in the destructor.
2173 Args.clear();
2174 delete this;
2175 return;
2176 }
2177 getContext().pImpl->DIArgLists.insert(this);
2178 track();
2179}
2180void DIArgList::track() {
2181 for (ValueAsMetadata *&VAM : Args)
2182 if (VAM)
2183 MetadataTracking::track(&VAM, *VAM, *this);
2184}
2185void DIArgList::untrack() {
2186 for (ValueAsMetadata *&VAM : Args)
2187 if (VAM)
2188 MetadataTracking::untrack(&VAM, *VAM);
2189}
2190void DIArgList::dropAllReferences(bool Untrack) {
2191 if (Untrack)
2192 untrack();
2193 Args.clear();
2194 ReplaceableMetadataImpl::resolveAllUses(/* ResolveUsers */ false);
2195}
static const LLT S1
AMDGPU Kernel Attributes
static cl::opt< ITMode > IT(cl::desc("IT block support"), cl::Hidden, cl::init(DefaultIT), cl::values(clEnumValN(DefaultIT, "arm-default-it", "Generate any type of IT block"), clEnumValN(RestrictedIT, "arm-restrict-it", "Disallow complex IT blocks")))
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
Analysis containing CSE Info
Definition: CSEInfo.cpp:27
static DISubprogram * getSubprogram(bool IsDistinct, Ts &&...Args)
Definition: DIBuilder.cpp:849
Returns the sub type a function will return at a given Idx Should correspond to the result type of an ExtractValue instruction executed with just that one unsigned Idx
static const char * ChecksumKindName[DIFile::CSK_Last]
#define DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(CLASS, OPS)
static void adjustColumn(unsigned &Column)
#define DEFINE_GETIMPL_STORE_N(CLASS, ARGS, OPS, NUM_OPS)
static bool isCanonical(const MDString *S)
#define DEFINE_GETIMPL_STORE(CLASS, ARGS, OPS)
#define DEFINE_GETIMPL_LOOKUP(CLASS, ARGS)
#define DEFINE_GETIMPL_STORE_NO_OPS(CLASS, ARGS)
static RegisterPass< DebugifyFunctionPass > DF("debugify-function", "Attach debug info to a function")
static unsigned encodingBits(unsigned C)
Definition: Discriminator.h:49
static unsigned encodeComponent(unsigned C)
Definition: Discriminator.h:45
static unsigned getNextComponentInDiscriminator(unsigned D)
Returns the next component stored in discriminator.
Definition: Discriminator.h:38
static unsigned getUnsignedFromPrefixEncoding(unsigned U)
Reverse transformation as getPrefixEncodingFromUnsigned.
Definition: Discriminator.h:30
This file contains constants used for implementing Dwarf debug support.
std::string Name
uint64_t Size
bool End
Definition: ELF_riscv.cpp:480
#define F(x, y, z)
Definition: MD5.cpp:55
#define I(x, y, z)
Definition: MD5.cpp:58
static DebugLoc getDebugLoc(MachineBasicBlock::instr_iterator FirstMI, MachineBasicBlock::instr_iterator LastMI)
Return the first found DebugLoc that has a DILocation, given a range of instructions.
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This file defines the SmallPtrSet class.
This file implements the StringSwitch template, which mimics a switch() statement whose cases are str...
support::ulittle16_t & Lo
Definition: aarch32.cpp:206
Class for arbitrary precision integers.
Definition: APInt.h:77
APInt zextOrTrunc(unsigned width) const
Zero extend or truncate to width.
Definition: APInt.cpp:1002
APInt sextOrTrunc(unsigned width) const
Sign extend or truncate to width.
Definition: APInt.cpp:1010
Annotations lets you mark points and ranges inside source code, for tests:
Definition: Annotations.h:53
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
const T & back() const
back - Get the last element.
Definition: ArrayRef.h:174
ArrayRef< T > drop_front(size_t N=1) const
Drop the first N elements of the array.
Definition: ArrayRef.h:204
iterator end() const
Definition: ArrayRef.h:154
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:165
ArrayRef< T > drop_back(size_t N=1) const
Drop the last N elements of the array.
Definition: ArrayRef.h:210
iterator begin() const
Definition: ArrayRef.h:153
bool empty() const
empty - Check if the array is empty.
Definition: ArrayRef.h:160
static ConstantAsMetadata * get(Constant *C)
Definition: Metadata.h:528
This is the shared class of boolean and integer constants.
Definition: Constants.h:81
static ConstantInt * getSigned(IntegerType *Ty, int64_t V)
Return a ConstantInt with the specified value for the specified type.
Definition: Constants.h:124
const APInt & getValue() const
Return the constant as an APInt value reference.
Definition: Constants.h:146
This is an important base class in LLVM.
Definition: Constant.h:41
List of ValueAsMetadata, to be used as an argument to a dbg.value intrinsic.
void handleChangedOperand(void *Ref, Metadata *New)
static DIArgList * get(LLVMContext &Context, ArrayRef< ValueAsMetadata * > Args)
Assignment ID.
Basic type, like 'int' or 'float'.
unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t unsigned DIFlags Flags
unsigned StringRef uint64_t SizeInBits
std::optional< Signedness > getSignedness() const
Return the signedness of this type, or std::nullopt if this type is neither signed nor unsigned.
unsigned getEncoding() const
unsigned StringRef Name
unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t AlignInBits
Debug common block.
Metadata Metadata * Decl
Metadata Metadata MDString Metadata unsigned LineNo
Metadata Metadata MDString * Name
Metadata Metadata MDString Metadata * File
static const char * nameTableKindString(DebugNameTableKind PK)
static const char * emissionKindString(DebugEmissionKind EK)
DebugEmissionKind getEmissionKind() const
unsigned Metadata * File
unsigned Metadata MDString bool MDString unsigned MDString unsigned Metadata Metadata Metadata Metadata Metadata * Macros
unsigned Metadata MDString bool MDString * Flags
unsigned Metadata MDString bool MDString unsigned MDString unsigned Metadata * EnumTypes
unsigned Metadata MDString bool MDString unsigned MDString unsigned Metadata Metadata * RetainedTypes
DebugNameTableKind getNameTableKind() const
unsigned Metadata MDString bool MDString unsigned MDString unsigned Metadata Metadata Metadata * GlobalVariables
unsigned Metadata MDString bool MDString unsigned MDString unsigned Metadata Metadata Metadata Metadata Metadata uint64_t bool bool unsigned bool MDString MDString * SDK
unsigned Metadata MDString * Producer
unsigned Metadata MDString bool MDString unsigned MDString unsigned Metadata Metadata Metadata Metadata Metadata uint64_t bool bool unsigned bool MDString * SysRoot
unsigned Metadata MDString bool MDString unsigned MDString * SplitDebugFilename
unsigned Metadata MDString bool MDString unsigned MDString unsigned Metadata Metadata Metadata Metadata * ImportedEntities
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t AlignInBits
unsigned MDString Metadata unsigned Line
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata * Elements
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned Metadata Metadata * TemplateParams
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned Metadata Metadata MDString Metadata Metadata Metadata Metadata Metadata * Rank
static DICompositeType * getODRTypeIfExists(LLVMContext &Context, MDString &Identifier)
unsigned MDString * Name
static DICompositeType * buildODRType(LLVMContext &Context, MDString &Identifier, unsigned Tag, MDString *Name, Metadata *File, unsigned Line, Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags, Metadata *Elements, unsigned RuntimeLang, Metadata *VTableHolder, Metadata *TemplateParams, Metadata *Discriminator, Metadata *DataLocation, Metadata *Associated, Metadata *Allocated, Metadata *Rank, Metadata *Annotations)
Build a DICompositeType with the given ODR identifier.
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t OffsetInBits
unsigned MDString Metadata unsigned Metadata * Scope
unsigned MDString Metadata * File
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned Metadata Metadata MDString Metadata Metadata Metadata Metadata * Allocated
unsigned MDString Metadata unsigned Metadata Metadata * BaseType
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Flags
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned Metadata Metadata MDString Metadata * Discriminator
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned Metadata Metadata MDString Metadata Metadata * DataLocation
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned Metadata Metadata MDString * Identifier
unsigned MDString Metadata unsigned Metadata Metadata uint64_t SizeInBits
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned Metadata Metadata MDString Metadata Metadata Metadata * Associated
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned Metadata * VTableHolder
unsigned StringRef DIFile unsigned DIScope DIType * BaseType
unsigned StringRef DIFile unsigned DIScope DIType uint64_t uint32_t uint64_t std::optional< unsigned > std::optional< PtrAuthData > DIFlags Metadata * ExtraData
unsigned StringRef DIFile unsigned DIScope DIType uint64_t SizeInBits
Metadata * getExtraData() const
Get extra data associated with this derived type.
unsigned StringRef DIFile * File
unsigned StringRef DIFile unsigned DIScope DIType uint64_t uint32_t uint64_t OffsetInBits
unsigned StringRef DIFile unsigned DIScope DIType uint64_t uint32_t AlignInBits
unsigned StringRef DIFile unsigned DIScope * Scope
DIType * getClassType() const
Get casted version of extra data.
Constant * getConstant() const
Constant * getStorageOffsetInBits() const
Constant * getDiscriminantValue() const
unsigned StringRef Name
uint32_t getVBPtrOffset() const
unsigned StringRef DIFile unsigned DIScope DIType uint64_t uint32_t uint64_t std::optional< unsigned > std::optional< PtrAuthData > DIFlags Flags
unsigned StringRef DIFile unsigned Line
Enumeration value.
int64_t bool MDString * Name
unsigned getSize() const
Return the size of the operand.
uint64_t getOp() const
Get the operand code.
An iterator for expression operands.
DWARF expression.
element_iterator elements_end() const
bool isEntryValue() const
Check if the expression consists of exactly one entry value operand.
iterator_range< expr_op_iterator > expr_ops() const
static DIExpression * append(const DIExpression *Expr, ArrayRef< uint64_t > Ops)
Append the opcodes Ops to DIExpr.
std::array< uint64_t, 6 > ExtOps
unsigned getNumElements() const
static ExtOps getExtOps(unsigned FromSize, unsigned ToSize, bool Signed)
Returns the ops for a zero- or sign-extension in a DIExpression.
expr_op_iterator expr_op_begin() const
Visit the elements via ExprOperand wrappers.
bool extractIfOffset(int64_t &Offset) const
If this is a constant offset, extract it.
static void appendOffset(SmallVectorImpl< uint64_t > &Ops, int64_t Offset)
Append Ops with operations to apply the Offset.
bool startsWithDeref() const
Return whether the first element a DW_OP_deref.
static bool isEqualExpression(const DIExpression *FirstExpr, bool FirstIndirect, const DIExpression *SecondExpr, bool SecondIndirect)
Determines whether two debug values should produce equivalent DWARF expressions, using their DIExpres...
expr_op_iterator expr_op_end() const
bool isImplicit() const
Return whether this is an implicit location description.
element_iterator elements_begin() const
bool hasAllLocationOps(unsigned N) const
Returns true iff this DIExpression contains at least one instance of DW_OP_LLVM_arg,...
std::optional< FragmentInfo > getFragmentInfo() const
Retrieve the details of this fragment expression.
static DIExpression * appendOpsToArg(const DIExpression *Expr, ArrayRef< uint64_t > Ops, unsigned ArgNo, bool StackValue=false)
Create a copy of Expr by appending the given list of Ops to each instance of the operand DW_OP_LLVM_a...
bool isComplex() const
Return whether the location is computed on the expression stack, meaning it cannot be a simple regist...
static std::optional< FragmentInfo > getFragmentInfo(expr_op_iterator Start, expr_op_iterator End)
Retrieve the details of this fragment expression.
static std::optional< const DIExpression * > convertToNonVariadicExpression(const DIExpression *Expr)
If Expr is a valid single-location expression, i.e.
std::pair< DIExpression *, const ConstantInt * > constantFold(const ConstantInt *CI)
Try to shorten an expression with an initial constant operand.
bool isDeref() const
Return whether there is exactly one operator and it is a DW_OP_deref;.
static const DIExpression * convertToVariadicExpression(const DIExpression *Expr)
If Expr is a non-variadic expression (i.e.
uint64_t getNumLocationOperands() const
Return the number of unique location operands referred to (via DW_OP_LLVM_arg) in this expression; th...
ArrayRef< uint64_t > getElements() const
static DIExpression * replaceArg(const DIExpression *Expr, uint64_t OldArg, uint64_t NewArg)
Create a copy of Expr with each instance of DW_OP_LLVM_arg, \p OldArg replaced with DW_OP_LLVM_arg,...
static void canonicalizeExpressionOps(SmallVectorImpl< uint64_t > &Ops, const DIExpression *Expr, bool IsIndirect)
Inserts the elements of Expr into Ops modified to a canonical form, which uses DW_OP_LLVM_arg (i....
uint64_t getElement(unsigned I) const
static std::optional< DIExpression * > createFragmentExpression(const DIExpression *Expr, unsigned OffsetInBits, unsigned SizeInBits)
Create a DIExpression to describe one part of an aggregate variable that is fragmented across multipl...
static const DIExpression * convertToUndefExpression(const DIExpression *Expr)
Removes all elements from Expr that do not apply to an undef debug value, which includes every operat...
static DIExpression * prepend(const DIExpression *Expr, uint8_t Flags, int64_t Offset=0)
Prepend DIExpr with a deref and offset operation and optionally turn it into a stack value or/and an ...
static DIExpression * appendToStack(const DIExpression *Expr, ArrayRef< uint64_t > Ops)
Convert DIExpr into a stack value if it isn't one already by appending DW_OP_deref if needed,...
static DIExpression * appendExt(const DIExpression *Expr, unsigned FromSize, unsigned ToSize, bool Signed)
Append a zero- or sign-extension to Expr.
std::optional< ArrayRef< uint64_t > > getSingleLocationExpressionElements() const
Returns a reference to the elements contained in this expression, skipping past the leading DW_OP_LLV...
bool isSingleLocationExpression() const
Return whether the evaluated expression makes use of a single location at the start of the expression...
std::optional< SignedOrUnsignedConstant > isConstant() const
Determine whether this represents a constant value, if so.
static const DIExpression * extractAddressClass(const DIExpression *Expr, unsigned &AddrClass)
Checks if the last 4 elements of the expression are DW_OP_constu <DWARF Address Space> DW_OP_swap DW_...
static DIExpression * prependOpcodes(const DIExpression *Expr, SmallVectorImpl< uint64_t > &Ops, bool StackValue=false, bool EntryValue=false)
Prepend DIExpr with the given opcodes and optionally turn it into a stack value.
MDString MDString * Directory
MDString * Filename
static std::optional< ChecksumKind > getChecksumKind(StringRef CSKindStr)
MDString MDString std::optional< ChecksumInfo< MDString * > > CS
Metadata * getRawLowerBound() const
Metadata * getRawCountNode() const
Metadata * getRawStride() const
BoundType getLowerBound() const
Metadata * getRawUpperBound() const
BoundType getUpperBound() const
PointerUnion< DIVariable *, DIExpression * > BoundType
A pair of DIGlobalVariable and DIExpression.
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata * TemplateParams
Metadata MDString MDString Metadata unsigned Line
Metadata MDString MDString Metadata unsigned Metadata * Type
Metadata MDString * Name
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata * StaticDataMemberDeclaration
Metadata MDString MDString * LinkageName
Metadata MDString MDString Metadata * File
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t AlignInBits
An imported module (C++ using directive or similar).
unsigned Metadata Metadata * Entity
unsigned Metadata Metadata Metadata unsigned Line
unsigned Metadata Metadata Metadata unsigned MDString * Name
unsigned Metadata Metadata Metadata * File
unsigned Metadata * Scope
Metadata MDString Metadata unsigned Line
Metadata MDString * Name
Metadata MDString Metadata * File
DILexicalBlockBase(LLVMContext &C, unsigned ID, StorageType Storage, ArrayRef< Metadata * > Ops)
Metadata Metadata unsigned Discriminator
Metadata Metadata * File
Debug lexical block.
Metadata Metadata unsigned Line
Metadata Metadata * File
A scope for locals.
DISubprogram * getSubprogram() const
Get the subprogram for this scope.
DILocalScope * getNonLexicalBlockFileScope() const
Get the first non DILexicalBlockFile scope of this scope.
static DILocalScope * cloneScopeForSubprogram(DILocalScope &RootScope, DISubprogram &NewSP, LLVMContext &Ctx, DenseMap< const MDNode *, MDNode * > &Cache)
Traverses the scope chain rooted at RootScope until it hits a Subprogram, recreating the chain with "...
Metadata MDString Metadata unsigned Metadata * Type
Metadata MDString Metadata * File
Metadata MDString * Name
Metadata MDString Metadata unsigned Line
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t AlignInBits
Debug location.
unsigned unsigned DILocalScope * Scope
static DILocation * getMergedLocations(ArrayRef< DILocation * > Locs)
Try to combine the vector of locations passed as input in a single one.
static std::optional< unsigned > encodeDiscriminator(unsigned BD, unsigned DF, unsigned CI)
Raw encoding of the discriminator.
unsigned unsigned DILocalScope DILocation bool ImplicitCode
static void decodeDiscriminator(unsigned D, unsigned &BD, unsigned &DF, unsigned &CI)
Raw decoder for values in an encoded discriminator D.
static DILocation * getMergedLocation(DILocation *LocA, DILocation *LocB)
When two instructions are combined into a single instruction we also need to combine the original loc...
unsigned unsigned Column
unsigned unsigned DILocalScope DILocation * InlinedAt
unsigned unsigned Metadata * File
unsigned unsigned Line
unsigned unsigned Metadata Metadata * Elements
unsigned unsigned MDString * Name
unsigned unsigned Line
Represents a module in the programming language, for example, a Clang module, or a Fortran module.
Metadata Metadata * Scope
Metadata Metadata MDString * Name
Metadata Metadata MDString MDString MDString MDString * APINotesFile
Metadata Metadata MDString MDString MDString * IncludePath
Metadata Metadata MDString MDString * ConfigurationMacros
Metadata Metadata MDString MDString MDString MDString unsigned LineNo
Debug lexical block.
Metadata MDString bool ExportSymbols
Metadata MDString * Name
Tagged DWARF-like metadata node.
dwarf::Tag getTag() const
static DIFlags getFlag(StringRef Flag)
static DIFlags splitFlags(DIFlags Flags, SmallVectorImpl< DIFlags > &SplitFlags)
Split up a flags bitfield.
static StringRef getFlagString(DIFlags Flag)
DIFlags
Debug info flags.
MDString Metadata * File
MDString Metadata unsigned MDString * GetterName
MDString Metadata unsigned MDString MDString * SetterName
Base class for scope-like contexts.
StringRef getName() const
DIScope * getScope() const
String type, Fortran CHARACTER(n)
unsigned MDString * Name
unsigned MDString Metadata Metadata Metadata uint64_t SizeInBits
unsigned MDString Metadata Metadata Metadata uint64_t uint32_t AlignInBits
unsigned MDString Metadata Metadata Metadata * StringLocationExp
unsigned MDString Metadata Metadata * StringLengthExp
unsigned MDString Metadata * StringLength
Subprogram description.
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags DISPFlags Metadata * Unit
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags DISPFlags Metadata Metadata Metadata Metadata Metadata Metadata * Annotations
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata * ContainingType
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags DISPFlags Metadata Metadata * TemplateParams
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags DISPFlags Metadata Metadata Metadata * Declaration
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags DISPFlags Metadata Metadata Metadata Metadata Metadata Metadata MDString * TargetFuncName
static DISPFlags toSPFlags(bool IsLocalToUnit, bool IsDefinition, bool IsOptimized, unsigned Virtuality=SPFlagNonvirtual, bool IsMainSubprogram=false)
Metadata MDString * Name
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags DISPFlags Metadata Metadata Metadata Metadata Metadata * ThrownTypes
static DISPFlags getFlag(StringRef Flag)
Metadata MDString MDString Metadata * File
static DISPFlags splitFlags(DISPFlags Flags, SmallVectorImpl< DISPFlags > &SplitFlags)
Split up a flags bitfield for easier printing.
Metadata MDString MDString * LinkageName
static StringRef getFlagString(DISPFlags Flag)
Metadata MDString MDString Metadata unsigned Metadata * Type
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags DISPFlags Metadata Metadata Metadata Metadata * RetainedNodes
DISPFlags
Debug info subprogram flags.
Array subrange.
BoundType getUpperBound() const
BoundType getStride() const
BoundType getLowerBound() const
BoundType getCount() const
Type array for a subprogram.
DIFlags uint8_t Metadata * TypeArray
Base class for template parameters.
unsigned MDString Metadata * Type
Base class for types.
bool isBitField() const
bool isStaticMember() const
uint32_t getAlignInBits() const
std::optional< uint64_t > getSizeInBits() const
Determines the size of the variable's type.
Metadata * getRawType() const
DIVariable(LLVMContext &C, unsigned ID, StorageType Storage, signed Line, ArrayRef< Metadata * > Ops, uint32_t AlignInBits=0)
This class represents an Operation in the Expression.
This is the common base class for debug info intrinsics for variables.
Record of a variable value-assignment, aka a non instruction representation of the dbg....
DebugVariableAggregate(const DbgVariableIntrinsic *DVI)
Identifies a unique instance of a variable.
DebugVariable(const DbgVariableIntrinsic *DII)
iterator find(const_arg_type_t< KeyT > Val)
Definition: DenseMap.h:155
std::pair< iterator, bool > try_emplace(KeyT &&Key, Ts &&... Args)
Definition: DenseMap.h:235
iterator end()
Definition: DenseMap.h:84
Class representing an expression and its matching format.
Generic tagged DWARF-like metadata node.
dwarf::Tag getTag() const
unsigned MDString * Header
unsigned MDString ArrayRef< Metadata * > DwarfOps
DenseSet< DIArgList *, DIArgListInfo > DIArgLists
std::optional< DenseMap< const MDString *, DICompositeType * > > DITypeMap
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:67
bool isODRUniquingDebugTypes() const
Whether there is a string map for uniquing debug info identifiers across the context.
LLVMContextImpl *const pImpl
Definition: LLVMContext.h:69
Metadata node.
Definition: Metadata.h:1067
friend class DIAssignID
Definition: Metadata.h:1070
static MDTuple * getDistinct(LLVMContext &Context, ArrayRef< Metadata * > MDs)
Definition: Metadata.h:1549
static MDTuple * get(LLVMContext &Context, ArrayRef< Metadata * > MDs)
Definition: Metadata.h:1541
TempMDNode clone() const
Create a (temporary) clone of this.
Definition: Metadata.cpp:661
static T * storeImpl(T *N, StorageType Storage, StoreT &Store)
Definition: MetadataImpl.h:42
LLVMContext & getContext() const
Definition: Metadata.h:1231
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * > replaceWithUniqued(std::unique_ptr< T, TempMDNodeDeleter > N)
Replace a temporary node with a uniqued one.
Definition: Metadata.h:1299
A single uniqued string.
Definition: Metadata.h:720
StringRef getString() const
Definition: Metadata.cpp:610
static void untrack(Metadata *&MD)
Stop tracking a reference to metadata.
Definition: Metadata.h:349
static bool track(Metadata *&MD)
Track the reference to metadata.
Definition: Metadata.h:315
Root of the metadata hierarchy.
Definition: Metadata.h:62
StorageType
Active type of storage.
Definition: Metadata.h:70
unsigned short SubclassData16
Definition: Metadata.h:76
unsigned SubclassData32
Definition: Metadata.h:77
unsigned char Storage
Storage flag for non-uniqued, otherwise unowned, metadata.
Definition: Metadata.h:73
unsigned char SubclassData1
Definition: Metadata.h:75
A discriminated union of two or more pointer types, with the discriminator in the low bit of the poin...
Definition: PointerUnion.h:118
static PoisonValue * get(Type *T)
Static factory methods - Return an 'poison' object of the specified type.
Definition: Constants.cpp:1814
void replaceAllUsesWith(Metadata *MD)
Replace all uses of this with MD.
Definition: Metadata.cpp:361
LLVMContext & getContext() const
Definition: Metadata.h:400
void resolveAllUses(bool ResolveUsers=true)
Resolve all uses of this.
Definition: Metadata.cpp:414
Implements a dense probed hash-table based set with some number of buckets stored inline.
Definition: DenseSet.h:290
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
Definition: SmallPtrSet.h:427
bool empty() const
Definition: SmallVector.h:94
size_t size() const
Definition: SmallVector.h:91
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: SmallVector.h:586
void reserve(size_type N)
Definition: SmallVector.h:676
void append(ItTy in_start, ItTy in_end)
Add the specified range to the end of the SmallVector.
Definition: SmallVector.h:696
iterator insert(iterator I, T &&Elt)
Definition: SmallVector.h:818
void push_back(const T &Elt)
Definition: SmallVector.h:426
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1209
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
constexpr bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:134
A switch()-like statement whose cases are string literals.
Definition: StringSwitch.h:44
StringSwitch & Case(StringLiteral S, T Value)
Definition: StringSwitch.h:69
R Default(T Value)
Definition: StringSwitch.h:182
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
static IntegerType * getInt64Ty(LLVMContext &C)
Value wrapper in the Metadata hierarchy.
Definition: Metadata.h:450
static ValueAsMetadata * get(Value *V)
Definition: Metadata.cpp:495
LLVM Value Representation.
Definition: Value.h:74
std::pair< iterator, bool > insert(const ValueT &V)
Definition: DenseSet.h:206
bool contains(const_arg_type_t< ValueT > V) const
Check if the set contains the given element.
Definition: DenseSet.h:185
constexpr char Args[]
Key for Kernel::Metadata::mArgs.
@ C
The default llvm calling convention, compatible with C.
Definition: CallingConv.h:34
@ DW_OP_LLVM_entry_value
Only used in LLVM metadata.
Definition: Dwarf.h:145
@ DW_OP_LLVM_implicit_pointer
Only used in LLVM metadata.
Definition: Dwarf.h:146
@ DW_OP_LLVM_extract_bits_zext
Only used in LLVM metadata.
Definition: Dwarf.h:149
@ DW_OP_LLVM_tag_offset
Only used in LLVM metadata.
Definition: Dwarf.h:144
@ DW_OP_LLVM_fragment
Only used in LLVM metadata.
Definition: Dwarf.h:142
@ DW_OP_LLVM_arg
Only used in LLVM metadata.
Definition: Dwarf.h:147
@ DW_OP_LLVM_convert
Only used in LLVM metadata.
Definition: Dwarf.h:143
@ DW_OP_LLVM_extract_bits_sext
Only used in LLVM metadata.
Definition: Dwarf.h:148
SourceLanguage
Definition: Dwarf.h:207
@ DW_VIRTUALITY_max
Definition: Dwarf.h:198
@ NameTableKind
Definition: LLToken.h:484
@ EmissionKind
Definition: LLToken.h:483
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
auto drop_begin(T &&RangeOrContainer, size_t N=1)
Return a range covering RangeOrContainer with the first N elements excluded.
Definition: STLExtras.h:329
@ Offset
Definition: DWP.cpp:456
static T * getUniqued(DenseSet< T *, InfoT > &Store, const typename InfoT::KeyTy &Key)
Definition: MetadataImpl.h:22
cl::opt< bool > EnableFSDiscriminator
bool any_of(R &&range, UnaryPredicate P)
Provide wrappers to std::any_of which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1729
auto reverse(ContainerTy &&C)
Definition: STLExtras.h:419
bool none_of(R &&Range, UnaryPredicate P)
Provide wrappers to std::none_of which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1736
@ Ref
The access may reference the value stored in memory.
@ First
Helpers to iterate all locations in the MemoryEffectsBase class.
Implement std::hash so that hash_code can be used in STL containers.
Definition: BitVector.h:858
#define N
Holds the characteristics of one fragment of a larger variable.
A single checksum, represented by a Kind and a Value (a string).