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
708 return static_cast<llvm::dwarf::SourceLanguage>(
709 getLanguage().getUnversionedName());
710}
711
712std::string DwarfUnit::getParentContextString(const DIScope *Context) const {
713 if (!Context)
714 return "";
715
716 // FIXME: Decide whether to implement this for non-C++ languages.
718 return "";
719
720 std::string CS;
722 while (!isa<DICompileUnit>(Context)) {
723 Parents.push_back(Context);
724 if (const DIScope *S = Context->getScope())
725 Context = S;
726 else
727 // Structure, etc types will have a NULL context if they're at the top
728 // level.
729 break;
730 }
731
732 // Reverse iterate over our list to go from the outermost construct to the
733 // innermost.
734 for (const DIScope *Ctx : llvm::reverse(Parents)) {
735 StringRef Name = Ctx->getName();
736 if (Name.empty() && isa<DINamespace>(Ctx))
737 Name = "(anonymous namespace)";
738 if (!Name.empty()) {
739 CS += Name;
740 CS += "::";
741 }
742 }
743 return CS;
744}
745
746void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIBasicType *BTy) {
747 // Get core information.
748 StringRef Name = BTy->getName();
749 // Add name if not anonymous or intermediate type.
750 if (!Name.empty())
751 addString(Buffer, dwarf::DW_AT_name, Name);
752
753 // An unspecified type only has a name attribute.
754 if (BTy->getTag() == dwarf::DW_TAG_unspecified_type)
755 return;
756
757 if (BTy->getTag() != dwarf::DW_TAG_string_type)
758 addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
759 BTy->getEncoding());
760
761 uint64_t Size = BTy->getSizeInBits() >> 3;
762 addUInt(Buffer, dwarf::DW_AT_byte_size, std::nullopt, Size);
763
764 if (BTy->isBigEndian())
765 addUInt(Buffer, dwarf::DW_AT_endianity, std::nullopt, dwarf::DW_END_big);
766 else if (BTy->isLittleEndian())
767 addUInt(Buffer, dwarf::DW_AT_endianity, std::nullopt, dwarf::DW_END_little);
768
769 if (uint32_t NumExtraInhabitants = BTy->getNumExtraInhabitants())
770 addUInt(Buffer, dwarf::DW_AT_LLVM_num_extra_inhabitants, std::nullopt,
771 NumExtraInhabitants);
772}
773
774void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIFixedPointType *BTy) {
775 // Base type handling.
776 constructTypeDIE(Buffer, static_cast<const DIBasicType *>(BTy));
777
778 if (BTy->isBinary())
779 addSInt(Buffer, dwarf::DW_AT_binary_scale, dwarf::DW_FORM_sdata,
780 BTy->getFactor());
781 else if (BTy->isDecimal())
782 addSInt(Buffer, dwarf::DW_AT_decimal_scale, dwarf::DW_FORM_sdata,
783 BTy->getFactor());
784 else {
785 assert(BTy->isRational());
786 DIE *ContextDIE = getOrCreateContextDIE(BTy->getScope());
787 DIE &Constant = createAndAddDIE(dwarf::DW_TAG_constant, *ContextDIE);
788
789 addInt(Constant, dwarf::DW_AT_GNU_numerator, BTy->getNumerator(),
790 !BTy->isSigned());
791 addInt(Constant, dwarf::DW_AT_GNU_denominator, BTy->getDenominator(),
792 !BTy->isSigned());
793
794 addDIEEntry(Buffer, dwarf::DW_AT_small, Constant);
795 }
796}
797
798void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIStringType *STy) {
799 // Get core information.
800 StringRef Name = STy->getName();
801 // Add name if not anonymous or intermediate type.
802 if (!Name.empty())
803 addString(Buffer, dwarf::DW_AT_name, Name);
804
805 if (DIVariable *Var = STy->getStringLength()) {
806 if (auto *VarDIE = getDIE(Var))
807 addDIEEntry(Buffer, dwarf::DW_AT_string_length, *VarDIE);
808 } else if (DIExpression *Expr = STy->getStringLengthExp()) {
809 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
810 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
811 // This is to describe the memory location of the
812 // length of a Fortran deferred length string, so
813 // lock it down as such.
814 DwarfExpr.setMemoryLocationKind();
815 DwarfExpr.addExpression(Expr);
816 addBlock(Buffer, dwarf::DW_AT_string_length, DwarfExpr.finalize());
817 } else {
818 uint64_t Size = STy->getSizeInBits() >> 3;
819 addUInt(Buffer, dwarf::DW_AT_byte_size, std::nullopt, Size);
820 }
821
822 if (DIExpression *Expr = STy->getStringLocationExp()) {
823 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
824 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
825 // This is to describe the memory location of the
826 // string, so lock it down as such.
827 DwarfExpr.setMemoryLocationKind();
828 DwarfExpr.addExpression(Expr);
829 addBlock(Buffer, dwarf::DW_AT_data_location, DwarfExpr.finalize());
830 }
831
832 if (STy->getEncoding()) {
833 // For eventual Unicode support.
834 addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
835 STy->getEncoding());
836 }
837}
838
839void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIDerivedType *DTy) {
840 // Get core information.
841 StringRef Name = DTy->getName();
842 uint64_t Size = DTy->getSizeInBits() >> 3;
843 uint16_t Tag = Buffer.getTag();
844
845 // Map to main type, void will not have a type.
846 const DIType *FromTy = DTy->getBaseType();
847 if (FromTy)
848 addType(Buffer, FromTy);
849
850 // Add name if not anonymous or intermediate type.
851 if (!Name.empty())
852 addString(Buffer, dwarf::DW_AT_name, Name);
853
854 addAnnotation(Buffer, DTy->getAnnotations());
855
856 // If alignment is specified for a typedef , create and insert DW_AT_alignment
857 // attribute in DW_TAG_typedef DIE.
858 if (Tag == dwarf::DW_TAG_typedef && DD->getDwarfVersion() >= 5) {
859 uint32_t AlignInBytes = DTy->getAlignInBytes();
860 if (AlignInBytes > 0)
861 addUInt(Buffer, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
862 AlignInBytes);
863 }
864
865 // Add size if non-zero (derived types might be zero-sized.)
866 if (Size && Tag != dwarf::DW_TAG_pointer_type
867 && Tag != dwarf::DW_TAG_ptr_to_member_type
868 && Tag != dwarf::DW_TAG_reference_type
869 && Tag != dwarf::DW_TAG_rvalue_reference_type)
870 addUInt(Buffer, dwarf::DW_AT_byte_size, std::nullopt, Size);
871
872 if (Tag == dwarf::DW_TAG_ptr_to_member_type)
873 addDIEEntry(Buffer, dwarf::DW_AT_containing_type,
874 *getOrCreateTypeDIE(cast<DIDerivedType>(DTy)->getClassType()));
875
876 addAccess(Buffer, DTy->getFlags());
877
878 // Add source line info if available and TyDesc is not a forward declaration.
879 if (!DTy->isForwardDecl())
880 addSourceLine(Buffer, DTy);
881
882 // If DWARF address space value is other than None, add it. The IR
883 // verifier checks that DWARF address space only exists for pointer
884 // or reference types.
885 if (DTy->getDWARFAddressSpace())
886 addUInt(Buffer, dwarf::DW_AT_address_class, dwarf::DW_FORM_data4,
887 *DTy->getDWARFAddressSpace());
888
889 // Add template alias template parameters.
890 if (Tag == dwarf::DW_TAG_template_alias)
891 addTemplateParams(Buffer, DTy->getTemplateParams());
892
893 if (auto PtrAuthData = DTy->getPtrAuthData()) {
894 addUInt(Buffer, dwarf::DW_AT_LLVM_ptrauth_key, dwarf::DW_FORM_data1,
895 PtrAuthData->key());
896 if (PtrAuthData->isAddressDiscriminated())
897 addFlag(Buffer, dwarf::DW_AT_LLVM_ptrauth_address_discriminated);
898 addUInt(Buffer, dwarf::DW_AT_LLVM_ptrauth_extra_discriminator,
899 dwarf::DW_FORM_data2, PtrAuthData->extraDiscriminator());
900 if (PtrAuthData->isaPointer())
901 addFlag(Buffer, dwarf::DW_AT_LLVM_ptrauth_isa_pointer);
902 if (PtrAuthData->authenticatesNullValues())
903 addFlag(Buffer, dwarf::DW_AT_LLVM_ptrauth_authenticates_null_values);
904 }
905}
906
907std::optional<unsigned>
909 // Args[0] is the return type.
910 std::optional<unsigned> ObjectPointerIndex;
911 for (unsigned i = 1, N = Args.size(); i < N; ++i) {
912 const DIType *Ty = Args[i];
913 if (!Ty) {
914 assert(i == N-1 && "Unspecified parameter must be the last argument");
915 createAndAddDIE(dwarf::DW_TAG_unspecified_parameters, Buffer);
916 } else {
917 DIE &Arg = createAndAddDIE(dwarf::DW_TAG_formal_parameter, Buffer);
918 addType(Arg, Ty);
919 if (Ty->isArtificial())
920 addFlag(Arg, dwarf::DW_AT_artificial);
921
922 if (Ty->isObjectPointer()) {
923 assert(!ObjectPointerIndex &&
924 "Can't have more than one object pointer");
925 ObjectPointerIndex = i;
926 }
927 }
928 }
929
930 return ObjectPointerIndex;
931}
932
933void DwarfUnit::constructTypeDIE(DIE &Buffer, const DISubroutineType *CTy) {
934 // Add return type. A void return won't have a type.
935 auto Elements = cast<DISubroutineType>(CTy)->getTypeArray();
936 if (Elements.size())
937 if (auto RTy = Elements[0])
938 addType(Buffer, RTy);
939
940 bool isPrototyped = true;
941 if (Elements.size() == 2 && !Elements[1])
942 isPrototyped = false;
943
944 constructSubprogramArguments(Buffer, Elements);
945
946 // Add prototype flag if we're dealing with a C language and the function has
947 // been prototyped.
948 if (isPrototyped && dwarf::isC(getSourceLanguage()))
949 addFlag(Buffer, dwarf::DW_AT_prototyped);
950
951 // Add a DW_AT_calling_convention if this has an explicit convention.
952 if (CTy->getCC() && CTy->getCC() != dwarf::DW_CC_normal)
953 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1,
954 CTy->getCC());
955
956 if (CTy->isLValueReference())
957 addFlag(Buffer, dwarf::DW_AT_reference);
958
959 if (CTy->isRValueReference())
960 addFlag(Buffer, dwarf::DW_AT_rvalue_reference);
961}
962
963void DwarfUnit::addAnnotation(DIE &Buffer, DINodeArray Annotations) {
964 if (!Annotations)
965 return;
966
967 for (const Metadata *Annotation : Annotations->operands()) {
968 const MDNode *MD = cast<MDNode>(Annotation);
969 const MDString *Name = cast<MDString>(MD->getOperand(0));
970 const auto &Value = MD->getOperand(1);
971
972 DIE &AnnotationDie = createAndAddDIE(dwarf::DW_TAG_LLVM_annotation, Buffer);
973 addString(AnnotationDie, dwarf::DW_AT_name, Name->getString());
974 if (const auto *Data = dyn_cast<MDString>(Value))
975 addString(AnnotationDie, dwarf::DW_AT_const_value, Data->getString());
976 else if (const auto *Data = dyn_cast<ConstantAsMetadata>(Value))
977 addConstantValue(AnnotationDie, Data->getValue()->getUniqueInteger(),
978 /*Unsigned=*/true);
979 else
980 assert(false && "Unsupported annotation value type");
981 }
982}
983
984void DwarfUnit::addDiscriminant(DIE &Variant, Constant *Discriminant,
985 bool IsUnsigned) {
986 if (const auto *CI = dyn_cast_or_null<ConstantInt>(Discriminant)) {
987 addInt(Variant, dwarf::DW_AT_discr_value, CI->getValue(), IsUnsigned);
988 } else if (const auto *CA =
990 // Must have an even number of operands.
991 unsigned NElems = CA->getNumElements();
992 if (NElems % 2 != 0) {
993 return;
994 }
995
996 DIEBlock *Block = new (DIEValueAllocator) DIEBlock;
997
998 auto AddInt = [&](const APInt &Val) {
999 if (IsUnsigned)
1000 addUInt(*Block, dwarf::DW_FORM_udata, Val.getZExtValue());
1001 else
1002 addSInt(*Block, dwarf::DW_FORM_sdata, Val.getSExtValue());
1003 };
1004
1005 for (unsigned I = 0; I < NElems; I += 2) {
1006 APInt LV = CA->getElementAsAPInt(I);
1007 APInt HV = CA->getElementAsAPInt(I + 1);
1008 if (LV == HV) {
1009 addUInt(*Block, dwarf::DW_FORM_data1, dwarf::DW_DSC_label);
1010 AddInt(LV);
1011 } else {
1012 addUInt(*Block, dwarf::DW_FORM_data1, dwarf::DW_DSC_range);
1013 AddInt(LV);
1014 AddInt(HV);
1015 }
1016 }
1017 addBlock(Variant, dwarf::DW_AT_discr_list, Block);
1018 }
1019}
1020
1022 // Add name if not anonymous or intermediate type.
1023 StringRef Name = CTy->getName();
1024
1025 uint16_t Tag = Buffer.getTag();
1026
1027 switch (Tag) {
1028 case dwarf::DW_TAG_array_type:
1029 constructArrayTypeDIE(Buffer, CTy);
1030 break;
1031 case dwarf::DW_TAG_enumeration_type:
1032 constructEnumTypeDIE(Buffer, CTy);
1033 break;
1034 case dwarf::DW_TAG_variant_part:
1035 case dwarf::DW_TAG_variant:
1036 case dwarf::DW_TAG_structure_type:
1037 case dwarf::DW_TAG_union_type:
1038 case dwarf::DW_TAG_class_type:
1039 case dwarf::DW_TAG_namelist: {
1040 // Emit the discriminator for a variant part.
1041 DIDerivedType *Discriminator = nullptr;
1042 if (Tag == dwarf::DW_TAG_variant_part) {
1043 Discriminator = CTy->getDiscriminator();
1044 if (Discriminator) {
1045 // DWARF says:
1046 // If the variant part has a discriminant, the discriminant is
1047 // represented by a separate debugging information entry which is
1048 // a child of the variant part entry.
1049 // However, for a language like Ada, this yields a weird
1050 // result: a discriminant field would have to be emitted
1051 // multiple times, once per variant part. Instead, this DWARF
1052 // restriction was lifted for DWARF 6 (see
1053 // https://dwarfstd.org/issues/180123.1.html) and so we allow
1054 // this here.
1055 DIE *DiscDIE = getDIE(Discriminator);
1056 if (DiscDIE == nullptr) {
1057 DiscDIE = &constructMemberDIE(Buffer, Discriminator);
1058 }
1059 addDIEEntry(Buffer, dwarf::DW_AT_discr, *DiscDIE);
1060 }
1061 }
1062
1063 // Add template parameters to a class, structure or union types.
1064 if (Tag == dwarf::DW_TAG_class_type ||
1065 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1066 addTemplateParams(Buffer, CTy->getTemplateParams());
1067
1068 // Add elements to structure type.
1069 DINodeArray Elements = CTy->getElements();
1070 for (const auto *Element : Elements) {
1071 if (!Element)
1072 continue;
1073 if (auto *SP = dyn_cast<DISubprogram>(Element))
1074 getOrCreateSubprogramDIE(SP, nullptr);
1075 else if (auto *DDTy = dyn_cast<DIDerivedType>(Element)) {
1076 if (DDTy->getTag() == dwarf::DW_TAG_friend) {
1077 DIE &ElemDie = createAndAddDIE(dwarf::DW_TAG_friend, Buffer);
1078 addType(ElemDie, DDTy->getBaseType(), dwarf::DW_AT_friend);
1079 } else if (DDTy->isStaticMember()) {
1081 } else if (Tag == dwarf::DW_TAG_variant_part) {
1082 // When emitting a variant part, wrap each member in
1083 // DW_TAG_variant.
1084 DIE &Variant = createAndAddDIE(dwarf::DW_TAG_variant, Buffer);
1085 if (Constant *CI = DDTy->getDiscriminantValue()) {
1086 addDiscriminant(Variant, CI,
1087 DD->isUnsignedDIType(Discriminator->getBaseType()));
1088 }
1089 // If the variant holds a composite type with tag
1090 // DW_TAG_variant, inline those members into the variant
1091 // DIE.
1092 if (auto *Composite =
1093 dyn_cast_or_null<DICompositeType>(DDTy->getBaseType());
1094 Composite != nullptr &&
1095 Composite->getTag() == dwarf::DW_TAG_variant) {
1096 constructTypeDIE(Variant, Composite);
1097 } else {
1098 constructMemberDIE(Variant, DDTy);
1099 }
1100 } else {
1101 constructMemberDIE(Buffer, DDTy);
1102 }
1103 } else if (auto *Property = dyn_cast<DIObjCProperty>(Element)) {
1104 DIE &ElemDie = createAndAddDIE(Property->getTag(), Buffer);
1105 StringRef PropertyName = Property->getName();
1106 addString(ElemDie, dwarf::DW_AT_APPLE_property_name, PropertyName);
1107 if (Property->getType())
1108 addType(ElemDie, Property->getType());
1109 addSourceLine(ElemDie, Property);
1110 StringRef GetterName = Property->getGetterName();
1111 if (!GetterName.empty())
1112 addString(ElemDie, dwarf::DW_AT_APPLE_property_getter, GetterName);
1113 StringRef SetterName = Property->getSetterName();
1114 if (!SetterName.empty())
1115 addString(ElemDie, dwarf::DW_AT_APPLE_property_setter, SetterName);
1116 if (unsigned PropertyAttributes = Property->getAttributes())
1117 addUInt(ElemDie, dwarf::DW_AT_APPLE_property_attribute, std::nullopt,
1118 PropertyAttributes);
1119 } else if (auto *Composite = dyn_cast<DICompositeType>(Element)) {
1120 if (Composite->getTag() == dwarf::DW_TAG_variant_part) {
1121 DIE &VariantPart = createAndAddDIE(Composite->getTag(), Buffer);
1122 constructTypeDIE(VariantPart, Composite);
1123 }
1124 } else if (Tag == dwarf::DW_TAG_namelist) {
1125 auto *Var = dyn_cast<DINode>(Element);
1126 auto *VarDIE = getDIE(Var);
1127 if (VarDIE) {
1128 DIE &ItemDie = createAndAddDIE(dwarf::DW_TAG_namelist_item, Buffer);
1129 addDIEEntry(ItemDie, dwarf::DW_AT_namelist_item, *VarDIE);
1130 }
1131 }
1132 }
1133
1134 if (CTy->isAppleBlockExtension())
1135 addFlag(Buffer, dwarf::DW_AT_APPLE_block);
1136
1137 if (CTy->getExportSymbols())
1138 addFlag(Buffer, dwarf::DW_AT_export_symbols);
1139
1140 // This is outside the DWARF spec, but GDB expects a DW_AT_containing_type
1141 // inside C++ composite types to point to the base class with the vtable.
1142 // Rust uses DW_AT_containing_type to link a vtable to the type
1143 // for which it was created.
1144 if (auto *ContainingType = CTy->getVTableHolder())
1145 addDIEEntry(Buffer, dwarf::DW_AT_containing_type,
1146 *getOrCreateTypeDIE(ContainingType));
1147
1148 if (CTy->isObjcClassComplete())
1149 addFlag(Buffer, dwarf::DW_AT_APPLE_objc_complete_type);
1150
1151 // Add the type's non-standard calling convention.
1152 // DW_CC_pass_by_value/DW_CC_pass_by_reference are introduced in DWARF 5.
1153 if (!Asm->TM.Options.DebugStrictDwarf || DD->getDwarfVersion() >= 5) {
1154 uint8_t CC = 0;
1155 if (CTy->isTypePassByValue())
1156 CC = dwarf::DW_CC_pass_by_value;
1157 else if (CTy->isTypePassByReference())
1158 CC = dwarf::DW_CC_pass_by_reference;
1159 if (CC)
1160 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1,
1161 CC);
1162 }
1163
1164 if (auto *SpecifiedFrom = CTy->getSpecification())
1165 addDIEEntry(Buffer, dwarf::DW_AT_specification,
1166 *getOrCreateContextDIE(SpecifiedFrom));
1167
1168 break;
1169 }
1170 default:
1171 break;
1172 }
1173
1174 // Add name if not anonymous or intermediate type.
1175 if (!Name.empty())
1176 addString(Buffer, dwarf::DW_AT_name, Name);
1177
1178 // For Swift, mangled names are put into DW_AT_linkage_name.
1179 if (CTy->getRuntimeLang() == dwarf::DW_LANG_Swift && CTy->getRawIdentifier())
1180 addString(Buffer, dwarf::DW_AT_linkage_name, CTy->getIdentifier());
1181
1182 addAnnotation(Buffer, CTy->getAnnotations());
1183
1184 if (Tag == dwarf::DW_TAG_enumeration_type ||
1185 Tag == dwarf::DW_TAG_class_type || Tag == dwarf::DW_TAG_structure_type ||
1186 Tag == dwarf::DW_TAG_union_type) {
1187 if (auto *Var = dyn_cast_or_null<DIVariable>(CTy->getRawSizeInBits())) {
1188 if (auto *VarDIE = getDIE(Var))
1189 addDIEEntry(Buffer, dwarf::DW_AT_bit_size, *VarDIE);
1190 } else if (auto *Exp =
1193 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1194 DwarfExpr.setMemoryLocationKind();
1195 DwarfExpr.addExpression(Exp);
1196 addBlock(Buffer, dwarf::DW_AT_bit_size, DwarfExpr.finalize());
1197 } else {
1198 uint64_t Size = CTy->getSizeInBits() >> 3;
1199 // Add size if non-zero (derived types might be zero-sized.)
1200 // Ignore the size if it's a non-enum forward decl.
1201 // TODO: Do we care about size for enum forward declarations?
1202 if (Size &&
1203 (!CTy->isForwardDecl() || Tag == dwarf::DW_TAG_enumeration_type))
1204 addUInt(Buffer, dwarf::DW_AT_byte_size, std::nullopt, Size);
1205 else if (!CTy->isForwardDecl())
1206 // Add zero size if it is not a forward declaration.
1207 addUInt(Buffer, dwarf::DW_AT_byte_size, std::nullopt, 0);
1208 }
1209
1210 // If we're a forward decl, say so.
1211 if (CTy->isForwardDecl())
1212 addFlag(Buffer, dwarf::DW_AT_declaration);
1213
1214 // Add accessibility info if available.
1215 addAccess(Buffer, CTy->getFlags());
1216
1217 // Add source line info if available.
1218 if (!CTy->isForwardDecl())
1219 addSourceLine(Buffer, CTy);
1220
1221 // No harm in adding the runtime language to the declaration.
1222 unsigned RLang = CTy->getRuntimeLang();
1223 if (RLang)
1224 addUInt(Buffer, dwarf::DW_AT_APPLE_runtime_class, dwarf::DW_FORM_data1,
1225 RLang);
1226
1227 // Add align info if available.
1228 if (uint32_t AlignInBytes = CTy->getAlignInBytes())
1229 addUInt(Buffer, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1230 AlignInBytes);
1231
1232 if (uint32_t NumExtraInhabitants = CTy->getNumExtraInhabitants())
1233 addUInt(Buffer, dwarf::DW_AT_LLVM_num_extra_inhabitants, std::nullopt,
1234 NumExtraInhabitants);
1235 }
1236}
1237
1238void DwarfUnit::constructTemplateTypeParameterDIE(
1239 DIE &Buffer, const DITemplateTypeParameter *TP) {
1240 DIE &ParamDIE =
1241 createAndAddDIE(dwarf::DW_TAG_template_type_parameter, Buffer);
1242 // Add the type if it exists, it could be void and therefore no type.
1243 if (TP->getType())
1244 addType(ParamDIE, TP->getType());
1245 if (!TP->getName().empty())
1246 addString(ParamDIE, dwarf::DW_AT_name, TP->getName());
1247 if (TP->isDefault() && isCompatibleWithVersion(5))
1248 addFlag(ParamDIE, dwarf::DW_AT_default_value);
1249}
1250
1251void DwarfUnit::constructTemplateValueParameterDIE(
1252 DIE &Buffer, const DITemplateValueParameter *VP) {
1253 DIE &ParamDIE = createAndAddDIE(VP->getTag(), Buffer);
1254
1255 // Add the type if there is one, template template and template parameter
1256 // packs will not have a type.
1257 if (VP->getTag() == dwarf::DW_TAG_template_value_parameter)
1258 addType(ParamDIE, VP->getType());
1259 if (!VP->getName().empty())
1260 addString(ParamDIE, dwarf::DW_AT_name, VP->getName());
1261 if (VP->isDefault() && isCompatibleWithVersion(5))
1262 addFlag(ParamDIE, dwarf::DW_AT_default_value);
1263 if (Metadata *Val = VP->getValue()) {
1265 addConstantValue(ParamDIE, CI, VP->getType());
1266 else if (ConstantFP *CF = mdconst::dyn_extract<ConstantFP>(Val))
1267 addConstantFPValue(ParamDIE, CF);
1268 else if (GlobalValue *GV = mdconst::dyn_extract<GlobalValue>(Val)) {
1269 // We cannot describe the location of dllimport'd entities: the
1270 // computation of their address requires loads from the IAT.
1271 if (!GV->hasDLLImportStorageClass()) {
1272 // For declaration non-type template parameters (such as global values
1273 // and functions)
1275 addOpAddress(*Loc, Asm->getSymbol(GV));
1276 // Emit DW_OP_stack_value to use the address as the immediate value of
1277 // the parameter, rather than a pointer to it.
1278 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_stack_value);
1279 addBlock(ParamDIE, dwarf::DW_AT_location, Loc);
1280 }
1281 } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_template_param) {
1282 assert(isa<MDString>(Val));
1283 addString(ParamDIE, dwarf::DW_AT_GNU_template_name,
1284 cast<MDString>(Val)->getString());
1285 } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_parameter_pack) {
1286 addTemplateParams(ParamDIE, cast<MDTuple>(Val));
1287 }
1288 }
1289}
1290
1292 // Construct the context before querying for the existence of the DIE in case
1293 // such construction creates the DIE.
1294 DIE *ContextDIE = getOrCreateContextDIE(NS->getScope());
1295
1296 if (DIE *NDie = getDIE(NS))
1297 return NDie;
1298 DIE &NDie = createAndAddDIE(dwarf::DW_TAG_namespace, *ContextDIE, NS);
1299
1300 StringRef Name = NS->getName();
1301 if (!Name.empty())
1302 addString(NDie, dwarf::DW_AT_name, NS->getName());
1303 else
1304 Name = "(anonymous namespace)";
1305 DD->addAccelNamespace(*this, CUNode->getNameTableKind(), Name, NDie);
1306 addGlobalName(Name, NDie, NS->getScope());
1307 if (NS->getExportSymbols())
1308 addFlag(NDie, dwarf::DW_AT_export_symbols);
1309 return &NDie;
1310}
1311
1313 // Construct the context before querying for the existence of the DIE in case
1314 // such construction creates the DIE.
1315 DIE *ContextDIE = getOrCreateContextDIE(M->getScope());
1316
1317 if (DIE *MDie = getDIE(M))
1318 return MDie;
1319 DIE &MDie = createAndAddDIE(dwarf::DW_TAG_module, *ContextDIE, M);
1320
1321 if (!M->getName().empty()) {
1322 addString(MDie, dwarf::DW_AT_name, M->getName());
1323 addGlobalName(M->getName(), MDie, M->getScope());
1324 }
1325 if (!M->getConfigurationMacros().empty())
1326 addString(MDie, dwarf::DW_AT_LLVM_config_macros,
1327 M->getConfigurationMacros());
1328 if (!M->getIncludePath().empty())
1329 addString(MDie, dwarf::DW_AT_LLVM_include_path, M->getIncludePath());
1330 if (!M->getAPINotesFile().empty())
1331 addString(MDie, dwarf::DW_AT_LLVM_apinotes, M->getAPINotesFile());
1332 if (M->getFile())
1333 addUInt(MDie, dwarf::DW_AT_decl_file, std::nullopt,
1334 getOrCreateSourceID(M->getFile()));
1335 if (M->getLineNo())
1336 addUInt(MDie, dwarf::DW_AT_decl_line, std::nullopt, M->getLineNo());
1337 if (M->getIsDecl())
1338 addFlag(MDie, dwarf::DW_AT_declaration);
1339
1340 return &MDie;
1341}
1342
1344 const Function *FnHint, bool Minimal) {
1345 // Construct the context before querying for the existence of the DIE in case
1346 // such construction creates the DIE (as is the case for member function
1347 // declarations).
1348 DIE *ContextDIE =
1350
1351 if (DIE *SPDie = getDIE(SP))
1352 return SPDie;
1353
1354 if (auto *SPDecl = SP->getDeclaration()) {
1355 if (!Minimal) {
1356 // Build the decl now to ensure it precedes the definition.
1357 getOrCreateSubprogramDIE(SPDecl, nullptr);
1358 // Check whether the DIE for SP has already been created after the call
1359 // above.
1360 // FIXME: Should the creation of definition subprogram DIE during
1361 // the creation of declaration subprogram DIE be allowed?
1362 // See https://github.com/llvm/llvm-project/pull/154636.
1363 if (DIE *SPDie = getDIE(SP))
1364 return SPDie;
1365 }
1366 }
1367
1368 // DW_TAG_inlined_subroutine may refer to this DIE.
1369 DIE &SPDie = createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE, SP);
1370
1371 // Stop here and fill this in later, depending on whether or not this
1372 // subprogram turns out to have inlined instances or not.
1373 if (SP->isDefinition())
1374 return &SPDie;
1375
1376 static_cast<DwarfUnit *>(SPDie.getUnit())
1377 ->applySubprogramAttributes(SP, SPDie);
1378 return &SPDie;
1379}
1380
1382 DIE &SPDie, bool Minimal) {
1383 DIE *DeclDie = nullptr;
1384 StringRef DeclLinkageName;
1385 if (auto *SPDecl = SP->getDeclaration()) {
1386 if (!Minimal) {
1387 DITypeRefArray DeclArgs, DefinitionArgs;
1388 DeclArgs = SPDecl->getType()->getTypeArray();
1389 DefinitionArgs = SP->getType()->getTypeArray();
1390
1391 if (DeclArgs.size() && DefinitionArgs.size())
1392 if (DefinitionArgs[0] != nullptr && DeclArgs[0] != DefinitionArgs[0])
1393 addType(SPDie, DefinitionArgs[0]);
1394
1395 DeclDie = getDIE(SPDecl);
1396 assert(DeclDie && "This DIE should've already been constructed when the "
1397 "definition DIE was created in "
1398 "getOrCreateSubprogramDIE");
1399 // Look at the Decl's linkage name only if we emitted it.
1400 if (DD->useAllLinkageNames())
1401 DeclLinkageName = SPDecl->getLinkageName();
1402 unsigned DeclID = getOrCreateSourceID(SPDecl->getFile());
1403 unsigned DefID = getOrCreateSourceID(SP->getFile());
1404 if (DeclID != DefID)
1405 addUInt(SPDie, dwarf::DW_AT_decl_file, std::nullopt, DefID);
1406
1407 if (SP->getLine() != SPDecl->getLine())
1408 addUInt(SPDie, dwarf::DW_AT_decl_line, std::nullopt, SP->getLine());
1409 }
1410 }
1411
1412 // Add function template parameters.
1413 addTemplateParams(SPDie, SP->getTemplateParams());
1414
1415 // Add the linkage name if we have one and it isn't in the Decl.
1416 StringRef LinkageName = SP->getLinkageName();
1417 // Always emit linkage name for abstract subprograms.
1418 if (DeclLinkageName != LinkageName &&
1419 (DD->useAllLinkageNames() || DU->getAbstractScopeDIEs().lookup(SP)))
1421
1422 if (!DeclDie)
1423 return false;
1424
1425 // Refer to the function declaration where all the other attributes will be
1426 // found.
1427 addDIEEntry(SPDie, dwarf::DW_AT_specification, *DeclDie);
1428 return true;
1429}
1430
1432 bool SkipSPAttributes) {
1433 // If -fdebug-info-for-profiling is enabled, need to emit the subprogram
1434 // and its source location.
1435 bool SkipSPSourceLocation = SkipSPAttributes &&
1436 !CUNode->getDebugInfoForProfiling();
1437 if (!SkipSPSourceLocation)
1438 if (applySubprogramDefinitionAttributes(SP, SPDie, SkipSPAttributes))
1439 return;
1440
1441 // Constructors and operators for anonymous aggregates do not have names.
1442 if (!SP->getName().empty())
1443 addString(SPDie, dwarf::DW_AT_name, SP->getName());
1444
1445 addAnnotation(SPDie, SP->getAnnotations());
1446
1447 if (!SkipSPSourceLocation)
1448 addSourceLine(SPDie, SP);
1449
1450 // Skip the rest of the attributes under -gmlt to save space.
1451 if (SkipSPAttributes)
1452 return;
1453
1454 // Add the prototype if we have a prototype and we have a C like
1455 // language.
1456 if (SP->isPrototyped() && dwarf::isC(getSourceLanguage()))
1457 addFlag(SPDie, dwarf::DW_AT_prototyped);
1458
1459 if (SP->isObjCDirect())
1460 addFlag(SPDie, dwarf::DW_AT_APPLE_objc_direct);
1461
1462 unsigned CC = 0;
1463 DITypeRefArray Args;
1464 if (const DISubroutineType *SPTy = SP->getType()) {
1465 Args = SPTy->getTypeArray();
1466 CC = SPTy->getCC();
1467 }
1468
1469 // Add a DW_AT_calling_convention if this has an explicit convention.
1470 if (CC && CC != dwarf::DW_CC_normal)
1471 addUInt(SPDie, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1, CC);
1472
1473 // Add a return type. If this is a type like a C/C++ void type we don't add a
1474 // return type.
1475 if (Args.size())
1476 if (auto Ty = Args[0])
1477 addType(SPDie, Ty);
1478
1479 unsigned VK = SP->getVirtuality();
1480 if (VK) {
1481 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, VK);
1482 if (SP->getVirtualIndex() != -1u) {
1483 DIELoc *Block = getDIELoc();
1484 addUInt(*Block, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1485 addUInt(*Block, dwarf::DW_FORM_udata, SP->getVirtualIndex());
1486 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, Block);
1487 }
1488 ContainingTypeMap.insert(std::make_pair(&SPDie, SP->getContainingType()));
1489 }
1490
1491 if (!SP->isDefinition()) {
1492 addFlag(SPDie, dwarf::DW_AT_declaration);
1493
1494 // Add arguments. Do not add arguments for subprogram definition. They will
1495 // be handled while processing variables.
1496 //
1497 // Encode the object pointer as an index instead of a DIE reference in order
1498 // to minimize the affect on the .debug_info size.
1499 if (std::optional<unsigned> ObjectPointerIndex =
1500 constructSubprogramArguments(SPDie, Args)) {
1501 if (getDwarfDebug().tuneForLLDB() &&
1502 getDwarfDebug().getDwarfVersion() >= 5) {
1503 // 0th index in Args is the return type, hence adjust by 1. In DWARF
1504 // we want the first parameter to be at index 0.
1505 assert(*ObjectPointerIndex > 0);
1506 addSInt(SPDie, dwarf::DW_AT_object_pointer,
1507 dwarf::DW_FORM_implicit_const, *ObjectPointerIndex - 1);
1508 }
1509 }
1510 }
1511
1512 addThrownTypes(SPDie, SP->getThrownTypes());
1513
1514 if (SP->isArtificial())
1515 addFlag(SPDie, dwarf::DW_AT_artificial);
1516
1517 if (!SP->isLocalToUnit())
1518 addFlag(SPDie, dwarf::DW_AT_external);
1519
1520 if (DD->useAppleExtensionAttributes()) {
1521 if (SP->isOptimized())
1522 addFlag(SPDie, dwarf::DW_AT_APPLE_optimized);
1523
1524 if (unsigned isa = Asm->getISAEncoding())
1525 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1526 }
1527
1528 if (SP->isLValueReference())
1529 addFlag(SPDie, dwarf::DW_AT_reference);
1530
1531 if (SP->isRValueReference())
1532 addFlag(SPDie, dwarf::DW_AT_rvalue_reference);
1533
1534 if (SP->isNoReturn())
1535 addFlag(SPDie, dwarf::DW_AT_noreturn);
1536
1537 addAccess(SPDie, SP->getFlags());
1538
1539 if (SP->isExplicit())
1540 addFlag(SPDie, dwarf::DW_AT_explicit);
1541
1542 if (SP->isMainSubprogram())
1543 addFlag(SPDie, dwarf::DW_AT_main_subprogram);
1544 if (SP->isPure())
1545 addFlag(SPDie, dwarf::DW_AT_pure);
1546 if (SP->isElemental())
1547 addFlag(SPDie, dwarf::DW_AT_elemental);
1548 if (SP->isRecursive())
1549 addFlag(SPDie, dwarf::DW_AT_recursive);
1550
1551 if (!SP->getTargetFuncName().empty())
1552 addString(SPDie, dwarf::DW_AT_trampoline, SP->getTargetFuncName());
1553
1554 if (DD->getDwarfVersion() >= 5 && SP->isDeleted())
1555 addFlag(SPDie, dwarf::DW_AT_deleted);
1556}
1557
1558void DwarfUnit::constructSubrangeDIE(DIE &DW_Subrange, const DISubrangeType *SR,
1559 bool ForArray) {
1560 StringRef Name = SR->getName();
1561 if (!Name.empty())
1562 addString(DW_Subrange, dwarf::DW_AT_name, Name);
1563
1564 if (SR->getBaseType())
1565 addType(DW_Subrange, SR->getBaseType());
1566
1567 addSourceLine(DW_Subrange, SR);
1568
1569 if (uint64_t Size = SR->getSizeInBits())
1570 addUInt(DW_Subrange, dwarf::DW_AT_byte_size, std::nullopt, Size >> 3);
1571 if (uint32_t AlignInBytes = SR->getAlignInBytes())
1572 addUInt(DW_Subrange, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1573 AlignInBytes);
1574
1575 if (SR->isBigEndian())
1576 addUInt(DW_Subrange, dwarf::DW_AT_endianity, std::nullopt,
1577 dwarf::DW_END_big);
1578 else if (SR->isLittleEndian())
1579 addUInt(DW_Subrange, dwarf::DW_AT_endianity, std::nullopt,
1580 dwarf::DW_END_little);
1581
1582 // The LowerBound value defines the lower bounds which is typically
1583 // zero for C/C++. Values are 64 bit.
1584 int64_t DefaultLowerBound = getDefaultLowerBound();
1585
1586 auto AddBoundTypeEntry = [&](dwarf::Attribute Attr,
1587 DISubrangeType::BoundType Bound) -> void {
1588 if (auto *BV = dyn_cast_if_present<DIVariable *>(Bound)) {
1589 if (auto *VarDIE = getDIE(BV))
1590 addDIEEntry(DW_Subrange, Attr, *VarDIE);
1591 } else if (auto *BE = dyn_cast_if_present<DIExpression *>(Bound)) {
1593 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1594 DwarfExpr.setMemoryLocationKind();
1595 DwarfExpr.addExpression(BE);
1596 addBlock(DW_Subrange, Attr, DwarfExpr.finalize());
1597 } else if (auto *BI = dyn_cast_if_present<ConstantInt *>(Bound)) {
1598 if (Attr == dwarf::DW_AT_GNU_bias) {
1599 if (BI->getSExtValue() != 0)
1600 addUInt(DW_Subrange, Attr, dwarf::DW_FORM_sdata, BI->getSExtValue());
1601 } else if (Attr != dwarf::DW_AT_lower_bound || DefaultLowerBound == -1 ||
1602 BI->getSExtValue() != DefaultLowerBound || !ForArray)
1603 addSInt(DW_Subrange, Attr, dwarf::DW_FORM_sdata, BI->getSExtValue());
1604 }
1605 };
1606
1607 AddBoundTypeEntry(dwarf::DW_AT_lower_bound, SR->getLowerBound());
1608
1609 AddBoundTypeEntry(dwarf::DW_AT_upper_bound, SR->getUpperBound());
1610
1611 AddBoundTypeEntry(dwarf::DW_AT_bit_stride, SR->getStride());
1612
1613 AddBoundTypeEntry(dwarf::DW_AT_GNU_bias, SR->getBias());
1614}
1615
1616void DwarfUnit::constructSubrangeDIE(DIE &Buffer, const DISubrange *SR) {
1617 DIE &DW_Subrange = createAndAddDIE(dwarf::DW_TAG_subrange_type, Buffer);
1618
1619 DIE *IdxTy = getIndexTyDie();
1620 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, *IdxTy);
1621
1622 // The LowerBound value defines the lower bounds which is typically zero for
1623 // C/C++. The Count value is the number of elements. Values are 64 bit. If
1624 // Count == -1 then the array is unbounded and we do not emit
1625 // DW_AT_lower_bound and DW_AT_count attributes.
1626 int64_t DefaultLowerBound = getDefaultLowerBound();
1627
1628 auto AddBoundTypeEntry = [&](dwarf::Attribute Attr,
1629 DISubrange::BoundType Bound) -> void {
1630 if (auto *BV = dyn_cast_if_present<DIVariable *>(Bound)) {
1631 if (auto *VarDIE = getDIE(BV))
1632 addDIEEntry(DW_Subrange, Attr, *VarDIE);
1633 } else if (auto *BE = dyn_cast_if_present<DIExpression *>(Bound)) {
1634 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1635 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1636 DwarfExpr.setMemoryLocationKind();
1637 DwarfExpr.addExpression(BE);
1638 addBlock(DW_Subrange, Attr, DwarfExpr.finalize());
1639 } else if (auto *BI = dyn_cast_if_present<ConstantInt *>(Bound)) {
1640 if (Attr == dwarf::DW_AT_count) {
1641 if (BI->getSExtValue() != -1)
1642 addUInt(DW_Subrange, Attr, std::nullopt, BI->getSExtValue());
1643 } else if (Attr != dwarf::DW_AT_lower_bound || DefaultLowerBound == -1 ||
1644 BI->getSExtValue() != DefaultLowerBound)
1645 addSInt(DW_Subrange, Attr, dwarf::DW_FORM_sdata, BI->getSExtValue());
1646 }
1647 };
1648
1649 AddBoundTypeEntry(dwarf::DW_AT_lower_bound, SR->getLowerBound());
1650
1651 AddBoundTypeEntry(dwarf::DW_AT_count, SR->getCount());
1652
1653 AddBoundTypeEntry(dwarf::DW_AT_upper_bound, SR->getUpperBound());
1654
1655 AddBoundTypeEntry(dwarf::DW_AT_byte_stride, SR->getStride());
1656}
1657
1658void DwarfUnit::constructGenericSubrangeDIE(DIE &Buffer,
1659 const DIGenericSubrange *GSR) {
1660 DIE &DwGenericSubrange =
1661 createAndAddDIE(dwarf::DW_TAG_generic_subrange, Buffer);
1662 // Get an anonymous type for index type.
1663 // FIXME: This type should be passed down from the front end
1664 // as different languages may have different sizes for indexes.
1665 DIE *IdxTy = getIndexTyDie();
1666 addDIEEntry(DwGenericSubrange, dwarf::DW_AT_type, *IdxTy);
1667
1668 int64_t DefaultLowerBound = getDefaultLowerBound();
1669
1670 auto AddBoundTypeEntry = [&](dwarf::Attribute Attr,
1671 DIGenericSubrange::BoundType Bound) -> void {
1672 if (auto *BV = dyn_cast_if_present<DIVariable *>(Bound)) {
1673 if (auto *VarDIE = getDIE(BV))
1674 addDIEEntry(DwGenericSubrange, Attr, *VarDIE);
1675 } else if (auto *BE = dyn_cast_if_present<DIExpression *>(Bound)) {
1676 if (BE->isConstant() &&
1678 *BE->isConstant()) {
1679 if (Attr != dwarf::DW_AT_lower_bound || DefaultLowerBound == -1 ||
1680 static_cast<int64_t>(BE->getElement(1)) != DefaultLowerBound)
1681 addSInt(DwGenericSubrange, Attr, dwarf::DW_FORM_sdata,
1682 BE->getElement(1));
1683 } else {
1684 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1685 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1686 DwarfExpr.setMemoryLocationKind();
1687 DwarfExpr.addExpression(BE);
1688 addBlock(DwGenericSubrange, Attr, DwarfExpr.finalize());
1689 }
1690 }
1691 };
1692
1693 AddBoundTypeEntry(dwarf::DW_AT_lower_bound, GSR->getLowerBound());
1694 AddBoundTypeEntry(dwarf::DW_AT_count, GSR->getCount());
1695 AddBoundTypeEntry(dwarf::DW_AT_upper_bound, GSR->getUpperBound());
1696 AddBoundTypeEntry(dwarf::DW_AT_byte_stride, GSR->getStride());
1697}
1698
1699DIE *DwarfUnit::getIndexTyDie() {
1700 if (IndexTyDie)
1701 return IndexTyDie;
1702 // Construct an integer type to use for indexes.
1703 IndexTyDie = &createAndAddDIE(dwarf::DW_TAG_base_type, getUnitDie());
1704 StringRef Name = "__ARRAY_SIZE_TYPE__";
1705 addString(*IndexTyDie, dwarf::DW_AT_name, Name);
1706 addUInt(*IndexTyDie, dwarf::DW_AT_byte_size, std::nullopt, sizeof(int64_t));
1707 addUInt(*IndexTyDie, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1709 DD->addAccelType(*this, CUNode->getNameTableKind(), Name, *IndexTyDie,
1710 /*Flags*/ 0);
1711 return IndexTyDie;
1712}
1713
1714/// Returns true if the vector's size differs from the sum of sizes of elements
1715/// the user specified. This can occur if the vector has been rounded up to
1716/// fit memory alignment constraints.
1717static bool hasVectorBeenPadded(const DICompositeType *CTy) {
1718 assert(CTy && CTy->isVector() && "Composite type is not a vector");
1719 const uint64_t ActualSize = CTy->getSizeInBits();
1720
1721 // Obtain the size of each element in the vector.
1722 DIType *BaseTy = CTy->getBaseType();
1723 assert(BaseTy && "Unknown vector element type.");
1724 const uint64_t ElementSize = BaseTy->getSizeInBits();
1725
1726 // Locate the number of elements in the vector.
1727 const DINodeArray Elements = CTy->getElements();
1728 assert(Elements.size() == 1 &&
1729 Elements[0]->getTag() == dwarf::DW_TAG_subrange_type &&
1730 "Invalid vector element array, expected one element of type subrange");
1731 const auto Subrange = cast<DISubrange>(Elements[0]);
1732 const auto NumVecElements =
1733 Subrange->getCount()
1734 ? cast<ConstantInt *>(Subrange->getCount())->getSExtValue()
1735 : 0;
1736
1737 // Ensure we found the element count and that the actual size is wide
1738 // enough to contain the requested size.
1739 assert(ActualSize >= (NumVecElements * ElementSize) && "Invalid vector size");
1740 return ActualSize != (NumVecElements * ElementSize);
1741}
1742
1743void DwarfUnit::constructArrayTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
1744 if (CTy->isVector()) {
1745 addFlag(Buffer, dwarf::DW_AT_GNU_vector);
1746 if (hasVectorBeenPadded(CTy))
1747 addUInt(Buffer, dwarf::DW_AT_byte_size, std::nullopt,
1748 CTy->getSizeInBits() / CHAR_BIT);
1749 }
1750
1751 if (DIVariable *Var = CTy->getDataLocation()) {
1752 if (auto *VarDIE = getDIE(Var))
1753 addDIEEntry(Buffer, dwarf::DW_AT_data_location, *VarDIE);
1754 } else if (DIExpression *Expr = CTy->getDataLocationExp()) {
1755 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1756 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1757 DwarfExpr.setMemoryLocationKind();
1758 DwarfExpr.addExpression(Expr);
1759 addBlock(Buffer, dwarf::DW_AT_data_location, DwarfExpr.finalize());
1760 }
1761
1762 if (DIVariable *Var = CTy->getAssociated()) {
1763 if (auto *VarDIE = getDIE(Var))
1764 addDIEEntry(Buffer, dwarf::DW_AT_associated, *VarDIE);
1765 } else if (DIExpression *Expr = CTy->getAssociatedExp()) {
1766 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1767 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1768 DwarfExpr.setMemoryLocationKind();
1769 DwarfExpr.addExpression(Expr);
1770 addBlock(Buffer, dwarf::DW_AT_associated, DwarfExpr.finalize());
1771 }
1772
1773 if (DIVariable *Var = CTy->getAllocated()) {
1774 if (auto *VarDIE = getDIE(Var))
1775 addDIEEntry(Buffer, dwarf::DW_AT_allocated, *VarDIE);
1776 } else if (DIExpression *Expr = CTy->getAllocatedExp()) {
1777 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1778 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1779 DwarfExpr.setMemoryLocationKind();
1780 DwarfExpr.addExpression(Expr);
1781 addBlock(Buffer, dwarf::DW_AT_allocated, DwarfExpr.finalize());
1782 }
1783
1784 if (auto *RankConst = CTy->getRankConst()) {
1785 addSInt(Buffer, dwarf::DW_AT_rank, dwarf::DW_FORM_sdata,
1786 RankConst->getSExtValue());
1787 } else if (auto *RankExpr = CTy->getRankExp()) {
1788 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1789 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1790 DwarfExpr.setMemoryLocationKind();
1791 DwarfExpr.addExpression(RankExpr);
1792 addBlock(Buffer, dwarf::DW_AT_rank, DwarfExpr.finalize());
1793 }
1794
1795 if (auto *BitStride = CTy->getBitStrideConst()) {
1796 addUInt(Buffer, dwarf::DW_AT_bit_stride, {}, BitStride->getZExtValue());
1797 }
1798
1799 // Emit the element type.
1800 addType(Buffer, CTy->getBaseType());
1801
1802 // Add subranges to array type.
1803 DINodeArray Elements = CTy->getElements();
1804 for (DINode *E : Elements) {
1805 if (auto *Element = dyn_cast_or_null<DISubrangeType>(E)) {
1806 DIE &TyDIE = createAndAddDIE(Element->getTag(), Buffer, CTy);
1807 constructSubrangeDIE(TyDIE, Element, true);
1808 } else if (auto *Element = dyn_cast_or_null<DISubrange>(E))
1809 constructSubrangeDIE(Buffer, Element);
1810 else if (auto *Element = dyn_cast_or_null<DIGenericSubrange>(E))
1811 constructGenericSubrangeDIE(Buffer, Element);
1812 }
1813}
1814
1815void DwarfUnit::constructEnumTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
1816 const DIType *DTy = CTy->getBaseType();
1817 bool IsUnsigned = DTy && DD->isUnsignedDIType(DTy);
1818 if (DTy) {
1819 if (!Asm->TM.Options.DebugStrictDwarf || DD->getDwarfVersion() >= 3)
1820 addType(Buffer, DTy);
1821 if (DD->getDwarfVersion() >= 4 && (CTy->getFlags() & DINode::FlagEnumClass))
1822 addFlag(Buffer, dwarf::DW_AT_enum_class);
1823 }
1824
1825 if (auto Kind = CTy->getEnumKind())
1826 addUInt(Buffer, dwarf::DW_AT_APPLE_enum_kind, dwarf::DW_FORM_data1, *Kind);
1827
1828 auto *Context = CTy->getScope();
1829 bool IndexEnumerators = !Context || isa<DICompileUnit>(Context) || isa<DIFile>(Context) ||
1831 DINodeArray Elements = CTy->getElements();
1832
1833 // Add enumerators to enumeration type.
1834 for (const DINode *E : Elements) {
1836 if (Enum) {
1837 DIE &Enumerator = createAndAddDIE(dwarf::DW_TAG_enumerator, Buffer);
1838 StringRef Name = Enum->getName();
1839 addString(Enumerator, dwarf::DW_AT_name, Name);
1840 addConstantValue(Enumerator, Enum->getValue(), IsUnsigned);
1841 if (IndexEnumerators)
1843 }
1844 }
1845}
1846
1848 for (auto &P : ContainingTypeMap) {
1849 DIE &SPDie = *P.first;
1850 const DINode *D = P.second;
1851 if (!D)
1852 continue;
1853 DIE *NDie = getDIE(D);
1854 if (!NDie)
1855 continue;
1856 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, *NDie);
1857 }
1858}
1859
1860DIE &DwarfUnit::constructMemberDIE(DIE &Buffer, const DIDerivedType *DT) {
1861 DIE &MemberDie = createAndAddDIE(DT->getTag(), Buffer, DT);
1862 StringRef Name = DT->getName();
1863 if (!Name.empty())
1864 addString(MemberDie, dwarf::DW_AT_name, Name);
1865
1866 addAnnotation(MemberDie, DT->getAnnotations());
1867
1868 if (DIType *Resolved = DT->getBaseType())
1869 addType(MemberDie, Resolved);
1870
1871 addSourceLine(MemberDie, DT);
1872
1873 if (DT->getTag() == dwarf::DW_TAG_inheritance && DT->isVirtual()) {
1874
1875 // For C++, virtual base classes are not at fixed offset. Use following
1876 // expression to extract appropriate offset from vtable.
1877 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1878
1879 DIELoc *VBaseLocationDie = new (DIEValueAllocator) DIELoc;
1880 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1881 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1882 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1883 addUInt(*VBaseLocationDie, dwarf::DW_FORM_udata, DT->getOffsetInBits());
1884 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1885 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1886 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1887
1888 addBlock(MemberDie, dwarf::DW_AT_data_member_location, VBaseLocationDie);
1889 } else {
1890 uint64_t Size = 0;
1891 uint64_t FieldSize = 0;
1892
1893 bool IsBitfield = DT->isBitField();
1894
1895 // Handle the size.
1896 if (DT->getRawSizeInBits() == nullptr) {
1897 // No size, just ignore.
1898 } else if (auto *Var = dyn_cast<DIVariable>(DT->getRawSizeInBits())) {
1899 if (auto *VarDIE = getDIE(Var))
1900 addDIEEntry(MemberDie, dwarf::DW_AT_bit_size, *VarDIE);
1901 } else if (auto *Exp = dyn_cast<DIExpression>(DT->getRawSizeInBits())) {
1902 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1903 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1904 DwarfExpr.setMemoryLocationKind();
1905 DwarfExpr.addExpression(Exp);
1906 addBlock(MemberDie, dwarf::DW_AT_bit_size, DwarfExpr.finalize());
1907 } else {
1908 Size = DT->getSizeInBits();
1909 FieldSize = DD->getBaseTypeSize(DT);
1910 if (IsBitfield) {
1911 // Handle bitfield, assume bytes are 8 bits.
1912 if (DD->useDWARF2Bitfields())
1913 addUInt(MemberDie, dwarf::DW_AT_byte_size, std::nullopt,
1914 FieldSize / 8);
1915 addUInt(MemberDie, dwarf::DW_AT_bit_size, std::nullopt, Size);
1916 }
1917 }
1918
1919 // Handle the location. DW_AT_data_bit_offset won't allow an
1920 // expression until DWARF 6, but it can be used as an extension.
1921 // See https://dwarfstd.org/issues/250501.1.html
1922 if (auto *Var = dyn_cast_or_null<DIVariable>(DT->getRawOffsetInBits())) {
1923 if (!Asm->TM.Options.DebugStrictDwarf || DD->getDwarfVersion() >= 6) {
1924 if (auto *VarDIE = getDIE(Var))
1925 addDIEEntry(MemberDie, dwarf::DW_AT_data_bit_offset, *VarDIE);
1926 }
1927 } else if (auto *Expr =
1929 if (!Asm->TM.Options.DebugStrictDwarf || DD->getDwarfVersion() >= 6) {
1930 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1931 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1932 DwarfExpr.setMemoryLocationKind();
1933 DwarfExpr.addExpression(Expr);
1934 addBlock(MemberDie, dwarf::DW_AT_data_bit_offset, DwarfExpr.finalize());
1935 }
1936 } else {
1937 uint32_t AlignInBytes = DT->getAlignInBytes();
1938 uint64_t OffsetInBytes;
1939
1940 if (IsBitfield) {
1941 assert(DT->getOffsetInBits() <=
1942 (uint64_t)std::numeric_limits<int64_t>::max());
1943 int64_t Offset = DT->getOffsetInBits();
1944 // We can't use DT->getAlignInBits() here: AlignInBits for member type
1945 // is non-zero if and only if alignment was forced (e.g. _Alignas()),
1946 // which can't be done with bitfields. Thus we use FieldSize here.
1947 uint32_t AlignInBits = FieldSize;
1948 uint32_t AlignMask = ~(AlignInBits - 1);
1949 // The bits from the start of the storage unit to the start of the
1950 // field.
1951 uint64_t StartBitOffset = Offset - (Offset & AlignMask);
1952 // The byte offset of the field's aligned storage unit inside the
1953 // struct.
1954 OffsetInBytes = (Offset - StartBitOffset) / 8;
1955
1956 if (DD->useDWARF2Bitfields()) {
1957 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1958 uint64_t FieldOffset = (HiMark - FieldSize);
1959 Offset -= FieldOffset;
1960
1961 // Maybe we need to work from the other end.
1962 if (Asm->getDataLayout().isLittleEndian())
1963 Offset = FieldSize - (Offset + Size);
1964
1965 if (Offset < 0)
1966 addSInt(MemberDie, dwarf::DW_AT_bit_offset, dwarf::DW_FORM_sdata,
1967 Offset);
1968 else
1969 addUInt(MemberDie, dwarf::DW_AT_bit_offset, std::nullopt,
1970 (uint64_t)Offset);
1971 OffsetInBytes = FieldOffset >> 3;
1972 } else {
1973 addUInt(MemberDie, dwarf::DW_AT_data_bit_offset, std::nullopt,
1974 Offset);
1975 }
1976 } else {
1977 // This is not a bitfield.
1978 OffsetInBytes = DT->getOffsetInBits() / 8;
1979 if (AlignInBytes)
1980 addUInt(MemberDie, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1981 AlignInBytes);
1982 }
1983
1984 if (DD->getDwarfVersion() <= 2) {
1985 DIELoc *MemLocationDie = new (DIEValueAllocator) DIELoc;
1986 addUInt(*MemLocationDie, dwarf::DW_FORM_data1,
1987 dwarf::DW_OP_plus_uconst);
1988 addUInt(*MemLocationDie, dwarf::DW_FORM_udata, OffsetInBytes);
1989 addBlock(MemberDie, dwarf::DW_AT_data_member_location, MemLocationDie);
1990 } else if (!IsBitfield || DD->useDWARF2Bitfields()) {
1991 // In DWARF v3, DW_FORM_data4/8 in DW_AT_data_member_location are
1992 // interpreted as location-list pointers. Interpreting constants as
1993 // pointers is not expected, so we use DW_FORM_udata to encode the
1994 // constants here.
1995 if (DD->getDwarfVersion() == 3)
1996 addUInt(MemberDie, dwarf::DW_AT_data_member_location,
1997 dwarf::DW_FORM_udata, OffsetInBytes);
1998 else
1999 addUInt(MemberDie, dwarf::DW_AT_data_member_location, std::nullopt,
2000 OffsetInBytes);
2001 }
2002 }
2003 }
2004
2005 addAccess(MemberDie, DT->getFlags());
2006
2007 if (DT->isVirtual())
2008 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1,
2009 dwarf::DW_VIRTUALITY_virtual);
2010
2011 // Objective-C properties.
2012 if (DINode *PNode = DT->getObjCProperty())
2013 if (DIE *PDie = getDIE(PNode))
2014 addAttribute(MemberDie, dwarf::DW_AT_APPLE_property,
2015 dwarf::DW_FORM_ref4, DIEEntry(*PDie));
2016
2017 if (DT->isArtificial())
2018 addFlag(MemberDie, dwarf::DW_AT_artificial);
2019
2020 return MemberDie;
2021}
2022
2024 if (!DT)
2025 return nullptr;
2026
2027 // Construct the context before querying for the existence of the DIE in case
2028 // such construction creates the DIE.
2029 DIE *ContextDIE = getOrCreateContextDIE(DT->getScope());
2030 assert(dwarf::isType(ContextDIE->getTag()) &&
2031 "Static member should belong to a type.");
2032
2033 if (DIE *StaticMemberDIE = getDIE(DT))
2034 return StaticMemberDIE;
2035
2036 DwarfUnit *ContextUnit = static_cast<DwarfUnit *>(ContextDIE->getUnit());
2037 DIE &StaticMemberDIE = createAndAddDIE(DT->getTag(), *ContextDIE, DT);
2038
2039 const DIType *Ty = DT->getBaseType();
2040
2041 addString(StaticMemberDIE, dwarf::DW_AT_name, DT->getName());
2042 addType(StaticMemberDIE, Ty);
2043 ContextUnit->addSourceLine(StaticMemberDIE, DT);
2044 addFlag(StaticMemberDIE, dwarf::DW_AT_external);
2045 addFlag(StaticMemberDIE, dwarf::DW_AT_declaration);
2046
2047 // Consider the case when the static member was created by the compiler.
2048 if (DT->isArtificial())
2049 addFlag(StaticMemberDIE, dwarf::DW_AT_artificial);
2050
2051 // FIXME: We could omit private if the parent is a class_type, and
2052 // public if the parent is something else.
2053 addAccess(StaticMemberDIE, DT->getFlags());
2054
2056 addConstantValue(StaticMemberDIE, CI, Ty);
2057 if (const ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(DT->getConstant()))
2058 addConstantFPValue(StaticMemberDIE, CFP);
2059
2060 if (uint32_t AlignInBytes = DT->getAlignInBytes())
2061 addUInt(StaticMemberDIE, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
2062 AlignInBytes);
2063
2064 return &StaticMemberDIE;
2065}
2066
2068 // Emit size of content not including length itself
2069 if (!DD->useSectionsAsReferences())
2070 EndLabel = Asm->emitDwarfUnitLength(
2071 isDwoUnit() ? "debug_info_dwo" : "debug_info", "Length of Unit");
2072 else
2073 Asm->emitDwarfUnitLength(getHeaderSize() + getUnitDie().getSize(),
2074 "Length of Unit");
2075
2076 Asm->OutStreamer->AddComment("DWARF version number");
2077 unsigned Version = DD->getDwarfVersion();
2078 Asm->emitInt16(Version);
2079
2080 // DWARF v5 reorders the address size and adds a unit type.
2081 if (Version >= 5) {
2082 Asm->OutStreamer->AddComment("DWARF Unit Type");
2083 Asm->emitInt8(UT);
2084 Asm->OutStreamer->AddComment("Address Size (in bytes)");
2085 Asm->emitInt8(Asm->MAI->getCodePointerSize());
2086 }
2087
2088 // We share one abbreviations table across all units so it's always at the
2089 // start of the section. Use a relocatable offset where needed to ensure
2090 // linking doesn't invalidate that offset.
2091 Asm->OutStreamer->AddComment("Offset Into Abbrev. Section");
2092 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
2093 if (UseOffsets)
2094 Asm->emitDwarfLengthOrOffset(0);
2095 else
2096 Asm->emitDwarfSymbolReference(
2097 TLOF.getDwarfAbbrevSection()->getBeginSymbol(), false);
2098
2099 if (Version <= 4) {
2100 Asm->OutStreamer->AddComment("Address Size (in bytes)");
2101 Asm->emitInt8(Asm->MAI->getCodePointerSize());
2102 }
2103}
2104
2105void DwarfTypeUnit::emitHeader(bool UseOffsets) {
2106 if (!DD->useSplitDwarf()) {
2107 LabelBegin = Asm->createTempSymbol("tu_begin");
2108 Asm->OutStreamer->emitLabel(LabelBegin);
2109 }
2110 DwarfUnit::emitCommonHeader(UseOffsets,
2111 DD->useSplitDwarf() ? dwarf::DW_UT_split_type
2112 : dwarf::DW_UT_type);
2113 Asm->OutStreamer->AddComment("Type Signature");
2114 Asm->OutStreamer->emitIntValue(TypeSignature, sizeof(TypeSignature));
2115 Asm->OutStreamer->AddComment("Type DIE Offset");
2116 // In a skeleton type unit there is no type DIE so emit a zero offset.
2117 Asm->emitDwarfLengthOrOffset(Ty ? Ty->getOffset() : 0);
2118}
2119
2121 const MCSymbol *Hi, const MCSymbol *Lo) {
2122 addAttribute(Die, Attribute, DD->getDwarfSectionOffsetForm(),
2124}
2125
2127 const MCSymbol *Label, const MCSymbol *Sec) {
2128 if (Asm->doesDwarfUseRelocationsAcrossSections())
2129 addLabel(Die, Attribute, DD->getDwarfSectionOffsetForm(), Label);
2130 else
2131 addSectionDelta(Die, Attribute, Label, Sec);
2132}
2133
2134bool DwarfTypeUnit::isDwoUnit() const {
2135 // Since there are no skeleton type units, all type units are dwo type units
2136 // when split DWARF is being used.
2137 return DD->useSplitDwarf();
2138}
2139
2141 const DIScope *Context) {
2142 getCU().addGlobalNameForTypeUnit(Name, Context);
2143}
2144
2146 const DIScope *Context) {
2147 getCU().addGlobalTypeUnitType(Ty, Context);
2148}
2149
2152 return nullptr;
2153 if (isDwoUnit())
2154 return nullptr;
2155 return getSection()->getBeginSymbol();
2156}
2157
2159 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
2160 addSectionLabel(getUnitDie(), dwarf::DW_AT_str_offsets_base,
2161 DU->getStringOffsetsStartSym(),
2163}
2164
2166 assert(DD->getDwarfVersion() >= 5 &&
2167 "DW_AT_rnglists_base requires DWARF version 5 or later");
2168 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
2169 addSectionLabel(getUnitDie(), dwarf::DW_AT_rnglists_base,
2170 DU->getRnglistsTableBaseSym(),
2172}
2173
2174void DwarfTypeUnit::finishNonUnitTypeDIE(DIE& D, const DICompositeType *CTy) {
2176}
2177
2178bool DwarfUnit::isCompatibleWithVersion(uint16_t Version) const {
2179 return !Asm->TM.Options.DebugStrictDwarf || DD->getDwarfVersion() >= Version;
2180}
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:377
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
UnitType
Constants for unit types in DWARF v5.
Definition Dwarf.h:896
bool isType(Tag T)
Definition Dwarf.h:113
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