LLVM 22.0.0git
DwarfUnit.cpp
Go to the documentation of this file.
1//===-- llvm/CodeGen/DwarfUnit.cpp - Dwarf Type and Compile Units ---------===//
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 contains support for constructing a dwarf compile unit.
10//
11//===----------------------------------------------------------------------===//
12
13#include "DwarfUnit.h"
14#include "AddressPool.h"
15#include "DwarfCompileUnit.h"
16#include "DwarfExpression.h"
17#include "llvm/ADT/APFloat.h"
18#include "llvm/ADT/APInt.h"
20#include "llvm/IR/Constants.h"
21#include "llvm/IR/DataLayout.h"
22#include "llvm/IR/GlobalValue.h"
23#include "llvm/IR/Metadata.h"
24#include "llvm/MC/MCAsmInfo.h"
25#include "llvm/MC/MCContext.h"
26#include "llvm/MC/MCDwarf.h"
27#include "llvm/MC/MCSection.h"
28#include "llvm/MC/MCStreamer.h"
31#include <cassert>
32#include <cstdint>
33#include <limits>
34#include <string>
35#include <utility>
36
37using namespace llvm;
38
39#define DEBUG_TYPE "dwarfdebug"
40
43 : DwarfExpression(AP.getDwarfVersion(), CU), AP(AP), OutDIE(DIE) {}
44
45void DIEDwarfExpression::emitOp(uint8_t Op, const char* Comment) {
46 CU.addUInt(getActiveDIE(), dwarf::DW_FORM_data1, Op);
47}
48
49void DIEDwarfExpression::emitSigned(int64_t Value) {
50 CU.addSInt(getActiveDIE(), dwarf::DW_FORM_sdata, Value);
51}
52
53void DIEDwarfExpression::emitUnsigned(uint64_t Value) {
54 CU.addUInt(getActiveDIE(), dwarf::DW_FORM_udata, Value);
55}
56
57void DIEDwarfExpression::emitData1(uint8_t Value) {
58 CU.addUInt(getActiveDIE(), dwarf::DW_FORM_data1, Value);
59}
60
61void DIEDwarfExpression::emitBaseTypeRef(uint64_t Idx) {
62 CU.addBaseTypeRef(getActiveDIE(), Idx);
63}
64
66 assert(!IsBuffering && "Already buffering?");
67 IsBuffering = true;
68}
69
70void DIEDwarfExpression::disableTemporaryBuffer() { IsBuffering = false; }
71
73 return TmpDIE.computeSize(AP.getDwarfFormParams());
74}
75
76void DIEDwarfExpression::commitTemporaryBuffer() { OutDIE.takeValues(TmpDIE); }
77
78bool DIEDwarfExpression::isFrameRegister(const TargetRegisterInfo &TRI,
79 llvm::Register MachineReg) {
80 return MachineReg == TRI.getFrameRegister(*AP.MF);
81}
82
84 AsmPrinter *A, DwarfDebug *DW, DwarfFile *DWU,
85 unsigned UniqueID)
86 : DIEUnit(UnitTag), UniqueID(UniqueID), CUNode(Node), Asm(A), DD(DW),
87 DU(DWU) {}
88
90 DwarfDebug *DW, DwarfFile *DWU, unsigned UniqueID,
91 MCDwarfDwoLineTable *SplitLineTable)
92 : DwarfUnit(dwarf::DW_TAG_type_unit, CU.getCUNode(), A, DW, DWU, UniqueID),
93 CU(CU), SplitLineTable(SplitLineTable) {}
94
96 for (DIEBlock *B : DIEBlocks)
97 B->~DIEBlock();
98 for (DIELoc *L : DIELocs)
99 L->~DIELoc();
100}
101
102int64_t DwarfUnit::getDefaultLowerBound() const {
103 switch (getSourceLanguage()) {
104 default:
105 break;
106
107 // The languages below have valid values in all DWARF versions.
108 case dwarf::DW_LANG_C:
109 case dwarf::DW_LANG_C89:
110 case dwarf::DW_LANG_C_plus_plus:
111 return 0;
112
113 case dwarf::DW_LANG_Fortran77:
114 case dwarf::DW_LANG_Fortran90:
115 return 1;
116
117 // The languages below have valid values only if the DWARF version >= 3.
118 case dwarf::DW_LANG_C99:
119 case dwarf::DW_LANG_ObjC:
120 case dwarf::DW_LANG_ObjC_plus_plus:
121 if (DD->getDwarfVersion() >= 3)
122 return 0;
123 break;
124
125 case dwarf::DW_LANG_Fortran95:
126 if (DD->getDwarfVersion() >= 3)
127 return 1;
128 break;
129
130 // Starting with DWARF v4, all defined languages have valid values.
131 case dwarf::DW_LANG_D:
132 case dwarf::DW_LANG_Java:
133 case dwarf::DW_LANG_Python:
134 case dwarf::DW_LANG_UPC:
135 if (DD->getDwarfVersion() >= 4)
136 return 0;
137 break;
138
139 case dwarf::DW_LANG_Ada83:
140 case dwarf::DW_LANG_Ada95:
141 case dwarf::DW_LANG_Cobol74:
142 case dwarf::DW_LANG_Cobol85:
143 case dwarf::DW_LANG_Modula2:
144 case dwarf::DW_LANG_Pascal83:
145 case dwarf::DW_LANG_PLI:
146 if (DD->getDwarfVersion() >= 4)
147 return 1;
148 break;
149
150 // The languages below are new in DWARF v5.
151 case dwarf::DW_LANG_BLISS:
152 case dwarf::DW_LANG_C11:
153 case dwarf::DW_LANG_C_plus_plus_03:
154 case dwarf::DW_LANG_C_plus_plus_11:
155 case dwarf::DW_LANG_C_plus_plus_14:
156 case dwarf::DW_LANG_Dylan:
157 case dwarf::DW_LANG_Go:
158 case dwarf::DW_LANG_Haskell:
159 case dwarf::DW_LANG_OCaml:
160 case dwarf::DW_LANG_OpenCL:
161 case dwarf::DW_LANG_RenderScript:
162 case dwarf::DW_LANG_Rust:
163 case dwarf::DW_LANG_Swift:
164 if (DD->getDwarfVersion() >= 5)
165 return 0;
166 break;
167
168 case dwarf::DW_LANG_Fortran03:
169 case dwarf::DW_LANG_Fortran08:
170 case dwarf::DW_LANG_Julia:
171 case dwarf::DW_LANG_Modula3:
172 if (DD->getDwarfVersion() >= 5)
173 return 1;
174 break;
175 }
176
177 return -1;
178}
179
180/// Check whether the DIE for this MDNode can be shared across CUs.
182 // When the MDNode can be part of the type system, the DIE can be shared
183 // across CUs.
184 // Combining type units and cross-CU DIE sharing is lower value (since
185 // cross-CU DIE sharing is used in LTO and removes type redundancy at that
186 // level already) but may be implementable for some value in projects
187 // building multiple independent libraries with LTO and then linking those
188 // together.
189 if (isDwoUnit() && !DD->shareAcrossDWOCUs())
190 return false;
191 return (isa<DIType>(D) ||
192 (isa<DISubprogram>(D) && !cast<DISubprogram>(D)->isDefinition())) &&
193 !DD->generateTypeUnits();
194}
195
198 return DU->getDIE(D);
199 return MDNodeToDieMap.lookup(D);
200}
201
204 DU->insertDIE(Desc, D);
205 return;
206 }
207 MDNodeToDieMap.insert(std::make_pair(Desc, D));
208}
209
211 MDNodeToDieMap.insert(std::make_pair(nullptr, D));
212}
213
215 if (DD->getDwarfVersion() >= 4)
216 addAttribute(Die, Attribute, dwarf::DW_FORM_flag_present, DIEInteger(1));
217 else
218 addAttribute(Die, Attribute, dwarf::DW_FORM_flag, DIEInteger(1));
219}
220
222 std::optional<dwarf::Form> Form, uint64_t Integer) {
223 if (!Form)
224 Form = DIEInteger::BestForm(false, Integer);
225 assert(Form != dwarf::DW_FORM_implicit_const &&
226 "DW_FORM_implicit_const is used only for signed integers");
228}
229
234
235void DwarfUnit::addIntAsBlock(DIE &Die, dwarf::Attribute Attribute, const APInt &Val) {
237
238 // Get the raw data form of the large APInt.
239 const uint64_t *Ptr64 = Val.getRawData();
240
241 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
242 bool LittleEndian = Asm->getDataLayout().isLittleEndian();
243
244 // Output the constant to DWARF one byte at a time.
245 for (int i = 0; i < NumBytes; i++) {
246 uint8_t c;
247 if (LittleEndian)
248 c = Ptr64[i / 8] >> (8 * (i & 7));
249 else
250 c = Ptr64[(NumBytes - 1 - i) / 8] >> (8 * ((NumBytes - 1 - i) & 7));
251 addUInt(*Block, dwarf::DW_FORM_data1, c);
252 }
253
254 addBlock(Die, Attribute, Block);
255}
256
258 const APInt &Val, bool Unsigned) {
259 unsigned CIBitWidth = Val.getBitWidth();
260 if (CIBitWidth <= 64) {
261 if (Unsigned)
262 addUInt(Die, Attribute, std::nullopt, Val.getZExtValue());
263 else
264 addSInt(Die, Attribute, std::nullopt, Val.getSExtValue());
265 return;
266 }
267
268 addIntAsBlock(Die, Attribute, Val);
269}
270
272 std::optional<dwarf::Form> Form, int64_t Integer) {
273 if (!Form)
274 Form = DIEInteger::BestForm(true, Integer);
276}
277
278void DwarfUnit::addSInt(DIEValueList &Die, std::optional<dwarf::Form> Form,
279 int64_t Integer) {
280 addSInt(Die, (dwarf::Attribute)0, Form, Integer);
281}
282
285 if (CUNode->isDebugDirectivesOnly())
286 return;
287
288 if (DD->useInlineStrings()) {
289 addAttribute(Die, Attribute, dwarf::DW_FORM_string,
292 return;
293 }
294 dwarf::Form IxForm =
295 isDwoUnit() ? dwarf::DW_FORM_GNU_str_index : dwarf::DW_FORM_strp;
296
297 auto StringPoolEntry =
298 useSegmentedStringOffsetsTable() || IxForm == dwarf::DW_FORM_GNU_str_index
299 ? DU->getStringPool().getIndexedEntry(*Asm, String)
300 : DU->getStringPool().getEntry(*Asm, String);
301
302 // For DWARF v5 and beyond, use the smallest strx? form possible.
304 IxForm = dwarf::DW_FORM_strx1;
305 unsigned Index = StringPoolEntry.getIndex();
306 if (Index > 0xffffff)
307 IxForm = dwarf::DW_FORM_strx4;
308 else if (Index > 0xffff)
309 IxForm = dwarf::DW_FORM_strx3;
310 else if (Index > 0xff)
311 IxForm = dwarf::DW_FORM_strx2;
312 }
313 addAttribute(Die, Attribute, IxForm, DIEString(StringPoolEntry));
314}
315
317 dwarf::Form Form, const MCSymbol *Label) {
318 addAttribute(Die, Attribute, Form, DIELabel(Label));
319}
320
321void DwarfUnit::addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label) {
322 addLabel(Die, (dwarf::Attribute)0, Form, Label);
323}
324
327 addUInt(Die, Attribute, DD->getDwarfSectionOffsetForm(), Integer);
328}
329
330unsigned DwarfTypeUnit::getOrCreateSourceID(const DIFile *File) {
331 if (!SplitLineTable)
332 return getCU().getOrCreateSourceID(File);
333 if (!UsedLineTable) {
334 UsedLineTable = true;
335 // This is a split type unit that needs a line table.
336 addSectionOffset(getUnitDie(), dwarf::DW_AT_stmt_list, 0);
337 }
338 return SplitLineTable->getFile(
339 File->getDirectory(), File->getFilename(), DD->getMD5AsBytes(File),
340 Asm->OutContext.getDwarfVersion(), File->getSource());
341}
342
344 bool UseAddrOffsetFormOrExpressions =
345 DD->useAddrOffsetForm() || DD->useAddrOffsetExpressions();
346
347 const MCSymbol *Base = nullptr;
348 if (Label->isInSection() && UseAddrOffsetFormOrExpressions)
349 Base = DD->getSectionLabel(&Label->getSection());
350
351 uint32_t Index = DD->getAddressPool().getIndex(Base ? Base : Label);
352
353 if (DD->getDwarfVersion() >= 5) {
354 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_addrx);
355 addUInt(Die, dwarf::DW_FORM_addrx, Index);
356 } else {
357 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_addr_index);
358 addUInt(Die, dwarf::DW_FORM_GNU_addr_index, Index);
359 }
360
361 if (Base && Base != Label) {
362 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_const4u);
363 addLabelDelta(Die, (dwarf::Attribute)0, Label, Base);
364 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
365 }
366}
367
369 if (DD->getDwarfVersion() >= 5) {
370 addPoolOpAddress(Die, Sym);
371 return;
372 }
373
374 if (DD->useSplitDwarf()) {
375 addPoolOpAddress(Die, Sym);
376 return;
377 }
378
379 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
380 addLabel(Die, dwarf::DW_FORM_addr, Sym);
381}
382
384 const MCSymbol *Hi, const MCSymbol *Lo) {
385 addAttribute(Die, Attribute, dwarf::DW_FORM_data4,
387}
388
392
394 // Flag the type unit reference as a declaration so that if it contains
395 // members (implicit special members, static data member definitions, member
396 // declarations for definitions in this CU, etc) consumers don't get confused
397 // and think this is a full definition.
398 addFlag(Die, dwarf::DW_AT_declaration);
399
400 addAttribute(Die, dwarf::DW_AT_signature, dwarf::DW_FORM_ref_sig8,
401 DIEInteger(Signature));
402}
403
405 DIEEntry Entry) {
406 const DIEUnit *CU = Die.getUnit();
407 const DIEUnit *EntryCU = Entry.getEntry().getUnit();
408 if (!CU)
409 // We assume that Die belongs to this CU, if it is not linked to any CU yet.
410 CU = getUnitDie().getUnit();
411 if (!EntryCU)
412 EntryCU = getUnitDie().getUnit();
413 assert(EntryCU == CU || !DD->useSplitDwarf() || DD->shareAcrossDWOCUs() ||
414 !static_cast<const DwarfUnit*>(CU)->isDwoUnit());
416 EntryCU == CU ? dwarf::DW_FORM_ref4 : dwarf::DW_FORM_ref_addr,
417 Entry);
418}
419
421 DIE &Die = Parent.addChild(DIE::get(DIEValueAllocator, Tag));
422 if (N)
423 insertDIE(N, &Die);
424 return Die;
425}
426
428 Loc->computeSize(Asm->getDwarfFormParams());
429 DIELocs.push_back(Loc); // Memoize so we can call the destructor later on.
430 addAttribute(Die, Attribute, Loc->BestForm(DD->getDwarfVersion()), Loc);
431}
432
434 DIEBlock *Block) {
435 Block->computeSize(Asm->getDwarfFormParams());
436 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
437 addAttribute(Die, Attribute, Form, Block);
438}
439
444
445void DwarfUnit::addSourceLine(DIE &Die, unsigned Line, unsigned Column,
446 const DIFile *File) {
447 if (Line == 0)
448 return;
449
450 unsigned FileID = getOrCreateSourceID(File);
451 addUInt(Die, dwarf::DW_AT_decl_file, std::nullopt, FileID);
452 addUInt(Die, dwarf::DW_AT_decl_line, std::nullopt, Line);
453
454 if (Column != 0)
455 addUInt(Die, dwarf::DW_AT_decl_column, std::nullopt, Column);
456}
457
459 assert(V);
460
461 addSourceLine(Die, V->getLine(), /*Column*/ 0, V->getFile());
462}
463
465 assert(G);
466
467 addSourceLine(Die, G->getLine(), /*Column*/ 0, G->getFile());
468}
469
471 assert(SP);
472
473 addSourceLine(Die, SP->getLine(), /*Column*/ 0, SP->getFile());
474}
475
477 assert(L);
478
479 addSourceLine(Die, L->getLine(), L->getColumn(), L->getFile());
480}
481
482void DwarfUnit::addSourceLine(DIE &Die, const DIType *Ty) {
483 assert(Ty);
484
485 addSourceLine(Die, Ty->getLine(), /*Column*/ 0, Ty->getFile());
486}
487
489 assert(Ty);
490
491 addSourceLine(Die, Ty->getLine(), /*Column*/ 0, Ty->getFile());
492}
493
495 // Pass this down to addConstantValue as an unsigned bag of bits.
496 addConstantValue(Die, CFP->getValueAPF().bitcastToAPInt(), true);
497}
498
500 const DIType *Ty) {
501 addConstantValue(Die, CI->getValue(), Ty);
502}
503
504void DwarfUnit::addConstantValue(DIE &Die, uint64_t Val, const DIType *Ty) {
505 addConstantValue(Die, DD->isUnsignedDIType(Ty), Val);
506}
507
509 // FIXME: This is a bit conservative/simple - it emits negative values always
510 // sign extended to 64 bits rather than minimizing the number of bytes.
511 addUInt(Die, dwarf::DW_AT_const_value,
512 Unsigned ? dwarf::DW_FORM_udata : dwarf::DW_FORM_sdata, Val);
513}
514
515void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, const DIType *Ty) {
516 addConstantValue(Die, Val, DD->isUnsignedDIType(Ty));
517}
518
519void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, bool Unsigned) {
520 unsigned CIBitWidth = Val.getBitWidth();
521 if (CIBitWidth <= 64) {
523 Unsigned ? Val.getZExtValue() : Val.getSExtValue());
524 return;
525 }
526
527 addIntAsBlock(Die, dwarf::DW_AT_const_value, Val);
528}
529
531 if (!LinkageName.empty())
532 addString(Die,
533 DD->getDwarfVersion() >= 4 ? dwarf::DW_AT_linkage_name
534 : dwarf::DW_AT_MIPS_linkage_name,
536}
537
538void DwarfUnit::addTemplateParams(DIE &Buffer, DINodeArray TParams) {
539 // Add template parameters.
540 for (const auto *Element : TParams) {
541 if (auto *TTP = dyn_cast<DITemplateTypeParameter>(Element))
542 constructTemplateTypeParameterDIE(Buffer, TTP);
543 else if (auto *TVP = dyn_cast<DITemplateValueParameter>(Element))
544 constructTemplateValueParameterDIE(Buffer, TVP);
545 }
546}
547
548/// Add thrown types.
549void DwarfUnit::addThrownTypes(DIE &Die, DINodeArray ThrownTypes) {
550 for (const auto *Ty : ThrownTypes) {
551 DIE &TT = createAndAddDIE(dwarf::DW_TAG_thrown_type, Die);
552 addType(TT, cast<DIType>(Ty));
553 }
554}
555
557 if ((Flags & DINode::FlagAccessibility) == DINode::FlagProtected)
558 addUInt(Die, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
560 else if ((Flags & DINode::FlagAccessibility) == DINode::FlagPrivate)
561 addUInt(Die, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
563 else if ((Flags & DINode::FlagAccessibility) == DINode::FlagPublic)
564 addUInt(Die, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
566}
567
569 if (!Context || isa<DIFile>(Context) || isa<DICompileUnit>(Context))
570 return &getUnitDie();
571 if (auto *T = dyn_cast<DIType>(Context))
572 return getOrCreateTypeDIE(T);
573 if (auto *NS = dyn_cast<DINamespace>(Context))
574 return getOrCreateNameSpace(NS);
575 if (auto *SP = dyn_cast<DISubprogram>(Context))
576 return getOrCreateSubprogramDIE(SP, nullptr);
577 if (auto *M = dyn_cast<DIModule>(Context))
578 return getOrCreateModule(M);
579 return getDIE(Context);
580}
581
583 auto *Context = Ty->getScope();
584 DIE *ContextDIE = getOrCreateContextDIE(Context);
585
586 if (DIE *TyDIE = getDIE(Ty))
587 return TyDIE;
588
589 // Create new type.
590 DIE &TyDIE = createAndAddDIE(Ty->getTag(), *ContextDIE, Ty);
591
593
594 updateAcceleratorTables(Context, Ty, TyDIE);
595 return &TyDIE;
596}
597
598DIE *DwarfUnit::createTypeDIE(const DIScope *Context, DIE &ContextDIE,
599 const DIType *Ty) {
600 // Create new type.
601 DIE &TyDIE = createAndAddDIE(Ty->getTag(), ContextDIE, Ty);
602
603 auto construct = [&](const auto *Ty) {
604 updateAcceleratorTables(Context, Ty, TyDIE);
605 constructTypeDIE(TyDIE, Ty);
606 };
607
608 if (auto *CTy = dyn_cast<DICompositeType>(Ty)) {
609 if (DD->generateTypeUnits() && !Ty->isForwardDecl() &&
610 (Ty->getRawName() || CTy->getRawIdentifier())) {
611 // Skip updating the accelerator tables since this is not the full type.
612 if (MDString *TypeId = CTy->getRawIdentifier()) {
613 addGlobalType(Ty, TyDIE, Context);
614 DD->addDwarfTypeUnitType(getCU(), TypeId->getString(), TyDIE, CTy);
615 } else {
616 updateAcceleratorTables(Context, Ty, TyDIE);
617 finishNonUnitTypeDIE(TyDIE, CTy);
618 }
619 return &TyDIE;
620 }
621 construct(CTy);
622 } else if (auto *FPT = dyn_cast<DIFixedPointType>(Ty))
623 construct(FPT);
624 else if (auto *BT = dyn_cast<DIBasicType>(Ty))
625 construct(BT);
626 else if (auto *ST = dyn_cast<DIStringType>(Ty))
627 construct(ST);
628 else if (auto *STy = dyn_cast<DISubroutineType>(Ty))
629 construct(STy);
630 else if (auto *SRTy = dyn_cast<DISubrangeType>(Ty))
631 constructSubrangeDIE(TyDIE, SRTy);
632 else
633 construct(cast<DIDerivedType>(Ty));
634
635 return &TyDIE;
636}
637
639 if (!TyNode)
640 return nullptr;
641
642 auto *Ty = cast<DIType>(TyNode);
643
644 // DW_TAG_restrict_type is not supported in DWARF2
645 if (Ty->getTag() == dwarf::DW_TAG_restrict_type && DD->getDwarfVersion() <= 2)
647
648 // DW_TAG_atomic_type is not supported in DWARF < 5
649 if (Ty->getTag() == dwarf::DW_TAG_atomic_type && DD->getDwarfVersion() < 5)
651
652 // Construct the context before querying for the existence of the DIE in case
653 // such construction creates the DIE.
654 auto *Context = Ty->getScope();
655 DIE *ContextDIE = getOrCreateContextDIE(Context);
656 assert(ContextDIE);
657
658 if (DIE *TyDIE = getDIE(Ty))
659 return TyDIE;
660
661 return static_cast<DwarfUnit *>(ContextDIE->getUnit())
662 ->createTypeDIE(Context, *ContextDIE, Ty);
663}
664
666 const DIType *Ty, const DIE &TyDIE) {
667 if (Ty->getName().empty())
668 return;
669 if (Ty->isForwardDecl())
670 return;
671
672 // add temporary record for this type to be added later
673
674 unsigned Flags = 0;
675 if (auto *CT = dyn_cast<DICompositeType>(Ty)) {
676 // A runtime language of 0 actually means C/C++ and that any
677 // non-negative value is some version of Objective-C/C++.
678 if (CT->getRuntimeLang() == 0 || CT->isObjcClassComplete())
680 }
681
682 DD->addAccelType(*this, CUNode->getNameTableKind(), Ty->getName(), TyDIE,
683 Flags);
684
685 if (auto *CT = dyn_cast<DICompositeType>(Ty))
686 if (Ty->getName() != CT->getIdentifier() &&
687 CT->getRuntimeLang() == dwarf::DW_LANG_Swift)
688 DD->addAccelType(*this, CUNode->getNameTableKind(), CT->getIdentifier(),
689 TyDIE, Flags);
690
691 addGlobalType(Ty, TyDIE, Context);
692}
693
694void DwarfUnit::addGlobalType(const DIType *Ty, const DIE &TyDIE,
695 const DIScope *Context) {
696 if (!Context || isa<DICompileUnit>(Context) || isa<DIFile>(Context) ||
697 isa<DINamespace>(Context) || isa<DICommonBlock>(Context))
698 addGlobalTypeImpl(Ty, TyDIE, Context);
699}
700
701void DwarfUnit::addType(DIE &Entity, const DIType *Ty,
703 assert(Ty && "Trying to add a type that doesn't exist?");
705}
706
707// FIXME: change callsites to use the new DW_LNAME_ language codes.
709 const auto &Lang = getLanguage();
710
711 if (!Lang.hasVersionedName())
712 return static_cast<llvm::dwarf::SourceLanguage>(Lang.getName());
713
715 static_cast<llvm::dwarf::SourceLanguageName>(Lang.getName()),
716 Lang.getVersion())
718}
719
720std::string DwarfUnit::getParentContextString(const DIScope *Context) const {
721 if (!Context)
722 return "";
723
724 // FIXME: Decide whether to implement this for non-C++ languages.
726 return "";
727
728 std::string CS;
730 while (!isa<DICompileUnit>(Context)) {
731 Parents.push_back(Context);
732 if (const DIScope *S = Context->getScope())
733 Context = S;
734 else
735 // Structure, etc types will have a NULL context if they're at the top
736 // level.
737 break;
738 }
739
740 // Reverse iterate over our list to go from the outermost construct to the
741 // innermost.
742 for (const DIScope *Ctx : llvm::reverse(Parents)) {
743 StringRef Name = Ctx->getName();
744 if (Name.empty() && isa<DINamespace>(Ctx))
745 Name = "(anonymous namespace)";
746 if (!Name.empty()) {
747 CS += Name;
748 CS += "::";
749 }
750 }
751 return CS;
752}
753
754void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIBasicType *BTy) {
755 // Get core information.
756 StringRef Name = BTy->getName();
757 // Add name if not anonymous or intermediate type.
758 if (!Name.empty())
759 addString(Buffer, dwarf::DW_AT_name, Name);
760
761 // An unspecified type only has a name attribute.
762 if (BTy->getTag() == dwarf::DW_TAG_unspecified_type)
763 return;
764
765 if (BTy->getTag() != dwarf::DW_TAG_string_type)
766 addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
767 BTy->getEncoding());
768
769 uint64_t Size = BTy->getSizeInBits() >> 3;
770 addUInt(Buffer, dwarf::DW_AT_byte_size, std::nullopt, Size);
771
772 if (BTy->isBigEndian())
773 addUInt(Buffer, dwarf::DW_AT_endianity, std::nullopt, dwarf::DW_END_big);
774 else if (BTy->isLittleEndian())
775 addUInt(Buffer, dwarf::DW_AT_endianity, std::nullopt, dwarf::DW_END_little);
776
777 if (uint32_t NumExtraInhabitants = BTy->getNumExtraInhabitants())
778 addUInt(Buffer, dwarf::DW_AT_LLVM_num_extra_inhabitants, std::nullopt,
779 NumExtraInhabitants);
780}
781
782void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIFixedPointType *BTy) {
783 // Base type handling.
784 constructTypeDIE(Buffer, static_cast<const DIBasicType *>(BTy));
785
786 if (BTy->isBinary())
787 addSInt(Buffer, dwarf::DW_AT_binary_scale, dwarf::DW_FORM_sdata,
788 BTy->getFactor());
789 else if (BTy->isDecimal())
790 addSInt(Buffer, dwarf::DW_AT_decimal_scale, dwarf::DW_FORM_sdata,
791 BTy->getFactor());
792 else {
793 assert(BTy->isRational());
794 DIE *ContextDIE = getOrCreateContextDIE(BTy->getScope());
795 DIE &Constant = createAndAddDIE(dwarf::DW_TAG_constant, *ContextDIE);
796
797 addInt(Constant, dwarf::DW_AT_GNU_numerator, BTy->getNumerator(),
798 !BTy->isSigned());
799 addInt(Constant, dwarf::DW_AT_GNU_denominator, BTy->getDenominator(),
800 !BTy->isSigned());
801
802 addDIEEntry(Buffer, dwarf::DW_AT_small, Constant);
803 }
804}
805
806void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIStringType *STy) {
807 // Get core information.
808 StringRef Name = STy->getName();
809 // Add name if not anonymous or intermediate type.
810 if (!Name.empty())
811 addString(Buffer, dwarf::DW_AT_name, Name);
812
813 if (DIVariable *Var = STy->getStringLength()) {
814 if (auto *VarDIE = getDIE(Var))
815 addDIEEntry(Buffer, dwarf::DW_AT_string_length, *VarDIE);
816 } else if (DIExpression *Expr = STy->getStringLengthExp()) {
817 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
818 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
819 // This is to describe the memory location of the
820 // length of a Fortran deferred length string, so
821 // lock it down as such.
822 DwarfExpr.setMemoryLocationKind();
823 DwarfExpr.addExpression(Expr);
824 addBlock(Buffer, dwarf::DW_AT_string_length, DwarfExpr.finalize());
825 } else {
826 uint64_t Size = STy->getSizeInBits() >> 3;
827 addUInt(Buffer, dwarf::DW_AT_byte_size, std::nullopt, Size);
828 }
829
830 if (DIExpression *Expr = STy->getStringLocationExp()) {
831 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
832 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
833 // This is to describe the memory location of the
834 // string, so lock it down as such.
835 DwarfExpr.setMemoryLocationKind();
836 DwarfExpr.addExpression(Expr);
837 addBlock(Buffer, dwarf::DW_AT_data_location, DwarfExpr.finalize());
838 }
839
840 if (STy->getEncoding()) {
841 // For eventual Unicode support.
842 addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
843 STy->getEncoding());
844 }
845}
846
847void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIDerivedType *DTy) {
848 // Get core information.
849 StringRef Name = DTy->getName();
850 uint64_t Size = DTy->getSizeInBits() >> 3;
851 uint16_t Tag = Buffer.getTag();
852
853 // Map to main type, void will not have a type.
854 const DIType *FromTy = DTy->getBaseType();
855 if (FromTy)
856 addType(Buffer, FromTy);
857
858 // Add name if not anonymous or intermediate type.
859 if (!Name.empty())
860 addString(Buffer, dwarf::DW_AT_name, Name);
861
862 addAnnotation(Buffer, DTy->getAnnotations());
863
864 // If alignment is specified for a typedef , create and insert DW_AT_alignment
865 // attribute in DW_TAG_typedef DIE.
866 if (Tag == dwarf::DW_TAG_typedef && DD->getDwarfVersion() >= 5) {
867 uint32_t AlignInBytes = DTy->getAlignInBytes();
868 if (AlignInBytes > 0)
869 addUInt(Buffer, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
870 AlignInBytes);
871 }
872
873 // Add size if non-zero (derived types might be zero-sized.)
874 if (Size && Tag != dwarf::DW_TAG_pointer_type
875 && Tag != dwarf::DW_TAG_ptr_to_member_type
876 && Tag != dwarf::DW_TAG_reference_type
877 && Tag != dwarf::DW_TAG_rvalue_reference_type)
878 addUInt(Buffer, dwarf::DW_AT_byte_size, std::nullopt, Size);
879
880 if (Tag == dwarf::DW_TAG_ptr_to_member_type)
881 addDIEEntry(Buffer, dwarf::DW_AT_containing_type,
882 *getOrCreateTypeDIE(cast<DIDerivedType>(DTy)->getClassType()));
883
884 addAccess(Buffer, DTy->getFlags());
885
886 // Add source line info if available and TyDesc is not a forward declaration.
887 if (!DTy->isForwardDecl())
888 addSourceLine(Buffer, DTy);
889
890 // If DWARF address space value is other than None, add it. The IR
891 // verifier checks that DWARF address space only exists for pointer
892 // or reference types.
893 if (DTy->getDWARFAddressSpace())
894 addUInt(Buffer, dwarf::DW_AT_address_class, dwarf::DW_FORM_data4,
895 *DTy->getDWARFAddressSpace());
896
897 // Add template alias template parameters.
898 if (Tag == dwarf::DW_TAG_template_alias)
899 addTemplateParams(Buffer, DTy->getTemplateParams());
900
901 if (auto PtrAuthData = DTy->getPtrAuthData()) {
902 addUInt(Buffer, dwarf::DW_AT_LLVM_ptrauth_key, dwarf::DW_FORM_data1,
903 PtrAuthData->key());
904 if (PtrAuthData->isAddressDiscriminated())
905 addFlag(Buffer, dwarf::DW_AT_LLVM_ptrauth_address_discriminated);
906 addUInt(Buffer, dwarf::DW_AT_LLVM_ptrauth_extra_discriminator,
907 dwarf::DW_FORM_data2, PtrAuthData->extraDiscriminator());
908 if (PtrAuthData->isaPointer())
909 addFlag(Buffer, dwarf::DW_AT_LLVM_ptrauth_isa_pointer);
910 if (PtrAuthData->authenticatesNullValues())
911 addFlag(Buffer, dwarf::DW_AT_LLVM_ptrauth_authenticates_null_values);
912 }
913}
914
915std::optional<unsigned>
917 // Args[0] is the return type.
918 std::optional<unsigned> ObjectPointerIndex;
919 for (unsigned i = 1, N = Args.size(); i < N; ++i) {
920 const DIType *Ty = Args[i];
921 if (!Ty) {
922 assert(i == N-1 && "Unspecified parameter must be the last argument");
923 createAndAddDIE(dwarf::DW_TAG_unspecified_parameters, Buffer);
924 } else {
925 DIE &Arg = createAndAddDIE(dwarf::DW_TAG_formal_parameter, Buffer);
926 addType(Arg, Ty);
927 if (Ty->isArtificial())
928 addFlag(Arg, dwarf::DW_AT_artificial);
929
930 if (Ty->isObjectPointer()) {
931 assert(!ObjectPointerIndex &&
932 "Can't have more than one object pointer");
933 ObjectPointerIndex = i;
934 }
935 }
936 }
937
938 return ObjectPointerIndex;
939}
940
941void DwarfUnit::constructTypeDIE(DIE &Buffer, const DISubroutineType *CTy) {
942 // Add return type. A void return won't have a type.
943 auto Elements = cast<DISubroutineType>(CTy)->getTypeArray();
944 if (Elements.size())
945 if (auto RTy = Elements[0])
946 addType(Buffer, RTy);
947
948 bool isPrototyped = true;
949 if (Elements.size() == 2 && !Elements[1])
950 isPrototyped = false;
951
952 constructSubprogramArguments(Buffer, Elements);
953
954 // Add prototype flag if we're dealing with a C language and the function has
955 // been prototyped.
956 if (isPrototyped && dwarf::isC(getSourceLanguage()))
957 addFlag(Buffer, dwarf::DW_AT_prototyped);
958
959 // Add a DW_AT_calling_convention if this has an explicit convention.
960 if (CTy->getCC() && CTy->getCC() != dwarf::DW_CC_normal)
961 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1,
962 CTy->getCC());
963
964 if (CTy->isLValueReference())
965 addFlag(Buffer, dwarf::DW_AT_reference);
966
967 if (CTy->isRValueReference())
968 addFlag(Buffer, dwarf::DW_AT_rvalue_reference);
969}
970
971void DwarfUnit::addAnnotation(DIE &Buffer, DINodeArray Annotations) {
972 if (!Annotations)
973 return;
974
975 for (const Metadata *Annotation : Annotations->operands()) {
976 const MDNode *MD = cast<MDNode>(Annotation);
977 const MDString *Name = cast<MDString>(MD->getOperand(0));
978 const auto &Value = MD->getOperand(1);
979
980 DIE &AnnotationDie = createAndAddDIE(dwarf::DW_TAG_LLVM_annotation, Buffer);
981 addString(AnnotationDie, dwarf::DW_AT_name, Name->getString());
982 if (const auto *Data = dyn_cast<MDString>(Value))
983 addString(AnnotationDie, dwarf::DW_AT_const_value, Data->getString());
984 else if (const auto *Data = dyn_cast<ConstantAsMetadata>(Value))
985 addConstantValue(AnnotationDie, Data->getValue()->getUniqueInteger(),
986 /*Unsigned=*/true);
987 else
988 assert(false && "Unsupported annotation value type");
989 }
990}
991
992void DwarfUnit::addDiscriminant(DIE &Variant, Constant *Discriminant,
993 bool IsUnsigned) {
994 if (const auto *CI = dyn_cast_or_null<ConstantInt>(Discriminant)) {
995 addInt(Variant, dwarf::DW_AT_discr_value, CI->getValue(), IsUnsigned);
996 } else if (const auto *CA =
998 // Must have an even number of operands.
999 unsigned NElems = CA->getNumElements();
1000 if (NElems % 2 != 0) {
1001 return;
1002 }
1003
1004 DIEBlock *Block = new (DIEValueAllocator) DIEBlock;
1005
1006 auto AddInt = [&](const APInt &Val) {
1007 if (IsUnsigned)
1008 addUInt(*Block, dwarf::DW_FORM_udata, Val.getZExtValue());
1009 else
1010 addSInt(*Block, dwarf::DW_FORM_sdata, Val.getSExtValue());
1011 };
1012
1013 for (unsigned I = 0; I < NElems; I += 2) {
1014 APInt LV = CA->getElementAsAPInt(I);
1015 APInt HV = CA->getElementAsAPInt(I + 1);
1016 if (LV == HV) {
1017 addUInt(*Block, dwarf::DW_FORM_data1, dwarf::DW_DSC_label);
1018 AddInt(LV);
1019 } else {
1020 addUInt(*Block, dwarf::DW_FORM_data1, dwarf::DW_DSC_range);
1021 AddInt(LV);
1022 AddInt(HV);
1023 }
1024 }
1025 addBlock(Variant, dwarf::DW_AT_discr_list, Block);
1026 }
1027}
1028
1030 // Add name if not anonymous or intermediate type.
1031 StringRef Name = CTy->getName();
1032
1033 uint16_t Tag = Buffer.getTag();
1034
1035 switch (Tag) {
1036 case dwarf::DW_TAG_array_type:
1037 constructArrayTypeDIE(Buffer, CTy);
1038 break;
1039 case dwarf::DW_TAG_enumeration_type:
1040 constructEnumTypeDIE(Buffer, CTy);
1041 break;
1042 case dwarf::DW_TAG_variant_part:
1043 case dwarf::DW_TAG_variant:
1044 case dwarf::DW_TAG_structure_type:
1045 case dwarf::DW_TAG_union_type:
1046 case dwarf::DW_TAG_class_type:
1047 case dwarf::DW_TAG_namelist: {
1048 // Emit the discriminator for a variant part.
1049 DIDerivedType *Discriminator = nullptr;
1050 if (Tag == dwarf::DW_TAG_variant_part) {
1051 Discriminator = CTy->getDiscriminator();
1052 if (Discriminator) {
1053 // DWARF says:
1054 // If the variant part has a discriminant, the discriminant is
1055 // represented by a separate debugging information entry which is
1056 // a child of the variant part entry.
1057 // However, for a language like Ada, this yields a weird
1058 // result: a discriminant field would have to be emitted
1059 // multiple times, once per variant part. Instead, this DWARF
1060 // restriction was lifted for DWARF 6 (see
1061 // https://dwarfstd.org/issues/180123.1.html) and so we allow
1062 // this here.
1063 DIE *DiscDIE = getDIE(Discriminator);
1064 if (DiscDIE == nullptr) {
1065 DiscDIE = &constructMemberDIE(Buffer, Discriminator);
1066 }
1067 addDIEEntry(Buffer, dwarf::DW_AT_discr, *DiscDIE);
1068 }
1069 }
1070
1071 // Add template parameters to a class, structure or union types.
1072 if (Tag == dwarf::DW_TAG_class_type ||
1073 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1074 addTemplateParams(Buffer, CTy->getTemplateParams());
1075
1076 // Add elements to structure type.
1077 DINodeArray Elements = CTy->getElements();
1078 for (const auto *Element : Elements) {
1079 if (!Element)
1080 continue;
1081 if (auto *SP = dyn_cast<DISubprogram>(Element))
1082 getOrCreateSubprogramDIE(SP, nullptr);
1083 else if (auto *DDTy = dyn_cast<DIDerivedType>(Element)) {
1084 if (DDTy->getTag() == dwarf::DW_TAG_friend) {
1085 DIE &ElemDie = createAndAddDIE(dwarf::DW_TAG_friend, Buffer);
1086 addType(ElemDie, DDTy->getBaseType(), dwarf::DW_AT_friend);
1087 } else if (DDTy->isStaticMember()) {
1089 } else if (Tag == dwarf::DW_TAG_variant_part) {
1090 // When emitting a variant part, wrap each member in
1091 // DW_TAG_variant.
1092 DIE &Variant = createAndAddDIE(dwarf::DW_TAG_variant, Buffer);
1093 if (Constant *CI = DDTy->getDiscriminantValue()) {
1094 addDiscriminant(Variant, CI,
1095 DD->isUnsignedDIType(Discriminator->getBaseType()));
1096 }
1097 // If the variant holds a composite type with tag
1098 // DW_TAG_variant, inline those members into the variant
1099 // DIE.
1100 if (auto *Composite =
1101 dyn_cast_or_null<DICompositeType>(DDTy->getBaseType());
1102 Composite != nullptr &&
1103 Composite->getTag() == dwarf::DW_TAG_variant) {
1104 constructTypeDIE(Variant, Composite);
1105 } else {
1106 constructMemberDIE(Variant, DDTy);
1107 }
1108 } else {
1109 constructMemberDIE(Buffer, DDTy);
1110 }
1111 } else if (auto *Property = dyn_cast<DIObjCProperty>(Element)) {
1112 DIE &ElemDie = createAndAddDIE(Property->getTag(), Buffer);
1113 StringRef PropertyName = Property->getName();
1114 addString(ElemDie, dwarf::DW_AT_APPLE_property_name, PropertyName);
1115 if (Property->getType())
1116 addType(ElemDie, Property->getType());
1117 addSourceLine(ElemDie, Property);
1118 StringRef GetterName = Property->getGetterName();
1119 if (!GetterName.empty())
1120 addString(ElemDie, dwarf::DW_AT_APPLE_property_getter, GetterName);
1121 StringRef SetterName = Property->getSetterName();
1122 if (!SetterName.empty())
1123 addString(ElemDie, dwarf::DW_AT_APPLE_property_setter, SetterName);
1124 if (unsigned PropertyAttributes = Property->getAttributes())
1125 addUInt(ElemDie, dwarf::DW_AT_APPLE_property_attribute, std::nullopt,
1126 PropertyAttributes);
1127 } else if (auto *Composite = dyn_cast<DICompositeType>(Element)) {
1128 if (Composite->getTag() == dwarf::DW_TAG_variant_part) {
1129 DIE &VariantPart = createAndAddDIE(Composite->getTag(), Buffer);
1130 constructTypeDIE(VariantPart, Composite);
1131 }
1132 } else if (Tag == dwarf::DW_TAG_namelist) {
1133 auto *Var = dyn_cast<DINode>(Element);
1134 auto *VarDIE = getDIE(Var);
1135 if (VarDIE) {
1136 DIE &ItemDie = createAndAddDIE(dwarf::DW_TAG_namelist_item, Buffer);
1137 addDIEEntry(ItemDie, dwarf::DW_AT_namelist_item, *VarDIE);
1138 }
1139 }
1140 }
1141
1142 if (CTy->isAppleBlockExtension())
1143 addFlag(Buffer, dwarf::DW_AT_APPLE_block);
1144
1145 if (CTy->getExportSymbols())
1146 addFlag(Buffer, dwarf::DW_AT_export_symbols);
1147
1148 // This is outside the DWARF spec, but GDB expects a DW_AT_containing_type
1149 // inside C++ composite types to point to the base class with the vtable.
1150 // Rust uses DW_AT_containing_type to link a vtable to the type
1151 // for which it was created.
1152 if (auto *ContainingType = CTy->getVTableHolder())
1153 addDIEEntry(Buffer, dwarf::DW_AT_containing_type,
1154 *getOrCreateTypeDIE(ContainingType));
1155
1156 if (CTy->isObjcClassComplete())
1157 addFlag(Buffer, dwarf::DW_AT_APPLE_objc_complete_type);
1158
1159 // Add the type's non-standard calling convention.
1160 // DW_CC_pass_by_value/DW_CC_pass_by_reference are introduced in DWARF 5.
1161 if (!Asm->TM.Options.DebugStrictDwarf || DD->getDwarfVersion() >= 5) {
1162 uint8_t CC = 0;
1163 if (CTy->isTypePassByValue())
1164 CC = dwarf::DW_CC_pass_by_value;
1165 else if (CTy->isTypePassByReference())
1166 CC = dwarf::DW_CC_pass_by_reference;
1167 if (CC)
1168 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1,
1169 CC);
1170 }
1171
1172 if (auto *SpecifiedFrom = CTy->getSpecification())
1173 addDIEEntry(Buffer, dwarf::DW_AT_specification,
1174 *getOrCreateContextDIE(SpecifiedFrom));
1175
1176 break;
1177 }
1178 default:
1179 break;
1180 }
1181
1182 // Add name if not anonymous or intermediate type.
1183 if (!Name.empty())
1184 addString(Buffer, dwarf::DW_AT_name, Name);
1185
1186 // For Swift, mangled names are put into DW_AT_linkage_name.
1187 if (CTy->getRuntimeLang() == dwarf::DW_LANG_Swift && CTy->getRawIdentifier())
1188 addString(Buffer, dwarf::DW_AT_linkage_name, CTy->getIdentifier());
1189
1190 addAnnotation(Buffer, CTy->getAnnotations());
1191
1192 if (Tag == dwarf::DW_TAG_enumeration_type ||
1193 Tag == dwarf::DW_TAG_class_type || Tag == dwarf::DW_TAG_structure_type ||
1194 Tag == dwarf::DW_TAG_union_type) {
1195 if (auto *Var = dyn_cast_or_null<DIVariable>(CTy->getRawSizeInBits())) {
1196 if (auto *VarDIE = getDIE(Var))
1197 addDIEEntry(Buffer, dwarf::DW_AT_bit_size, *VarDIE);
1198 } else if (auto *Exp =
1201 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1202 DwarfExpr.setMemoryLocationKind();
1203 DwarfExpr.addExpression(Exp);
1204 addBlock(Buffer, dwarf::DW_AT_bit_size, DwarfExpr.finalize());
1205 } else {
1206 uint64_t Size = CTy->getSizeInBits() >> 3;
1207 // Add size if non-zero (derived types might be zero-sized.)
1208 // Ignore the size if it's a non-enum forward decl.
1209 // TODO: Do we care about size for enum forward declarations?
1210 if (Size &&
1211 (!CTy->isForwardDecl() || Tag == dwarf::DW_TAG_enumeration_type))
1212 addUInt(Buffer, dwarf::DW_AT_byte_size, std::nullopt, Size);
1213 else if (!CTy->isForwardDecl())
1214 // Add zero size if it is not a forward declaration.
1215 addUInt(Buffer, dwarf::DW_AT_byte_size, std::nullopt, 0);
1216 }
1217
1218 // If we're a forward decl, say so.
1219 if (CTy->isForwardDecl())
1220 addFlag(Buffer, dwarf::DW_AT_declaration);
1221
1222 // Add accessibility info if available.
1223 addAccess(Buffer, CTy->getFlags());
1224
1225 // Add source line info if available.
1226 if (!CTy->isForwardDecl())
1227 addSourceLine(Buffer, CTy);
1228
1229 // No harm in adding the runtime language to the declaration.
1230 unsigned RLang = CTy->getRuntimeLang();
1231 if (RLang)
1232 addUInt(Buffer, dwarf::DW_AT_APPLE_runtime_class, dwarf::DW_FORM_data1,
1233 RLang);
1234
1235 // Add align info if available.
1236 if (uint32_t AlignInBytes = CTy->getAlignInBytes())
1237 addUInt(Buffer, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1238 AlignInBytes);
1239
1240 if (uint32_t NumExtraInhabitants = CTy->getNumExtraInhabitants())
1241 addUInt(Buffer, dwarf::DW_AT_LLVM_num_extra_inhabitants, std::nullopt,
1242 NumExtraInhabitants);
1243 }
1244}
1245
1246void DwarfUnit::constructTemplateTypeParameterDIE(
1247 DIE &Buffer, const DITemplateTypeParameter *TP) {
1248 DIE &ParamDIE =
1249 createAndAddDIE(dwarf::DW_TAG_template_type_parameter, Buffer);
1250 // Add the type if it exists, it could be void and therefore no type.
1251 if (TP->getType())
1252 addType(ParamDIE, TP->getType());
1253 if (!TP->getName().empty())
1254 addString(ParamDIE, dwarf::DW_AT_name, TP->getName());
1255 if (TP->isDefault() && isCompatibleWithVersion(5))
1256 addFlag(ParamDIE, dwarf::DW_AT_default_value);
1257}
1258
1259void DwarfUnit::constructTemplateValueParameterDIE(
1260 DIE &Buffer, const DITemplateValueParameter *VP) {
1261 DIE &ParamDIE = createAndAddDIE(VP->getTag(), Buffer);
1262
1263 // Add the type if there is one, template template and template parameter
1264 // packs will not have a type.
1265 if (VP->getTag() == dwarf::DW_TAG_template_value_parameter)
1266 addType(ParamDIE, VP->getType());
1267 if (!VP->getName().empty())
1268 addString(ParamDIE, dwarf::DW_AT_name, VP->getName());
1269 if (VP->isDefault() && isCompatibleWithVersion(5))
1270 addFlag(ParamDIE, dwarf::DW_AT_default_value);
1271 if (Metadata *Val = VP->getValue()) {
1273 addConstantValue(ParamDIE, CI, VP->getType());
1274 else if (ConstantFP *CF = mdconst::dyn_extract<ConstantFP>(Val))
1275 addConstantFPValue(ParamDIE, CF);
1276 else if (GlobalValue *GV = mdconst::dyn_extract<GlobalValue>(Val)) {
1277 // We cannot describe the location of dllimport'd entities: the
1278 // computation of their address requires loads from the IAT.
1279 if (!GV->hasDLLImportStorageClass()) {
1280 // For declaration non-type template parameters (such as global values
1281 // and functions)
1283 addOpAddress(*Loc, Asm->getSymbol(GV));
1284 // Emit DW_OP_stack_value to use the address as the immediate value of
1285 // the parameter, rather than a pointer to it.
1286 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_stack_value);
1287 addBlock(ParamDIE, dwarf::DW_AT_location, Loc);
1288 }
1289 } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_template_param) {
1290 assert(isa<MDString>(Val));
1291 addString(ParamDIE, dwarf::DW_AT_GNU_template_name,
1292 cast<MDString>(Val)->getString());
1293 } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_parameter_pack) {
1294 addTemplateParams(ParamDIE, cast<MDTuple>(Val));
1295 }
1296 }
1297}
1298
1300 // Construct the context before querying for the existence of the DIE in case
1301 // such construction creates the DIE.
1302 DIE *ContextDIE = getOrCreateContextDIE(NS->getScope());
1303
1304 if (DIE *NDie = getDIE(NS))
1305 return NDie;
1306 DIE &NDie = createAndAddDIE(dwarf::DW_TAG_namespace, *ContextDIE, NS);
1307
1308 StringRef Name = NS->getName();
1309 if (!Name.empty())
1310 addString(NDie, dwarf::DW_AT_name, NS->getName());
1311 else
1312 Name = "(anonymous namespace)";
1313 DD->addAccelNamespace(*this, CUNode->getNameTableKind(), Name, NDie);
1314 addGlobalName(Name, NDie, NS->getScope());
1315 if (NS->getExportSymbols())
1316 addFlag(NDie, dwarf::DW_AT_export_symbols);
1317 return &NDie;
1318}
1319
1321 // Construct the context before querying for the existence of the DIE in case
1322 // such construction creates the DIE.
1323 DIE *ContextDIE = getOrCreateContextDIE(M->getScope());
1324
1325 if (DIE *MDie = getDIE(M))
1326 return MDie;
1327 DIE &MDie = createAndAddDIE(dwarf::DW_TAG_module, *ContextDIE, M);
1328
1329 if (!M->getName().empty()) {
1330 addString(MDie, dwarf::DW_AT_name, M->getName());
1331 addGlobalName(M->getName(), MDie, M->getScope());
1332 }
1333 if (!M->getConfigurationMacros().empty())
1334 addString(MDie, dwarf::DW_AT_LLVM_config_macros,
1335 M->getConfigurationMacros());
1336 if (!M->getIncludePath().empty())
1337 addString(MDie, dwarf::DW_AT_LLVM_include_path, M->getIncludePath());
1338 if (!M->getAPINotesFile().empty())
1339 addString(MDie, dwarf::DW_AT_LLVM_apinotes, M->getAPINotesFile());
1340 if (M->getFile())
1341 addUInt(MDie, dwarf::DW_AT_decl_file, std::nullopt,
1342 getOrCreateSourceID(M->getFile()));
1343 if (M->getLineNo())
1344 addUInt(MDie, dwarf::DW_AT_decl_line, std::nullopt, M->getLineNo());
1345 if (M->getIsDecl())
1346 addFlag(MDie, dwarf::DW_AT_declaration);
1347
1348 return &MDie;
1349}
1350
1352 const Function *FnHint, bool Minimal) {
1353 // Construct the context before querying for the existence of the DIE in case
1354 // such construction creates the DIE (as is the case for member function
1355 // declarations).
1356 DIE *ContextDIE =
1358
1359 if (DIE *SPDie = getDIE(SP))
1360 return SPDie;
1361
1362 if (auto *SPDecl = SP->getDeclaration()) {
1363 if (!Minimal) {
1364 // Build the decl now to ensure it precedes the definition.
1365 getOrCreateSubprogramDIE(SPDecl, nullptr);
1366 // Check whether the DIE for SP has already been created after the call
1367 // above.
1368 // FIXME: Should the creation of definition subprogram DIE during
1369 // the creation of declaration subprogram DIE be allowed?
1370 // See https://github.com/llvm/llvm-project/pull/154636.
1371 if (DIE *SPDie = getDIE(SP))
1372 return SPDie;
1373 }
1374 }
1375
1376 // DW_TAG_inlined_subroutine may refer to this DIE.
1377 DIE &SPDie = createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE, SP);
1378
1379 // Stop here and fill this in later, depending on whether or not this
1380 // subprogram turns out to have inlined instances or not.
1381 if (SP->isDefinition())
1382 return &SPDie;
1383
1384 static_cast<DwarfUnit *>(SPDie.getUnit())
1385 ->applySubprogramAttributes(SP, SPDie);
1386 return &SPDie;
1387}
1388
1390 DIE &SPDie, bool Minimal) {
1391 DIE *DeclDie = nullptr;
1392 StringRef DeclLinkageName;
1393 if (auto *SPDecl = SP->getDeclaration()) {
1394 if (!Minimal) {
1395 DITypeRefArray DeclArgs, DefinitionArgs;
1396 DeclArgs = SPDecl->getType()->getTypeArray();
1397 DefinitionArgs = SP->getType()->getTypeArray();
1398
1399 if (DeclArgs.size() && DefinitionArgs.size())
1400 if (DefinitionArgs[0] != nullptr && DeclArgs[0] != DefinitionArgs[0])
1401 addType(SPDie, DefinitionArgs[0]);
1402
1403 DeclDie = getDIE(SPDecl);
1404 assert(DeclDie && "This DIE should've already been constructed when the "
1405 "definition DIE was created in "
1406 "getOrCreateSubprogramDIE");
1407 // Look at the Decl's linkage name only if we emitted it.
1408 if (DD->useAllLinkageNames())
1409 DeclLinkageName = SPDecl->getLinkageName();
1410 unsigned DeclID = getOrCreateSourceID(SPDecl->getFile());
1411 unsigned DefID = getOrCreateSourceID(SP->getFile());
1412 if (DeclID != DefID)
1413 addUInt(SPDie, dwarf::DW_AT_decl_file, std::nullopt, DefID);
1414
1415 if (SP->getLine() != SPDecl->getLine())
1416 addUInt(SPDie, dwarf::DW_AT_decl_line, std::nullopt, SP->getLine());
1417 }
1418 }
1419
1420 // Add function template parameters.
1421 addTemplateParams(SPDie, SP->getTemplateParams());
1422
1423 // Add the linkage name if we have one and it isn't in the Decl.
1424 StringRef LinkageName = SP->getLinkageName();
1425 // Always emit linkage name for abstract subprograms.
1426 if (DeclLinkageName != LinkageName &&
1427 (DD->useAllLinkageNames() || DU->getAbstractScopeDIEs().lookup(SP)))
1429
1430 if (!DeclDie)
1431 return false;
1432
1433 // Refer to the function declaration where all the other attributes will be
1434 // found.
1435 addDIEEntry(SPDie, dwarf::DW_AT_specification, *DeclDie);
1436 return true;
1437}
1438
1440 bool SkipSPAttributes) {
1441 // If -fdebug-info-for-profiling is enabled, need to emit the subprogram
1442 // and its source location.
1443 bool SkipSPSourceLocation = SkipSPAttributes &&
1444 !CUNode->getDebugInfoForProfiling();
1445 if (!SkipSPSourceLocation)
1446 if (applySubprogramDefinitionAttributes(SP, SPDie, SkipSPAttributes))
1447 return;
1448
1449 // Constructors and operators for anonymous aggregates do not have names.
1450 if (!SP->getName().empty())
1451 addString(SPDie, dwarf::DW_AT_name, SP->getName());
1452
1453 addAnnotation(SPDie, SP->getAnnotations());
1454
1455 if (!SkipSPSourceLocation)
1456 addSourceLine(SPDie, SP);
1457
1458 // Skip the rest of the attributes under -gmlt to save space.
1459 if (SkipSPAttributes)
1460 return;
1461
1462 // Add the prototype if we have a prototype and we have a C like
1463 // language.
1464 if (SP->isPrototyped() && dwarf::isC(getSourceLanguage()))
1465 addFlag(SPDie, dwarf::DW_AT_prototyped);
1466
1467 if (SP->isObjCDirect())
1468 addFlag(SPDie, dwarf::DW_AT_APPLE_objc_direct);
1469
1470 unsigned CC = 0;
1471 DITypeRefArray Args;
1472 if (const DISubroutineType *SPTy = SP->getType()) {
1473 Args = SPTy->getTypeArray();
1474 CC = SPTy->getCC();
1475 }
1476
1477 // Add a DW_AT_calling_convention if this has an explicit convention.
1478 if (CC && CC != dwarf::DW_CC_normal)
1479 addUInt(SPDie, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1, CC);
1480
1481 // Add a return type. If this is a type like a C/C++ void type we don't add a
1482 // return type.
1483 if (Args.size())
1484 if (auto Ty = Args[0])
1485 addType(SPDie, Ty);
1486
1487 unsigned VK = SP->getVirtuality();
1488 if (VK) {
1489 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, VK);
1490 if (SP->getVirtualIndex() != -1u) {
1491 DIELoc *Block = getDIELoc();
1492 addUInt(*Block, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1493 addUInt(*Block, dwarf::DW_FORM_udata, SP->getVirtualIndex());
1494 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, Block);
1495 }
1496 ContainingTypeMap.insert(std::make_pair(&SPDie, SP->getContainingType()));
1497 }
1498
1499 if (!SP->isDefinition()) {
1500 addFlag(SPDie, dwarf::DW_AT_declaration);
1501
1502 // Add arguments. Do not add arguments for subprogram definition. They will
1503 // be handled while processing variables.
1504 //
1505 // Encode the object pointer as an index instead of a DIE reference in order
1506 // to minimize the affect on the .debug_info size.
1507 if (std::optional<unsigned> ObjectPointerIndex =
1508 constructSubprogramArguments(SPDie, Args)) {
1509 if (getDwarfDebug().tuneForLLDB() &&
1510 getDwarfDebug().getDwarfVersion() >= 5) {
1511 // 0th index in Args is the return type, hence adjust by 1. In DWARF
1512 // we want the first parameter to be at index 0.
1513 assert(*ObjectPointerIndex > 0);
1514 addSInt(SPDie, dwarf::DW_AT_object_pointer,
1515 dwarf::DW_FORM_implicit_const, *ObjectPointerIndex - 1);
1516 }
1517 }
1518 }
1519
1520 addThrownTypes(SPDie, SP->getThrownTypes());
1521
1522 if (SP->isArtificial())
1523 addFlag(SPDie, dwarf::DW_AT_artificial);
1524
1525 if (!SP->isLocalToUnit())
1526 addFlag(SPDie, dwarf::DW_AT_external);
1527
1528 if (DD->useAppleExtensionAttributes()) {
1529 if (SP->isOptimized())
1530 addFlag(SPDie, dwarf::DW_AT_APPLE_optimized);
1531
1532 if (unsigned isa = Asm->getISAEncoding())
1533 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1534 }
1535
1536 if (SP->isLValueReference())
1537 addFlag(SPDie, dwarf::DW_AT_reference);
1538
1539 if (SP->isRValueReference())
1540 addFlag(SPDie, dwarf::DW_AT_rvalue_reference);
1541
1542 if (SP->isNoReturn())
1543 addFlag(SPDie, dwarf::DW_AT_noreturn);
1544
1545 addAccess(SPDie, SP->getFlags());
1546
1547 if (SP->isExplicit())
1548 addFlag(SPDie, dwarf::DW_AT_explicit);
1549
1550 if (SP->isMainSubprogram())
1551 addFlag(SPDie, dwarf::DW_AT_main_subprogram);
1552 if (SP->isPure())
1553 addFlag(SPDie, dwarf::DW_AT_pure);
1554 if (SP->isElemental())
1555 addFlag(SPDie, dwarf::DW_AT_elemental);
1556 if (SP->isRecursive())
1557 addFlag(SPDie, dwarf::DW_AT_recursive);
1558
1559 if (!SP->getTargetFuncName().empty())
1560 addString(SPDie, dwarf::DW_AT_trampoline, SP->getTargetFuncName());
1561
1562 if (DD->getDwarfVersion() >= 5 && SP->isDeleted())
1563 addFlag(SPDie, dwarf::DW_AT_deleted);
1564}
1565
1566void DwarfUnit::constructSubrangeDIE(DIE &DW_Subrange, const DISubrangeType *SR,
1567 bool ForArray) {
1568 StringRef Name = SR->getName();
1569 if (!Name.empty())
1570 addString(DW_Subrange, dwarf::DW_AT_name, Name);
1571
1572 if (SR->getBaseType())
1573 addType(DW_Subrange, SR->getBaseType());
1574
1575 addSourceLine(DW_Subrange, SR);
1576
1577 if (uint64_t Size = SR->getSizeInBits())
1578 addUInt(DW_Subrange, dwarf::DW_AT_byte_size, std::nullopt, Size >> 3);
1579 if (uint32_t AlignInBytes = SR->getAlignInBytes())
1580 addUInt(DW_Subrange, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1581 AlignInBytes);
1582
1583 if (SR->isBigEndian())
1584 addUInt(DW_Subrange, dwarf::DW_AT_endianity, std::nullopt,
1585 dwarf::DW_END_big);
1586 else if (SR->isLittleEndian())
1587 addUInt(DW_Subrange, dwarf::DW_AT_endianity, std::nullopt,
1588 dwarf::DW_END_little);
1589
1590 // The LowerBound value defines the lower bounds which is typically
1591 // zero for C/C++. Values are 64 bit.
1592 int64_t DefaultLowerBound = getDefaultLowerBound();
1593
1594 auto AddBoundTypeEntry = [&](dwarf::Attribute Attr,
1595 DISubrangeType::BoundType Bound) -> void {
1596 if (auto *BV = dyn_cast_if_present<DIVariable *>(Bound)) {
1597 if (auto *VarDIE = getDIE(BV))
1598 addDIEEntry(DW_Subrange, Attr, *VarDIE);
1599 } else if (auto *BE = dyn_cast_if_present<DIExpression *>(Bound)) {
1601 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1602 DwarfExpr.setMemoryLocationKind();
1603 DwarfExpr.addExpression(BE);
1604 addBlock(DW_Subrange, Attr, DwarfExpr.finalize());
1605 } else if (auto *BI = dyn_cast_if_present<ConstantInt *>(Bound)) {
1606 if (Attr == dwarf::DW_AT_GNU_bias) {
1607 if (BI->getSExtValue() != 0)
1608 addUInt(DW_Subrange, Attr, dwarf::DW_FORM_sdata, BI->getSExtValue());
1609 } else if (Attr != dwarf::DW_AT_lower_bound || DefaultLowerBound == -1 ||
1610 BI->getSExtValue() != DefaultLowerBound || !ForArray)
1611 addSInt(DW_Subrange, Attr, dwarf::DW_FORM_sdata, BI->getSExtValue());
1612 }
1613 };
1614
1615 AddBoundTypeEntry(dwarf::DW_AT_lower_bound, SR->getLowerBound());
1616
1617 AddBoundTypeEntry(dwarf::DW_AT_upper_bound, SR->getUpperBound());
1618
1619 AddBoundTypeEntry(dwarf::DW_AT_bit_stride, SR->getStride());
1620
1621 AddBoundTypeEntry(dwarf::DW_AT_GNU_bias, SR->getBias());
1622}
1623
1624void DwarfUnit::constructSubrangeDIE(DIE &Buffer, const DISubrange *SR) {
1625 DIE &DW_Subrange = createAndAddDIE(dwarf::DW_TAG_subrange_type, Buffer);
1626
1627 DIE *IdxTy = getIndexTyDie();
1628 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, *IdxTy);
1629
1630 // The LowerBound value defines the lower bounds which is typically zero for
1631 // C/C++. The Count value is the number of elements. Values are 64 bit. If
1632 // Count == -1 then the array is unbounded and we do not emit
1633 // DW_AT_lower_bound and DW_AT_count attributes.
1634 int64_t DefaultLowerBound = getDefaultLowerBound();
1635
1636 auto AddBoundTypeEntry = [&](dwarf::Attribute Attr,
1637 DISubrange::BoundType Bound) -> void {
1638 if (auto *BV = dyn_cast_if_present<DIVariable *>(Bound)) {
1639 if (auto *VarDIE = getDIE(BV))
1640 addDIEEntry(DW_Subrange, Attr, *VarDIE);
1641 } else if (auto *BE = dyn_cast_if_present<DIExpression *>(Bound)) {
1642 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1643 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1644 DwarfExpr.setMemoryLocationKind();
1645 DwarfExpr.addExpression(BE);
1646 addBlock(DW_Subrange, Attr, DwarfExpr.finalize());
1647 } else if (auto *BI = dyn_cast_if_present<ConstantInt *>(Bound)) {
1648 if (Attr == dwarf::DW_AT_count) {
1649 if (BI->getSExtValue() != -1)
1650 addUInt(DW_Subrange, Attr, std::nullopt, BI->getSExtValue());
1651 } else if (Attr != dwarf::DW_AT_lower_bound || DefaultLowerBound == -1 ||
1652 BI->getSExtValue() != DefaultLowerBound)
1653 addSInt(DW_Subrange, Attr, dwarf::DW_FORM_sdata, BI->getSExtValue());
1654 }
1655 };
1656
1657 AddBoundTypeEntry(dwarf::DW_AT_lower_bound, SR->getLowerBound());
1658
1659 AddBoundTypeEntry(dwarf::DW_AT_count, SR->getCount());
1660
1661 AddBoundTypeEntry(dwarf::DW_AT_upper_bound, SR->getUpperBound());
1662
1663 AddBoundTypeEntry(dwarf::DW_AT_byte_stride, SR->getStride());
1664}
1665
1666void DwarfUnit::constructGenericSubrangeDIE(DIE &Buffer,
1667 const DIGenericSubrange *GSR) {
1668 DIE &DwGenericSubrange =
1669 createAndAddDIE(dwarf::DW_TAG_generic_subrange, Buffer);
1670 // Get an anonymous type for index type.
1671 // FIXME: This type should be passed down from the front end
1672 // as different languages may have different sizes for indexes.
1673 DIE *IdxTy = getIndexTyDie();
1674 addDIEEntry(DwGenericSubrange, dwarf::DW_AT_type, *IdxTy);
1675
1676 int64_t DefaultLowerBound = getDefaultLowerBound();
1677
1678 auto AddBoundTypeEntry = [&](dwarf::Attribute Attr,
1679 DIGenericSubrange::BoundType Bound) -> void {
1680 if (auto *BV = dyn_cast_if_present<DIVariable *>(Bound)) {
1681 if (auto *VarDIE = getDIE(BV))
1682 addDIEEntry(DwGenericSubrange, Attr, *VarDIE);
1683 } else if (auto *BE = dyn_cast_if_present<DIExpression *>(Bound)) {
1684 if (BE->isConstant() &&
1686 *BE->isConstant()) {
1687 if (Attr != dwarf::DW_AT_lower_bound || DefaultLowerBound == -1 ||
1688 static_cast<int64_t>(BE->getElement(1)) != DefaultLowerBound)
1689 addSInt(DwGenericSubrange, Attr, dwarf::DW_FORM_sdata,
1690 BE->getElement(1));
1691 } else {
1692 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1693 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1694 DwarfExpr.setMemoryLocationKind();
1695 DwarfExpr.addExpression(BE);
1696 addBlock(DwGenericSubrange, Attr, DwarfExpr.finalize());
1697 }
1698 }
1699 };
1700
1701 AddBoundTypeEntry(dwarf::DW_AT_lower_bound, GSR->getLowerBound());
1702 AddBoundTypeEntry(dwarf::DW_AT_count, GSR->getCount());
1703 AddBoundTypeEntry(dwarf::DW_AT_upper_bound, GSR->getUpperBound());
1704 AddBoundTypeEntry(dwarf::DW_AT_byte_stride, GSR->getStride());
1705}
1706
1707DIE *DwarfUnit::getIndexTyDie() {
1708 if (IndexTyDie)
1709 return IndexTyDie;
1710 // Construct an integer type to use for indexes.
1711 IndexTyDie = &createAndAddDIE(dwarf::DW_TAG_base_type, getUnitDie());
1712 StringRef Name = "__ARRAY_SIZE_TYPE__";
1713 addString(*IndexTyDie, dwarf::DW_AT_name, Name);
1714 addUInt(*IndexTyDie, dwarf::DW_AT_byte_size, std::nullopt, sizeof(int64_t));
1715 addUInt(*IndexTyDie, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1717 DD->addAccelType(*this, CUNode->getNameTableKind(), Name, *IndexTyDie,
1718 /*Flags*/ 0);
1719 return IndexTyDie;
1720}
1721
1722/// Returns true if the vector's size differs from the sum of sizes of elements
1723/// the user specified. This can occur if the vector has been rounded up to
1724/// fit memory alignment constraints.
1725static bool hasVectorBeenPadded(const DICompositeType *CTy) {
1726 assert(CTy && CTy->isVector() && "Composite type is not a vector");
1727 const uint64_t ActualSize = CTy->getSizeInBits();
1728
1729 // Obtain the size of each element in the vector.
1730 DIType *BaseTy = CTy->getBaseType();
1731 assert(BaseTy && "Unknown vector element type.");
1732 const uint64_t ElementSize = BaseTy->getSizeInBits();
1733
1734 // Locate the number of elements in the vector.
1735 const DINodeArray Elements = CTy->getElements();
1736 assert(Elements.size() == 1 &&
1737 Elements[0]->getTag() == dwarf::DW_TAG_subrange_type &&
1738 "Invalid vector element array, expected one element of type subrange");
1739 const auto Subrange = cast<DISubrange>(Elements[0]);
1740 const auto NumVecElements =
1741 Subrange->getCount()
1742 ? cast<ConstantInt *>(Subrange->getCount())->getSExtValue()
1743 : 0;
1744
1745 // Ensure we found the element count and that the actual size is wide
1746 // enough to contain the requested size.
1747 assert(ActualSize >= (NumVecElements * ElementSize) && "Invalid vector size");
1748 return ActualSize != (NumVecElements * ElementSize);
1749}
1750
1751void DwarfUnit::constructArrayTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
1752 if (CTy->isVector()) {
1753 addFlag(Buffer, dwarf::DW_AT_GNU_vector);
1754 if (hasVectorBeenPadded(CTy))
1755 addUInt(Buffer, dwarf::DW_AT_byte_size, std::nullopt,
1756 CTy->getSizeInBits() / CHAR_BIT);
1757 }
1758
1759 if (DIVariable *Var = CTy->getDataLocation()) {
1760 if (auto *VarDIE = getDIE(Var))
1761 addDIEEntry(Buffer, dwarf::DW_AT_data_location, *VarDIE);
1762 } else if (DIExpression *Expr = CTy->getDataLocationExp()) {
1763 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1764 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1765 DwarfExpr.setMemoryLocationKind();
1766 DwarfExpr.addExpression(Expr);
1767 addBlock(Buffer, dwarf::DW_AT_data_location, DwarfExpr.finalize());
1768 }
1769
1770 if (DIVariable *Var = CTy->getAssociated()) {
1771 if (auto *VarDIE = getDIE(Var))
1772 addDIEEntry(Buffer, dwarf::DW_AT_associated, *VarDIE);
1773 } else if (DIExpression *Expr = CTy->getAssociatedExp()) {
1774 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1775 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1776 DwarfExpr.setMemoryLocationKind();
1777 DwarfExpr.addExpression(Expr);
1778 addBlock(Buffer, dwarf::DW_AT_associated, DwarfExpr.finalize());
1779 }
1780
1781 if (DIVariable *Var = CTy->getAllocated()) {
1782 if (auto *VarDIE = getDIE(Var))
1783 addDIEEntry(Buffer, dwarf::DW_AT_allocated, *VarDIE);
1784 } else if (DIExpression *Expr = CTy->getAllocatedExp()) {
1785 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1786 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1787 DwarfExpr.setMemoryLocationKind();
1788 DwarfExpr.addExpression(Expr);
1789 addBlock(Buffer, dwarf::DW_AT_allocated, DwarfExpr.finalize());
1790 }
1791
1792 if (auto *RankConst = CTy->getRankConst()) {
1793 addSInt(Buffer, dwarf::DW_AT_rank, dwarf::DW_FORM_sdata,
1794 RankConst->getSExtValue());
1795 } else if (auto *RankExpr = CTy->getRankExp()) {
1796 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1797 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1798 DwarfExpr.setMemoryLocationKind();
1799 DwarfExpr.addExpression(RankExpr);
1800 addBlock(Buffer, dwarf::DW_AT_rank, DwarfExpr.finalize());
1801 }
1802
1803 if (auto *BitStride = CTy->getBitStrideConst()) {
1804 addUInt(Buffer, dwarf::DW_AT_bit_stride, {}, BitStride->getZExtValue());
1805 }
1806
1807 // Emit the element type.
1808 addType(Buffer, CTy->getBaseType());
1809
1810 // Add subranges to array type.
1811 DINodeArray Elements = CTy->getElements();
1812 for (DINode *E : Elements) {
1813 if (auto *Element = dyn_cast_or_null<DISubrangeType>(E)) {
1814 DIE &TyDIE = createAndAddDIE(Element->getTag(), Buffer, CTy);
1815 constructSubrangeDIE(TyDIE, Element, true);
1816 } else if (auto *Element = dyn_cast_or_null<DISubrange>(E))
1817 constructSubrangeDIE(Buffer, Element);
1818 else if (auto *Element = dyn_cast_or_null<DIGenericSubrange>(E))
1819 constructGenericSubrangeDIE(Buffer, Element);
1820 }
1821}
1822
1823void DwarfUnit::constructEnumTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
1824 const DIType *DTy = CTy->getBaseType();
1825 bool IsUnsigned = DTy && DD->isUnsignedDIType(DTy);
1826 if (DTy) {
1827 if (!Asm->TM.Options.DebugStrictDwarf || DD->getDwarfVersion() >= 3)
1828 addType(Buffer, DTy);
1829 if (DD->getDwarfVersion() >= 4 && (CTy->getFlags() & DINode::FlagEnumClass))
1830 addFlag(Buffer, dwarf::DW_AT_enum_class);
1831 }
1832
1833 if (auto Kind = CTy->getEnumKind())
1834 addUInt(Buffer, dwarf::DW_AT_APPLE_enum_kind, dwarf::DW_FORM_data1, *Kind);
1835
1836 auto *Context = CTy->getScope();
1837 bool IndexEnumerators = !Context || isa<DICompileUnit>(Context) || isa<DIFile>(Context) ||
1839 DINodeArray Elements = CTy->getElements();
1840
1841 // Add enumerators to enumeration type.
1842 for (const DINode *E : Elements) {
1844 if (Enum) {
1845 DIE &Enumerator = createAndAddDIE(dwarf::DW_TAG_enumerator, Buffer);
1846 StringRef Name = Enum->getName();
1847 addString(Enumerator, dwarf::DW_AT_name, Name);
1848 addConstantValue(Enumerator, Enum->getValue(), IsUnsigned);
1849 if (IndexEnumerators)
1851 }
1852 }
1853}
1854
1856 for (auto &P : ContainingTypeMap) {
1857 DIE &SPDie = *P.first;
1858 const DINode *D = P.second;
1859 if (!D)
1860 continue;
1861 DIE *NDie = getDIE(D);
1862 if (!NDie)
1863 continue;
1864 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, *NDie);
1865 }
1866}
1867
1868DIE &DwarfUnit::constructMemberDIE(DIE &Buffer, const DIDerivedType *DT) {
1869 DIE &MemberDie = createAndAddDIE(DT->getTag(), Buffer, DT);
1870 StringRef Name = DT->getName();
1871 if (!Name.empty())
1872 addString(MemberDie, dwarf::DW_AT_name, Name);
1873
1874 addAnnotation(MemberDie, DT->getAnnotations());
1875
1876 if (DIType *Resolved = DT->getBaseType())
1877 addType(MemberDie, Resolved);
1878
1879 addSourceLine(MemberDie, DT);
1880
1881 if (DT->getTag() == dwarf::DW_TAG_inheritance && DT->isVirtual()) {
1882
1883 // For C++, virtual base classes are not at fixed offset. Use following
1884 // expression to extract appropriate offset from vtable.
1885 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1886
1887 DIELoc *VBaseLocationDie = new (DIEValueAllocator) DIELoc;
1888 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1889 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1890 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1891 addUInt(*VBaseLocationDie, dwarf::DW_FORM_udata, DT->getOffsetInBits());
1892 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1893 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1894 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1895
1896 addBlock(MemberDie, dwarf::DW_AT_data_member_location, VBaseLocationDie);
1897 } else {
1898 uint64_t Size = 0;
1899 uint64_t FieldSize = 0;
1900
1901 bool IsBitfield = DT->isBitField();
1902
1903 // Handle the size.
1904 if (DT->getRawSizeInBits() == nullptr) {
1905 // No size, just ignore.
1906 } else if (auto *Var = dyn_cast<DIVariable>(DT->getRawSizeInBits())) {
1907 if (auto *VarDIE = getDIE(Var))
1908 addDIEEntry(MemberDie, dwarf::DW_AT_bit_size, *VarDIE);
1909 } else if (auto *Exp = dyn_cast<DIExpression>(DT->getRawSizeInBits())) {
1910 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1911 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1912 DwarfExpr.setMemoryLocationKind();
1913 DwarfExpr.addExpression(Exp);
1914 addBlock(MemberDie, dwarf::DW_AT_bit_size, DwarfExpr.finalize());
1915 } else {
1916 Size = DT->getSizeInBits();
1917 FieldSize = DD->getBaseTypeSize(DT);
1918 if (IsBitfield) {
1919 // Handle bitfield, assume bytes are 8 bits.
1920 if (DD->useDWARF2Bitfields())
1921 addUInt(MemberDie, dwarf::DW_AT_byte_size, std::nullopt,
1922 FieldSize / 8);
1923 addUInt(MemberDie, dwarf::DW_AT_bit_size, std::nullopt, Size);
1924 }
1925 }
1926
1927 // Handle the location. DW_AT_data_bit_offset won't allow an
1928 // expression until DWARF 6, but it can be used as an extension.
1929 // See https://dwarfstd.org/issues/250501.1.html
1930 if (auto *Var = dyn_cast_or_null<DIVariable>(DT->getRawOffsetInBits())) {
1931 if (!Asm->TM.Options.DebugStrictDwarf || DD->getDwarfVersion() >= 6) {
1932 if (auto *VarDIE = getDIE(Var))
1933 addDIEEntry(MemberDie, dwarf::DW_AT_data_bit_offset, *VarDIE);
1934 }
1935 } else if (auto *Expr =
1937 if (!Asm->TM.Options.DebugStrictDwarf || DD->getDwarfVersion() >= 6) {
1938 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1939 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1940 DwarfExpr.setMemoryLocationKind();
1941 DwarfExpr.addExpression(Expr);
1942 addBlock(MemberDie, dwarf::DW_AT_data_bit_offset, DwarfExpr.finalize());
1943 }
1944 } else {
1945 uint32_t AlignInBytes = DT->getAlignInBytes();
1946 uint64_t OffsetInBytes;
1947
1948 if (IsBitfield) {
1949 assert(DT->getOffsetInBits() <=
1950 (uint64_t)std::numeric_limits<int64_t>::max());
1951 int64_t Offset = DT->getOffsetInBits();
1952 // We can't use DT->getAlignInBits() here: AlignInBits for member type
1953 // is non-zero if and only if alignment was forced (e.g. _Alignas()),
1954 // which can't be done with bitfields. Thus we use FieldSize here.
1955 uint32_t AlignInBits = FieldSize;
1956 uint32_t AlignMask = ~(AlignInBits - 1);
1957 // The bits from the start of the storage unit to the start of the
1958 // field.
1959 uint64_t StartBitOffset = Offset - (Offset & AlignMask);
1960 // The byte offset of the field's aligned storage unit inside the
1961 // struct.
1962 OffsetInBytes = (Offset - StartBitOffset) / 8;
1963
1964 if (DD->useDWARF2Bitfields()) {
1965 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1966 uint64_t FieldOffset = (HiMark - FieldSize);
1967 Offset -= FieldOffset;
1968
1969 // Maybe we need to work from the other end.
1970 if (Asm->getDataLayout().isLittleEndian())
1971 Offset = FieldSize - (Offset + Size);
1972
1973 if (Offset < 0)
1974 addSInt(MemberDie, dwarf::DW_AT_bit_offset, dwarf::DW_FORM_sdata,
1975 Offset);
1976 else
1977 addUInt(MemberDie, dwarf::DW_AT_bit_offset, std::nullopt,
1978 (uint64_t)Offset);
1979 OffsetInBytes = FieldOffset >> 3;
1980 } else {
1981 addUInt(MemberDie, dwarf::DW_AT_data_bit_offset, std::nullopt,
1982 Offset);
1983 }
1984 } else {
1985 // This is not a bitfield.
1986 OffsetInBytes = DT->getOffsetInBits() / 8;
1987 if (AlignInBytes)
1988 addUInt(MemberDie, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1989 AlignInBytes);
1990 }
1991
1992 if (DD->getDwarfVersion() <= 2) {
1993 DIELoc *MemLocationDie = new (DIEValueAllocator) DIELoc;
1994 addUInt(*MemLocationDie, dwarf::DW_FORM_data1,
1995 dwarf::DW_OP_plus_uconst);
1996 addUInt(*MemLocationDie, dwarf::DW_FORM_udata, OffsetInBytes);
1997 addBlock(MemberDie, dwarf::DW_AT_data_member_location, MemLocationDie);
1998 } else if (!IsBitfield || DD->useDWARF2Bitfields()) {
1999 // In DWARF v3, DW_FORM_data4/8 in DW_AT_data_member_location are
2000 // interpreted as location-list pointers. Interpreting constants as
2001 // pointers is not expected, so we use DW_FORM_udata to encode the
2002 // constants here.
2003 if (DD->getDwarfVersion() == 3)
2004 addUInt(MemberDie, dwarf::DW_AT_data_member_location,
2005 dwarf::DW_FORM_udata, OffsetInBytes);
2006 else
2007 addUInt(MemberDie, dwarf::DW_AT_data_member_location, std::nullopt,
2008 OffsetInBytes);
2009 }
2010 }
2011 }
2012
2013 addAccess(MemberDie, DT->getFlags());
2014
2015 if (DT->isVirtual())
2016 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1,
2017 dwarf::DW_VIRTUALITY_virtual);
2018
2019 // Objective-C properties.
2020 if (DINode *PNode = DT->getObjCProperty())
2021 if (DIE *PDie = getDIE(PNode))
2022 addAttribute(MemberDie, dwarf::DW_AT_APPLE_property,
2023 dwarf::DW_FORM_ref4, DIEEntry(*PDie));
2024
2025 if (DT->isArtificial())
2026 addFlag(MemberDie, dwarf::DW_AT_artificial);
2027
2028 return MemberDie;
2029}
2030
2032 if (!DT)
2033 return nullptr;
2034
2035 // Construct the context before querying for the existence of the DIE in case
2036 // such construction creates the DIE.
2037 DIE *ContextDIE = getOrCreateContextDIE(DT->getScope());
2038 assert(dwarf::isType(ContextDIE->getTag()) &&
2039 "Static member should belong to a type.");
2040
2041 if (DIE *StaticMemberDIE = getDIE(DT))
2042 return StaticMemberDIE;
2043
2044 DwarfUnit *ContextUnit = static_cast<DwarfUnit *>(ContextDIE->getUnit());
2045 DIE &StaticMemberDIE = createAndAddDIE(DT->getTag(), *ContextDIE, DT);
2046
2047 const DIType *Ty = DT->getBaseType();
2048
2049 addString(StaticMemberDIE, dwarf::DW_AT_name, DT->getName());
2050 addType(StaticMemberDIE, Ty);
2051 ContextUnit->addSourceLine(StaticMemberDIE, DT);
2052 addFlag(StaticMemberDIE, dwarf::DW_AT_external);
2053 addFlag(StaticMemberDIE, dwarf::DW_AT_declaration);
2054
2055 // Consider the case when the static member was created by the compiler.
2056 if (DT->isArtificial())
2057 addFlag(StaticMemberDIE, dwarf::DW_AT_artificial);
2058
2059 // FIXME: We could omit private if the parent is a class_type, and
2060 // public if the parent is something else.
2061 addAccess(StaticMemberDIE, DT->getFlags());
2062
2064 addConstantValue(StaticMemberDIE, CI, Ty);
2065 if (const ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(DT->getConstant()))
2066 addConstantFPValue(StaticMemberDIE, CFP);
2067
2068 if (uint32_t AlignInBytes = DT->getAlignInBytes())
2069 addUInt(StaticMemberDIE, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
2070 AlignInBytes);
2071
2072 return &StaticMemberDIE;
2073}
2074
2076 // Emit size of content not including length itself
2077 if (!DD->useSectionsAsReferences())
2078 EndLabel = Asm->emitDwarfUnitLength(
2079 isDwoUnit() ? "debug_info_dwo" : "debug_info", "Length of Unit");
2080 else
2081 Asm->emitDwarfUnitLength(getHeaderSize() + getUnitDie().getSize(),
2082 "Length of Unit");
2083
2084 Asm->OutStreamer->AddComment("DWARF version number");
2085 unsigned Version = DD->getDwarfVersion();
2086 Asm->emitInt16(Version);
2087
2088 // DWARF v5 reorders the address size and adds a unit type.
2089 if (Version >= 5) {
2090 Asm->OutStreamer->AddComment("DWARF Unit Type");
2091 Asm->emitInt8(UT);
2092 Asm->OutStreamer->AddComment("Address Size (in bytes)");
2093 Asm->emitInt8(Asm->MAI->getCodePointerSize());
2094 }
2095
2096 // We share one abbreviations table across all units so it's always at the
2097 // start of the section. Use a relocatable offset where needed to ensure
2098 // linking doesn't invalidate that offset.
2099 Asm->OutStreamer->AddComment("Offset Into Abbrev. Section");
2100 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
2101 if (UseOffsets)
2102 Asm->emitDwarfLengthOrOffset(0);
2103 else
2104 Asm->emitDwarfSymbolReference(
2105 TLOF.getDwarfAbbrevSection()->getBeginSymbol(), false);
2106
2107 if (Version <= 4) {
2108 Asm->OutStreamer->AddComment("Address Size (in bytes)");
2109 Asm->emitInt8(Asm->MAI->getCodePointerSize());
2110 }
2111}
2112
2113void DwarfTypeUnit::emitHeader(bool UseOffsets) {
2114 if (!DD->useSplitDwarf()) {
2115 LabelBegin = Asm->createTempSymbol("tu_begin");
2116 Asm->OutStreamer->emitLabel(LabelBegin);
2117 }
2118 DwarfUnit::emitCommonHeader(UseOffsets,
2119 DD->useSplitDwarf() ? dwarf::DW_UT_split_type
2120 : dwarf::DW_UT_type);
2121 Asm->OutStreamer->AddComment("Type Signature");
2122 Asm->OutStreamer->emitIntValue(TypeSignature, sizeof(TypeSignature));
2123 Asm->OutStreamer->AddComment("Type DIE Offset");
2124 // In a skeleton type unit there is no type DIE so emit a zero offset.
2125 Asm->emitDwarfLengthOrOffset(Ty ? Ty->getOffset() : 0);
2126}
2127
2129 const MCSymbol *Hi, const MCSymbol *Lo) {
2130 addAttribute(Die, Attribute, DD->getDwarfSectionOffsetForm(),
2132}
2133
2135 const MCSymbol *Label, const MCSymbol *Sec) {
2136 if (Asm->doesDwarfUseRelocationsAcrossSections())
2137 addLabel(Die, Attribute, DD->getDwarfSectionOffsetForm(), Label);
2138 else
2139 addSectionDelta(Die, Attribute, Label, Sec);
2140}
2141
2142bool DwarfTypeUnit::isDwoUnit() const {
2143 // Since there are no skeleton type units, all type units are dwo type units
2144 // when split DWARF is being used.
2145 return DD->useSplitDwarf();
2146}
2147
2149 const DIScope *Context) {
2150 getCU().addGlobalNameForTypeUnit(Name, Context);
2151}
2152
2154 const DIScope *Context) {
2155 getCU().addGlobalTypeUnitType(Ty, Context);
2156}
2157
2160 return nullptr;
2161 if (isDwoUnit())
2162 return nullptr;
2163 return getSection()->getBeginSymbol();
2164}
2165
2167 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
2168 addSectionLabel(getUnitDie(), dwarf::DW_AT_str_offsets_base,
2169 DU->getStringOffsetsStartSym(),
2171}
2172
2174 assert(DD->getDwarfVersion() >= 5 &&
2175 "DW_AT_rnglists_base requires DWARF version 5 or later");
2176 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
2177 addSectionLabel(getUnitDie(), dwarf::DW_AT_rnglists_base,
2178 DU->getRnglistsTableBaseSym(),
2180}
2181
2182void DwarfTypeUnit::finishNonUnitTypeDIE(DIE& D, const DICompositeType *CTy) {
2184}
2185
2186bool DwarfUnit::isCompatibleWithVersion(uint16_t Version) const {
2187 return !Asm->TM.Options.DebugStrictDwarf || DD->getDwarfVersion() >= Version;
2188}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
This file declares a class to represent arbitrary precision floating point values and provide a varie...
This file implements a class to represent arbitrary precision integral constant values and operations...
BitTracker BT
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
This file contains the declarations for the subclasses of Constant, which represent the different fla...
static bool hasVectorBeenPadded(const DICompositeType *CTy)
Returns true if the vector's size differs from the sum of sizes of elements the user specified.
#define I(x, y, z)
Definition MD5.cpp:58
#define G(x, y, z)
Definition MD5.cpp:56
Register const TargetRegisterInfo * TRI
This file contains the declarations for metadata subclasses.
#define T
#define P(N)
static enum BaseType getBaseType(const Value *Val)
Return the baseType for Val which states whether Val is exclusively derived from constant/null,...
static unsigned getSize(unsigned Kind)
APInt bitcastToAPInt() const
Definition APFloat.h:1353
Class for arbitrary precision integers.
Definition APInt.h:78
uint64_t getZExtValue() const
Get zero extended value.
Definition APInt.h:1540
unsigned getBitWidth() const
Return the number of bits in the APInt.
Definition APInt.h:1488
const uint64_t * getRawData() const
This function returns a pointer to the internal storage of the APInt.
Definition APInt.h:569
int64_t getSExtValue() const
Get sign extended value.
Definition APInt.h:1562
void resetUsedFlag(bool HasBeenUsed=false)
Definition AddressPool.h:51
Annotations lets you mark points and ranges inside source code, for tests:
Definition Annotations.h:53
This class is intended to be used as a driving class for all asm writers.
Definition AsmPrinter.h:91
MCSymbol * getSymbol(const GlobalValue *GV) const
TargetMachine & TM
Target machine description.
Definition AsmPrinter.h:94
MCContext & OutContext
This is the context for the output file that we are streaming.
Definition AsmPrinter.h:101
const DataLayout & getDataLayout() const
Return information about data layout.
bool doesDwarfUseRelocationsAcrossSections() const
Definition AsmPrinter.h:364
Functions, function parameters, and return types can have attributes to indicate how they should be t...
Definition Attributes.h:69
ConstantFP - Floating Point Values [float, double].
Definition Constants.h:277
const APFloat & getValueAPF() const
Definition Constants.h:320
This is the shared class of boolean and integer constants.
Definition Constants.h:87
const APInt & getValue() const
Return the constant as an APInt value reference.
Definition Constants.h:154
This is an important base class in LLVM.
Definition Constant.h:43
Basic type, like 'int' or 'float'.
unsigned getEncoding() const
DIExpression * getRankExp() const
DIExpression * getAssociatedExp() const
DIVariable * getAllocated() const
DIExpression * getDataLocationExp() const
DIVariable * getAssociated() const
DIDerivedType * getDiscriminator() const
DIVariable * getDataLocation() const
unsigned getRuntimeLang() const
DIType * getSpecification() const
StringRef getIdentifier() const
DINodeArray getElements() const
DITemplateParameterArray getTemplateParams() const
DIExpression * getAllocatedExp() const
ConstantInt * getBitStrideConst() const
std::optional< uint32_t > getEnumKind() const
DIType * getVTableHolder() const
DINodeArray getAnnotations() const
ConstantInt * getRankConst() const
MDString * getRawIdentifier() const
DIType * getBaseType() const
DINodeArray getAnnotations() const
Get annotations associated with this derived type.
DITemplateParameterArray getTemplateParams() const
Get the template parameters from a template alias.
DIObjCProperty * getObjCProperty() const
LLVM_ABI Constant * getConstant() const
DIEBlock - Represents a block of values.
Definition DIE.h:1056
A simple label difference DIE.
Definition DIE.h:265
DwarfExpression implementation for singular DW_AT_location.
DIEDwarfExpression(const AsmPrinter &AP, DwarfCompileUnit &CU, DIELoc &DIE)
Definition DwarfUnit.cpp:41
A pointer to another debug information entry.
Definition DIE.h:325
A container for inline string values.
Definition DIE.h:303
An integer value DIE.
Definition DIE.h:169
static dwarf::Form BestForm(bool IsSigned, uint64_t Int)
Choose the best form for integer.
Definition DIE.h:176
A label DIE.
Definition DIE.h:226
DIELoc - Represents an expression location.
Definition DIE.h:1020
A container for string pool string values.
Definition DIE.h:283
virtual const MCSymbol * getCrossSectionRelativeBaseAddress() const
Definition DIE.h:999
LLVM_ABI DIEUnit(dwarf::Tag UnitTag)
Definition DIE.cpp:306
MCSection * getSection() const
Return the section that this DIEUnit will be emitted into.
Definition DIE.h:1006
DIE & getUnitDie()
Definition DIE.h:1009
A list of DIE values.
Definition DIE.h:698
A structured debug information entry.
Definition DIE.h:828
DIE & addChild(DIE *Child)
Add a child to the DIE.
Definition DIE.h:944
static DIE * get(BumpPtrAllocator &Alloc, dwarf::Tag Tag)
Definition DIE.h:858
LLVM_ABI DIEUnit * getUnit() const
Climb up the parent chain to get the compile unit or type unit that this DIE belongs to.
Definition DIE.cpp:203
dwarf::Tag getTag() const
Definition DIE.h:864
const APInt & getDenominator() const
LLVM_ABI bool isSigned() const
const APInt & getNumerator() const
LLVM_ABI BoundType getLowerBound() const
LLVM_ABI BoundType getCount() const
LLVM_ABI BoundType getUpperBound() const
PointerUnion< DIVariable *, DIExpression * > BoundType
LLVM_ABI BoundType getStride() const
Represents a module in the programming language, for example, a Clang module, or a Fortran module.
Debug lexical block.
DIScope * getScope() const
StringRef getName() const
bool getExportSymbols() const
Tagged DWARF-like metadata node.
LLVM_ABI dwarf::Tag getTag() const
DIFlags
Debug info flags.
Base class for scope-like contexts.
LLVM_ABI DIScope * getScope() const
String type, Fortran CHARACTER(n)
unsigned getEncoding() const
DIExpression * getStringLengthExp() const
DIVariable * getStringLength() const
DIExpression * getStringLocationExp() const
Subprogram description. Uses SubclassData1.
BoundType getLowerBound() const
PointerUnion< ConstantInt *, DIVariable *, DIExpression * > BoundType
BoundType getBias() const
BoundType getUpperBound() const
DIType * getBaseType() const
Get the base type this is derived from.
BoundType getStride() const
Array subrange.
LLVM_ABI BoundType getUpperBound() const
LLVM_ABI BoundType getStride() const
LLVM_ABI BoundType getLowerBound() const
LLVM_ABI BoundType getCount() const
Type array for a subprogram.
Base class for types.
bool isLittleEndian() const
uint32_t getNumExtraInhabitants() const
bool isBigEndian() const
bool isLValueReference() const
bool isBitField() const
bool isVirtual() const
bool isObjcClassComplete() const
bool isAppleBlockExtension() const
uint64_t getOffsetInBits() const
bool isVector() const
DIFlags getFlags() const
StringRef getName() const
bool isForwardDecl() const
bool isTypePassByValue() const
uint64_t getSizeInBits() const
uint32_t getAlignInBytes() const
Metadata * getRawSizeInBits() const
bool isRValueReference() const
bool isArtificial() const
bool getExportSymbols() const
DIScope * getScope() const
bool isTypePassByReference() const
Metadata * getRawOffsetInBits() const
bool isLittleEndian() const
Layout endianness...
Definition DataLayout.h:207
void addGlobalNameForTypeUnit(StringRef Name, const DIScope *Context)
Add a new global name present in a type unit to this compile unit.
unsigned getOrCreateSourceID(const DIFile *File) override
Look up the source ID for the given file.
void addGlobalTypeUnitType(const DIType *Ty, const DIScope *Context)
Add a new global type present in a type unit to this compile unit.
Collects and handles dwarf debug information.
Definition DwarfDebug.h:351
std::optional< MD5::MD5Result > getMD5AsBytes(const DIFile *File) const
If the File has an MD5 checksum, return it as an MD5Result allocated in the MCContext.
uint16_t getDwarfVersion() const
Returns the Dwarf Version.
AddressPool & getAddressPool()
Definition DwarfDebug.h:879
bool useSplitDwarf() const
Returns whether or not to change the current debug info for the split dwarf proposal support.
Definition DwarfDebug.h:824
virtual void disableTemporaryBuffer()=0
Disable emission to the temporary buffer.
virtual unsigned getTemporaryBufferSize()=0
Return the emitted size, in number of bytes, for the data stored in the temporary buffer.
void setMemoryLocationKind()
Lock this down to become a memory location description.
DwarfCompileUnit & CU
void addExpression(DIExpressionCursor &&Expr)
Emit all remaining operations in the DIExpressionCursor.
virtual void commitTemporaryBuffer()=0
Commit the data stored in the temporary buffer to the main output.
DwarfExpression(unsigned DwarfVersion, DwarfCompileUnit &CU)
virtual void enableTemporaryBuffer()=0
Start emitting data to the temporary buffer.
DwarfTypeUnit(DwarfCompileUnit &CU, AsmPrinter *A, DwarfDebug *DW, DwarfFile *DWU, unsigned UniqueID, MCDwarfDwoLineTable *SplitLineTable=nullptr)
Definition DwarfUnit.cpp:89
void addGlobalTypeImpl(const DIType *Ty, const DIE &Die, const DIScope *Context) override
Add a new global type to the compile unit.
DwarfCompileUnit & getCU() override
Definition DwarfUnit.h:442
void emitHeader(bool UseOffsets) override
Emit the header for this unit, not including the initial length field.
void addGlobalName(StringRef Name, const DIE &Die, const DIScope *Context) override
Add a new global name to the compile unit.
virtual DIE * getOrCreateTypeDIE(const MDNode *TyNode)
Find existing DIE or create new DIE for the given type.
void addInt(DIE &Die, dwarf::Attribute Attribute, const APInt &Integer, bool Unsigned)
Add an integer attribute data and value; value may be any width.
DwarfDebug & getDwarfDebug() const
Definition DwarfUnit.h:113
void addThrownTypes(DIE &Die, DINodeArray ThrownTypes)
Add thrown types.
void addStringOffsetsStart()
Add the DW_AT_str_offsets_base attribute to the unit DIE.
void addAnnotation(DIE &Buffer, DINodeArray Annotations)
Add DW_TAG_LLVM_annotation.
std::vector< DIEBlock * > DIEBlocks
A list of all the DIEBlocks in use.
Definition DwarfUnit.h:67
std::vector< DIELoc * > DIELocs
A list of all the DIELocs in use.
Definition DwarfUnit.h:70
void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Loc)
Add block data.
void addTemplateParams(DIE &Buffer, DINodeArray TParams)
Add template parameters in buffer.
virtual DIE * getOrCreateContextDIE(const DIScope *Context)
Get context owner's DIE.
bool useSegmentedStringOffsetsTable() const
Definition DwarfUnit.h:290
bool applySubprogramDefinitionAttributes(const DISubprogram *SP, DIE &SPDie, bool Minimal)
DIELoc * getDIELoc()
Returns a fresh newly allocated DIELoc.
Definition DwarfUnit.h:145
void updateAcceleratorTables(const DIScope *Context, const DIType *Ty, const DIE &TyDIE)
If this is a named finished type then include it in the list of types for the accelerator tables.
void addAttribute(DIEValueList &Die, dwarf::Attribute Attribute, dwarf::Form Form, T &&Value)
Definition DwarfUnit.h:85
void addOpAddress(DIELoc &Die, const MCSymbol *Sym)
Add a dwarf op address data and value using the form given and an op of either DW_FORM_addr or DW_FOR...
void addUInt(DIEValueList &Die, dwarf::Attribute Attribute, std::optional< dwarf::Form > Form, uint64_t Integer)
Add an unsigned integer attribute data and value.
void addString(DIE &Die, dwarf::Attribute Attribute, StringRef Str)
Add a string attribute data and value.
void addConstantValue(DIE &Die, const ConstantInt *CI, const DIType *Ty)
Add constant value entry in variable DIE.
DIE * getOrCreateNameSpace(const DINamespace *NS)
void insertDIE(const DINode *Desc, DIE *D)
Insert DIE into the map.
void addAccess(DIE &Die, DINode::DIFlags Flags)
Add the accessibility attribute.
void addSectionDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi, const MCSymbol *Lo)
addSectionDelta - Add a label delta attribute data and value.
void addGlobalType(const DIType *Ty, const DIE &Die, const DIScope *Context)
DIE * createTypeDIE(const DIScope *Context, DIE &ContextDIE, const DIType *Ty)
Creates type DIE with specific context.
bool shouldPlaceInUnitDIE(const DISubprogram *SP, bool Minimal)
Definition DwarfUnit.h:349
DwarfDebug * DD
Definition DwarfUnit.h:56
DenseMap< DIE *, const DINode * > ContainingTypeMap
This map is used to keep track of subprogram DIEs that need DW_AT_containing_type attribute.
Definition DwarfUnit.h:75
const DICompileUnit * CUNode
MDNode for the compile unit.
Definition DwarfUnit.h:41
virtual unsigned getOrCreateSourceID(const DIFile *File)=0
Look up the source ID for the given file.
virtual DIE * getOrCreateSubprogramDIE(const DISubprogram *SP, const Function *FnHint, bool Minimal=false)
DIE * getOrCreateSubprogramContextDIE(const DISubprogram *SP, bool IgnoreScope)
Definition DwarfUnit.h:354
virtual void addGlobalTypeImpl(const DIType *Ty, const DIE &Die, const DIScope *Context)=0
Add a new global type to the compile unit.
void addDIETypeSignature(DIE &Die, uint64_t Signature)
Add a type's DW_AT_signature and set the declaration flag.
std::optional< unsigned > constructSubprogramArguments(DIE &Buffer, DITypeRefArray Args)
Construct function argument DIEs.
virtual DwarfCompileUnit & getCU()=0
DIE * getDIE(const DINode *D) const
Returns the DIE map slot for the specified debug variable.
virtual unsigned getHeaderSize() const
Compute the size of a header for this unit, not including the initial length field.
Definition DwarfUnit.h:296
MCSymbol * LabelBegin
The start of the unit within its section.
Definition DwarfUnit.h:50
void addSInt(DIEValueList &Die, dwarf::Attribute Attribute, std::optional< dwarf::Form > Form, int64_t Integer)
Add an signed integer attribute data and value.
DwarfUnit(dwarf::Tag, const DICompileUnit *Node, AsmPrinter *A, DwarfDebug *DW, DwarfFile *DWU, unsigned UniqueID=0)
Definition DwarfUnit.cpp:83
void addLabelDelta(DIEValueList &Die, dwarf::Attribute Attribute, const MCSymbol *Hi, const MCSymbol *Lo)
Add a label delta attribute data and value.
void addLinkageName(DIE &Die, StringRef LinkageName)
Add a linkage name, if it isn't empty.
std::string getParentContextString(const DIScope *Context) const
Get string containing language specific context for a global name.
void addSourceLine(DIE &Die, unsigned Line, unsigned Column, const DIFile *File)
Add location information to specified debug information entry.
void emitCommonHeader(bool UseOffsets, dwarf::UnitType UT)
Emit the common part of the header for this unit.
BumpPtrAllocator DIEValueAllocator
Definition DwarfUnit.h:44
DIE * IndexTyDie
An anonymous type for index type. Owned by DIEUnit.
Definition DwarfUnit.h:60
void addRnglistsBase()
Add the DW_AT_rnglists_base attribute to the unit DIE.
DIE * getOrCreateModule(const DIModule *M)
const DICompileUnit * getCUNode() const
Definition DwarfUnit.h:112
DIE & createAndAddDIE(dwarf::Tag Tag, DIE &Parent, const DINode *N=nullptr)
Create a DIE with the given Tag, add the DIE to its parent, and call insertDIE if MD is not null.
DwarfFile * DU
Definition DwarfUnit.h:57
void addSectionOffset(DIE &Die, dwarf::Attribute Attribute, uint64_t Integer)
Add an offset into a section attribute data and value.
DIE * getOrCreateStaticMemberDIE(const DIDerivedType *DT)
Create new static data member DIE.
void addLabel(DIEValueList &Die, dwarf::Attribute Attribute, dwarf::Form Form, const MCSymbol *Label)
Add a Dwarf label attribute data and value.
void addConstantFPValue(DIE &Die, const ConstantFP *CFP)
Add constant value entry in variable DIE.
void constructContainingTypeDIEs()
Construct DIEs for types that contain vtables.
unsigned UniqueID
A numeric ID unique among all CUs in the module.
Definition DwarfUnit.h:39
void addSectionLabel(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Label, const MCSymbol *Sec)
Add a Dwarf section label attribute data and value.
bool isShareableAcrossCUs(const DINode *D) const
Check whether the DIE for this MDNode can be shared across CUs.
llvm::dwarf::SourceLanguage getSourceLanguage() const
void addPoolOpAddress(DIEValueList &Die, const MCSymbol *Label)
DenseMap< const MDNode *, DIE * > MDNodeToDieMap
Tracks the mapping of unit level debug information variables to debug information entries.
Definition DwarfUnit.h:64
void constructTypeDIE(DIE &Buffer, const DICompositeType *CTy)
virtual void addGlobalName(StringRef Name, const DIE &Die, const DIScope *Context)=0
Add a new global name to the compile unit.
MCSymbol * EndLabel
Emitted at the end of the CU and used to compute the CU Length field.
Definition DwarfUnit.h:53
void addFlag(DIE &Die, dwarf::Attribute Attribute)
Add a flag that is true to the DIE.
AsmPrinter * Asm
Target of Dwarf emission.
Definition DwarfUnit.h:47
void addType(DIE &Entity, const DIType *Ty, dwarf::Attribute Attribute=dwarf::DW_AT_type)
Add a new type attribute to the specified entity.
void applySubprogramAttributes(const DISubprogram *SP, DIE &SPDie, bool SkipSPAttributes=false)
void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry)
Add a DIE attribute data and value.
static StringRef dropLLVMManglingEscape(StringRef Name)
If the given string begins with the GlobalValue name mangling escape character '\1',...
uint16_t getDwarfVersion() const
Definition MCContext.h:817
unsigned getFile(StringRef Directory, StringRef FileName, std::optional< MD5::MD5Result > Checksum, uint16_t DwarfVersion, std::optional< StringRef > Source)
Definition MCDwarf.h:357
MCSection * getDwarfStrOffSection() const
MCSection * getDwarfRnglistsSection() const
MCSection * getDwarfAbbrevSection() const
MCSymbol * getBeginSymbol()
Definition MCSection.h:593
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition MCSymbol.h:42
Metadata node.
Definition Metadata.h:1078
const MDOperand & getOperand(unsigned I) const
Definition Metadata.h:1442
A single uniqued string.
Definition Metadata.h:721
Root of the metadata hierarchy.
Definition Metadata.h:64
Wrapper class representing virtual and physical registers.
Definition Register.h:19
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
constexpr bool empty() const
empty - Check if the string is empty.
Definition StringRef.h:143
TargetOptions Options
unsigned DebugStrictDwarf
When set to true, don't use DWARF extensions in later DWARF versions.
TargetRegisterInfo base class - We assume that the target defines a static array of TargetRegisterDes...
LLVM Value Representation.
Definition Value.h:75
Calculates the starting offsets for various sections within the .debug_names section.
Definition Dwarf.h:35
@ DW_ACCESS_private
Definition Dwarf.h:187
@ DW_ACCESS_protected
Definition Dwarf.h:186
@ DW_ACCESS_public
Definition Dwarf.h:185
Attribute
Attributes.
Definition Dwarf.h:125
SourceLanguageName
Definition Dwarf.h:223
UnitType
Constants for unit types in DWARF v5.
Definition Dwarf.h:896
bool isType(Tag T)
Definition Dwarf.h:113
@ DW_LANG_hi_user
Definition Dwarf.h:220
std::optional< SourceLanguage > toDW_LANG(SourceLanguageName name, uint32_t version)
Convert a DWARF 6 pair of language name and version to a DWARF 5 DW_LANG.
Definition Dwarf.h:231
bool isCPlusPlus(SourceLanguage S)
Definition Dwarf.h:512
TypeKind getArrayIndexTypeEncoding(SourceLanguage S)
Definition Dwarf.h:748
@ DW_DSC_range
Definition Dwarf.h:791
@ DW_DSC_label
Definition Dwarf.h:790
@ DW_FLAG_type_implementation
Definition Dwarf.h:953
bool isC(SourceLanguage S)
Definition Dwarf.h:672
std::enable_if_t< detail::IsValidPointer< X, Y >::value, X * > dyn_extract(Y &&MD)
Extract a Value from Metadata, if any.
Definition Metadata.h:695
This is an optimization pass for GlobalISel generic memory operations.
FunctionAddr VTableAddr Value
Definition InstrProf.h:137
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:644
auto dyn_cast_if_present(const Y &Val)
dyn_cast_if_present<X> - Functionally identical to dyn_cast, except that a null (or none in the case ...
Definition Casting.h:733
Op::Description Desc
auto dyn_cast_or_null(const Y &Val)
Definition Casting.h:754
FunctionAddr VTableAddr uintptr_t uintptr_t Version
Definition InstrProf.h:302
auto reverse(ContainerTy &&C)
Definition STLExtras.h:408
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:548
FunctionAddr VTableAddr uintptr_t uintptr_t Data
Definition InstrProf.h:189
DWARFExpression::Operation Op
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:560
#define N