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
13#include "llvm/IR/DebugInfoMetadata.h"
14#include "LLVMContextImpl.h"
15#include "MetadataImpl.h"
16#include "llvm/ADT/SetVector.h"
17#include "llvm/ADT/StringSwitch.h"
18#include "llvm/BinaryFormat/Dwarf.h"
19#include "llvm/IR/DebugProgramInstruction.h"
20#include "llvm/IR/Function.h"
21#include "llvm/IR/IntrinsicInst.h"
22#include "llvm/IR/Type.h"
23#include "llvm/IR/Value.h"
24#include "llvm/Support/CommandLine.h"
25#include "llvm/Support/Compiler.h"
26
27#include <numeric>
28#include <optional>
29
30using namespace llvm;
31
32namespace llvm {
33// Use FS-AFDO discriminator.
34cl::opt<bool> EnableFSDiscriminator(
35 "enable-fs-discriminator", cl::Hidden,
36 cl::desc("Enable adding flow sensitive discriminators"));
37
38// When true, preserves line and column number by picking one of the merged
39// location info in a deterministic manner to assist sample based PGO.
40LLVM_ABI cl::opt<bool> PickMergedSourceLocations(
41 "pick-merged-source-locations", cl::init(Val: false), cl::Hidden,
42 cl::desc("Preserve line and column number when merging locations."));
43} // namespace llvm
44
45uint32_t DIType::getAlignInBits() const {
46 return (getTag() == dwarf::DW_TAG_LLVM_ptrauth_type ? 0 : SubclassData32);
47}
48
49const DIExpression::FragmentInfo DebugVariable::DefaultFragment = {
50 std::numeric_limits<uint64_t>::max(), std::numeric_limits<uint64_t>::min()};
51
52DebugVariable::DebugVariable(const DbgVariableRecord *DVR)
53 : Variable(DVR->getVariable()),
54 Fragment(DVR->getExpression()->getFragmentInfo()),
55 InlinedAt(DVR->getDebugLoc().getInlinedAt()) {}
56
57DebugVariableAggregate::DebugVariableAggregate(const DbgVariableRecord *DVR)
58 : DebugVariable(DVR->getVariable(), std::nullopt,
59 DVR->getDebugLoc()->getInlinedAt()) {}
60
61DILocation::DILocation(LLVMContext &C, StorageType Storage, unsigned Line,
62 unsigned Column, uint64_t AtomGroup, uint8_t AtomRank,
63 ArrayRef<Metadata *> MDs, bool ImplicitCode)
64 : MDNode(C, DILocationKind, Storage, MDs), AtomGroup(AtomGroup),
65 AtomRank(AtomRank) {
66 assert(AtomRank <= 7 && "AtomRank number should fit in 3 bits");
67 if (AtomGroup)
68 C.updateDILocationAtomGroupWaterline(G: AtomGroup + 1);
69
70 assert((MDs.size() == 1 || MDs.size() == 2) &&
71 "Expected a scope and optional inlined-at");
72 // Set line and column.
73 assert(Column < (1u << 16) && "Expected 16-bit column");
74
75 SubclassData32 = Line;
76 SubclassData16 = Column;
77
78 setImplicitCode(ImplicitCode);
79}
80
81static void adjustColumn(unsigned &Column) {
82 // Set to unknown on overflow. We only have 16 bits to play with here.
83 if (Column >= (1u << 16))
84 Column = 0;
85}
86
87DILocation *DILocation::getImpl(LLVMContext &Context, unsigned Line,
88 unsigned Column, Metadata *Scope,
89 Metadata *InlinedAt, bool ImplicitCode,
90 uint64_t AtomGroup, uint8_t AtomRank,
91 StorageType Storage, bool ShouldCreate) {
92 // Fixup column.
93 adjustColumn(Column);
94
95 if (Storage == Uniqued) {
96 if (auto *N = getUniqued(Store&: Context.pImpl->DILocations,
97 Key: DILocationInfo::KeyTy(Line, Column, Scope,
98 InlinedAt, ImplicitCode,
99 AtomGroup, AtomRank)))
100 return N;
101 if (!ShouldCreate)
102 return nullptr;
103 } else {
104 assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
105 }
106
107 SmallVector<Metadata *, 2> Ops;
108 Ops.push_back(Elt: Scope);
109 if (InlinedAt)
110 Ops.push_back(Elt: InlinedAt);
111 return storeImpl(N: new (Ops.size(), Storage)
112 DILocation(Context, Storage, Line, Column, AtomGroup,
113 AtomRank, Ops, ImplicitCode),
114 Storage, Store&: Context.pImpl->DILocations);
115}
116
117DILocation *DILocation::getMergedLocations(ArrayRef<DILocation *> Locs) {
118 if (Locs.empty())
119 return nullptr;
120 if (Locs.size() == 1)
121 return Locs[0];
122 auto *Merged = Locs[0];
123 for (DILocation *L : llvm::drop_begin(RangeOrContainer&: Locs)) {
124 Merged = getMergedLocation(LocA: Merged, LocB: L);
125 if (Merged == nullptr)
126 break;
127 }
128 return Merged;
129}
130
131static DILexicalBlockBase *cloneAndReplaceParentScope(DILexicalBlockBase *LBB,
132 DIScope *NewParent) {
133 TempMDNode ClonedScope = LBB->clone();
134 cast<DILexicalBlockBase>(Val&: *ClonedScope).replaceScope(Scope: NewParent);
135 return cast<DILexicalBlockBase>(
136 Val: MDNode::replaceWithUniqued(N: std::move(ClonedScope)));
137}
138
139using LineColumn = std::pair<unsigned /* Line */, unsigned /* Column */>;
140
141/// Returns the location of DILocalScope, if present, or a default value.
142static LineColumn getLocalScopeLocationOr(DIScope *S, LineColumn Default) {
143 assert(isa<DILocalScope>(S) && "Expected DILocalScope.");
144
145 if (isa<DILexicalBlockFile>(Val: S))
146 return Default;
147 if (auto *LB = dyn_cast<DILexicalBlock>(Val: S))
148 return {LB->getLine(), LB->getColumn()};
149 if (auto *SP = dyn_cast<DISubprogram>(Val: S))
150 return {SP->getLine(), 0u};
151
152 llvm_unreachable("Unhandled type of DILocalScope.");
153}
154
155// Returns the nearest matching scope inside a subprogram.
156template <typename MatcherT>
157static std::pair<DIScope *, LineColumn>
158getNearestMatchingScope(const DILocation *L1, const DILocation *L2) {
159 MatcherT Matcher;
160
161 DIScope *S1 = L1->getScope();
162 DIScope *S2 = L2->getScope();
163
164 LineColumn Loc1(L1->getLine(), L1->getColumn());
165 for (; S1; S1 = S1->getScope()) {
166 Loc1 = getLocalScopeLocationOr(S: S1, Default: Loc1);
167 Matcher.insert(S1, Loc1);
168 if (isa<DISubprogram>(Val: S1))
169 break;
170 }
171
172 LineColumn Loc2(L2->getLine(), L2->getColumn());
173 for (; S2; S2 = S2->getScope()) {
174 Loc2 = getLocalScopeLocationOr(S: S2, Default: Loc2);
175
176 if (DIScope *S = Matcher.match(S2, Loc2))
177 return std::make_pair(x&: S, y&: Loc2);
178
179 if (isa<DISubprogram>(Val: S2))
180 break;
181 }
182 return std::make_pair(x: nullptr, y: LineColumn(L2->getLine(), L2->getColumn()));
183}
184
185// Matches equal scopes.
186struct EqualScopesMatcher {
187 SmallPtrSet<DIScope *, 8> Scopes;
188
189 void insert(DIScope *S, LineColumn Loc) { Scopes.insert(Ptr: S); }
190
191 DIScope *match(DIScope *S, LineColumn Loc) {
192 return Scopes.contains(Ptr: S) ? S : nullptr;
193 }
194};
195
196// Matches scopes with the same location.
197struct ScopeLocationsMatcher {
198 SmallMapVector<std::pair<DIFile *, LineColumn>, SmallSetVector<DIScope *, 8>,
199 8>
200 Scopes;
201
202 void insert(DIScope *S, LineColumn Loc) {
203 Scopes[{S->getFile(), Loc}].insert(X: S);
204 }
205
206 DIScope *match(DIScope *S, LineColumn Loc) {
207 auto ScopesAtLoc = Scopes.find(Key: {S->getFile(), Loc});
208 // No scope found with the given location.
209 if (ScopesAtLoc == Scopes.end())
210 return nullptr;
211
212 // Prefer S over other scopes with the same location.
213 if (ScopesAtLoc->second.contains(key: S))
214 return S;
215
216 if (!ScopesAtLoc->second.empty())
217 return *ScopesAtLoc->second.begin();
218
219 llvm_unreachable("Scopes must not have empty entries.");
220 }
221};
222
223DILocation *DILocation::getMergedLocation(DILocation *LocA, DILocation *LocB) {
224 if (LocA == LocB)
225 return LocA;
226
227 // For some use cases (SamplePGO), it is important to retain distinct source
228 // locations. When this flag is set, we choose arbitrarily between A and B,
229 // rather than computing a merged location using line 0, which is typically
230 // not useful for PGO. If one of them is null, then try to return one which is
231 // valid.
232 if (PickMergedSourceLocations) {
233 if (!LocA || !LocB)
234 return LocA ? LocA : LocB;
235
236 auto A = std::make_tuple(args: LocA->getLine(), args: LocA->getColumn(),
237 args: LocA->getDiscriminator(), args: LocA->getFilename(),
238 args: LocA->getDirectory());
239 auto B = std::make_tuple(args: LocB->getLine(), args: LocB->getColumn(),
240 args: LocB->getDiscriminator(), args: LocB->getFilename(),
241 args: LocB->getDirectory());
242 return A < B ? LocA : LocB;
243 }
244
245 if (!LocA || !LocB)
246 return nullptr;
247
248 LLVMContext &C = LocA->getContext();
249
250 using LocVec = SmallVector<const DILocation *>;
251 LocVec ALocs;
252 LocVec BLocs;
253 SmallDenseMap<std::pair<const DISubprogram *, const DILocation *>, unsigned,
254 4>
255 ALookup;
256
257 // Walk through LocA and its inlined-at locations, populate them in ALocs and
258 // save the index for the subprogram and inlined-at pair, which we use to find
259 // a matching starting location in LocB's chain.
260 for (auto [L, I] = std::make_pair(x&: LocA, y: 0U); L; L = L->getInlinedAt(), I++) {
261 ALocs.push_back(Elt: L);
262 auto Res = ALookup.try_emplace(
263 Key: {L->getScope()->getSubprogram(), L->getInlinedAt()}, Args&: I);
264 assert(Res.second && "Multiple <SP, InlinedAt> pairs in a location chain?");
265 (void)Res;
266 }
267
268 LocVec::reverse_iterator ARIt = ALocs.rend();
269 LocVec::reverse_iterator BRIt = BLocs.rend();
270
271 // Populate BLocs and look for a matching starting location, the first
272 // location with the same subprogram and inlined-at location as in LocA's
273 // chain. Since the two locations have the same inlined-at location we do
274 // not need to look at those parts of the chains.
275 for (auto [L, I] = std::make_pair(x&: LocB, y: 0U); L; L = L->getInlinedAt(), I++) {
276 BLocs.push_back(Elt: L);
277
278 if (ARIt != ALocs.rend())
279 // We have already found a matching starting location.
280 continue;
281
282 auto IT = ALookup.find(Val: {L->getScope()->getSubprogram(), L->getInlinedAt()});
283 if (IT == ALookup.end())
284 continue;
285
286 // The + 1 is to account for the &*rev_it = &(it - 1) relationship.
287 ARIt = LocVec::reverse_iterator(ALocs.begin() + IT->second + 1);
288 BRIt = LocVec::reverse_iterator(BLocs.begin() + I + 1);
289
290 // If we have found a matching starting location we do not need to add more
291 // locations to BLocs, since we will only look at location pairs preceding
292 // the matching starting location, and adding more elements to BLocs could
293 // invalidate the iterator that we initialized here.
294 break;
295 }
296
297 // Merge the two locations if possible, using the supplied
298 // inlined-at location for the created location.
299 auto *LocAIA = LocA->getInlinedAt();
300 auto *LocBIA = LocB->getInlinedAt();
301 auto MergeLocPair = [&C, LocAIA,
302 LocBIA](const DILocation *L1, const DILocation *L2,
303 DILocation *InlinedAt) -> DILocation * {
304 if (L1 == L2)
305 return DILocation::get(Context&: C, Line: L1->getLine(), Column: L1->getColumn(), Scope: L1->getScope(),
306 InlinedAt, ImplicitCode: L1->isImplicitCode(),
307 AtomGroup: L1->getAtomGroup(), AtomRank: L1->getAtomRank());
308
309 // If the locations originate from different subprograms we can't produce
310 // a common location.
311 if (L1->getScope()->getSubprogram() != L2->getScope()->getSubprogram())
312 return nullptr;
313
314 // Find nearest common scope inside subprogram.
315 DIScope *Scope = getNearestMatchingScope<EqualScopesMatcher>(L1, L2).first;
316 assert(Scope && "No common scope in the same subprogram?");
317
318 // Try using the nearest scope with common location if files are different.
319 if (Scope->getFile() != L1->getFile() || L1->getFile() != L2->getFile()) {
320 auto [CommonLocScope, CommonLoc] =
321 getNearestMatchingScope<ScopeLocationsMatcher>(L1, L2);
322
323 // If CommonLocScope is a DILexicalBlockBase, clone it and locate
324 // a new scope inside the nearest common scope to preserve
325 // lexical blocks structure.
326 if (auto *LBB = dyn_cast<DILexicalBlockBase>(Val: CommonLocScope);
327 LBB && LBB != Scope)
328 CommonLocScope = cloneAndReplaceParentScope(LBB, NewParent: Scope);
329
330 Scope = CommonLocScope;
331
332 // If files are still different, assume that L1 and L2 were "included"
333 // from CommonLoc. Use it as merged location.
334 if (Scope->getFile() != L1->getFile() || L1->getFile() != L2->getFile())
335 return DILocation::get(Context&: C, Line: CommonLoc.first, Column: CommonLoc.second,
336 Scope: CommonLocScope, InlinedAt);
337 }
338
339 bool SameLine = L1->getLine() == L2->getLine();
340 bool SameCol = L1->getColumn() == L2->getColumn();
341 unsigned Line = SameLine ? L1->getLine() : 0;
342 unsigned Col = SameLine && SameCol ? L1->getColumn() : 0;
343 bool IsImplicitCode = L1->isImplicitCode() && L2->isImplicitCode();
344
345 // Discard source location atom if the line becomes 0. And there's nothing
346 // further to do if neither location has an atom number.
347 if (!SameLine || !(L1->getAtomGroup() || L2->getAtomGroup()))
348 return DILocation::get(Context&: C, Line, Column: Col, Scope, InlinedAt, ImplicitCode: IsImplicitCode,
349 /*AtomGroup*/ 0, /*AtomRank*/ 0);
350
351 uint64_t Group = 0;
352 uint64_t Rank = 0;
353 // If we're preserving the same matching inlined-at field we can
354 // preserve the atom.
355 if (LocBIA == LocAIA && InlinedAt == LocBIA) {
356 // Deterministically keep the lowest non-zero ranking atom group
357 // number.
358 // FIXME: It would be nice if we could track that an instruction
359 // belongs to two source atoms.
360 bool UseL1Atom = [L1, L2]() {
361 if (L1->getAtomRank() == L2->getAtomRank()) {
362 // Arbitrarily choose the lowest non-zero group number.
363 if (!L1->getAtomGroup() || !L2->getAtomGroup())
364 return !L2->getAtomGroup();
365 return L1->getAtomGroup() < L2->getAtomGroup();
366 }
367 // Choose the lowest non-zero rank.
368 if (!L1->getAtomRank() || !L2->getAtomRank())
369 return !L2->getAtomRank();
370 return L1->getAtomRank() < L2->getAtomRank();
371 }();
372 Group = UseL1Atom ? L1->getAtomGroup() : L2->getAtomGroup();
373 Rank = UseL1Atom ? L1->getAtomRank() : L2->getAtomRank();
374 } else {
375 // If either instruction is part of a source atom, reassign it a new
376 // atom group. This essentially regresses to non-key-instructions
377 // behaviour (now that it's the only instruction in its group it'll
378 // probably get is_stmt applied).
379 Group = C.incNextDILocationAtomGroup();
380 Rank = 1;
381 }
382 return DILocation::get(Context&: C, Line, Column: Col, Scope, InlinedAt, ImplicitCode: IsImplicitCode,
383 AtomGroup: Group, AtomRank: Rank);
384 };
385
386 DILocation *Result = ARIt != ALocs.rend() ? (*ARIt)->getInlinedAt() : nullptr;
387
388 // If we have found a common starting location, walk up the inlined-at chains
389 // and try to produce common locations.
390 for (; ARIt != ALocs.rend() && BRIt != BLocs.rend(); ++ARIt, ++BRIt) {
391 DILocation *Tmp = MergeLocPair(*ARIt, *BRIt, Result);
392
393 if (!Tmp)
394 // We have walked up to a point in the chains where the two locations
395 // are irreconsilable. At this point Result contains the nearest common
396 // location in the inlined-at chains of LocA and LocB, so we break here.
397 break;
398
399 Result = Tmp;
400 }
401
402 if (Result)
403 return Result;
404
405 // We ended up with LocA and LocB as irreconsilable locations. Produce a
406 // location at 0:0 with one of the locations' scope. The function has
407 // historically picked A's scope, and a nullptr inlined-at location, so that
408 // behavior is mimicked here but I am not sure if this is always the correct
409 // way to handle this.
410 // Key Instructions: it's fine to drop atom group and rank here, as line 0
411 // is a nonsensical is_stmt location.
412 return DILocation::get(Context&: C, Line: 0, Column: 0, Scope: LocA->getScope(), InlinedAt: nullptr, ImplicitCode: false,
413 /*AtomGroup*/ 0, /*AtomRank*/ 0);
414}
415
416std::optional<unsigned>
417DILocation::encodeDiscriminator(unsigned BD, unsigned DF, unsigned CI) {
418 std::array<unsigned, 3> Components = {BD, DF, CI};
419 uint64_t RemainingWork = 0U;
420 // We use RemainingWork to figure out if we have no remaining components to
421 // encode. For example: if BD != 0 but DF == 0 && CI == 0, we don't need to
422 // encode anything for the latter 2.
423 // Since any of the input components is at most 32 bits, their sum will be
424 // less than 34 bits, and thus RemainingWork won't overflow.
425 RemainingWork =
426 std::accumulate(first: Components.begin(), last: Components.end(), init: RemainingWork);
427
428 int I = 0;
429 unsigned Ret = 0;
430 unsigned NextBitInsertionIndex = 0;
431 while (RemainingWork > 0) {
432 unsigned C = Components[I++];
433 RemainingWork -= C;
434 unsigned EC = encodeComponent(C);
435 Ret |= (EC << NextBitInsertionIndex);
436 NextBitInsertionIndex += encodingBits(C);
437 }
438
439 // Encoding may be unsuccessful because of overflow. We determine success by
440 // checking equivalence of components before & after encoding. Alternatively,
441 // we could determine Success during encoding, but the current alternative is
442 // simpler.
443 unsigned TBD, TDF, TCI = 0;
444 decodeDiscriminator(D: Ret, BD&: TBD, DF&: TDF, CI&: TCI);
445 if (TBD == BD && TDF == DF && TCI == CI)
446 return Ret;
447 return std::nullopt;
448}
449
450void DILocation::decodeDiscriminator(unsigned D, unsigned &BD, unsigned &DF,
451 unsigned &CI) {
452 BD = getUnsignedFromPrefixEncoding(U: D);
453 DF = getUnsignedFromPrefixEncoding(U: getNextComponentInDiscriminator(D));
454 CI = getUnsignedFromPrefixEncoding(
455 U: getNextComponentInDiscriminator(D: getNextComponentInDiscriminator(D)));
456}
457dwarf::Tag DINode::getTag() const { return (dwarf::Tag)SubclassData16; }
458
459DINode::DIFlags DINode::getFlag(StringRef Flag) {
460 return StringSwitch<DIFlags>(Flag)
461#define HANDLE_DI_FLAG(ID, NAME) .Case("DIFlag" #NAME, Flag##NAME)
462#include "llvm/IR/DebugInfoFlags.def"
463 .Default(Value: DINode::FlagZero);
464}
465
466StringRef DINode::getFlagString(DIFlags Flag) {
467 switch (Flag) {
468#define HANDLE_DI_FLAG(ID, NAME) \
469 case Flag##NAME: \
470 return "DIFlag" #NAME;
471#include "llvm/IR/DebugInfoFlags.def"
472 }
473 return "";
474}
475
476DINode::DIFlags DINode::splitFlags(DIFlags Flags,
477 SmallVectorImpl<DIFlags> &SplitFlags) {
478 // Flags that are packed together need to be specially handled, so
479 // that, for example, we emit "DIFlagPublic" and not
480 // "DIFlagPrivate | DIFlagProtected".
481 if (DIFlags A = Flags & FlagAccessibility) {
482 if (A == FlagPrivate)
483 SplitFlags.push_back(Elt: FlagPrivate);
484 else if (A == FlagProtected)
485 SplitFlags.push_back(Elt: FlagProtected);
486 else
487 SplitFlags.push_back(Elt: FlagPublic);
488 Flags &= ~A;
489 }
490 if (DIFlags R = Flags & FlagPtrToMemberRep) {
491 if (R == FlagSingleInheritance)
492 SplitFlags.push_back(Elt: FlagSingleInheritance);
493 else if (R == FlagMultipleInheritance)
494 SplitFlags.push_back(Elt: FlagMultipleInheritance);
495 else
496 SplitFlags.push_back(Elt: FlagVirtualInheritance);
497 Flags &= ~R;
498 }
499 if ((Flags & FlagIndirectVirtualBase) == FlagIndirectVirtualBase) {
500 Flags &= ~FlagIndirectVirtualBase;
501 SplitFlags.push_back(Elt: FlagIndirectVirtualBase);
502 }
503
504#define HANDLE_DI_FLAG(ID, NAME) \
505 if (DIFlags Bit = Flags & Flag##NAME) { \
506 SplitFlags.push_back(Bit); \
507 Flags &= ~Bit; \
508 }
509#include "llvm/IR/DebugInfoFlags.def"
510 return Flags;
511}
512
513DIScope *DIScope::getScope() const {
514 if (auto *T = dyn_cast<DIType>(Val: this))
515 return T->getScope();
516
517 if (auto *SP = dyn_cast<DISubprogram>(Val: this))
518 return SP->getScope();
519
520 if (auto *LB = dyn_cast<DILexicalBlockBase>(Val: this))
521 return LB->getScope();
522
523 if (auto *NS = dyn_cast<DINamespace>(Val: this))
524 return NS->getScope();
525
526 if (auto *CB = dyn_cast<DICommonBlock>(Val: this))
527 return CB->getScope();
528
529 if (auto *M = dyn_cast<DIModule>(Val: this))
530 return M->getScope();
531
532 assert((isa<DIFile>(this) || isa<DICompileUnit>(this)) &&
533 "Unhandled type of scope.");
534 return nullptr;
535}
536
537StringRef DIScope::getName() const {
538 if (auto *T = dyn_cast<DIType>(Val: this))
539 return T->getName();
540 if (auto *SP = dyn_cast<DISubprogram>(Val: this))
541 return SP->getName();
542 if (auto *NS = dyn_cast<DINamespace>(Val: this))
543 return NS->getName();
544 if (auto *CB = dyn_cast<DICommonBlock>(Val: this))
545 return CB->getName();
546 if (auto *M = dyn_cast<DIModule>(Val: this))
547 return M->getName();
548 assert((isa<DILexicalBlockBase>(this) || isa<DIFile>(this) ||
549 isa<DICompileUnit>(this)) &&
550 "Unhandled type of scope.");
551 return "";
552}
553
554#ifndef NDEBUG
555static bool isCanonical(const MDString *S) {
556 return !S || !S->getString().empty();
557}
558#endif
559
560dwarf::Tag GenericDINode::getTag() const { return (dwarf::Tag)SubclassData16; }
561GenericDINode *GenericDINode::getImpl(LLVMContext &Context, unsigned Tag,
562 MDString *Header,
563 ArrayRef<Metadata *> DwarfOps,
564 StorageType Storage, bool ShouldCreate) {
565 unsigned Hash = 0;
566 if (Storage == Uniqued) {
567 GenericDINodeInfo::KeyTy Key(Tag, Header, DwarfOps);
568 if (auto *N = getUniqued(Store&: Context.pImpl->GenericDINodes, Key))
569 return N;
570 if (!ShouldCreate)
571 return nullptr;
572 Hash = Key.getHash();
573 } else {
574 assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
575 }
576
577 // Use a nullptr for empty headers.
578 assert(isCanonical(Header) && "Expected canonical MDString");
579 Metadata *PreOps[] = {Header};
580 return storeImpl(N: new (DwarfOps.size() + 1, Storage) GenericDINode(
581 Context, Storage, Hash, Tag, PreOps, DwarfOps),
582 Storage, Store&: Context.pImpl->GenericDINodes);
583}
584
585void GenericDINode::recalculateHash() {
586 setHash(GenericDINodeInfo::KeyTy::calculateHash(N: this));
587}
588
589#define UNWRAP_ARGS_IMPL(...) __VA_ARGS__
590#define UNWRAP_ARGS(ARGS) UNWRAP_ARGS_IMPL ARGS
591#define DEFINE_GETIMPL_LOOKUP(CLASS, ARGS) \
592 do { \
593 if (Storage == Uniqued) { \
594 if (auto *N = getUniqued(Context.pImpl->CLASS##s, \
595 CLASS##Info::KeyTy(UNWRAP_ARGS(ARGS)))) \
596 return N; \
597 if (!ShouldCreate) \
598 return nullptr; \
599 } else { \
600 assert(ShouldCreate && \
601 "Expected non-uniqued nodes to always be created"); \
602 } \
603 } while (false)
604#define DEFINE_GETIMPL_STORE(CLASS, ARGS, OPS) \
605 return storeImpl(new (std::size(OPS), Storage) \
606 CLASS(Context, Storage, UNWRAP_ARGS(ARGS), OPS), \
607 Storage, Context.pImpl->CLASS##s)
608#define DEFINE_GETIMPL_STORE_NO_OPS(CLASS, ARGS) \
609 return storeImpl(new (0u, Storage) \
610 CLASS(Context, Storage, UNWRAP_ARGS(ARGS)), \
611 Storage, Context.pImpl->CLASS##s)
612#define DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(CLASS, OPS) \
613 return storeImpl(new (std::size(OPS), Storage) CLASS(Context, Storage, OPS), \
614 Storage, Context.pImpl->CLASS##s)
615#define DEFINE_GETIMPL_STORE_N(CLASS, ARGS, OPS, NUM_OPS) \
616 return storeImpl(new (NUM_OPS, Storage) \
617 CLASS(Context, Storage, UNWRAP_ARGS(ARGS), OPS), \
618 Storage, Context.pImpl->CLASS##s)
619
620DISubrange::DISubrange(LLVMContext &C, StorageType Storage,
621 ArrayRef<Metadata *> Ops)
622 : DINode(C, DISubrangeKind, Storage, dwarf::DW_TAG_subrange_type, Ops) {}
623DISubrange *DISubrange::getImpl(LLVMContext &Context, int64_t Count, int64_t Lo,
624 StorageType Storage, bool ShouldCreate) {
625 auto *CountNode = ConstantAsMetadata::get(
626 C: ConstantInt::getSigned(Ty: Type::getInt64Ty(C&: Context), V: Count));
627 auto *LB = ConstantAsMetadata::get(
628 C: ConstantInt::getSigned(Ty: Type::getInt64Ty(C&: Context), V: Lo));
629 return getImpl(Context, CountNode, LowerBound: LB, UpperBound: nullptr, Stride: nullptr, Storage,
630 ShouldCreate);
631}
632
633DISubrange *DISubrange::getImpl(LLVMContext &Context, Metadata *CountNode,
634 int64_t Lo, StorageType Storage,
635 bool ShouldCreate) {
636 auto *LB = ConstantAsMetadata::get(
637 C: ConstantInt::getSigned(Ty: Type::getInt64Ty(C&: Context), V: Lo));
638 return getImpl(Context, CountNode, LowerBound: LB, UpperBound: nullptr, Stride: nullptr, Storage,
639 ShouldCreate);
640}
641
642DISubrange *DISubrange::getImpl(LLVMContext &Context, Metadata *CountNode,
643 Metadata *LB, Metadata *UB, Metadata *Stride,
644 StorageType Storage, bool ShouldCreate) {
645 DEFINE_GETIMPL_LOOKUP(DISubrange, (CountNode, LB, UB, Stride));
646 Metadata *Ops[] = {CountNode, LB, UB, Stride};
647 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DISubrange, Ops);
648}
649
650DISubrange::BoundType DISubrange::getCount() const {
651 Metadata *CB = getRawCountNode();
652 if (!CB)
653 return BoundType();
654
655 assert((isa<ConstantAsMetadata>(CB) || isa<DIVariable>(CB) ||
656 isa<DIExpression>(CB)) &&
657 "Count must be signed constant or DIVariable or DIExpression");
658
659 if (auto *MD = dyn_cast<ConstantAsMetadata>(Val: CB))
660 return BoundType(cast<ConstantInt>(Val: MD->getValue()));
661
662 if (auto *MD = dyn_cast<DIVariable>(Val: CB))
663 return BoundType(MD);
664
665 if (auto *MD = dyn_cast<DIExpression>(Val: CB))
666 return BoundType(MD);
667
668 return BoundType();
669}
670
671DISubrange::BoundType DISubrange::getLowerBound() const {
672 Metadata *LB = getRawLowerBound();
673 if (!LB)
674 return BoundType();
675
676 assert((isa<ConstantAsMetadata>(LB) || isa<DIVariable>(LB) ||
677 isa<DIExpression>(LB)) &&
678 "LowerBound must be signed constant or DIVariable or DIExpression");
679
680 if (auto *MD = dyn_cast<ConstantAsMetadata>(Val: LB))
681 return BoundType(cast<ConstantInt>(Val: MD->getValue()));
682
683 if (auto *MD = dyn_cast<DIVariable>(Val: LB))
684 return BoundType(MD);
685
686 if (auto *MD = dyn_cast<DIExpression>(Val: LB))
687 return BoundType(MD);
688
689 return BoundType();
690}
691
692DISubrange::BoundType DISubrange::getUpperBound() const {
693 Metadata *UB = getRawUpperBound();
694 if (!UB)
695 return BoundType();
696
697 assert((isa<ConstantAsMetadata>(UB) || isa<DIVariable>(UB) ||
698 isa<DIExpression>(UB)) &&
699 "UpperBound must be signed constant or DIVariable or DIExpression");
700
701 if (auto *MD = dyn_cast<ConstantAsMetadata>(Val: UB))
702 return BoundType(cast<ConstantInt>(Val: MD->getValue()));
703
704 if (auto *MD = dyn_cast<DIVariable>(Val: UB))
705 return BoundType(MD);
706
707 if (auto *MD = dyn_cast<DIExpression>(Val: UB))
708 return BoundType(MD);
709
710 return BoundType();
711}
712
713DISubrange::BoundType DISubrange::getStride() const {
714 Metadata *ST = getRawStride();
715 if (!ST)
716 return BoundType();
717
718 assert((isa<ConstantAsMetadata>(ST) || isa<DIVariable>(ST) ||
719 isa<DIExpression>(ST)) &&
720 "Stride must be signed constant or DIVariable or DIExpression");
721
722 if (auto *MD = dyn_cast<ConstantAsMetadata>(Val: ST))
723 return BoundType(cast<ConstantInt>(Val: MD->getValue()));
724
725 if (auto *MD = dyn_cast<DIVariable>(Val: ST))
726 return BoundType(MD);
727
728 if (auto *MD = dyn_cast<DIExpression>(Val: ST))
729 return BoundType(MD);
730
731 return BoundType();
732}
733DIGenericSubrange::DIGenericSubrange(LLVMContext &C, StorageType Storage,
734 ArrayRef<Metadata *> Ops)
735 : DINode(C, DIGenericSubrangeKind, Storage, dwarf::DW_TAG_generic_subrange,
736 Ops) {}
737
738DIGenericSubrange *DIGenericSubrange::getImpl(LLVMContext &Context,
739 Metadata *CountNode, Metadata *LB,
740 Metadata *UB, Metadata *Stride,
741 StorageType Storage,
742 bool ShouldCreate) {
743 DEFINE_GETIMPL_LOOKUP(DIGenericSubrange, (CountNode, LB, UB, Stride));
744 Metadata *Ops[] = {CountNode, LB, UB, Stride};
745 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DIGenericSubrange, Ops);
746}
747
748DIGenericSubrange::BoundType DIGenericSubrange::getCount() const {
749 Metadata *CB = getRawCountNode();
750 if (!CB)
751 return BoundType();
752
753 assert((isa<DIVariable>(CB) || isa<DIExpression>(CB)) &&
754 "Count must be signed constant or DIVariable or DIExpression");
755
756 if (auto *MD = dyn_cast<DIVariable>(Val: CB))
757 return BoundType(MD);
758
759 if (auto *MD = dyn_cast<DIExpression>(Val: CB))
760 return BoundType(MD);
761
762 return BoundType();
763}
764
765DIGenericSubrange::BoundType DIGenericSubrange::getLowerBound() const {
766 Metadata *LB = getRawLowerBound();
767 if (!LB)
768 return BoundType();
769
770 assert((isa<DIVariable>(LB) || isa<DIExpression>(LB)) &&
771 "LowerBound must be signed constant or DIVariable or DIExpression");
772
773 if (auto *MD = dyn_cast<DIVariable>(Val: LB))
774 return BoundType(MD);
775
776 if (auto *MD = dyn_cast<DIExpression>(Val: LB))
777 return BoundType(MD);
778
779 return BoundType();
780}
781
782DIGenericSubrange::BoundType DIGenericSubrange::getUpperBound() const {
783 Metadata *UB = getRawUpperBound();
784 if (!UB)
785 return BoundType();
786
787 assert((isa<DIVariable>(UB) || isa<DIExpression>(UB)) &&
788 "UpperBound must be signed constant or DIVariable or DIExpression");
789
790 if (auto *MD = dyn_cast<DIVariable>(Val: UB))
791 return BoundType(MD);
792
793 if (auto *MD = dyn_cast<DIExpression>(Val: UB))
794 return BoundType(MD);
795
796 return BoundType();
797}
798
799DIGenericSubrange::BoundType DIGenericSubrange::getStride() const {
800 Metadata *ST = getRawStride();
801 if (!ST)
802 return BoundType();
803
804 assert((isa<DIVariable>(ST) || isa<DIExpression>(ST)) &&
805 "Stride must be signed constant or DIVariable or DIExpression");
806
807 if (auto *MD = dyn_cast<DIVariable>(Val: ST))
808 return BoundType(MD);
809
810 if (auto *MD = dyn_cast<DIExpression>(Val: ST))
811 return BoundType(MD);
812
813 return BoundType();
814}
815
816DISubrangeType::DISubrangeType(LLVMContext &C, StorageType Storage,
817 unsigned Line, uint32_t AlignInBits,
818 DIFlags Flags, ArrayRef<Metadata *> Ops)
819 : DIType(C, DISubrangeTypeKind, Storage, dwarf::DW_TAG_subrange_type, Line,
820 AlignInBits, 0, Flags, Ops) {}
821
822DISubrangeType *DISubrangeType::getImpl(
823 LLVMContext &Context, MDString *Name, Metadata *File, unsigned Line,
824 Metadata *Scope, Metadata *SizeInBits, uint32_t AlignInBits, DIFlags Flags,
825 Metadata *BaseType, Metadata *LowerBound, Metadata *UpperBound,
826 Metadata *Stride, Metadata *Bias, StorageType Storage, bool ShouldCreate) {
827 assert(isCanonical(Name) && "Expected canonical MDString");
828 DEFINE_GETIMPL_LOOKUP(DISubrangeType, (Name, File, Line, Scope, SizeInBits,
829 AlignInBits, Flags, BaseType,
830 LowerBound, UpperBound, Stride, Bias));
831 Metadata *Ops[] = {File, Scope, Name, SizeInBits, nullptr,
832 BaseType, LowerBound, UpperBound, Stride, Bias};
833 DEFINE_GETIMPL_STORE(DISubrangeType, (Line, AlignInBits, Flags), Ops);
834}
835
836DISubrangeType::BoundType
837DISubrangeType::convertRawToBound(Metadata *IN) const {
838 if (!IN)
839 return BoundType();
840
841 assert(isa<ConstantAsMetadata>(IN) || isa<DIVariable>(IN) ||
842 isa<DIExpression>(IN) || isa<DIDerivedType>(IN));
843
844 if (auto *MD = dyn_cast<ConstantAsMetadata>(Val: IN))
845 return BoundType(cast<ConstantInt>(Val: MD->getValue()));
846
847 if (auto *MD = dyn_cast<DIVariable>(Val: IN))
848 return BoundType(MD);
849
850 if (auto *MD = dyn_cast<DIExpression>(Val: IN))
851 return BoundType(MD);
852
853 if (auto *DT = dyn_cast<DIDerivedType>(Val: IN))
854 return BoundType(DT);
855
856 return BoundType();
857}
858
859DIEnumerator::DIEnumerator(LLVMContext &C, StorageType Storage,
860 const APInt &Value, bool IsUnsigned,
861 ArrayRef<Metadata *> Ops)
862 : DINode(C, DIEnumeratorKind, Storage, dwarf::DW_TAG_enumerator, Ops),
863 Value(Value) {
864 SubclassData32 = IsUnsigned;
865}
866DIEnumerator *DIEnumerator::getImpl(LLVMContext &Context, const APInt &Value,
867 bool IsUnsigned, MDString *Name,
868 StorageType Storage, bool ShouldCreate) {
869 assert(isCanonical(Name) && "Expected canonical MDString");
870 DEFINE_GETIMPL_LOOKUP(DIEnumerator, (Value, IsUnsigned, Name));
871 Metadata *Ops[] = {Name};
872 DEFINE_GETIMPL_STORE(DIEnumerator, (Value, IsUnsigned), Ops);
873}
874
875DIBasicType *DIBasicType::getImpl(LLVMContext &Context, unsigned Tag,
876 MDString *Name, Metadata *File,
877 unsigned LineNo, Metadata *Scope,
878 Metadata *SizeInBits, uint32_t AlignInBits,
879 unsigned Encoding,
880 uint32_t NumExtraInhabitants,
881 uint32_t DataSizeInBits, DIFlags Flags,
882 StorageType Storage, bool ShouldCreate) {
883 assert(isCanonical(Name) && "Expected canonical MDString");
884 DEFINE_GETIMPL_LOOKUP(
885 DIBasicType, (Tag, Name, File, LineNo, Scope, SizeInBits, AlignInBits,
886 Encoding, NumExtraInhabitants, DataSizeInBits, Flags));
887 Metadata *Ops[] = {File, Scope, Name, SizeInBits, nullptr};
888 DEFINE_GETIMPL_STORE(DIBasicType,
889 (Tag, LineNo, AlignInBits, Encoding, NumExtraInhabitants,
890 DataSizeInBits, Flags),
891 Ops);
892}
893
894std::optional<DIBasicType::Signedness> DIBasicType::getSignedness() const {
895 switch (getEncoding()) {
896 case dwarf::DW_ATE_signed:
897 case dwarf::DW_ATE_signed_char:
898 case dwarf::DW_ATE_signed_fixed:
899 return Signedness::Signed;
900 case dwarf::DW_ATE_unsigned:
901 case dwarf::DW_ATE_unsigned_char:
902 case dwarf::DW_ATE_unsigned_fixed:
903 return Signedness::Unsigned;
904 default:
905 return std::nullopt;
906 }
907}
908
909DIFixedPointType *
910DIFixedPointType::getImpl(LLVMContext &Context, unsigned Tag, MDString *Name,
911 Metadata *File, unsigned LineNo, Metadata *Scope,
912 Metadata *SizeInBits, uint32_t AlignInBits,
913 unsigned Encoding, DIFlags Flags, unsigned Kind,
914 int Factor, APInt Numerator, APInt Denominator,
915 StorageType Storage, bool ShouldCreate) {
916 DEFINE_GETIMPL_LOOKUP(DIFixedPointType,
917 (Tag, Name, File, LineNo, Scope, SizeInBits,
918 AlignInBits, Encoding, Flags, Kind, Factor, Numerator,
919 Denominator));
920 Metadata *Ops[] = {File, Scope, Name, SizeInBits, nullptr};
921 DEFINE_GETIMPL_STORE(DIFixedPointType,
922 (Tag, LineNo, AlignInBits, Encoding, Flags, Kind, Factor,
923 Numerator, Denominator),
924 Ops);
925}
926
927bool DIFixedPointType::isSigned() const {
928 return getEncoding() == dwarf::DW_ATE_signed_fixed;
929}
930
931std::optional<DIFixedPointType::FixedPointKind>
932DIFixedPointType::getFixedPointKind(StringRef Str) {
933 return StringSwitch<std::optional<FixedPointKind>>(Str)
934 .Case(S: "Binary", Value: FixedPointBinary)
935 .Case(S: "Decimal", Value: FixedPointDecimal)
936 .Case(S: "Rational", Value: FixedPointRational)
937 .Default(Value: std::nullopt);
938}
939
940const char *DIFixedPointType::fixedPointKindString(FixedPointKind V) {
941 switch (V) {
942 case FixedPointBinary:
943 return "Binary";
944 case FixedPointDecimal:
945 return "Decimal";
946 case FixedPointRational:
947 return "Rational";
948 }
949 return nullptr;
950}
951
952DIStringType *DIStringType::getImpl(LLVMContext &Context, unsigned Tag,
953 MDString *Name, Metadata *StringLength,
954 Metadata *StringLengthExp,
955 Metadata *StringLocationExp,
956 Metadata *SizeInBits, uint32_t AlignInBits,
957 unsigned Encoding, StorageType Storage,
958 bool ShouldCreate) {
959 assert(isCanonical(Name) && "Expected canonical MDString");
960 DEFINE_GETIMPL_LOOKUP(DIStringType,
961 (Tag, Name, StringLength, StringLengthExp,
962 StringLocationExp, SizeInBits, AlignInBits, Encoding));
963 Metadata *Ops[] = {nullptr, nullptr, Name,
964 SizeInBits, nullptr, StringLength,
965 StringLengthExp, StringLocationExp};
966 DEFINE_GETIMPL_STORE(DIStringType, (Tag, AlignInBits, Encoding), Ops);
967}
968DIType *DIDerivedType::getClassType() const {
969 assert(getTag() == dwarf::DW_TAG_ptr_to_member_type);
970 return cast_or_null<DIType>(Val: getExtraData());
971}
972
973// Helper function to extract ConstantAsMetadata from ExtraData,
974// handling extra data MDTuple unwrapping if needed.
975static ConstantAsMetadata *extractConstantMetadata(Metadata *ExtraData) {
976 Metadata *ED = ExtraData;
977 if (auto *Tuple = dyn_cast_or_null<MDTuple>(Val: ED)) {
978 if (Tuple->getNumOperands() != 1)
979 return nullptr;
980 ED = Tuple->getOperand(I: 0);
981 }
982 return cast_or_null<ConstantAsMetadata>(Val: ED);
983}
984
985uint32_t DIDerivedType::getVBPtrOffset() const {
986 assert(getTag() == dwarf::DW_TAG_inheritance);
987 if (auto *CM = extractConstantMetadata(ExtraData: getExtraData()))
988 if (auto *CI = dyn_cast_or_null<ConstantInt>(Val: CM->getValue()))
989 return static_cast<uint32_t>(CI->getZExtValue());
990 return 0;
991}
992Constant *DIDerivedType::getStorageOffsetInBits() const {
993 assert(getTag() == dwarf::DW_TAG_member && isBitField());
994 if (auto *C = extractConstantMetadata(ExtraData: getExtraData()))
995 return C->getValue();
996 return nullptr;
997}
998
999Constant *DIDerivedType::getConstant() const {
1000 assert((getTag() == dwarf::DW_TAG_member ||
1001 getTag() == dwarf::DW_TAG_variable) &&
1002 isStaticMember());
1003 if (auto *C = extractConstantMetadata(ExtraData: getExtraData()))
1004 return C->getValue();
1005 return nullptr;
1006}
1007Constant *DIDerivedType::getDiscriminantValue() const {
1008 assert(getTag() == dwarf::DW_TAG_member && !isStaticMember());
1009 if (auto *C = extractConstantMetadata(ExtraData: getExtraData()))
1010 return C->getValue();
1011 return nullptr;
1012}
1013
1014DIDerivedType *DIDerivedType::getImpl(
1015 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File,
1016 unsigned Line, Metadata *Scope, Metadata *BaseType, Metadata *SizeInBits,
1017 uint32_t AlignInBits, Metadata *OffsetInBits,
1018 std::optional<unsigned> DWARFAddressSpace,
1019 std::optional<PtrAuthData> PtrAuthData, DIFlags Flags, Metadata *ExtraData,
1020 Metadata *Annotations, StorageType Storage, bool ShouldCreate) {
1021 assert(isCanonical(Name) && "Expected canonical MDString");
1022 DEFINE_GETIMPL_LOOKUP(DIDerivedType,
1023 (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
1024 AlignInBits, OffsetInBits, DWARFAddressSpace,
1025 PtrAuthData, Flags, ExtraData, Annotations));
1026 Metadata *Ops[] = {File, Scope, Name, SizeInBits,
1027 OffsetInBits, BaseType, ExtraData, Annotations};
1028 DEFINE_GETIMPL_STORE(
1029 DIDerivedType,
1030 (Tag, Line, AlignInBits, DWARFAddressSpace, PtrAuthData, Flags), Ops);
1031}
1032
1033std::optional<DIDerivedType::PtrAuthData>
1034DIDerivedType::getPtrAuthData() const {
1035 return getTag() == dwarf::DW_TAG_LLVM_ptrauth_type
1036 ? std::make_optional<PtrAuthData>(args: SubclassData32)
1037 : std::nullopt;
1038}
1039
1040DICompositeType *DICompositeType::getImpl(
1041 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File,
1042 unsigned Line, Metadata *Scope, Metadata *BaseType, Metadata *SizeInBits,
1043 uint32_t AlignInBits, Metadata *OffsetInBits, DIFlags Flags,
1044 Metadata *Elements, unsigned RuntimeLang, std::optional<uint32_t> EnumKind,
1045 Metadata *VTableHolder, Metadata *TemplateParams, MDString *Identifier,
1046 Metadata *Discriminator, Metadata *DataLocation, Metadata *Associated,
1047 Metadata *Allocated, Metadata *Rank, Metadata *Annotations,
1048 Metadata *Specification, uint32_t NumExtraInhabitants, Metadata *BitStride,
1049 StorageType Storage, bool ShouldCreate) {
1050 assert(isCanonical(Name) && "Expected canonical MDString");
1051
1052 // Keep this in sync with buildODRType.
1053 DEFINE_GETIMPL_LOOKUP(
1054 DICompositeType,
1055 (Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits,
1056 OffsetInBits, Flags, Elements, RuntimeLang, VTableHolder, TemplateParams,
1057 Identifier, Discriminator, DataLocation, Associated, Allocated, Rank,
1058 Annotations, Specification, NumExtraInhabitants, BitStride));
1059 Metadata *Ops[] = {File, Scope, Name, SizeInBits,
1060 OffsetInBits, BaseType, Elements, VTableHolder,
1061 TemplateParams, Identifier, Discriminator, DataLocation,
1062 Associated, Allocated, Rank, Annotations,
1063 Specification, BitStride};
1064 DEFINE_GETIMPL_STORE(DICompositeType,
1065 (Tag, Line, RuntimeLang, AlignInBits,
1066 NumExtraInhabitants, EnumKind, Flags),
1067 Ops);
1068}
1069
1070DICompositeType *DICompositeType::buildODRType(
1071 LLVMContext &Context, MDString &Identifier, unsigned Tag, MDString *Name,
1072 Metadata *File, unsigned Line, Metadata *Scope, Metadata *BaseType,
1073 Metadata *SizeInBits, uint32_t AlignInBits, Metadata *OffsetInBits,
1074 Metadata *Specification, uint32_t NumExtraInhabitants, DIFlags Flags,
1075 Metadata *Elements, unsigned RuntimeLang, std::optional<uint32_t> EnumKind,
1076 Metadata *VTableHolder, Metadata *TemplateParams, Metadata *Discriminator,
1077 Metadata *DataLocation, Metadata *Associated, Metadata *Allocated,
1078 Metadata *Rank, Metadata *Annotations, Metadata *BitStride) {
1079 assert(!Identifier.getString().empty() && "Expected valid identifier");
1080 if (!Context.isODRUniquingDebugTypes())
1081 return nullptr;
1082 auto *&CT = (*Context.pImpl->DITypeMap)[&Identifier];
1083 if (!CT)
1084 return CT = DICompositeType::getDistinct(
1085 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
1086 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
1087 EnumKind, VTableHolder, TemplateParams, Identifier: &Identifier,
1088 Discriminator, DataLocation, Associated, Allocated, Rank,
1089 Annotations, Specification, NumExtraInhabitants, BitStride);
1090 if (CT->getTag() != Tag)
1091 return nullptr;
1092
1093 // Only mutate CT if it's a forward declaration and the new operands aren't.
1094 assert(CT->getRawIdentifier() == &Identifier && "Wrong ODR identifier?");
1095 if (!CT->isForwardDecl() || (Flags & DINode::FlagFwdDecl))
1096 return CT;
1097
1098 // Mutate CT in place. Keep this in sync with getImpl.
1099 CT->mutate(Tag, Line, RuntimeLang, AlignInBits, NumExtraInhabitants, EnumKind,
1100 Flags);
1101 Metadata *Ops[] = {File, Scope, Name, SizeInBits,
1102 OffsetInBits, BaseType, Elements, VTableHolder,
1103 TemplateParams, &Identifier, Discriminator, DataLocation,
1104 Associated, Allocated, Rank, Annotations,
1105 Specification, BitStride};
1106 assert((std::end(Ops) - std::begin(Ops)) == (int)CT->getNumOperands() &&
1107 "Mismatched number of operands");
1108 for (unsigned I = 0, E = CT->getNumOperands(); I != E; ++I)
1109 if (Ops[I] != CT->getOperand(I))
1110 CT->setOperand(I, New: Ops[I]);
1111 return CT;
1112}
1113
1114DICompositeType *DICompositeType::getODRType(
1115 LLVMContext &Context, MDString &Identifier, unsigned Tag, MDString *Name,
1116 Metadata *File, unsigned Line, Metadata *Scope, Metadata *BaseType,
1117 Metadata *SizeInBits, uint32_t AlignInBits, Metadata *OffsetInBits,
1118 Metadata *Specification, uint32_t NumExtraInhabitants, DIFlags Flags,
1119 Metadata *Elements, unsigned RuntimeLang, std::optional<uint32_t> EnumKind,
1120 Metadata *VTableHolder, Metadata *TemplateParams, Metadata *Discriminator,
1121 Metadata *DataLocation, Metadata *Associated, Metadata *Allocated,
1122 Metadata *Rank, Metadata *Annotations, Metadata *BitStride) {
1123 assert(!Identifier.getString().empty() && "Expected valid identifier");
1124 if (!Context.isODRUniquingDebugTypes())
1125 return nullptr;
1126 auto *&CT = (*Context.pImpl->DITypeMap)[&Identifier];
1127 if (!CT) {
1128 CT = DICompositeType::getDistinct(
1129 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
1130 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang, EnumKind,
1131 VTableHolder, TemplateParams, Identifier: &Identifier, Discriminator, DataLocation,
1132 Associated, Allocated, Rank, Annotations, Specification,
1133 NumExtraInhabitants, BitStride);
1134 } else {
1135 if (CT->getTag() != Tag)
1136 return nullptr;
1137 }
1138 return CT;
1139}
1140
1141DICompositeType *DICompositeType::getODRTypeIfExists(LLVMContext &Context,
1142 MDString &Identifier) {
1143 assert(!Identifier.getString().empty() && "Expected valid identifier");
1144 if (!Context.isODRUniquingDebugTypes())
1145 return nullptr;
1146 return Context.pImpl->DITypeMap->lookup(Val: &Identifier);
1147}
1148DISubroutineType::DISubroutineType(LLVMContext &C, StorageType Storage,
1149 DIFlags Flags, uint8_t CC,
1150 ArrayRef<Metadata *> Ops)
1151 : DIType(C, DISubroutineTypeKind, Storage, dwarf::DW_TAG_subroutine_type, 0,
1152 0, 0, Flags, Ops),
1153 CC(CC) {}
1154
1155DISubroutineType *DISubroutineType::getImpl(LLVMContext &Context, DIFlags Flags,
1156 uint8_t CC, Metadata *TypeArray,
1157 StorageType Storage,
1158 bool ShouldCreate) {
1159 DEFINE_GETIMPL_LOOKUP(DISubroutineType, (Flags, CC, TypeArray));
1160 Metadata *Ops[] = {nullptr, nullptr, nullptr, nullptr, nullptr, TypeArray};
1161 DEFINE_GETIMPL_STORE(DISubroutineType, (Flags, CC), Ops);
1162}
1163
1164DIFile::DIFile(LLVMContext &C, StorageType Storage,
1165 std::optional<ChecksumInfo<MDString *>> CS, MDString *Src,
1166 ArrayRef<Metadata *> Ops)
1167 : DIScope(C, DIFileKind, Storage, dwarf::DW_TAG_file_type, Ops),
1168 Checksum(CS), Source(Src) {}
1169
1170// FIXME: Implement this string-enum correspondence with a .def file and macros,
1171// so that the association is explicit rather than implied.
1172static const char *ChecksumKindName[DIFile::CSK_Last] = {
1173 "CSK_MD5",
1174 "CSK_SHA1",
1175 "CSK_SHA256",
1176};
1177
1178StringRef DIFile::getChecksumKindAsString(ChecksumKind CSKind) {
1179 assert(CSKind <= DIFile::CSK_Last && "Invalid checksum kind");
1180 // The first space was originally the CSK_None variant, which is now
1181 // obsolete, but the space is still reserved in ChecksumKind, so we account
1182 // for it here.
1183 return ChecksumKindName[CSKind - 1];
1184}
1185
1186std::optional<DIFile::ChecksumKind>
1187DIFile::getChecksumKind(StringRef CSKindStr) {
1188 return StringSwitch<std::optional<DIFile::ChecksumKind>>(CSKindStr)
1189 .Case(S: "CSK_MD5", Value: DIFile::CSK_MD5)
1190 .Case(S: "CSK_SHA1", Value: DIFile::CSK_SHA1)
1191 .Case(S: "CSK_SHA256", Value: DIFile::CSK_SHA256)
1192 .Default(Value: std::nullopt);
1193}
1194
1195DIFile *DIFile::getImpl(LLVMContext &Context, MDString *Filename,
1196 MDString *Directory,
1197 std::optional<DIFile::ChecksumInfo<MDString *>> CS,
1198 MDString *Source, StorageType Storage,
1199 bool ShouldCreate) {
1200 assert(isCanonical(Filename) && "Expected canonical MDString");
1201 assert(isCanonical(Directory) && "Expected canonical MDString");
1202 assert((!CS || isCanonical(CS->Value)) && "Expected canonical MDString");
1203 // We do *NOT* expect Source to be a canonical MDString because nullptr
1204 // means none, so we need something to represent the empty file.
1205 DEFINE_GETIMPL_LOOKUP(DIFile, (Filename, Directory, CS, Source));
1206 Metadata *Ops[] = {Filename, Directory, CS ? CS->Value : nullptr, Source};
1207 DEFINE_GETIMPL_STORE(DIFile, (CS, Source), Ops);
1208}
1209DICompileUnit::DICompileUnit(LLVMContext &C, StorageType Storage,
1210 DISourceLanguageName SourceLanguage,
1211 bool IsOptimized, unsigned RuntimeVersion,
1212 unsigned EmissionKind, uint64_t DWOId,
1213 bool SplitDebugInlining,
1214 bool DebugInfoForProfiling, unsigned NameTableKind,
1215 bool RangesBaseAddress, ArrayRef<Metadata *> Ops)
1216 : DIScope(C, DICompileUnitKind, Storage, dwarf::DW_TAG_compile_unit, Ops),
1217 SourceLanguage(SourceLanguage), RuntimeVersion(RuntimeVersion),
1218 DWOId(DWOId), EmissionKind(EmissionKind), NameTableKind(NameTableKind),
1219 IsOptimized(IsOptimized), SplitDebugInlining(SplitDebugInlining),
1220 DebugInfoForProfiling(DebugInfoForProfiling),
1221 RangesBaseAddress(RangesBaseAddress) {
1222 assert(Storage != Uniqued);
1223}
1224
1225DICompileUnit *DICompileUnit::getImpl(
1226 LLVMContext &Context, DISourceLanguageName SourceLanguage, Metadata *File,
1227 MDString *Producer, bool IsOptimized, MDString *Flags,
1228 unsigned RuntimeVersion, MDString *SplitDebugFilename,
1229 unsigned EmissionKind, Metadata *EnumTypes, Metadata *RetainedTypes,
1230 Metadata *GlobalVariables, Metadata *ImportedEntities, Metadata *Macros,
1231 uint64_t DWOId, bool SplitDebugInlining, bool DebugInfoForProfiling,
1232 unsigned NameTableKind, bool RangesBaseAddress, MDString *SysRoot,
1233 MDString *SDK, StorageType Storage, bool ShouldCreate) {
1234 assert(Storage != Uniqued && "Cannot unique DICompileUnit");
1235 assert(isCanonical(Producer) && "Expected canonical MDString");
1236 assert(isCanonical(Flags) && "Expected canonical MDString");
1237 assert(isCanonical(SplitDebugFilename) && "Expected canonical MDString");
1238
1239 Metadata *Ops[] = {File,
1240 Producer,
1241 Flags,
1242 SplitDebugFilename,
1243 EnumTypes,
1244 RetainedTypes,
1245 GlobalVariables,
1246 ImportedEntities,
1247 Macros,
1248 SysRoot,
1249 SDK};
1250 return storeImpl(N: new (std::size(Ops), Storage) DICompileUnit(
1251 Context, Storage, SourceLanguage, IsOptimized,
1252 RuntimeVersion, EmissionKind, DWOId, SplitDebugInlining,
1253 DebugInfoForProfiling, NameTableKind, RangesBaseAddress,
1254 Ops),
1255 Storage);
1256}
1257
1258std::optional<DICompileUnit::DebugEmissionKind>
1259DICompileUnit::getEmissionKind(StringRef Str) {
1260 return StringSwitch<std::optional<DebugEmissionKind>>(Str)
1261 .Case(S: "NoDebug", Value: NoDebug)
1262 .Case(S: "FullDebug", Value: FullDebug)
1263 .Case(S: "LineTablesOnly", Value: LineTablesOnly)
1264 .Case(S: "DebugDirectivesOnly", Value: DebugDirectivesOnly)
1265 .Default(Value: std::nullopt);
1266}
1267
1268std::optional<DICompileUnit::DebugNameTableKind>
1269DICompileUnit::getNameTableKind(StringRef Str) {
1270 return StringSwitch<std::optional<DebugNameTableKind>>(Str)
1271 .Case(S: "Default", Value: DebugNameTableKind::Default)
1272 .Case(S: "GNU", Value: DebugNameTableKind::GNU)
1273 .Case(S: "Apple", Value: DebugNameTableKind::Apple)
1274 .Case(S: "None", Value: DebugNameTableKind::None)
1275 .Default(Value: std::nullopt);
1276}
1277
1278const char *DICompileUnit::emissionKindString(DebugEmissionKind EK) {
1279 switch (EK) {
1280 case NoDebug:
1281 return "NoDebug";
1282 case FullDebug:
1283 return "FullDebug";
1284 case LineTablesOnly:
1285 return "LineTablesOnly";
1286 case DebugDirectivesOnly:
1287 return "DebugDirectivesOnly";
1288 }
1289 return nullptr;
1290}
1291
1292const char *DICompileUnit::nameTableKindString(DebugNameTableKind NTK) {
1293 switch (NTK) {
1294 case DebugNameTableKind::Default:
1295 return nullptr;
1296 case DebugNameTableKind::GNU:
1297 return "GNU";
1298 case DebugNameTableKind::Apple:
1299 return "Apple";
1300 case DebugNameTableKind::None:
1301 return "None";
1302 }
1303 return nullptr;
1304}
1305DISubprogram::DISubprogram(LLVMContext &C, StorageType Storage, unsigned Line,
1306 unsigned ScopeLine, unsigned VirtualIndex,
1307 int ThisAdjustment, DIFlags Flags, DISPFlags SPFlags,
1308 bool UsesKeyInstructions, ArrayRef<Metadata *> Ops)
1309 : DILocalScope(C, DISubprogramKind, Storage, dwarf::DW_TAG_subprogram, Ops),
1310 Line(Line), ScopeLine(ScopeLine), VirtualIndex(VirtualIndex),
1311 ThisAdjustment(ThisAdjustment), Flags(Flags), SPFlags(SPFlags) {
1312 static_assert(dwarf::DW_VIRTUALITY_max < 4, "Virtuality out of range");
1313 SubclassData1 = UsesKeyInstructions;
1314}
1315DISubprogram::DISPFlags
1316DISubprogram::toSPFlags(bool IsLocalToUnit, bool IsDefinition, bool IsOptimized,
1317 unsigned Virtuality, bool IsMainSubprogram) {
1318 // We're assuming virtuality is the low-order field.
1319 static_assert(int(SPFlagVirtual) == int(dwarf::DW_VIRTUALITY_virtual) &&
1320 int(SPFlagPureVirtual) ==
1321 int(dwarf::DW_VIRTUALITY_pure_virtual),
1322 "Virtuality constant mismatch");
1323 return static_cast<DISPFlags>(
1324 (Virtuality & SPFlagVirtuality) |
1325 (IsLocalToUnit ? SPFlagLocalToUnit : SPFlagZero) |
1326 (IsDefinition ? SPFlagDefinition : SPFlagZero) |
1327 (IsOptimized ? SPFlagOptimized : SPFlagZero) |
1328 (IsMainSubprogram ? SPFlagMainSubprogram : SPFlagZero));
1329}
1330
1331DISubprogram *DILocalScope::getSubprogram() const {
1332 if (auto *Block = dyn_cast<DILexicalBlockBase>(Val: this))
1333 return Block->getScope()->getSubprogram();
1334 return const_cast<DISubprogram *>(cast<DISubprogram>(Val: this));
1335}
1336
1337DILocalScope *DILocalScope::getNonLexicalBlockFileScope() const {
1338 if (auto *File = dyn_cast<DILexicalBlockFile>(Val: this))
1339 return File->getScope()->getNonLexicalBlockFileScope();
1340 return const_cast<DILocalScope *>(this);
1341}
1342
1343DILocalScope *DILocalScope::cloneScopeForSubprogram(
1344 DILocalScope &RootScope, DISubprogram &NewSP, LLVMContext &Ctx,
1345 DenseMap<const MDNode *, MDNode *> &Cache) {
1346 SmallVector<DIScope *> ScopeChain;
1347 DIScope *CachedResult = nullptr;
1348
1349 for (DIScope *Scope = &RootScope; !isa<DISubprogram>(Val: Scope);
1350 Scope = Scope->getScope()) {
1351 if (auto It = Cache.find(Val: Scope); It != Cache.end()) {
1352 CachedResult = cast<DIScope>(Val: It->second);
1353 break;
1354 }
1355 ScopeChain.push_back(Elt: Scope);
1356 }
1357
1358 // Recreate the scope chain, bottom-up, starting at the new subprogram (or a
1359 // cached result).
1360 DIScope *UpdatedScope = CachedResult ? CachedResult : &NewSP;
1361 for (DIScope *ScopeToUpdate : reverse(C&: ScopeChain)) {
1362 UpdatedScope = cloneAndReplaceParentScope(
1363 LBB: cast<DILexicalBlockBase>(Val: ScopeToUpdate), NewParent: UpdatedScope);
1364 Cache[ScopeToUpdate] = UpdatedScope;
1365 }
1366
1367 return cast<DILocalScope>(Val: UpdatedScope);
1368}
1369
1370DISubprogram::DISPFlags DISubprogram::getFlag(StringRef Flag) {
1371 return StringSwitch<DISPFlags>(Flag)
1372#define HANDLE_DISP_FLAG(ID, NAME) .Case("DISPFlag" #NAME, SPFlag##NAME)
1373#include "llvm/IR/DebugInfoFlags.def"
1374 .Default(Value: SPFlagZero);
1375}
1376
1377StringRef DISubprogram::getFlagString(DISPFlags Flag) {
1378 switch (Flag) {
1379 // Appease a warning.
1380 case SPFlagVirtuality:
1381 return "";
1382#define HANDLE_DISP_FLAG(ID, NAME) \
1383 case SPFlag##NAME: \
1384 return "DISPFlag" #NAME;
1385#include "llvm/IR/DebugInfoFlags.def"
1386 }
1387 return "";
1388}
1389
1390DISubprogram::DISPFlags
1391DISubprogram::splitFlags(DISPFlags Flags,
1392 SmallVectorImpl<DISPFlags> &SplitFlags) {
1393 // Multi-bit fields can require special handling. In our case, however, the
1394 // only multi-bit field is virtuality, and all its values happen to be
1395 // single-bit values, so the right behavior just falls out.
1396#define HANDLE_DISP_FLAG(ID, NAME) \
1397 if (DISPFlags Bit = Flags & SPFlag##NAME) { \
1398 SplitFlags.push_back(Bit); \
1399 Flags &= ~Bit; \
1400 }
1401#include "llvm/IR/DebugInfoFlags.def"
1402 return Flags;
1403}
1404
1405DISubprogram *DISubprogram::getImpl(
1406 LLVMContext &Context, Metadata *Scope, MDString *Name,
1407 MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
1408 unsigned ScopeLine, Metadata *ContainingType, unsigned VirtualIndex,
1409 int ThisAdjustment, DIFlags Flags, DISPFlags SPFlags, Metadata *Unit,
1410 Metadata *TemplateParams, Metadata *Declaration, Metadata *RetainedNodes,
1411 Metadata *ThrownTypes, Metadata *Annotations, MDString *TargetFuncName,
1412 bool UsesKeyInstructions, StorageType Storage, bool ShouldCreate) {
1413 assert(isCanonical(Name) && "Expected canonical MDString");
1414 assert(isCanonical(LinkageName) && "Expected canonical MDString");
1415 assert(isCanonical(TargetFuncName) && "Expected canonical MDString");
1416 DEFINE_GETIMPL_LOOKUP(DISubprogram,
1417 (Scope, Name, LinkageName, File, Line, Type, ScopeLine,
1418 ContainingType, VirtualIndex, ThisAdjustment, Flags,
1419 SPFlags, Unit, TemplateParams, Declaration,
1420 RetainedNodes, ThrownTypes, Annotations,
1421 TargetFuncName, UsesKeyInstructions));
1422 SmallVector<Metadata *, 13> Ops = {
1423 File, Scope, Name, LinkageName,
1424 Type, Unit, Declaration, RetainedNodes,
1425 ContainingType, TemplateParams, ThrownTypes, Annotations,
1426 TargetFuncName};
1427 if (!TargetFuncName) {
1428 Ops.pop_back();
1429 if (!Annotations) {
1430 Ops.pop_back();
1431 if (!ThrownTypes) {
1432 Ops.pop_back();
1433 if (!TemplateParams) {
1434 Ops.pop_back();
1435 if (!ContainingType)
1436 Ops.pop_back();
1437 }
1438 }
1439 }
1440 }
1441 DEFINE_GETIMPL_STORE_N(DISubprogram,
1442 (Line, ScopeLine, VirtualIndex, ThisAdjustment, Flags,
1443 SPFlags, UsesKeyInstructions),
1444 Ops, Ops.size());
1445}
1446
1447bool DISubprogram::describes(const Function *F) const {
1448 assert(F && "Invalid function");
1449 return F->getSubprogram() == this;
1450}
1451
1452template <typename ScopeT, typename NodeT>
1453static ScopeT getRawRetainedNodeScopeInternal(NodeT *N) {
1454 auto getScopeLambda = [](auto *N) { return getScope(N); };
1455 return DISubprogram::visitRetainedNode<ScopeT>(
1456 N, getScopeLambda, getScopeLambda, getScopeLambda, getScopeLambda,
1457 getScopeLambda, [](auto *N) { return nullptr; });
1458}
1459
1460const DIScope *DISubprogram::getRawRetainedNodeScope(const MDNode *N) {
1461 return getRawRetainedNodeScopeInternal<const DIScope *>(N);
1462}
1463
1464DIScope *DISubprogram::getRawRetainedNodeScope(MDNode *N) {
1465 return getRawRetainedNodeScopeInternal<DIScope *>(N);
1466}
1467
1468const DILocalScope *DISubprogram::getRetainedNodeScope(const MDNode *N) {
1469 return cast<DILocalScope>(Val: getRawRetainedNodeScope(N));
1470}
1471
1472DILocalScope *DISubprogram::getRetainedNodeScope(MDNode *N) {
1473 return cast<DILocalScope>(Val: getRawRetainedNodeScope(N));
1474}
1475
1476void DISubprogram::cleanupRetainedNodes() {
1477 // Checks if a metadata node from retainedTypes is a type belonging to
1478 // this subprogram.
1479 auto IsTypeInSP = [this](Metadata *N) {
1480 auto *T = dyn_cast_or_null<DIType>(Val: N);
1481 if (!T)
1482 return true;
1483
1484 DISubprogram *TypeSP = nullptr;
1485 // The type might have been global in the previously loaded IR modules.
1486 if (auto *LS = dyn_cast_or_null<DILocalScope>(Val: T->getScope()))
1487 TypeSP = LS->getSubprogram();
1488
1489 return this == TypeSP;
1490 };
1491
1492 cleanupRetainedNodesIf(Pred&: IsTypeInSP);
1493}
1494
1495DILexicalBlockBase::DILexicalBlockBase(LLVMContext &C, unsigned ID,
1496 StorageType Storage,
1497 ArrayRef<Metadata *> Ops)
1498 : DILocalScope(C, ID, Storage, dwarf::DW_TAG_lexical_block, Ops) {}
1499
1500DILexicalBlock *DILexicalBlock::getImpl(LLVMContext &Context, Metadata *Scope,
1501 Metadata *File, unsigned Line,
1502 unsigned Column, StorageType Storage,
1503 bool ShouldCreate) {
1504 // Fixup column.
1505 adjustColumn(Column);
1506
1507 assert(Scope && "Expected scope");
1508 DEFINE_GETIMPL_LOOKUP(DILexicalBlock, (Scope, File, Line, Column));
1509 Metadata *Ops[] = {File, Scope};
1510 DEFINE_GETIMPL_STORE(DILexicalBlock, (Line, Column), Ops);
1511}
1512
1513DILexicalBlockFile *DILexicalBlockFile::getImpl(LLVMContext &Context,
1514 Metadata *Scope, Metadata *File,
1515 unsigned Discriminator,
1516 StorageType Storage,
1517 bool ShouldCreate) {
1518 assert(Scope && "Expected scope");
1519 DEFINE_GETIMPL_LOOKUP(DILexicalBlockFile, (Scope, File, Discriminator));
1520 Metadata *Ops[] = {File, Scope};
1521 DEFINE_GETIMPL_STORE(DILexicalBlockFile, (Discriminator), Ops);
1522}
1523
1524DINamespace::DINamespace(LLVMContext &Context, StorageType Storage,
1525 bool ExportSymbols, ArrayRef<Metadata *> Ops)
1526 : DIScope(Context, DINamespaceKind, Storage, dwarf::DW_TAG_namespace, Ops) {
1527 SubclassData1 = ExportSymbols;
1528}
1529DINamespace *DINamespace::getImpl(LLVMContext &Context, Metadata *Scope,
1530 MDString *Name, bool ExportSymbols,
1531 StorageType Storage, bool ShouldCreate) {
1532 assert(isCanonical(Name) && "Expected canonical MDString");
1533 DEFINE_GETIMPL_LOOKUP(DINamespace, (Scope, Name, ExportSymbols));
1534 // The nullptr is for DIScope's File operand. This should be refactored.
1535 Metadata *Ops[] = {nullptr, Scope, Name};
1536 DEFINE_GETIMPL_STORE(DINamespace, (ExportSymbols), Ops);
1537}
1538
1539DICommonBlock::DICommonBlock(LLVMContext &Context, StorageType Storage,
1540 unsigned LineNo, ArrayRef<Metadata *> Ops)
1541 : DIScope(Context, DICommonBlockKind, Storage, dwarf::DW_TAG_common_block,
1542 Ops) {
1543 SubclassData32 = LineNo;
1544}
1545DICommonBlock *DICommonBlock::getImpl(LLVMContext &Context, Metadata *Scope,
1546 Metadata *Decl, MDString *Name,
1547 Metadata *File, unsigned LineNo,
1548 StorageType Storage, bool ShouldCreate) {
1549 assert(isCanonical(Name) && "Expected canonical MDString");
1550 DEFINE_GETIMPL_LOOKUP(DICommonBlock, (Scope, Decl, Name, File, LineNo));
1551 // The nullptr is for DIScope's File operand. This should be refactored.
1552 Metadata *Ops[] = {Scope, Decl, Name, File};
1553 DEFINE_GETIMPL_STORE(DICommonBlock, (LineNo), Ops);
1554}
1555
1556DIModule::DIModule(LLVMContext &Context, StorageType Storage, unsigned LineNo,
1557 bool IsDecl, ArrayRef<Metadata *> Ops)
1558 : DIScope(Context, DIModuleKind, Storage, dwarf::DW_TAG_module, Ops) {
1559 SubclassData1 = IsDecl;
1560 SubclassData32 = LineNo;
1561}
1562DIModule *DIModule::getImpl(LLVMContext &Context, Metadata *File,
1563 Metadata *Scope, MDString *Name,
1564 MDString *ConfigurationMacros,
1565 MDString *IncludePath, MDString *APINotesFile,
1566 unsigned LineNo, bool IsDecl, StorageType Storage,
1567 bool ShouldCreate) {
1568 assert(isCanonical(Name) && "Expected canonical MDString");
1569 DEFINE_GETIMPL_LOOKUP(DIModule, (File, Scope, Name, ConfigurationMacros,
1570 IncludePath, APINotesFile, LineNo, IsDecl));
1571 Metadata *Ops[] = {File, Scope, Name, ConfigurationMacros,
1572 IncludePath, APINotesFile};
1573 DEFINE_GETIMPL_STORE(DIModule, (LineNo, IsDecl), Ops);
1574}
1575DITemplateTypeParameter::DITemplateTypeParameter(LLVMContext &Context,
1576 StorageType Storage,
1577 bool IsDefault,
1578 ArrayRef<Metadata *> Ops)
1579 : DITemplateParameter(Context, DITemplateTypeParameterKind, Storage,
1580 dwarf::DW_TAG_template_type_parameter, IsDefault,
1581 Ops) {}
1582
1583DITemplateTypeParameter *
1584DITemplateTypeParameter::getImpl(LLVMContext &Context, MDString *Name,
1585 Metadata *Type, bool isDefault,
1586 StorageType Storage, bool ShouldCreate) {
1587 assert(isCanonical(Name) && "Expected canonical MDString");
1588 DEFINE_GETIMPL_LOOKUP(DITemplateTypeParameter, (Name, Type, isDefault));
1589 Metadata *Ops[] = {Name, Type};
1590 DEFINE_GETIMPL_STORE(DITemplateTypeParameter, (isDefault), Ops);
1591}
1592
1593DITemplateValueParameter *DITemplateValueParameter::getImpl(
1594 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *Type,
1595 bool isDefault, Metadata *Value, StorageType Storage, bool ShouldCreate) {
1596 assert(isCanonical(Name) && "Expected canonical MDString");
1597 DEFINE_GETIMPL_LOOKUP(DITemplateValueParameter,
1598 (Tag, Name, Type, isDefault, Value));
1599 Metadata *Ops[] = {Name, Type, Value};
1600 DEFINE_GETIMPL_STORE(DITemplateValueParameter, (Tag, isDefault), Ops);
1601}
1602
1603DIGlobalVariable *
1604DIGlobalVariable::getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
1605 MDString *LinkageName, Metadata *File, unsigned Line,
1606 Metadata *Type, bool IsLocalToUnit, bool IsDefinition,
1607 Metadata *StaticDataMemberDeclaration,
1608 Metadata *TemplateParams, uint32_t AlignInBits,
1609 Metadata *Annotations, StorageType Storage,
1610 bool ShouldCreate) {
1611 assert(isCanonical(Name) && "Expected canonical MDString");
1612 assert(isCanonical(LinkageName) && "Expected canonical MDString");
1613 DEFINE_GETIMPL_LOOKUP(
1614 DIGlobalVariable,
1615 (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, IsDefinition,
1616 StaticDataMemberDeclaration, TemplateParams, AlignInBits, Annotations));
1617 Metadata *Ops[] = {Scope,
1618 Name,
1619 File,
1620 Type,
1621 Name,
1622 LinkageName,
1623 StaticDataMemberDeclaration,
1624 TemplateParams,
1625 Annotations};
1626 DEFINE_GETIMPL_STORE(DIGlobalVariable,
1627 (Line, IsLocalToUnit, IsDefinition, AlignInBits), Ops);
1628}
1629
1630DILocalVariable *
1631DILocalVariable::getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
1632 Metadata *File, unsigned Line, Metadata *Type,
1633 unsigned Arg, DIFlags Flags, uint32_t AlignInBits,
1634 Metadata *Annotations, StorageType Storage,
1635 bool ShouldCreate) {
1636 // 64K ought to be enough for any frontend.
1637 assert(Arg <= UINT16_MAX && "Expected argument number to fit in 16-bits");
1638
1639 assert(Scope && "Expected scope");
1640 assert(isCanonical(Name) && "Expected canonical MDString");
1641 DEFINE_GETIMPL_LOOKUP(DILocalVariable, (Scope, Name, File, Line, Type, Arg,
1642 Flags, AlignInBits, Annotations));
1643 Metadata *Ops[] = {Scope, Name, File, Type, Annotations};
1644 DEFINE_GETIMPL_STORE(DILocalVariable, (Line, Arg, Flags, AlignInBits), Ops);
1645}
1646
1647DIVariable::DIVariable(LLVMContext &C, unsigned ID, StorageType Storage,
1648 signed Line, ArrayRef<Metadata *> Ops,
1649 uint32_t AlignInBits)
1650 : DINode(C, ID, Storage, dwarf::DW_TAG_variable, Ops), Line(Line) {
1651 SubclassData32 = AlignInBits;
1652}
1653std::optional<uint64_t> DIVariable::getSizeInBits() const {
1654 // This is used by the Verifier so be mindful of broken types.
1655 const Metadata *RawType = getRawType();
1656 while (RawType) {
1657 // Try to get the size directly.
1658 if (auto *T = dyn_cast<DIType>(Val: RawType))
1659 if (uint64_t Size = T->getSizeInBits())
1660 return Size;
1661
1662 if (auto *DT = dyn_cast<DIDerivedType>(Val: RawType)) {
1663 // Look at the base type.
1664 RawType = DT->getRawBaseType();
1665 continue;
1666 }
1667
1668 // Missing type or size.
1669 break;
1670 }
1671
1672 // Fail gracefully.
1673 return std::nullopt;
1674}
1675
1676DILabel::DILabel(LLVMContext &C, StorageType Storage, unsigned Line,
1677 unsigned Column, bool IsArtificial,
1678 std::optional<unsigned> CoroSuspendIdx,
1679 ArrayRef<Metadata *> Ops)
1680 : DINode(C, DILabelKind, Storage, dwarf::DW_TAG_label, Ops) {
1681 this->SubclassData32 = Line;
1682 this->Column = Column;
1683 this->IsArtificial = IsArtificial;
1684 this->CoroSuspendIdx = CoroSuspendIdx;
1685}
1686DILabel *DILabel::getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
1687 Metadata *File, unsigned Line, unsigned Column,
1688 bool IsArtificial,
1689 std::optional<unsigned> CoroSuspendIdx,
1690 StorageType Storage, bool ShouldCreate) {
1691 assert(Scope && "Expected scope");
1692 assert(isCanonical(Name) && "Expected canonical MDString");
1693 DEFINE_GETIMPL_LOOKUP(
1694 DILabel, (Scope, Name, File, Line, Column, IsArtificial, CoroSuspendIdx));
1695 Metadata *Ops[] = {Scope, Name, File};
1696 DEFINE_GETIMPL_STORE(DILabel, (Line, Column, IsArtificial, CoroSuspendIdx),
1697 Ops);
1698}
1699
1700DIExpression *DIExpression::getImpl(LLVMContext &Context,
1701 ArrayRef<uint64_t> Elements,
1702 StorageType Storage, bool ShouldCreate) {
1703 DEFINE_GETIMPL_LOOKUP(DIExpression, (Elements));
1704 DEFINE_GETIMPL_STORE_NO_OPS(DIExpression, (Elements));
1705}
1706bool DIExpression::isEntryValue() const {
1707 if (auto singleLocElts = getSingleLocationExpressionElements()) {
1708 return singleLocElts->size() > 0 &&
1709 (*singleLocElts)[0] == dwarf::DW_OP_LLVM_entry_value;
1710 }
1711 return false;
1712}
1713bool DIExpression::startsWithDeref() const {
1714 if (auto singleLocElts = getSingleLocationExpressionElements())
1715 return singleLocElts->size() > 0 &&
1716 (*singleLocElts)[0] == dwarf::DW_OP_deref;
1717 return false;
1718}
1719bool DIExpression::isDeref() const {
1720 if (auto singleLocElts = getSingleLocationExpressionElements())
1721 return singleLocElts->size() == 1 &&
1722 (*singleLocElts)[0] == dwarf::DW_OP_deref;
1723 return false;
1724}
1725
1726DIAssignID *DIAssignID::getImpl(LLVMContext &Context, StorageType Storage,
1727 bool ShouldCreate) {
1728 // Uniqued DIAssignID are not supported as the instance address *is* the ID.
1729 assert(Storage != StorageType::Uniqued && "uniqued DIAssignID unsupported");
1730 return storeImpl(N: new (0u, Storage) DIAssignID(Context, Storage), Storage);
1731}
1732
1733unsigned DIExpression::ExprOperand::getSize() const {
1734 uint64_t Op = getOp();
1735
1736 if (Op >= dwarf::DW_OP_breg0 && Op <= dwarf::DW_OP_breg31)
1737 return 2;
1738
1739 switch (Op) {
1740 case dwarf::DW_OP_LLVM_convert:
1741 case dwarf::DW_OP_LLVM_fragment:
1742 case dwarf::DW_OP_LLVM_extract_bits_sext:
1743 case dwarf::DW_OP_LLVM_extract_bits_zext:
1744 case dwarf::DW_OP_bregx:
1745 return 3;
1746 case dwarf::DW_OP_constu:
1747 case dwarf::DW_OP_consts:
1748 case dwarf::DW_OP_deref_size:
1749 case dwarf::DW_OP_plus_uconst:
1750 case dwarf::DW_OP_LLVM_tag_offset:
1751 case dwarf::DW_OP_LLVM_entry_value:
1752 case dwarf::DW_OP_LLVM_arg:
1753 case dwarf::DW_OP_regx:
1754 return 2;
1755 default:
1756 return 1;
1757 }
1758}
1759
1760bool DIExpression::ExprOperand::isNonEmitting() const {
1761 return getOp() == dwarf::DW_OP_LLVM_tag_offset;
1762}
1763
1764bool DIExpression::ArgOp::classof(const ExprOperand *Op) {
1765 return Op->is(Opcode: dwarf::DW_OP_LLVM_arg);
1766}
1767
1768bool DIExpression::FragmentOp::classof(const ExprOperand *Op) {
1769 return Op->is(Opcode: dwarf::DW_OP_LLVM_fragment);
1770}
1771
1772bool DIExpression::ExtractBitsOp::classof(const ExprOperand *Op) {
1773 return Op->is(Opcode: dwarf::DW_OP_LLVM_extract_bits_sext) ||
1774 Op->is(Opcode: dwarf::DW_OP_LLVM_extract_bits_zext);
1775}
1776
1777bool DIExpression::ExtractBitsOp::isSigned() const {
1778 return is(Opcode: dwarf::DW_OP_LLVM_extract_bits_sext);
1779}
1780
1781bool DIExpression::ConvertOp::classof(const ExprOperand *Op) {
1782 return Op->is(Opcode: dwarf::DW_OP_LLVM_convert);
1783}
1784
1785bool DIExpression::EntryValueOp::classof(const ExprOperand *Op) {
1786 return Op->is(Opcode: dwarf::DW_OP_LLVM_entry_value);
1787}
1788
1789bool DIExpression::TagOffsetOp::classof(const ExprOperand *Op) {
1790 return Op->is(Opcode: dwarf::DW_OP_LLVM_tag_offset);
1791}
1792
1793bool DIExpression::ConstuOp::classof(const ExprOperand *Op) {
1794 return Op->is(Opcode: dwarf::DW_OP_constu);
1795}
1796
1797bool DIExpression::PlusUconstOp::classof(const ExprOperand *Op) {
1798 return Op->is(Opcode: dwarf::DW_OP_plus_uconst);
1799}
1800
1801bool DIExpression::isValid() const {
1802 for (auto I = expr_op_begin(), E = expr_op_end(); I != E; ++I) {
1803 // Check that there's space for the operand.
1804 if (I->get() + I->getSize() > E->get())
1805 return false;
1806
1807 uint64_t Op = I->getOp();
1808 if ((Op >= dwarf::DW_OP_reg0 && Op <= dwarf::DW_OP_reg31) ||
1809 (Op >= dwarf::DW_OP_breg0 && Op <= dwarf::DW_OP_breg31))
1810 continue;
1811
1812 // Check that the operand is valid.
1813 switch (Op) {
1814 default:
1815 return false;
1816 case dwarf::DW_OP_LLVM_fragment:
1817 // A fragment operator must appear at the end.
1818 return I->get() + I->getSize() == E->get();
1819 case dwarf::DW_OP_stack_value: {
1820 // Must be the last one or followed by a DW_OP_LLVM_fragment.
1821 if (I->get() + I->getSize() == E->get())
1822 break;
1823 auto J = I;
1824 if ((++J)->getOp() != dwarf::DW_OP_LLVM_fragment)
1825 return false;
1826 break;
1827 }
1828 case dwarf::DW_OP_swap: {
1829 // Must be more than one implicit element on the stack.
1830
1831 // FIXME: A better way to implement this would be to add a local variable
1832 // that keeps track of the stack depth and introduce something like a
1833 // DW_LLVM_OP_implicit_location as a placeholder for the location this
1834 // DIExpression is attached to, or else pass the number of implicit stack
1835 // elements into isValid.
1836 if (getNumElements() == 1)
1837 return false;
1838 break;
1839 }
1840 case dwarf::DW_OP_LLVM_entry_value: {
1841 // An entry value operator must appear at the beginning or immediately
1842 // following `DW_OP_LLVM_arg 0`, and the number of operations it cover can
1843 // currently only be 1, because we support only entry values of a simple
1844 // register location. One reason for this is that we currently can't
1845 // calculate the size of the resulting DWARF block for other expressions.
1846 auto FirstOp = expr_op_begin();
1847 if (auto Arg = dyn_cast<ArgOp>(Val: *FirstOp); Arg && Arg.getIndex() == 0)
1848 ++FirstOp;
1849 if (I->get() != FirstOp->get() ||
1850 cast<EntryValueOp>(Val: *I).getNumOperations() != 1)
1851 return false;
1852 break;
1853 }
1854 case dwarf::DW_OP_LLVM_implicit_pointer:
1855 case dwarf::DW_OP_LLVM_convert:
1856 case dwarf::DW_OP_LLVM_arg:
1857 case dwarf::DW_OP_LLVM_tag_offset:
1858 case dwarf::DW_OP_LLVM_extract_bits_sext:
1859 case dwarf::DW_OP_LLVM_extract_bits_zext:
1860 case dwarf::DW_OP_constu:
1861 case dwarf::DW_OP_plus_uconst:
1862 case dwarf::DW_OP_plus:
1863 case dwarf::DW_OP_minus:
1864 case dwarf::DW_OP_mul:
1865 case dwarf::DW_OP_div:
1866 case dwarf::DW_OP_mod:
1867 case dwarf::DW_OP_or:
1868 case dwarf::DW_OP_and:
1869 case dwarf::DW_OP_xor:
1870 case dwarf::DW_OP_shl:
1871 case dwarf::DW_OP_shr:
1872 case dwarf::DW_OP_shra:
1873 case dwarf::DW_OP_deref:
1874 case dwarf::DW_OP_deref_size:
1875 case dwarf::DW_OP_xderef:
1876 case dwarf::DW_OP_lit0:
1877 case dwarf::DW_OP_not:
1878 case dwarf::DW_OP_dup:
1879 case dwarf::DW_OP_regx:
1880 case dwarf::DW_OP_bregx:
1881 case dwarf::DW_OP_push_object_address:
1882 case dwarf::DW_OP_over:
1883 case dwarf::DW_OP_rot:
1884 case dwarf::DW_OP_consts:
1885 case dwarf::DW_OP_eq:
1886 case dwarf::DW_OP_ne:
1887 case dwarf::DW_OP_gt:
1888 case dwarf::DW_OP_ge:
1889 case dwarf::DW_OP_lt:
1890 case dwarf::DW_OP_le:
1891 case dwarf::DW_OP_neg:
1892 case dwarf::DW_OP_abs:
1893 break;
1894 }
1895 }
1896 return true;
1897}
1898
1899bool DIExpression::isImplicit() const {
1900 if (!isValid())
1901 return false;
1902
1903 if (getNumElements() == 0)
1904 return false;
1905
1906 for (const auto &It : expr_ops()) {
1907 switch (It.getOp()) {
1908 default:
1909 break;
1910 case dwarf::DW_OP_stack_value:
1911 return true;
1912 }
1913 }
1914
1915 return false;
1916}
1917
1918bool DIExpression::isComplex() const {
1919 if (!isValid())
1920 return false;
1921
1922 if (getNumElements() == 0)
1923 return false;
1924
1925 // Tag offsets are non-emitting. They, fragments, and location operands don't
1926 // perform a computation by themselves.
1927 for (const auto &It : expr_ops()) {
1928 if (It.isNonEmitting())
1929 continue;
1930 switch (It.getOp()) {
1931 case dwarf::DW_OP_LLVM_fragment:
1932 case dwarf::DW_OP_LLVM_arg:
1933 continue;
1934 default:
1935 return true;
1936 }
1937 }
1938
1939 return false;
1940}
1941
1942bool DIExpression::isSingleLocationExpression() const {
1943 if (!isValid())
1944 return false;
1945
1946 if (getNumElements() == 0)
1947 return true;
1948
1949 auto ExprOpBegin = expr_ops().begin();
1950 auto ExprOpEnd = expr_ops().end();
1951 if (auto Arg = dyn_cast<ArgOp>(Val: *ExprOpBegin)) {
1952 if (Arg.getIndex() != 0)
1953 return false;
1954 ++ExprOpBegin;
1955 }
1956
1957 return !std::any_of(first: ExprOpBegin, last: ExprOpEnd,
1958 pred: [](auto Op) { return Op.is(dwarf::DW_OP_LLVM_arg); });
1959}
1960
1961std::optional<ArrayRef<uint64_t>>
1962DIExpression::getSingleLocationExpressionElements() const {
1963 // Check for `isValid` covered by `isSingleLocationExpression`.
1964 if (!isSingleLocationExpression())
1965 return std::nullopt;
1966
1967 // An empty expression is already non-variadic.
1968 if (!getNumElements())
1969 return ArrayRef<uint64_t>();
1970
1971 // If Expr does not have a leading DW_OP_LLVM_arg then we don't need to do
1972 // anything.
1973 if (getElements()[0] == dwarf::DW_OP_LLVM_arg)
1974 return getElements().drop_front(N: 2);
1975 return getElements();
1976}
1977
1978const DIExpression *
1979DIExpression::convertToUndefExpression(const DIExpression *Expr) {
1980 SmallVector<uint64_t, 3> UndefOps;
1981 if (auto FragmentInfo = Expr->getFragmentInfo()) {
1982 UndefOps.append(IL: {dwarf::DW_OP_LLVM_fragment, FragmentInfo->OffsetInBits,
1983 FragmentInfo->SizeInBits});
1984 }
1985 return DIExpression::get(Context&: Expr->getContext(), Elements: UndefOps);
1986}
1987
1988const DIExpression *
1989DIExpression::convertToVariadicExpression(const DIExpression *Expr) {
1990 if (any_of(Range: Expr->expr_ops(), P: [](auto ExprOp) {
1991 return ExprOp.getOp() == dwarf::DW_OP_LLVM_arg;
1992 }))
1993 return Expr;
1994 SmallVector<uint64_t> NewOps;
1995 NewOps.reserve(N: Expr->getNumElements() + 2);
1996 NewOps.append(IL: {dwarf::DW_OP_LLVM_arg, 0});
1997 NewOps.append(in_start: Expr->elements_begin(), in_end: Expr->elements_end());
1998 return DIExpression::get(Context&: Expr->getContext(), Elements: NewOps);
1999}
2000
2001std::optional<const DIExpression *>
2002DIExpression::convertToNonVariadicExpression(const DIExpression *Expr) {
2003 if (!Expr)
2004 return std::nullopt;
2005
2006 if (auto Elts = Expr->getSingleLocationExpressionElements())
2007 return DIExpression::get(Context&: Expr->getContext(), Elements: *Elts);
2008
2009 return std::nullopt;
2010}
2011
2012void DIExpression::canonicalizeExpressionOps(SmallVectorImpl<uint64_t> &Ops,
2013 const DIExpression *Expr,
2014 bool IsIndirect) {
2015 // If Expr is not already variadic, insert the implied `DW_OP_LLVM_arg 0`
2016 // to the existing expression ops.
2017 if (none_of(Range: Expr->expr_ops(), P: [](auto ExprOp) {
2018 return ExprOp.getOp() == dwarf::DW_OP_LLVM_arg;
2019 }))
2020 Ops.append(IL: {dwarf::DW_OP_LLVM_arg, 0});
2021 // If Expr is not indirect, we only need to insert the expression elements and
2022 // we're done.
2023 if (!IsIndirect) {
2024 Ops.append(in_start: Expr->elements_begin(), in_end: Expr->elements_end());
2025 return;
2026 }
2027 // If Expr is indirect, insert the implied DW_OP_deref at the end of the
2028 // expression but before DW_OP_{stack_value, LLVM_fragment} if they are
2029 // present.
2030 for (auto Op : Expr->expr_ops()) {
2031 if (Op.getOp() == dwarf::DW_OP_stack_value ||
2032 Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
2033 Ops.push_back(Elt: dwarf::DW_OP_deref);
2034 IsIndirect = false;
2035 }
2036 Op.appendToVector(V&: Ops);
2037 }
2038 if (IsIndirect)
2039 Ops.push_back(Elt: dwarf::DW_OP_deref);
2040}
2041
2042bool DIExpression::isEqualExpression(const DIExpression *FirstExpr,
2043 bool FirstIndirect,
2044 const DIExpression *SecondExpr,
2045 bool SecondIndirect) {
2046 SmallVector<uint64_t> FirstOps;
2047 DIExpression::canonicalizeExpressionOps(Ops&: FirstOps, Expr: FirstExpr, IsIndirect: FirstIndirect);
2048 SmallVector<uint64_t> SecondOps;
2049 DIExpression::canonicalizeExpressionOps(Ops&: SecondOps, Expr: SecondExpr,
2050 IsIndirect: SecondIndirect);
2051 return FirstOps == SecondOps;
2052}
2053
2054std::optional<DIExpression::FragmentInfo>
2055DIExpression::getFragmentInfo(expr_op_iterator Start, expr_op_iterator End) {
2056 for (auto I = Start; I != End; ++I)
2057 if (auto Fragment = dyn_cast<FragmentOp>(Val: *I))
2058 return FragmentInfo{Fragment.getSizeInBits(), Fragment.getOffsetInBits()};
2059 return std::nullopt;
2060}
2061
2062std::optional<uint64_t> DIExpression::getActiveBits(DIVariable *Var) {
2063 std::optional<uint64_t> InitialActiveBits = Var->getSizeInBits();
2064 std::optional<uint64_t> ActiveBits = InitialActiveBits;
2065 auto NarrowActiveBits = [&](uint64_t SizeInBits) {
2066 ActiveBits = ActiveBits ? std::min(a: *ActiveBits, b: SizeInBits) : SizeInBits;
2067 };
2068
2069 for (auto Op : expr_ops()) {
2070 switch (Op.getOp()) {
2071 default:
2072 // We assume the worst case for anything we don't currently handle and
2073 // revert to the initial active bits.
2074 ActiveBits = InitialActiveBits;
2075 break;
2076 case dwarf::DW_OP_LLVM_extract_bits_zext:
2077 case dwarf::DW_OP_LLVM_extract_bits_sext: {
2078 auto Extract = cast<ExtractBitsOp>(Val&: Op);
2079 // We can't handle an extract whose sign doesn't match that of the
2080 // variable.
2081 std::optional<DIBasicType::Signedness> VarSign = Var->getSignedness();
2082 bool VarSigned = (VarSign == DIBasicType::Signedness::Signed);
2083 if (!VarSign || VarSigned != Extract.isSigned()) {
2084 ActiveBits = InitialActiveBits;
2085 break;
2086 }
2087 NarrowActiveBits(Extract.getSizeInBits());
2088 break;
2089 }
2090 case dwarf::DW_OP_LLVM_fragment:
2091 NarrowActiveBits(cast<FragmentOp>(Val&: Op).getSizeInBits());
2092 break;
2093 }
2094 }
2095 return ActiveBits;
2096}
2097
2098void DIExpression::appendOffset(SmallVectorImpl<uint64_t> &Ops,
2099 int64_t Offset) {
2100 if (Offset > 0) {
2101 Ops.push_back(Elt: dwarf::DW_OP_plus_uconst);
2102 Ops.push_back(Elt: Offset);
2103 } else if (Offset < 0) {
2104 Ops.push_back(Elt: dwarf::DW_OP_constu);
2105 // Avoid UB when encountering LLONG_MIN, because in 2's complement
2106 // abs(LLONG_MIN) is LLONG_MAX+1.
2107 uint64_t AbsMinusOne = -(Offset+1);
2108 Ops.push_back(Elt: AbsMinusOne + 1);
2109 Ops.push_back(Elt: dwarf::DW_OP_minus);
2110 }
2111}
2112
2113bool DIExpression::extractIfOffset(int64_t &Offset) const {
2114 auto SingleLocEltsOpt = getSingleLocationExpressionElements();
2115 if (!SingleLocEltsOpt)
2116 return false;
2117 auto SingleLocElts = *SingleLocEltsOpt;
2118
2119 if (SingleLocElts.size() == 0) {
2120 Offset = 0;
2121 return true;
2122 }
2123
2124 if (SingleLocElts.size() == 2 &&
2125 SingleLocElts[0] == dwarf::DW_OP_plus_uconst) {
2126 Offset = SingleLocElts[1];
2127 return true;
2128 }
2129
2130 if (SingleLocElts.size() == 3 && SingleLocElts[0] == dwarf::DW_OP_constu) {
2131 if (SingleLocElts[2] == dwarf::DW_OP_plus) {
2132 Offset = SingleLocElts[1];
2133 return true;
2134 }
2135 if (SingleLocElts[2] == dwarf::DW_OP_minus) {
2136 Offset = -SingleLocElts[1];
2137 return true;
2138 }
2139 }
2140
2141 return false;
2142}
2143
2144bool DIExpression::extractLeadingOffset(
2145 ArrayRef<uint64_t> Ops, int64_t &OffsetInBytes,
2146 SmallVectorImpl<uint64_t> &RemainingOps) {
2147 OffsetInBytes = 0;
2148 RemainingOps.clear();
2149
2150 auto ExprOpEnd = expr_op_iterator(Ops.end());
2151 auto ExprOpIt = expr_op_iterator(Ops.begin());
2152 while (ExprOpIt != ExprOpEnd) {
2153 uint64_t Op = ExprOpIt->getOp();
2154 if (Op == dwarf::DW_OP_deref || Op == dwarf::DW_OP_deref_size ||
2155 Op == dwarf::DW_OP_deref_type || Op == dwarf::DW_OP_LLVM_fragment ||
2156 Op == dwarf::DW_OP_LLVM_extract_bits_zext ||
2157 Op == dwarf::DW_OP_LLVM_extract_bits_sext) {
2158 break;
2159 } else if (auto PlusUconst = dyn_cast<PlusUconstOp>(Val: *ExprOpIt)) {
2160 OffsetInBytes += PlusUconst.getOffset();
2161 } else if (auto Constant = dyn_cast<ConstuOp>(Val: *ExprOpIt)) {
2162 uint64_t Value = Constant.getValue();
2163 ++ExprOpIt;
2164 if (ExprOpIt->getOp() == dwarf::DW_OP_plus)
2165 OffsetInBytes += Value;
2166 else if (ExprOpIt->getOp() == dwarf::DW_OP_minus)
2167 OffsetInBytes -= Value;
2168 else
2169 return false;
2170 } else {
2171 // Not a const plus/minus operation or deref.
2172 return false;
2173 }
2174 ++ExprOpIt;
2175 }
2176 RemainingOps.append(in_start: ExprOpIt.getBase(), in_end: ExprOpEnd.getBase());
2177 return true;
2178}
2179
2180bool DIExpression::extractLeadingOffset(
2181 int64_t &OffsetInBytes, SmallVectorImpl<uint64_t> &RemainingOps) const {
2182 auto SingleLocEltsOpt = getSingleLocationExpressionElements();
2183 if (!SingleLocEltsOpt) {
2184 OffsetInBytes = 0;
2185 RemainingOps.clear();
2186 return false;
2187 }
2188
2189 return extractLeadingOffset(Ops: *SingleLocEltsOpt, OffsetInBytes, RemainingOps);
2190}
2191
2192bool DIExpression::hasAllLocationOps(unsigned N) const {
2193 SmallDenseSet<uint64_t, 4> SeenOps;
2194 for (auto ExprOp : expr_ops())
2195 if (auto Arg = dyn_cast<ArgOp>(Val&: ExprOp))
2196 SeenOps.insert(V: Arg.getIndex());
2197 for (uint64_t Idx = 0; Idx < N; ++Idx)
2198 if (!SeenOps.contains(V: Idx))
2199 return false;
2200 return true;
2201}
2202
2203const DIExpression *DIExpression::extractAddressClass(const DIExpression *Expr,
2204 unsigned &AddrClass) {
2205 // FIXME: This seems fragile. Nothing that verifies that these elements
2206 // actually map to ops and not operands.
2207 auto SingleLocEltsOpt = Expr->getSingleLocationExpressionElements();
2208 if (!SingleLocEltsOpt)
2209 return nullptr;
2210 auto SingleLocElts = *SingleLocEltsOpt;
2211
2212 const unsigned PatternSize = 4;
2213 if (SingleLocElts.size() >= PatternSize &&
2214 SingleLocElts[PatternSize - 4] == dwarf::DW_OP_constu &&
2215 SingleLocElts[PatternSize - 2] == dwarf::DW_OP_swap &&
2216 SingleLocElts[PatternSize - 1] == dwarf::DW_OP_xderef) {
2217 AddrClass = SingleLocElts[PatternSize - 3];
2218
2219 if (SingleLocElts.size() == PatternSize)
2220 return nullptr;
2221 return DIExpression::get(
2222 Context&: Expr->getContext(),
2223 Elements: ArrayRef(&*SingleLocElts.begin(), SingleLocElts.size() - PatternSize));
2224 }
2225 return Expr;
2226}
2227
2228DIExpression *DIExpression::prepend(const DIExpression *Expr, uint8_t Flags,
2229 int64_t Offset) {
2230 SmallVector<uint64_t, 8> Ops;
2231 if (Flags & DIExpression::DerefBefore)
2232 Ops.push_back(Elt: dwarf::DW_OP_deref);
2233
2234 appendOffset(Ops, Offset);
2235 if (Flags & DIExpression::DerefAfter)
2236 Ops.push_back(Elt: dwarf::DW_OP_deref);
2237
2238 bool StackValue = Flags & DIExpression::StackValue;
2239 bool EntryValue = Flags & DIExpression::EntryValue;
2240
2241 return prependOpcodes(Expr, Ops, StackValue, EntryValue);
2242}
2243
2244DIExpression *DIExpression::appendOpsToArg(const DIExpression *Expr,
2245 ArrayRef<uint64_t> Ops,
2246 unsigned ArgNo, bool StackValue) {
2247 assert(Expr && "Can't add ops to this expression");
2248
2249 // Handle non-variadic intrinsics by prepending the opcodes.
2250 if (!any_of(Range: Expr->expr_ops(),
2251 P: [](auto Op) { return Op.is(dwarf::DW_OP_LLVM_arg); })) {
2252 assert(ArgNo == 0 &&
2253 "Location Index must be 0 for a non-variadic expression.");
2254 SmallVector<uint64_t, 8> NewOps(Ops);
2255 return DIExpression::prependOpcodes(Expr, Ops&: NewOps, StackValue);
2256 }
2257
2258 SmallVector<uint64_t, 8> NewOps;
2259 for (auto Op : Expr->expr_ops()) {
2260 // A DW_OP_stack_value comes at the end, but before a DW_OP_LLVM_fragment.
2261 if (StackValue) {
2262 if (Op.getOp() == dwarf::DW_OP_stack_value)
2263 StackValue = false;
2264 else if (Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
2265 NewOps.push_back(Elt: dwarf::DW_OP_stack_value);
2266 StackValue = false;
2267 }
2268 }
2269 Op.appendToVector(V&: NewOps);
2270 if (auto Arg = dyn_cast<ArgOp>(Val&: Op); Arg && Arg.getIndex() == ArgNo)
2271 llvm::append_range(C&: NewOps, R&: Ops);
2272 }
2273 if (StackValue)
2274 NewOps.push_back(Elt: dwarf::DW_OP_stack_value);
2275
2276 return DIExpression::get(Context&: Expr->getContext(), Elements: NewOps);
2277}
2278
2279DIExpression *DIExpression::replaceArg(const DIExpression *Expr,
2280 uint64_t OldArg, uint64_t NewArg) {
2281 assert(Expr && "Can't replace args in this expression");
2282
2283 SmallVector<uint64_t, 8> NewOps;
2284
2285 for (auto Op : Expr->expr_ops()) {
2286 auto Arg = dyn_cast<ArgOp>(Val&: Op);
2287 if (!Arg || Arg.getIndex() < OldArg) {
2288 Op.appendToVector(V&: NewOps);
2289 continue;
2290 }
2291 NewOps.push_back(Elt: dwarf::DW_OP_LLVM_arg);
2292 uint64_t ArgIndex = Arg.getIndex() == OldArg ? NewArg : Arg.getIndex();
2293 // OldArg has been deleted from the Op list, so decrement all indices
2294 // greater than it.
2295 if (ArgIndex > OldArg)
2296 --ArgIndex;
2297 NewOps.push_back(Elt: ArgIndex);
2298 }
2299 return DIExpression::get(Context&: Expr->getContext(), Elements: NewOps);
2300}
2301
2302DIExpression *DIExpression::prependOpcodes(const DIExpression *Expr,
2303 SmallVectorImpl<uint64_t> &Ops,
2304 bool StackValue, bool EntryValue) {
2305 assert(Expr && "Can't prepend ops to this expression");
2306
2307 if (EntryValue) {
2308 Ops.push_back(Elt: dwarf::DW_OP_LLVM_entry_value);
2309 // Use a block size of 1 for the target register operand. The
2310 // DWARF backend currently cannot emit entry values with a block
2311 // size > 1.
2312 Ops.push_back(Elt: 1);
2313 }
2314
2315 // If there are no ops to prepend, do not even add the DW_OP_stack_value.
2316 if (Ops.empty())
2317 StackValue = false;
2318 for (auto Op : Expr->expr_ops()) {
2319 // A DW_OP_stack_value comes at the end, but before a DW_OP_LLVM_fragment.
2320 if (StackValue) {
2321 if (Op.getOp() == dwarf::DW_OP_stack_value)
2322 StackValue = false;
2323 else if (Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
2324 Ops.push_back(Elt: dwarf::DW_OP_stack_value);
2325 StackValue = false;
2326 }
2327 }
2328 Op.appendToVector(V&: Ops);
2329 }
2330 if (StackValue)
2331 Ops.push_back(Elt: dwarf::DW_OP_stack_value);
2332 return DIExpression::get(Context&: Expr->getContext(), Elements: Ops);
2333}
2334
2335DIExpression *DIExpression::append(const DIExpression *Expr,
2336 ArrayRef<uint64_t> Ops) {
2337 assert(Expr && !Ops.empty() && "Can't append ops to this expression");
2338
2339 // Copy Expr's current op list.
2340 SmallVector<uint64_t, 16> NewOps;
2341 for (auto Op : Expr->expr_ops()) {
2342 // Append new opcodes before DW_OP_{stack_value, LLVM_fragment}.
2343 if (Op.getOp() == dwarf::DW_OP_stack_value ||
2344 Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
2345 NewOps.append(in_start: Ops.begin(), in_end: Ops.end());
2346
2347 // Ensure that the new opcodes are only appended once.
2348 Ops = {};
2349 }
2350 Op.appendToVector(V&: NewOps);
2351 }
2352 NewOps.append(in_start: Ops.begin(), in_end: Ops.end());
2353 auto *result =
2354 DIExpression::get(Context&: Expr->getContext(), Elements: NewOps)->foldConstantMath();
2355 assert(result->isValid() && "concatenated expression is not valid");
2356 return result;
2357}
2358
2359DIExpression *DIExpression::appendToStack(const DIExpression *Expr,
2360 ArrayRef<uint64_t> Ops) {
2361 assert(Expr && !Ops.empty() && "Can't append ops to this expression");
2362 assert(std::none_of(expr_op_iterator(Ops.begin()),
2363 expr_op_iterator(Ops.end()),
2364 [](auto Op) {
2365 return Op.getOp() == dwarf::DW_OP_stack_value ||
2366 Op.getOp() == dwarf::DW_OP_LLVM_fragment;
2367 }) &&
2368 "Can't append this op");
2369
2370 // DIExpression stores opcodes and their arguments in a flat array. Walk the
2371 // parsed operations to find the last opcode that determines whether the
2372 // expression already ends in DW_OP_stack_value.
2373 std::optional<uint64_t> LastValueOp;
2374 for (auto Op : Expr->expr_ops()) {
2375 if (Op.isNonEmitting() || Op.getOp() == dwarf::DW_OP_LLVM_fragment)
2376 continue;
2377 LastValueOp = Op.getOp();
2378 }
2379 bool NeedsDeref = LastValueOp && *LastValueOp != dwarf::DW_OP_stack_value;
2380 bool NeedsStackValue = NeedsDeref || !LastValueOp;
2381
2382 // Append a DW_OP_deref after Expr's current op list if needed, then append
2383 // the new ops, and finally ensure that a single DW_OP_stack_value is present.
2384 SmallVector<uint64_t, 16> NewOps;
2385 if (NeedsDeref)
2386 NewOps.push_back(Elt: dwarf::DW_OP_deref);
2387 NewOps.append(in_start: Ops.begin(), in_end: Ops.end());
2388 if (NeedsStackValue)
2389 NewOps.push_back(Elt: dwarf::DW_OP_stack_value);
2390 return DIExpression::append(Expr, Ops: NewOps);
2391}
2392
2393std::optional<DIExpression *> DIExpression::createFragmentExpression(
2394 const DIExpression *Expr, unsigned OffsetInBits, unsigned SizeInBits) {
2395 SmallVector<uint64_t, 8> Ops;
2396 // Track whether it's safe to split the value at the top of the DWARF stack,
2397 // assuming that it'll be used as an implicit location value.
2398 bool CanSplitValue = true;
2399 // Track whether we need to add a fragment expression to the end of Expr.
2400 bool EmitFragment = true;
2401 // Copy over the expression, but leave off any trailing DW_OP_LLVM_fragment.
2402 if (Expr) {
2403 for (auto Op : Expr->expr_ops()) {
2404 switch (Op.getOp()) {
2405 default:
2406 break;
2407 case dwarf::DW_OP_shr:
2408 case dwarf::DW_OP_shra:
2409 case dwarf::DW_OP_shl:
2410 case dwarf::DW_OP_plus:
2411 case dwarf::DW_OP_plus_uconst:
2412 case dwarf::DW_OP_minus:
2413 // We can't safely split arithmetic or shift operations into multiple
2414 // fragments because we can't express carry-over between fragments.
2415 //
2416 // FIXME: We *could* preserve the lowest fragment of a constant offset
2417 // operation if the offset fits into SizeInBits.
2418 CanSplitValue = false;
2419 break;
2420 case dwarf::DW_OP_deref:
2421 case dwarf::DW_OP_deref_size:
2422 case dwarf::DW_OP_deref_type:
2423 case dwarf::DW_OP_xderef:
2424 case dwarf::DW_OP_xderef_size:
2425 case dwarf::DW_OP_xderef_type:
2426 // Preceeding arithmetic operations have been applied to compute an
2427 // address. It's okay to split the value loaded from that address.
2428 CanSplitValue = true;
2429 break;
2430 case dwarf::DW_OP_stack_value:
2431 // Bail if this expression computes a value that cannot be split.
2432 if (!CanSplitValue)
2433 return std::nullopt;
2434 break;
2435 case dwarf::DW_OP_LLVM_fragment: {
2436 auto Fragment = cast<FragmentOp>(Val&: Op);
2437 // If we've decided we don't need a fragment then give up if we see that
2438 // there's already a fragment expression.
2439 // FIXME: We could probably do better here
2440 if (!EmitFragment)
2441 return std::nullopt;
2442 // Make the new offset point into the existing fragment.
2443 uint64_t FragmentOffsetInBits = Fragment.getOffsetInBits();
2444 uint64_t FragmentSizeInBits = Fragment.getSizeInBits();
2445 (void)FragmentSizeInBits;
2446 assert((OffsetInBits + SizeInBits <= FragmentSizeInBits) &&
2447 "new fragment outside of original fragment");
2448 OffsetInBits += FragmentOffsetInBits;
2449 continue;
2450 }
2451 case dwarf::DW_OP_LLVM_extract_bits_zext:
2452 case dwarf::DW_OP_LLVM_extract_bits_sext: {
2453 auto Extract = cast<ExtractBitsOp>(Val&: Op);
2454 // If we're extracting bits from inside of the fragment that we're
2455 // creating then we don't have a fragment after all, and just need to
2456 // adjust the offset that we're extracting from.
2457 uint64_t ExtractOffsetInBits = Extract.getOffsetInBits();
2458 uint64_t ExtractSizeInBits = Extract.getSizeInBits();
2459 if (ExtractOffsetInBits >= OffsetInBits &&
2460 ExtractOffsetInBits + ExtractSizeInBits <=
2461 OffsetInBits + SizeInBits) {
2462 Ops.push_back(Elt: Op.getOp());
2463 Ops.push_back(Elt: ExtractOffsetInBits - OffsetInBits);
2464 Ops.push_back(Elt: ExtractSizeInBits);
2465 EmitFragment = false;
2466 continue;
2467 }
2468 // If the extracted bits aren't fully contained within the fragment then
2469 // give up.
2470 // FIXME: We could probably do better here
2471 return std::nullopt;
2472 }
2473 }
2474 Op.appendToVector(V&: Ops);
2475 }
2476 }
2477 assert((!Expr->isImplicit() || CanSplitValue) && "Expr can't be split");
2478 assert(Expr && "Unknown DIExpression");
2479 if (EmitFragment) {
2480 Ops.push_back(Elt: dwarf::DW_OP_LLVM_fragment);
2481 Ops.push_back(Elt: OffsetInBits);
2482 Ops.push_back(Elt: SizeInBits);
2483 }
2484 return DIExpression::get(Context&: Expr->getContext(), Elements: Ops);
2485}
2486
2487/// See declaration for more info.
2488bool DIExpression::calculateFragmentIntersect(
2489 const DataLayout &DL, const Value *SliceStart, uint64_t SliceOffsetInBits,
2490 uint64_t SliceSizeInBits, const Value *DbgPtr, int64_t DbgPtrOffsetInBits,
2491 int64_t DbgExtractOffsetInBits, DIExpression::FragmentInfo VarFrag,
2492 std::optional<DIExpression::FragmentInfo> &Result,
2493 int64_t &OffsetFromLocationInBits) {
2494
2495 if (VarFrag.SizeInBits == 0)
2496 return false; // Variable size is unknown.
2497
2498 // Difference between mem slice start and the dbg location start.
2499 // 0 4 8 12 16 ...
2500 // | |
2501 // dbg location start
2502 // |
2503 // mem slice start
2504 // Here MemStartRelToDbgStartInBits is 8. Note this can be negative.
2505 int64_t MemStartRelToDbgStartInBits;
2506 {
2507 auto MemOffsetFromDbgInBytes = SliceStart->getPointerOffsetFrom(Other: DbgPtr, DL);
2508 if (!MemOffsetFromDbgInBytes)
2509 return false; // Can't calculate difference in addresses.
2510 // Difference between the pointers.
2511 MemStartRelToDbgStartInBits = *MemOffsetFromDbgInBytes * 8;
2512 // Add the difference of the offsets.
2513 MemStartRelToDbgStartInBits +=
2514 SliceOffsetInBits - (DbgPtrOffsetInBits + DbgExtractOffsetInBits);
2515 }
2516
2517 // Out-param. Invert offset to get offset from debug location.
2518 OffsetFromLocationInBits = -MemStartRelToDbgStartInBits;
2519
2520 // Check if the variable fragment sits outside (before) this memory slice.
2521 int64_t MemEndRelToDbgStart = MemStartRelToDbgStartInBits + SliceSizeInBits;
2522 if (MemEndRelToDbgStart < 0) {
2523 Result = {0, 0}; // Out-param.
2524 return true;
2525 }
2526
2527 // Work towards creating SliceOfVariable which is the bits of the variable
2528 // that the memory region covers.
2529 // 0 4 8 12 16 ...
2530 // | |
2531 // dbg location start with VarFrag offset=32
2532 // |
2533 // mem slice start: SliceOfVariable offset=40
2534 int64_t MemStartRelToVarInBits =
2535 MemStartRelToDbgStartInBits + VarFrag.OffsetInBits;
2536 int64_t MemEndRelToVarInBits = MemStartRelToVarInBits + SliceSizeInBits;
2537 // If the memory region starts before the debug location the fragment
2538 // offset would be negative, which we can't encode. Limit those to 0. This
2539 // is fine because those bits necessarily don't overlap with the existing
2540 // variable fragment.
2541 int64_t MemFragStart = std::max<int64_t>(a: 0, b: MemStartRelToVarInBits);
2542 int64_t MemFragSize =
2543 std::max<int64_t>(a: 0, b: MemEndRelToVarInBits - MemFragStart);
2544 DIExpression::FragmentInfo SliceOfVariable(MemFragSize, MemFragStart);
2545
2546 // Intersect the memory region fragment with the variable location fragment.
2547 DIExpression::FragmentInfo TrimmedSliceOfVariable =
2548 DIExpression::FragmentInfo::intersect(A: SliceOfVariable, B: VarFrag);
2549 if (TrimmedSliceOfVariable == VarFrag)
2550 Result = std::nullopt; // Out-param.
2551 else
2552 Result = TrimmedSliceOfVariable; // Out-param.
2553 return true;
2554}
2555
2556std::pair<DIExpression *, const ConstantInt *>
2557DIExpression::constantFold(const ConstantInt *CI) {
2558 // Copy the APInt so we can modify it.
2559 APInt NewInt = CI->getValue();
2560 SmallVector<uint64_t, 8> Ops;
2561
2562 // Fold operators only at the beginning of the expression.
2563 bool First = true;
2564 bool Changed = false;
2565 for (auto Op : expr_ops()) {
2566 switch (Op.getOp()) {
2567 default:
2568 // We fold only the leading part of the expression; if we get to a part
2569 // that we're going to copy unchanged, and haven't done any folding,
2570 // then the entire expression is unchanged and we can return early.
2571 if (!Changed)
2572 return {this, CI};
2573 First = false;
2574 break;
2575 case dwarf::DW_OP_LLVM_convert: {
2576 if (!First)
2577 break;
2578 Changed = true;
2579 auto Convert = cast<ConvertOp>(Val&: Op);
2580 if (Convert.getEncoding() == dwarf::DW_ATE_signed)
2581 NewInt = NewInt.sextOrTrunc(width: Convert.getBitSize());
2582 else {
2583 assert(Convert.getEncoding() == dwarf::DW_ATE_unsigned &&
2584 "Unexpected operand");
2585 NewInt = NewInt.zextOrTrunc(width: Convert.getBitSize());
2586 }
2587 continue;
2588 }
2589 }
2590 Op.appendToVector(V&: Ops);
2591 }
2592 if (!Changed)
2593 return {this, CI};
2594 return {DIExpression::get(Context&: getContext(), Elements: Ops),
2595 ConstantInt::get(Context&: getContext(), V: NewInt)};
2596}
2597
2598uint64_t DIExpression::getNumLocationOperands() const {
2599 uint64_t Result = 0;
2600 for (auto ExprOp : expr_ops())
2601 if (auto Arg = dyn_cast<ArgOp>(Val&: ExprOp))
2602 Result = std::max(a: Result, b: Arg.getIndex() + 1);
2603 assert(hasAllLocationOps(Result) &&
2604 "Expression is missing one or more location operands.");
2605 return Result;
2606}
2607
2608std::optional<DIExpression::SignedOrUnsignedConstant>
2609DIExpression::isConstant() const {
2610
2611 // Recognize signed and unsigned constants.
2612 // An signed constants can be represented as DW_OP_consts C DW_OP_stack_value
2613 // (DW_OP_LLVM_fragment of Len).
2614 // An unsigned constant can be represented as
2615 // DW_OP_constu C DW_OP_stack_value (DW_OP_LLVM_fragment of Len).
2616
2617 if ((getNumElements() != 2 && getNumElements() != 3 &&
2618 getNumElements() != 6) ||
2619 (getElement(I: 0) != dwarf::DW_OP_consts &&
2620 getElement(I: 0) != dwarf::DW_OP_constu))
2621 return std::nullopt;
2622
2623 if (getNumElements() == 2 && getElement(I: 0) == dwarf::DW_OP_consts)
2624 return SignedOrUnsignedConstant::SignedConstant;
2625
2626 if ((getNumElements() == 3 && getElement(I: 2) != dwarf::DW_OP_stack_value) ||
2627 (getNumElements() == 6 && (getElement(I: 2) != dwarf::DW_OP_stack_value ||
2628 getElement(I: 3) != dwarf::DW_OP_LLVM_fragment)))
2629 return std::nullopt;
2630 return getElement(I: 0) == dwarf::DW_OP_constu
2631 ? SignedOrUnsignedConstant::UnsignedConstant
2632 : SignedOrUnsignedConstant::SignedConstant;
2633}
2634
2635DIExpression::ExtOps DIExpression::getExtOps(unsigned FromSize, unsigned ToSize,
2636 bool Signed) {
2637 dwarf::TypeKind TK = Signed ? dwarf::DW_ATE_signed : dwarf::DW_ATE_unsigned;
2638 DIExpression::ExtOps Ops{._M_elems: {dwarf::DW_OP_LLVM_convert, FromSize, TK,
2639 dwarf::DW_OP_LLVM_convert, ToSize, TK}};
2640 return Ops;
2641}
2642
2643DIExpression *DIExpression::appendExt(const DIExpression *Expr,
2644 unsigned FromSize, unsigned ToSize,
2645 bool Signed) {
2646 return appendToStack(Expr, Ops: getExtOps(FromSize, ToSize, Signed));
2647}
2648
2649DIGlobalVariableExpression *
2650DIGlobalVariableExpression::getImpl(LLVMContext &Context, Metadata *Variable,
2651 Metadata *Expression, StorageType Storage,
2652 bool ShouldCreate) {
2653 DEFINE_GETIMPL_LOOKUP(DIGlobalVariableExpression, (Variable, Expression));
2654 Metadata *Ops[] = {Variable, Expression};
2655 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DIGlobalVariableExpression, Ops);
2656}
2657DIObjCProperty::DIObjCProperty(LLVMContext &C, StorageType Storage,
2658 unsigned Line, unsigned Attributes,
2659 ArrayRef<Metadata *> Ops)
2660 : DINode(C, DIObjCPropertyKind, Storage, dwarf::DW_TAG_APPLE_property, Ops),
2661 Line(Line), Attributes(Attributes) {}
2662
2663DIObjCProperty *DIObjCProperty::getImpl(
2664 LLVMContext &Context, MDString *Name, Metadata *File, unsigned Line,
2665 MDString *GetterName, MDString *SetterName, unsigned Attributes,
2666 Metadata *Type, StorageType Storage, bool ShouldCreate) {
2667 assert(isCanonical(Name) && "Expected canonical MDString");
2668 assert(isCanonical(GetterName) && "Expected canonical MDString");
2669 assert(isCanonical(SetterName) && "Expected canonical MDString");
2670 DEFINE_GETIMPL_LOOKUP(DIObjCProperty, (Name, File, Line, GetterName,
2671 SetterName, Attributes, Type));
2672 Metadata *Ops[] = {Name, File, GetterName, SetterName, Type};
2673 DEFINE_GETIMPL_STORE(DIObjCProperty, (Line, Attributes), Ops);
2674}
2675
2676DIProperty::DIProperty(LLVMContext &C, StorageType Storage, unsigned Line,
2677 ArrayRef<Metadata *> Ops)
2678 : DINode(C, DIPropertyKind, Storage, dwarf::DW_TAG_property, Ops),
2679 Line(Line) {}
2680
2681DIProperty *DIProperty::getImpl(LLVMContext &Context, MDString *Name,
2682 Metadata *File, unsigned Line, Metadata *Type,
2683 Metadata *BackingStorage, StorageType Storage,
2684 bool ShouldCreate) {
2685 assert(isCanonical(Name) && "Expected canonical MDString");
2686 DEFINE_GETIMPL_LOOKUP(DIProperty, (Name, File, Line, Type, BackingStorage));
2687 Metadata *Ops[] = {Name, File, Type, BackingStorage};
2688 DEFINE_GETIMPL_STORE(DIProperty, (Line), Ops);
2689}
2690
2691DIImportedEntity *DIImportedEntity::getImpl(LLVMContext &Context, unsigned Tag,
2692 Metadata *Scope, Metadata *Entity,
2693 Metadata *File, unsigned Line,
2694 MDString *Name, Metadata *Elements,
2695 StorageType Storage,
2696 bool ShouldCreate) {
2697 assert(isCanonical(Name) && "Expected canonical MDString");
2698 DEFINE_GETIMPL_LOOKUP(DIImportedEntity,
2699 (Tag, Scope, Entity, File, Line, Name, Elements));
2700 Metadata *Ops[] = {Scope, Entity, Name, File, Elements};
2701 DEFINE_GETIMPL_STORE(DIImportedEntity, (Tag, Line), Ops);
2702}
2703
2704DIMacro *DIMacro::getImpl(LLVMContext &Context, unsigned MIType, unsigned Line,
2705 MDString *Name, MDString *Value, StorageType Storage,
2706 bool ShouldCreate) {
2707 assert(isCanonical(Name) && "Expected canonical MDString");
2708 DEFINE_GETIMPL_LOOKUP(DIMacro, (MIType, Line, Name, Value));
2709 Metadata *Ops[] = {Name, Value};
2710 DEFINE_GETIMPL_STORE(DIMacro, (MIType, Line), Ops);
2711}
2712
2713DIMacroFile *DIMacroFile::getImpl(LLVMContext &Context, unsigned MIType,
2714 unsigned Line, Metadata *File,
2715 Metadata *Elements, StorageType Storage,
2716 bool ShouldCreate) {
2717 DEFINE_GETIMPL_LOOKUP(DIMacroFile, (MIType, Line, File, Elements));
2718 Metadata *Ops[] = {File, Elements};
2719 DEFINE_GETIMPL_STORE(DIMacroFile, (MIType, Line), Ops);
2720}
2721
2722DIArgList *DIArgList::get(LLVMContext &Context,
2723 ArrayRef<ValueAsMetadata *> Args) {
2724 auto ExistingIt = Context.pImpl->DIArgLists.find_as(Val: DIArgListKeyInfo(Args));
2725 if (ExistingIt != Context.pImpl->DIArgLists.end())
2726 return *ExistingIt;
2727 DIArgList *NewArgList = new DIArgList(Context, Args);
2728 Context.pImpl->DIArgLists.insert(V: NewArgList);
2729 return NewArgList;
2730}
2731
2732void DIArgList::handleChangedOperand(void *Ref, Metadata *New) {
2733 ValueAsMetadata **OldVMPtr = static_cast<ValueAsMetadata **>(Ref);
2734 assert((!New || isa<ValueAsMetadata>(New)) &&
2735 "DIArgList must be passed a ValueAsMetadata");
2736 untrack();
2737 // We need to update the set storage once the Args are updated since they
2738 // form the key to the DIArgLists store.
2739 getContext().pImpl->DIArgLists.erase(V: this);
2740 ValueAsMetadata *NewVM = cast_or_null<ValueAsMetadata>(Val: New);
2741 for (ValueAsMetadata *&VM : Args) {
2742 if (&VM == OldVMPtr) {
2743 if (NewVM)
2744 VM = NewVM;
2745 else
2746 VM = ValueAsMetadata::get(V: PoisonValue::get(T: VM->getValue()->getType()));
2747 }
2748 }
2749 // We've changed the contents of this DIArgList, and the set storage may
2750 // already contain a DIArgList with our new set of args; if it does, then we
2751 // must RAUW this with the existing DIArgList, otherwise we simply insert this
2752 // back into the set storage.
2753 DIArgList *ExistingArgList = getUniqued(Store&: getContext().pImpl->DIArgLists, Key: this);
2754 if (ExistingArgList) {
2755 replaceAllUsesWith(MD: ExistingArgList);
2756 // Clear this here so we don't try to untrack in the destructor.
2757 Args.clear();
2758 delete this;
2759 return;
2760 }
2761 getContext().pImpl->DIArgLists.insert(V: this);
2762 track();
2763}
2764void DIArgList::track() {
2765 for (ValueAsMetadata *&VAM : Args)
2766 if (VAM)
2767 MetadataTracking::track(Ref: &VAM, MD&: *VAM, Owner&: *this);
2768}
2769void DIArgList::untrack() {
2770 for (ValueAsMetadata *&VAM : Args)
2771 if (VAM)
2772 MetadataTracking::untrack(Ref: &VAM, MD&: *VAM);
2773}
2774void DIArgList::dropAllReferences(bool Untrack) {
2775 if (Untrack)
2776 untrack();
2777 Args.clear();
2778 ReplaceableMetadataImpl::resolveAllUses(/* ResolveUsers */ false);
2779}
2780