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