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" 19 #include "llvm/ADT/None.h" 20 #include "llvm/ADT/StringExtras.h" 21 #include "llvm/ADT/iterator_range.h" 22 #include "llvm/CodeGen/MachineFunction.h" 23 #include "llvm/CodeGen/MachineOperand.h" 24 #include "llvm/CodeGen/TargetRegisterInfo.h" 25 #include "llvm/CodeGen/TargetSubtargetInfo.h" 26 #include "llvm/IR/Constants.h" 27 #include "llvm/IR/DataLayout.h" 28 #include "llvm/IR/GlobalValue.h" 29 #include "llvm/IR/Metadata.h" 30 #include "llvm/MC/MCAsmInfo.h" 31 #include "llvm/MC/MCContext.h" 32 #include "llvm/MC/MCDwarf.h" 33 #include "llvm/MC/MCSection.h" 34 #include "llvm/MC/MCStreamer.h" 35 #include "llvm/MC/MachineLocation.h" 36 #include "llvm/Support/Casting.h" 37 #include "llvm/Support/CommandLine.h" 38 #include "llvm/Target/TargetLoweringObjectFile.h" 39 #include <cassert> 40 #include <cstdint> 41 #include <string> 42 #include <utility> 43 44 using namespace llvm; 45 46 #define DEBUG_TYPE "dwarfdebug" 47 48 DIEDwarfExpression::DIEDwarfExpression(const AsmPrinter &AP, 49 DwarfCompileUnit &CU, DIELoc &DIE) 50 : DwarfExpression(AP.getDwarfVersion(), CU), AP(AP), OutDIE(DIE) {} 51 52 void DIEDwarfExpression::emitOp(uint8_t Op, const char* Comment) { 53 CU.addUInt(getActiveDIE(), dwarf::DW_FORM_data1, Op); 54 } 55 56 void DIEDwarfExpression::emitSigned(int64_t Value) { 57 CU.addSInt(getActiveDIE(), dwarf::DW_FORM_sdata, Value); 58 } 59 60 void DIEDwarfExpression::emitUnsigned(uint64_t Value) { 61 CU.addUInt(getActiveDIE(), dwarf::DW_FORM_udata, Value); 62 } 63 64 void DIEDwarfExpression::emitData1(uint8_t Value) { 65 CU.addUInt(getActiveDIE(), dwarf::DW_FORM_data1, Value); 66 } 67 68 void DIEDwarfExpression::emitBaseTypeRef(uint64_t Idx) { 69 CU.addBaseTypeRef(getActiveDIE(), Idx); 70 } 71 72 void DIEDwarfExpression::enableTemporaryBuffer() { 73 assert(!IsBuffering && "Already buffering?"); 74 IsBuffering = true; 75 } 76 77 void DIEDwarfExpression::disableTemporaryBuffer() { IsBuffering = false; } 78 79 unsigned DIEDwarfExpression::getTemporaryBufferSize() { 80 return TmpDIE.ComputeSize(&AP); 81 } 82 83 void DIEDwarfExpression::commitTemporaryBuffer() { OutDIE.takeValues(TmpDIE); } 84 85 bool DIEDwarfExpression::isFrameRegister(const TargetRegisterInfo &TRI, 86 llvm::Register MachineReg) { 87 return MachineReg == TRI.getFrameRegister(*AP.MF); 88 } 89 90 DwarfUnit::DwarfUnit(dwarf::Tag UnitTag, const DICompileUnit *Node, 91 AsmPrinter *A, DwarfDebug *DW, DwarfFile *DWU) 92 : DIEUnit(UnitTag), CUNode(Node), Asm(A), DD(DW), DU(DWU), 93 IndexTyDie(nullptr) {} 94 95 DwarfTypeUnit::DwarfTypeUnit(DwarfCompileUnit &CU, AsmPrinter *A, 96 DwarfDebug *DW, DwarfFile *DWU, 97 MCDwarfDwoLineTable *SplitLineTable) 98 : DwarfUnit(dwarf::DW_TAG_type_unit, CU.getCUNode(), A, DW, DWU), CU(CU), 99 SplitLineTable(SplitLineTable) { 100 } 101 102 DwarfUnit::~DwarfUnit() { 103 for (DIEBlock *B : DIEBlocks) 104 B->~DIEBlock(); 105 for (DIELoc *L : DIELocs) 106 L->~DIELoc(); 107 } 108 109 int64_t DwarfUnit::getDefaultLowerBound() const { 110 switch (getLanguage()) { 111 default: 112 break; 113 114 // The languages below have valid values in all DWARF versions. 115 case dwarf::DW_LANG_C: 116 case dwarf::DW_LANG_C89: 117 case dwarf::DW_LANG_C_plus_plus: 118 return 0; 119 120 case dwarf::DW_LANG_Fortran77: 121 case dwarf::DW_LANG_Fortran90: 122 return 1; 123 124 // The languages below have valid values only if the DWARF version >= 3. 125 case dwarf::DW_LANG_C99: 126 case dwarf::DW_LANG_ObjC: 127 case dwarf::DW_LANG_ObjC_plus_plus: 128 if (DD->getDwarfVersion() >= 3) 129 return 0; 130 break; 131 132 case dwarf::DW_LANG_Fortran95: 133 if (DD->getDwarfVersion() >= 3) 134 return 1; 135 break; 136 137 // Starting with DWARF v4, all defined languages have valid values. 138 case dwarf::DW_LANG_D: 139 case dwarf::DW_LANG_Java: 140 case dwarf::DW_LANG_Python: 141 case dwarf::DW_LANG_UPC: 142 if (DD->getDwarfVersion() >= 4) 143 return 0; 144 break; 145 146 case dwarf::DW_LANG_Ada83: 147 case dwarf::DW_LANG_Ada95: 148 case dwarf::DW_LANG_Cobol74: 149 case dwarf::DW_LANG_Cobol85: 150 case dwarf::DW_LANG_Modula2: 151 case dwarf::DW_LANG_Pascal83: 152 case dwarf::DW_LANG_PLI: 153 if (DD->getDwarfVersion() >= 4) 154 return 1; 155 break; 156 157 // The languages below are new in DWARF v5. 158 case dwarf::DW_LANG_BLISS: 159 case dwarf::DW_LANG_C11: 160 case dwarf::DW_LANG_C_plus_plus_03: 161 case dwarf::DW_LANG_C_plus_plus_11: 162 case dwarf::DW_LANG_C_plus_plus_14: 163 case dwarf::DW_LANG_Dylan: 164 case dwarf::DW_LANG_Go: 165 case dwarf::DW_LANG_Haskell: 166 case dwarf::DW_LANG_OCaml: 167 case dwarf::DW_LANG_OpenCL: 168 case dwarf::DW_LANG_RenderScript: 169 case dwarf::DW_LANG_Rust: 170 case dwarf::DW_LANG_Swift: 171 if (DD->getDwarfVersion() >= 5) 172 return 0; 173 break; 174 175 case dwarf::DW_LANG_Fortran03: 176 case dwarf::DW_LANG_Fortran08: 177 case dwarf::DW_LANG_Julia: 178 case dwarf::DW_LANG_Modula3: 179 if (DD->getDwarfVersion() >= 5) 180 return 1; 181 break; 182 } 183 184 return -1; 185 } 186 187 /// Check whether the DIE for this MDNode can be shared across CUs. 188 bool DwarfUnit::isShareableAcrossCUs(const DINode *D) const { 189 // When the MDNode can be part of the type system, the DIE can be shared 190 // across CUs. 191 // Combining type units and cross-CU DIE sharing is lower value (since 192 // cross-CU DIE sharing is used in LTO and removes type redundancy at that 193 // level already) but may be implementable for some value in projects 194 // building multiple independent libraries with LTO and then linking those 195 // together. 196 if (isDwoUnit() && !DD->shareAcrossDWOCUs()) 197 return false; 198 return (isa<DIType>(D) || 199 (isa<DISubprogram>(D) && !cast<DISubprogram>(D)->isDefinition())) && 200 !DD->generateTypeUnits(); 201 } 202 203 DIE *DwarfUnit::getDIE(const DINode *D) const { 204 if (isShareableAcrossCUs(D)) 205 return DU->getDIE(D); 206 return MDNodeToDieMap.lookup(D); 207 } 208 209 void DwarfUnit::insertDIE(const DINode *Desc, DIE *D) { 210 if (isShareableAcrossCUs(Desc)) { 211 DU->insertDIE(Desc, D); 212 return; 213 } 214 MDNodeToDieMap.insert(std::make_pair(Desc, D)); 215 } 216 217 void DwarfUnit::insertDIE(DIE *D) { 218 MDNodeToDieMap.insert(std::make_pair(nullptr, D)); 219 } 220 221 void DwarfUnit::addFlag(DIE &Die, dwarf::Attribute Attribute) { 222 if (DD->getDwarfVersion() >= 4) 223 addAttribute(Die, Attribute, dwarf::DW_FORM_flag_present, DIEInteger(1)); 224 else 225 addAttribute(Die, Attribute, dwarf::DW_FORM_flag, DIEInteger(1)); 226 } 227 228 void DwarfUnit::addUInt(DIEValueList &Die, dwarf::Attribute Attribute, 229 Optional<dwarf::Form> Form, uint64_t Integer) { 230 if (!Form) 231 Form = DIEInteger::BestForm(false, Integer); 232 assert(Form != dwarf::DW_FORM_implicit_const && 233 "DW_FORM_implicit_const is used only for signed integers"); 234 addAttribute(Die, Attribute, *Form, DIEInteger(Integer)); 235 } 236 237 void DwarfUnit::addUInt(DIEValueList &Block, dwarf::Form Form, 238 uint64_t Integer) { 239 addUInt(Block, (dwarf::Attribute)0, Form, Integer); 240 } 241 242 void DwarfUnit::addSInt(DIEValueList &Die, dwarf::Attribute Attribute, 243 Optional<dwarf::Form> Form, int64_t Integer) { 244 if (!Form) 245 Form = DIEInteger::BestForm(true, Integer); 246 addAttribute(Die, Attribute, *Form, DIEInteger(Integer)); 247 } 248 249 void DwarfUnit::addSInt(DIELoc &Die, Optional<dwarf::Form> Form, 250 int64_t Integer) { 251 addSInt(Die, (dwarf::Attribute)0, Form, Integer); 252 } 253 254 void DwarfUnit::addString(DIE &Die, dwarf::Attribute Attribute, 255 StringRef String) { 256 if (CUNode->isDebugDirectivesOnly()) 257 return; 258 259 if (DD->useInlineStrings()) { 260 addAttribute(Die, Attribute, dwarf::DW_FORM_string, 261 new (DIEValueAllocator) 262 DIEInlineString(String, DIEValueAllocator)); 263 return; 264 } 265 dwarf::Form IxForm = 266 isDwoUnit() ? dwarf::DW_FORM_GNU_str_index : dwarf::DW_FORM_strp; 267 268 auto StringPoolEntry = 269 useSegmentedStringOffsetsTable() || IxForm == dwarf::DW_FORM_GNU_str_index 270 ? DU->getStringPool().getIndexedEntry(*Asm, String) 271 : DU->getStringPool().getEntry(*Asm, String); 272 273 // For DWARF v5 and beyond, use the smallest strx? form possible. 274 if (useSegmentedStringOffsetsTable()) { 275 IxForm = dwarf::DW_FORM_strx1; 276 unsigned Index = StringPoolEntry.getIndex(); 277 if (Index > 0xffffff) 278 IxForm = dwarf::DW_FORM_strx4; 279 else if (Index > 0xffff) 280 IxForm = dwarf::DW_FORM_strx3; 281 else if (Index > 0xff) 282 IxForm = dwarf::DW_FORM_strx2; 283 } 284 addAttribute(Die, Attribute, IxForm, DIEString(StringPoolEntry)); 285 } 286 287 void DwarfUnit::addLabel(DIEValueList &Die, dwarf::Attribute Attribute, 288 dwarf::Form Form, const MCSymbol *Label) { 289 addAttribute(Die, Attribute, Form, DIELabel(Label)); 290 } 291 292 void DwarfUnit::addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label) { 293 addLabel(Die, (dwarf::Attribute)0, Form, Label); 294 } 295 296 void DwarfUnit::addSectionOffset(DIE &Die, dwarf::Attribute Attribute, 297 uint64_t Integer) { 298 addUInt(Die, Attribute, DD->getDwarfSectionOffsetForm(), Integer); 299 } 300 301 unsigned DwarfTypeUnit::getOrCreateSourceID(const DIFile *File) { 302 if (!SplitLineTable) 303 return getCU().getOrCreateSourceID(File); 304 if (!UsedLineTable) { 305 UsedLineTable = true; 306 // This is a split type unit that needs a line table. 307 addSectionOffset(getUnitDie(), dwarf::DW_AT_stmt_list, 0); 308 } 309 return SplitLineTable->getFile( 310 File->getDirectory(), File->getFilename(), DD->getMD5AsBytes(File), 311 Asm->OutContext.getDwarfVersion(), File->getSource()); 312 } 313 314 void DwarfUnit::addPoolOpAddress(DIEValueList &Die, const MCSymbol *Label) { 315 bool UseAddrOffsetFormOrExpressions = 316 DD->useAddrOffsetForm() || DD->useAddrOffsetExpressions(); 317 318 const MCSymbol *Base = nullptr; 319 if (Label->isInSection() && UseAddrOffsetFormOrExpressions) 320 Base = DD->getSectionLabel(&Label->getSection()); 321 322 uint32_t Index = DD->getAddressPool().getIndex(Base ? Base : Label); 323 324 if (DD->getDwarfVersion() >= 5) { 325 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_addrx); 326 addUInt(Die, dwarf::DW_FORM_addrx, Index); 327 } else { 328 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_addr_index); 329 addUInt(Die, dwarf::DW_FORM_GNU_addr_index, Index); 330 } 331 332 if (Base && Base != Label) { 333 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_const4u); 334 addLabelDelta(Die, (dwarf::Attribute)0, Label, Base); 335 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_plus); 336 } 337 } 338 339 void DwarfUnit::addOpAddress(DIELoc &Die, const MCSymbol *Sym) { 340 if (DD->getDwarfVersion() >= 5) { 341 addPoolOpAddress(Die, Sym); 342 return; 343 } 344 345 if (DD->useSplitDwarf()) { 346 addPoolOpAddress(Die, Sym); 347 return; 348 } 349 350 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_addr); 351 addLabel(Die, dwarf::DW_FORM_addr, Sym); 352 } 353 354 void DwarfUnit::addLabelDelta(DIEValueList &Die, dwarf::Attribute Attribute, 355 const MCSymbol *Hi, const MCSymbol *Lo) { 356 addAttribute(Die, Attribute, dwarf::DW_FORM_data4, 357 new (DIEValueAllocator) DIEDelta(Hi, Lo)); 358 } 359 360 void DwarfUnit::addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry) { 361 addDIEEntry(Die, Attribute, DIEEntry(Entry)); 362 } 363 364 void DwarfUnit::addDIETypeSignature(DIE &Die, uint64_t Signature) { 365 // Flag the type unit reference as a declaration so that if it contains 366 // members (implicit special members, static data member definitions, member 367 // declarations for definitions in this CU, etc) consumers don't get confused 368 // and think this is a full definition. 369 addFlag(Die, dwarf::DW_AT_declaration); 370 371 addAttribute(Die, dwarf::DW_AT_signature, dwarf::DW_FORM_ref_sig8, 372 DIEInteger(Signature)); 373 } 374 375 void DwarfUnit::addDIEEntry(DIE &Die, dwarf::Attribute Attribute, 376 DIEEntry Entry) { 377 const DIEUnit *CU = Die.getUnit(); 378 const DIEUnit *EntryCU = Entry.getEntry().getUnit(); 379 if (!CU) 380 // We assume that Die belongs to this CU, if it is not linked to any CU yet. 381 CU = getUnitDie().getUnit(); 382 if (!EntryCU) 383 EntryCU = getUnitDie().getUnit(); 384 addAttribute(Die, Attribute, 385 EntryCU == CU ? dwarf::DW_FORM_ref4 : dwarf::DW_FORM_ref_addr, 386 Entry); 387 } 388 389 DIE &DwarfUnit::createAndAddDIE(dwarf::Tag Tag, DIE &Parent, const DINode *N) { 390 DIE &Die = Parent.addChild(DIE::get(DIEValueAllocator, Tag)); 391 if (N) 392 insertDIE(N, &Die); 393 return Die; 394 } 395 396 void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Loc) { 397 Loc->ComputeSize(Asm); 398 DIELocs.push_back(Loc); // Memoize so we can call the destructor later on. 399 addAttribute(Die, Attribute, Loc->BestForm(DD->getDwarfVersion()), Loc); 400 } 401 402 void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form, 403 DIEBlock *Block) { 404 Block->ComputeSize(Asm); 405 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on. 406 addAttribute(Die, Attribute, Form, Block); 407 } 408 409 void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute, 410 DIEBlock *Block) { 411 addBlock(Die, Attribute, Block->BestForm(), Block); 412 } 413 414 void DwarfUnit::addSourceLine(DIE &Die, unsigned Line, const DIFile *File) { 415 if (Line == 0) 416 return; 417 418 unsigned FileID = getOrCreateSourceID(File); 419 addUInt(Die, dwarf::DW_AT_decl_file, None, FileID); 420 addUInt(Die, dwarf::DW_AT_decl_line, None, Line); 421 } 422 423 void DwarfUnit::addSourceLine(DIE &Die, const DILocalVariable *V) { 424 assert(V); 425 426 addSourceLine(Die, V->getLine(), V->getFile()); 427 } 428 429 void DwarfUnit::addSourceLine(DIE &Die, const DIGlobalVariable *G) { 430 assert(G); 431 432 addSourceLine(Die, G->getLine(), G->getFile()); 433 } 434 435 void DwarfUnit::addSourceLine(DIE &Die, const DISubprogram *SP) { 436 assert(SP); 437 438 addSourceLine(Die, SP->getLine(), SP->getFile()); 439 } 440 441 void DwarfUnit::addSourceLine(DIE &Die, const DILabel *L) { 442 assert(L); 443 444 addSourceLine(Die, L->getLine(), L->getFile()); 445 } 446 447 void DwarfUnit::addSourceLine(DIE &Die, const DIType *Ty) { 448 assert(Ty); 449 450 addSourceLine(Die, Ty->getLine(), Ty->getFile()); 451 } 452 453 void DwarfUnit::addSourceLine(DIE &Die, const DIObjCProperty *Ty) { 454 assert(Ty); 455 456 addSourceLine(Die, Ty->getLine(), Ty->getFile()); 457 } 458 459 void DwarfUnit::addConstantFPValue(DIE &Die, const ConstantFP *CFP) { 460 // Pass this down to addConstantValue as an unsigned bag of bits. 461 addConstantValue(Die, CFP->getValueAPF().bitcastToAPInt(), true); 462 } 463 464 void DwarfUnit::addConstantValue(DIE &Die, const ConstantInt *CI, 465 const DIType *Ty) { 466 addConstantValue(Die, CI->getValue(), Ty); 467 } 468 469 void DwarfUnit::addConstantValue(DIE &Die, uint64_t Val, const DIType *Ty) { 470 addConstantValue(Die, DD->isUnsignedDIType(Ty), Val); 471 } 472 473 void DwarfUnit::addConstantValue(DIE &Die, bool Unsigned, uint64_t Val) { 474 // FIXME: This is a bit conservative/simple - it emits negative values always 475 // sign extended to 64 bits rather than minimizing the number of bytes. 476 addUInt(Die, dwarf::DW_AT_const_value, 477 Unsigned ? dwarf::DW_FORM_udata : dwarf::DW_FORM_sdata, Val); 478 } 479 480 void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, const DIType *Ty) { 481 addConstantValue(Die, Val, DD->isUnsignedDIType(Ty)); 482 } 483 484 void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, bool Unsigned) { 485 unsigned CIBitWidth = Val.getBitWidth(); 486 if (CIBitWidth <= 64) { 487 addConstantValue(Die, Unsigned, 488 Unsigned ? Val.getZExtValue() : Val.getSExtValue()); 489 return; 490 } 491 492 DIEBlock *Block = new (DIEValueAllocator) DIEBlock; 493 494 // Get the raw data form of the large APInt. 495 const uint64_t *Ptr64 = Val.getRawData(); 496 497 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte. 498 bool LittleEndian = Asm->getDataLayout().isLittleEndian(); 499 500 // Output the constant to DWARF one byte at a time. 501 for (int i = 0; i < NumBytes; i++) { 502 uint8_t c; 503 if (LittleEndian) 504 c = Ptr64[i / 8] >> (8 * (i & 7)); 505 else 506 c = Ptr64[(NumBytes - 1 - i) / 8] >> (8 * ((NumBytes - 1 - i) & 7)); 507 addUInt(*Block, dwarf::DW_FORM_data1, c); 508 } 509 510 addBlock(Die, dwarf::DW_AT_const_value, Block); 511 } 512 513 void DwarfUnit::addLinkageName(DIE &Die, StringRef LinkageName) { 514 if (!LinkageName.empty()) 515 addString(Die, 516 DD->getDwarfVersion() >= 4 ? dwarf::DW_AT_linkage_name 517 : dwarf::DW_AT_MIPS_linkage_name, 518 GlobalValue::dropLLVMManglingEscape(LinkageName)); 519 } 520 521 void DwarfUnit::addTemplateParams(DIE &Buffer, DINodeArray TParams) { 522 // Add template parameters. 523 for (const auto *Element : TParams) { 524 if (auto *TTP = dyn_cast<DITemplateTypeParameter>(Element)) 525 constructTemplateTypeParameterDIE(Buffer, TTP); 526 else if (auto *TVP = dyn_cast<DITemplateValueParameter>(Element)) 527 constructTemplateValueParameterDIE(Buffer, TVP); 528 } 529 } 530 531 /// Add thrown types. 532 void DwarfUnit::addThrownTypes(DIE &Die, DINodeArray ThrownTypes) { 533 for (const auto *Ty : ThrownTypes) { 534 DIE &TT = createAndAddDIE(dwarf::DW_TAG_thrown_type, Die); 535 addType(TT, cast<DIType>(Ty)); 536 } 537 } 538 539 DIE *DwarfUnit::getOrCreateContextDIE(const DIScope *Context) { 540 if (!Context || isa<DIFile>(Context)) 541 return &getUnitDie(); 542 if (auto *T = dyn_cast<DIType>(Context)) 543 return getOrCreateTypeDIE(T); 544 if (auto *NS = dyn_cast<DINamespace>(Context)) 545 return getOrCreateNameSpace(NS); 546 if (auto *SP = dyn_cast<DISubprogram>(Context)) 547 return getOrCreateSubprogramDIE(SP); 548 if (auto *M = dyn_cast<DIModule>(Context)) 549 return getOrCreateModule(M); 550 return getDIE(Context); 551 } 552 553 DIE *DwarfUnit::createTypeDIE(const DICompositeType *Ty) { 554 auto *Context = Ty->getScope(); 555 DIE *ContextDIE = getOrCreateContextDIE(Context); 556 557 if (DIE *TyDIE = getDIE(Ty)) 558 return TyDIE; 559 560 // Create new type. 561 DIE &TyDIE = createAndAddDIE(Ty->getTag(), *ContextDIE, Ty); 562 563 constructTypeDIE(TyDIE, cast<DICompositeType>(Ty)); 564 565 updateAcceleratorTables(Context, Ty, TyDIE); 566 return &TyDIE; 567 } 568 569 DIE *DwarfUnit::createTypeDIE(const DIScope *Context, DIE &ContextDIE, 570 const DIType *Ty) { 571 // Create new type. 572 DIE &TyDIE = createAndAddDIE(Ty->getTag(), ContextDIE, Ty); 573 574 updateAcceleratorTables(Context, Ty, TyDIE); 575 576 if (auto *BT = dyn_cast<DIBasicType>(Ty)) 577 constructTypeDIE(TyDIE, BT); 578 else if (auto *ST = dyn_cast<DIStringType>(Ty)) 579 constructTypeDIE(TyDIE, ST); 580 else if (auto *STy = dyn_cast<DISubroutineType>(Ty)) 581 constructTypeDIE(TyDIE, STy); 582 else if (auto *CTy = dyn_cast<DICompositeType>(Ty)) { 583 if (DD->generateTypeUnits() && !Ty->isForwardDecl() && 584 (Ty->getRawName() || CTy->getRawIdentifier())) { 585 // Skip updating the accelerator tables since this is not the full type. 586 if (MDString *TypeId = CTy->getRawIdentifier()) 587 DD->addDwarfTypeUnitType(getCU(), TypeId->getString(), TyDIE, CTy); 588 else { 589 auto X = DD->enterNonTypeUnitContext(); 590 finishNonUnitTypeDIE(TyDIE, CTy); 591 } 592 return &TyDIE; 593 } 594 constructTypeDIE(TyDIE, CTy); 595 } else { 596 constructTypeDIE(TyDIE, cast<DIDerivedType>(Ty)); 597 } 598 599 return &TyDIE; 600 } 601 602 DIE *DwarfUnit::getOrCreateTypeDIE(const MDNode *TyNode) { 603 if (!TyNode) 604 return nullptr; 605 606 auto *Ty = cast<DIType>(TyNode); 607 608 // DW_TAG_restrict_type is not supported in DWARF2 609 if (Ty->getTag() == dwarf::DW_TAG_restrict_type && DD->getDwarfVersion() <= 2) 610 return getOrCreateTypeDIE(cast<DIDerivedType>(Ty)->getBaseType()); 611 612 // DW_TAG_atomic_type is not supported in DWARF < 5 613 if (Ty->getTag() == dwarf::DW_TAG_atomic_type && DD->getDwarfVersion() < 5) 614 return getOrCreateTypeDIE(cast<DIDerivedType>(Ty)->getBaseType()); 615 616 // Construct the context before querying for the existence of the DIE in case 617 // such construction creates the DIE. 618 auto *Context = Ty->getScope(); 619 DIE *ContextDIE = getOrCreateContextDIE(Context); 620 assert(ContextDIE); 621 622 if (DIE *TyDIE = getDIE(Ty)) 623 return TyDIE; 624 625 return static_cast<DwarfUnit *>(ContextDIE->getUnit()) 626 ->createTypeDIE(Context, *ContextDIE, Ty); 627 } 628 629 void DwarfUnit::updateAcceleratorTables(const DIScope *Context, 630 const DIType *Ty, const DIE &TyDIE) { 631 if (!Ty->getName().empty() && !Ty->isForwardDecl()) { 632 bool IsImplementation = false; 633 if (auto *CT = dyn_cast<DICompositeType>(Ty)) { 634 // A runtime language of 0 actually means C/C++ and that any 635 // non-negative value is some version of Objective-C/C++. 636 IsImplementation = CT->getRuntimeLang() == 0 || CT->isObjcClassComplete(); 637 } 638 unsigned Flags = IsImplementation ? dwarf::DW_FLAG_type_implementation : 0; 639 DD->addAccelType(*CUNode, Ty->getName(), TyDIE, Flags); 640 641 if (!Context || isa<DICompileUnit>(Context) || isa<DIFile>(Context) || 642 isa<DINamespace>(Context) || isa<DICommonBlock>(Context)) 643 addGlobalType(Ty, TyDIE, Context); 644 } 645 } 646 647 void DwarfUnit::addType(DIE &Entity, const DIType *Ty, 648 dwarf::Attribute Attribute) { 649 assert(Ty && "Trying to add a type that doesn't exist?"); 650 addDIEEntry(Entity, Attribute, DIEEntry(*getOrCreateTypeDIE(Ty))); 651 } 652 653 std::string DwarfUnit::getParentContextString(const DIScope *Context) const { 654 if (!Context) 655 return ""; 656 657 // FIXME: Decide whether to implement this for non-C++ languages. 658 if (!dwarf::isCPlusPlus((dwarf::SourceLanguage)getLanguage())) 659 return ""; 660 661 std::string CS; 662 SmallVector<const DIScope *, 1> Parents; 663 while (!isa<DICompileUnit>(Context)) { 664 Parents.push_back(Context); 665 if (const DIScope *S = Context->getScope()) 666 Context = S; 667 else 668 // Structure, etc types will have a NULL context if they're at the top 669 // level. 670 break; 671 } 672 673 // Reverse iterate over our list to go from the outermost construct to the 674 // innermost. 675 for (const DIScope *Ctx : make_range(Parents.rbegin(), Parents.rend())) { 676 StringRef Name = Ctx->getName(); 677 if (Name.empty() && isa<DINamespace>(Ctx)) 678 Name = "(anonymous namespace)"; 679 if (!Name.empty()) { 680 CS += Name; 681 CS += "::"; 682 } 683 } 684 return CS; 685 } 686 687 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIBasicType *BTy) { 688 // Get core information. 689 StringRef Name = BTy->getName(); 690 // Add name if not anonymous or intermediate type. 691 if (!Name.empty()) 692 addString(Buffer, dwarf::DW_AT_name, Name); 693 694 // An unspecified type only has a name attribute. 695 if (BTy->getTag() == dwarf::DW_TAG_unspecified_type) 696 return; 697 698 if (BTy->getTag() != dwarf::DW_TAG_string_type) 699 addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1, 700 BTy->getEncoding()); 701 702 uint64_t Size = BTy->getSizeInBits() >> 3; 703 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size); 704 705 if (BTy->isBigEndian()) 706 addUInt(Buffer, dwarf::DW_AT_endianity, None, dwarf::DW_END_big); 707 else if (BTy->isLittleEndian()) 708 addUInt(Buffer, dwarf::DW_AT_endianity, None, dwarf::DW_END_little); 709 } 710 711 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIStringType *STy) { 712 // Get core information. 713 StringRef Name = STy->getName(); 714 // Add name if not anonymous or intermediate type. 715 if (!Name.empty()) 716 addString(Buffer, dwarf::DW_AT_name, Name); 717 718 if (DIVariable *Var = STy->getStringLength()) { 719 if (auto *VarDIE = getDIE(Var)) 720 addDIEEntry(Buffer, dwarf::DW_AT_string_length, *VarDIE); 721 } else if (DIExpression *Expr = STy->getStringLengthExp()) { 722 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 723 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 724 // This is to describe the memory location of the 725 // length of a Fortran deferred length string, so 726 // lock it down as such. 727 DwarfExpr.setMemoryLocationKind(); 728 DwarfExpr.addExpression(Expr); 729 addBlock(Buffer, dwarf::DW_AT_string_length, DwarfExpr.finalize()); 730 } else { 731 uint64_t Size = STy->getSizeInBits() >> 3; 732 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size); 733 } 734 735 if (STy->getEncoding()) { 736 // For eventual Unicode support. 737 addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1, 738 STy->getEncoding()); 739 } 740 } 741 742 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIDerivedType *DTy) { 743 // Get core information. 744 StringRef Name = DTy->getName(); 745 uint64_t Size = DTy->getSizeInBits() >> 3; 746 uint16_t Tag = Buffer.getTag(); 747 748 // Map to main type, void will not have a type. 749 const DIType *FromTy = DTy->getBaseType(); 750 if (FromTy) 751 addType(Buffer, FromTy); 752 753 // Add name if not anonymous or intermediate type. 754 if (!Name.empty()) 755 addString(Buffer, dwarf::DW_AT_name, Name); 756 757 // If alignment is specified for a typedef , create and insert DW_AT_alignment 758 // attribute in DW_TAG_typedef DIE. 759 if (Tag == dwarf::DW_TAG_typedef && DD->getDwarfVersion() >= 5) { 760 uint32_t AlignInBytes = DTy->getAlignInBytes(); 761 if (AlignInBytes > 0) 762 addUInt(Buffer, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata, 763 AlignInBytes); 764 } 765 766 // Add size if non-zero (derived types might be zero-sized.) 767 if (Size && Tag != dwarf::DW_TAG_pointer_type 768 && Tag != dwarf::DW_TAG_ptr_to_member_type 769 && Tag != dwarf::DW_TAG_reference_type 770 && Tag != dwarf::DW_TAG_rvalue_reference_type) 771 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size); 772 773 if (Tag == dwarf::DW_TAG_ptr_to_member_type) 774 addDIEEntry(Buffer, dwarf::DW_AT_containing_type, 775 *getOrCreateTypeDIE(cast<DIDerivedType>(DTy)->getClassType())); 776 // Add source line info if available and TyDesc is not a forward declaration. 777 if (!DTy->isForwardDecl()) 778 addSourceLine(Buffer, DTy); 779 780 // If DWARF address space value is other than None, add it. The IR 781 // verifier checks that DWARF address space only exists for pointer 782 // or reference types. 783 if (DTy->getDWARFAddressSpace()) 784 addUInt(Buffer, dwarf::DW_AT_address_class, dwarf::DW_FORM_data4, 785 DTy->getDWARFAddressSpace().getValue()); 786 } 787 788 void DwarfUnit::constructSubprogramArguments(DIE &Buffer, DITypeRefArray Args) { 789 for (unsigned i = 1, N = Args.size(); i < N; ++i) { 790 const DIType *Ty = Args[i]; 791 if (!Ty) { 792 assert(i == N-1 && "Unspecified parameter must be the last argument"); 793 createAndAddDIE(dwarf::DW_TAG_unspecified_parameters, Buffer); 794 } else { 795 DIE &Arg = createAndAddDIE(dwarf::DW_TAG_formal_parameter, Buffer); 796 addType(Arg, Ty); 797 if (Ty->isArtificial()) 798 addFlag(Arg, dwarf::DW_AT_artificial); 799 } 800 } 801 } 802 803 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DISubroutineType *CTy) { 804 // Add return type. A void return won't have a type. 805 auto Elements = cast<DISubroutineType>(CTy)->getTypeArray(); 806 if (Elements.size()) 807 if (auto RTy = Elements[0]) 808 addType(Buffer, RTy); 809 810 bool isPrototyped = true; 811 if (Elements.size() == 2 && !Elements[1]) 812 isPrototyped = false; 813 814 constructSubprogramArguments(Buffer, Elements); 815 816 // Add prototype flag if we're dealing with a C language and the function has 817 // been prototyped. 818 uint16_t Language = getLanguage(); 819 if (isPrototyped && 820 (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 || 821 Language == dwarf::DW_LANG_ObjC)) 822 addFlag(Buffer, dwarf::DW_AT_prototyped); 823 824 // Add a DW_AT_calling_convention if this has an explicit convention. 825 if (CTy->getCC() && CTy->getCC() != dwarf::DW_CC_normal) 826 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1, 827 CTy->getCC()); 828 829 if (CTy->isLValueReference()) 830 addFlag(Buffer, dwarf::DW_AT_reference); 831 832 if (CTy->isRValueReference()) 833 addFlag(Buffer, dwarf::DW_AT_rvalue_reference); 834 } 835 836 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DICompositeType *CTy) { 837 // Add name if not anonymous or intermediate type. 838 StringRef Name = CTy->getName(); 839 840 uint64_t Size = CTy->getSizeInBits() >> 3; 841 uint16_t Tag = Buffer.getTag(); 842 843 switch (Tag) { 844 case dwarf::DW_TAG_array_type: 845 constructArrayTypeDIE(Buffer, CTy); 846 break; 847 case dwarf::DW_TAG_enumeration_type: 848 constructEnumTypeDIE(Buffer, CTy); 849 break; 850 case dwarf::DW_TAG_variant_part: 851 case dwarf::DW_TAG_structure_type: 852 case dwarf::DW_TAG_union_type: 853 case dwarf::DW_TAG_class_type: 854 case dwarf::DW_TAG_namelist: { 855 // Emit the discriminator for a variant part. 856 DIDerivedType *Discriminator = nullptr; 857 if (Tag == dwarf::DW_TAG_variant_part) { 858 Discriminator = CTy->getDiscriminator(); 859 if (Discriminator) { 860 // DWARF says: 861 // If the variant part has a discriminant, the discriminant is 862 // represented by a separate debugging information entry which is 863 // a child of the variant part entry. 864 DIE &DiscMember = constructMemberDIE(Buffer, Discriminator); 865 addDIEEntry(Buffer, dwarf::DW_AT_discr, DiscMember); 866 } 867 } 868 869 // Add template parameters to a class, structure or union types. 870 if (Tag == dwarf::DW_TAG_class_type || 871 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type) 872 addTemplateParams(Buffer, CTy->getTemplateParams()); 873 874 // Add elements to structure type. 875 DINodeArray Elements = CTy->getElements(); 876 for (const auto *Element : Elements) { 877 if (!Element) 878 continue; 879 if (auto *SP = dyn_cast<DISubprogram>(Element)) 880 getOrCreateSubprogramDIE(SP); 881 else if (auto *DDTy = dyn_cast<DIDerivedType>(Element)) { 882 if (DDTy->getTag() == dwarf::DW_TAG_friend) { 883 DIE &ElemDie = createAndAddDIE(dwarf::DW_TAG_friend, Buffer); 884 addType(ElemDie, DDTy->getBaseType(), dwarf::DW_AT_friend); 885 } else if (DDTy->isStaticMember()) { 886 getOrCreateStaticMemberDIE(DDTy); 887 } else if (Tag == dwarf::DW_TAG_variant_part) { 888 // When emitting a variant part, wrap each member in 889 // DW_TAG_variant. 890 DIE &Variant = createAndAddDIE(dwarf::DW_TAG_variant, Buffer); 891 if (const ConstantInt *CI = 892 dyn_cast_or_null<ConstantInt>(DDTy->getDiscriminantValue())) { 893 if (DD->isUnsignedDIType(Discriminator->getBaseType())) 894 addUInt(Variant, dwarf::DW_AT_discr_value, None, CI->getZExtValue()); 895 else 896 addSInt(Variant, dwarf::DW_AT_discr_value, None, CI->getSExtValue()); 897 } 898 constructMemberDIE(Variant, DDTy); 899 } else { 900 constructMemberDIE(Buffer, DDTy); 901 } 902 } else if (auto *Property = dyn_cast<DIObjCProperty>(Element)) { 903 DIE &ElemDie = createAndAddDIE(Property->getTag(), Buffer); 904 StringRef PropertyName = Property->getName(); 905 addString(ElemDie, dwarf::DW_AT_APPLE_property_name, PropertyName); 906 if (Property->getType()) 907 addType(ElemDie, Property->getType()); 908 addSourceLine(ElemDie, Property); 909 StringRef GetterName = Property->getGetterName(); 910 if (!GetterName.empty()) 911 addString(ElemDie, dwarf::DW_AT_APPLE_property_getter, GetterName); 912 StringRef SetterName = Property->getSetterName(); 913 if (!SetterName.empty()) 914 addString(ElemDie, dwarf::DW_AT_APPLE_property_setter, SetterName); 915 if (unsigned PropertyAttributes = Property->getAttributes()) 916 addUInt(ElemDie, dwarf::DW_AT_APPLE_property_attribute, None, 917 PropertyAttributes); 918 } else if (auto *Composite = dyn_cast<DICompositeType>(Element)) { 919 if (Composite->getTag() == dwarf::DW_TAG_variant_part) { 920 DIE &VariantPart = createAndAddDIE(Composite->getTag(), Buffer); 921 constructTypeDIE(VariantPart, Composite); 922 } 923 } else if (Tag == dwarf::DW_TAG_namelist) { 924 auto *Var = dyn_cast<DINode>(Element); 925 auto *VarDIE = getDIE(Var); 926 if (VarDIE) { 927 DIE &ItemDie = createAndAddDIE(dwarf::DW_TAG_namelist_item, Buffer); 928 addDIEEntry(ItemDie, dwarf::DW_AT_namelist_item, *VarDIE); 929 } 930 } 931 } 932 933 if (CTy->isAppleBlockExtension()) 934 addFlag(Buffer, dwarf::DW_AT_APPLE_block); 935 936 if (CTy->getExportSymbols()) 937 addFlag(Buffer, dwarf::DW_AT_export_symbols); 938 939 // This is outside the DWARF spec, but GDB expects a DW_AT_containing_type 940 // inside C++ composite types to point to the base class with the vtable. 941 // Rust uses DW_AT_containing_type to link a vtable to the type 942 // for which it was created. 943 if (auto *ContainingType = CTy->getVTableHolder()) 944 addDIEEntry(Buffer, dwarf::DW_AT_containing_type, 945 *getOrCreateTypeDIE(ContainingType)); 946 947 if (CTy->isObjcClassComplete()) 948 addFlag(Buffer, dwarf::DW_AT_APPLE_objc_complete_type); 949 950 // Add the type's non-standard calling convention. 951 // DW_CC_pass_by_value/DW_CC_pass_by_reference are introduced in DWARF 5. 952 if (!Asm->TM.Options.DebugStrictDwarf || DD->getDwarfVersion() >= 5) { 953 uint8_t CC = 0; 954 if (CTy->isTypePassByValue()) 955 CC = dwarf::DW_CC_pass_by_value; 956 else if (CTy->isTypePassByReference()) 957 CC = dwarf::DW_CC_pass_by_reference; 958 if (CC) 959 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1, 960 CC); 961 } 962 break; 963 } 964 default: 965 break; 966 } 967 968 // Add name if not anonymous or intermediate type. 969 if (!Name.empty()) 970 addString(Buffer, dwarf::DW_AT_name, Name); 971 972 if (Tag == dwarf::DW_TAG_enumeration_type || 973 Tag == dwarf::DW_TAG_class_type || Tag == dwarf::DW_TAG_structure_type || 974 Tag == dwarf::DW_TAG_union_type) { 975 // Add size if non-zero (derived types might be zero-sized.) 976 // Ignore the size if it's a non-enum forward decl. 977 // TODO: Do we care about size for enum forward declarations? 978 if (Size && 979 (!CTy->isForwardDecl() || Tag == dwarf::DW_TAG_enumeration_type)) 980 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size); 981 else if (!CTy->isForwardDecl()) 982 // Add zero size if it is not a forward declaration. 983 addUInt(Buffer, dwarf::DW_AT_byte_size, None, 0); 984 985 // If we're a forward decl, say so. 986 if (CTy->isForwardDecl()) 987 addFlag(Buffer, dwarf::DW_AT_declaration); 988 989 // Add source line info if available. 990 if (!CTy->isForwardDecl()) 991 addSourceLine(Buffer, CTy); 992 993 // No harm in adding the runtime language to the declaration. 994 unsigned RLang = CTy->getRuntimeLang(); 995 if (RLang) 996 addUInt(Buffer, dwarf::DW_AT_APPLE_runtime_class, dwarf::DW_FORM_data1, 997 RLang); 998 999 // Add align info if available. 1000 if (uint32_t AlignInBytes = CTy->getAlignInBytes()) 1001 addUInt(Buffer, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata, 1002 AlignInBytes); 1003 } 1004 } 1005 1006 void DwarfUnit::constructTemplateTypeParameterDIE( 1007 DIE &Buffer, const DITemplateTypeParameter *TP) { 1008 DIE &ParamDIE = 1009 createAndAddDIE(dwarf::DW_TAG_template_type_parameter, Buffer); 1010 // Add the type if it exists, it could be void and therefore no type. 1011 if (TP->getType()) 1012 addType(ParamDIE, TP->getType()); 1013 if (!TP->getName().empty()) 1014 addString(ParamDIE, dwarf::DW_AT_name, TP->getName()); 1015 if (TP->isDefault() && (DD->getDwarfVersion() >= 5)) 1016 addFlag(ParamDIE, dwarf::DW_AT_default_value); 1017 } 1018 1019 void DwarfUnit::constructTemplateValueParameterDIE( 1020 DIE &Buffer, const DITemplateValueParameter *VP) { 1021 DIE &ParamDIE = createAndAddDIE(VP->getTag(), Buffer); 1022 1023 // Add the type if there is one, template template and template parameter 1024 // packs will not have a type. 1025 if (VP->getTag() == dwarf::DW_TAG_template_value_parameter) 1026 addType(ParamDIE, VP->getType()); 1027 if (!VP->getName().empty()) 1028 addString(ParamDIE, dwarf::DW_AT_name, VP->getName()); 1029 if (VP->isDefault() && (DD->getDwarfVersion() >= 5)) 1030 addFlag(ParamDIE, dwarf::DW_AT_default_value); 1031 if (Metadata *Val = VP->getValue()) { 1032 if (ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(Val)) 1033 addConstantValue(ParamDIE, CI, VP->getType()); 1034 else if (GlobalValue *GV = mdconst::dyn_extract<GlobalValue>(Val)) { 1035 // We cannot describe the location of dllimport'd entities: the 1036 // computation of their address requires loads from the IAT. 1037 if (!GV->hasDLLImportStorageClass()) { 1038 // For declaration non-type template parameters (such as global values 1039 // and functions) 1040 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 1041 addOpAddress(*Loc, Asm->getSymbol(GV)); 1042 // Emit DW_OP_stack_value to use the address as the immediate value of 1043 // the parameter, rather than a pointer to it. 1044 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_stack_value); 1045 addBlock(ParamDIE, dwarf::DW_AT_location, Loc); 1046 } 1047 } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_template_param) { 1048 assert(isa<MDString>(Val)); 1049 addString(ParamDIE, dwarf::DW_AT_GNU_template_name, 1050 cast<MDString>(Val)->getString()); 1051 } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_parameter_pack) { 1052 addTemplateParams(ParamDIE, cast<MDTuple>(Val)); 1053 } 1054 } 1055 } 1056 1057 DIE *DwarfUnit::getOrCreateNameSpace(const DINamespace *NS) { 1058 // Construct the context before querying for the existence of the DIE in case 1059 // such construction creates the DIE. 1060 DIE *ContextDIE = getOrCreateContextDIE(NS->getScope()); 1061 1062 if (DIE *NDie = getDIE(NS)) 1063 return NDie; 1064 DIE &NDie = createAndAddDIE(dwarf::DW_TAG_namespace, *ContextDIE, NS); 1065 1066 StringRef Name = NS->getName(); 1067 if (!Name.empty()) 1068 addString(NDie, dwarf::DW_AT_name, NS->getName()); 1069 else 1070 Name = "(anonymous namespace)"; 1071 DD->addAccelNamespace(*CUNode, Name, NDie); 1072 addGlobalName(Name, NDie, NS->getScope()); 1073 if (NS->getExportSymbols()) 1074 addFlag(NDie, dwarf::DW_AT_export_symbols); 1075 return &NDie; 1076 } 1077 1078 DIE *DwarfUnit::getOrCreateModule(const DIModule *M) { 1079 // Construct the context before querying for the existence of the DIE in case 1080 // such construction creates the DIE. 1081 DIE *ContextDIE = getOrCreateContextDIE(M->getScope()); 1082 1083 if (DIE *MDie = getDIE(M)) 1084 return MDie; 1085 DIE &MDie = createAndAddDIE(dwarf::DW_TAG_module, *ContextDIE, M); 1086 1087 if (!M->getName().empty()) { 1088 addString(MDie, dwarf::DW_AT_name, M->getName()); 1089 addGlobalName(M->getName(), MDie, M->getScope()); 1090 } 1091 if (!M->getConfigurationMacros().empty()) 1092 addString(MDie, dwarf::DW_AT_LLVM_config_macros, 1093 M->getConfigurationMacros()); 1094 if (!M->getIncludePath().empty()) 1095 addString(MDie, dwarf::DW_AT_LLVM_include_path, M->getIncludePath()); 1096 if (!M->getAPINotesFile().empty()) 1097 addString(MDie, dwarf::DW_AT_LLVM_apinotes, M->getAPINotesFile()); 1098 if (M->getFile()) 1099 addUInt(MDie, dwarf::DW_AT_decl_file, None, 1100 getOrCreateSourceID(M->getFile())); 1101 if (M->getLineNo()) 1102 addUInt(MDie, dwarf::DW_AT_decl_line, None, M->getLineNo()); 1103 if (M->getIsDecl()) 1104 addFlag(MDie, dwarf::DW_AT_declaration); 1105 1106 return &MDie; 1107 } 1108 1109 DIE *DwarfUnit::getOrCreateSubprogramDIE(const DISubprogram *SP, bool Minimal) { 1110 // Construct the context before querying for the existence of the DIE in case 1111 // such construction creates the DIE (as is the case for member function 1112 // declarations). 1113 DIE *ContextDIE = 1114 Minimal ? &getUnitDie() : getOrCreateContextDIE(SP->getScope()); 1115 1116 if (DIE *SPDie = getDIE(SP)) 1117 return SPDie; 1118 1119 if (auto *SPDecl = SP->getDeclaration()) { 1120 if (!Minimal) { 1121 // Add subprogram definitions to the CU die directly. 1122 ContextDIE = &getUnitDie(); 1123 // Build the decl now to ensure it precedes the definition. 1124 getOrCreateSubprogramDIE(SPDecl); 1125 } 1126 } 1127 1128 // DW_TAG_inlined_subroutine may refer to this DIE. 1129 DIE &SPDie = createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE, SP); 1130 1131 // Stop here and fill this in later, depending on whether or not this 1132 // subprogram turns out to have inlined instances or not. 1133 if (SP->isDefinition()) 1134 return &SPDie; 1135 1136 static_cast<DwarfUnit *>(SPDie.getUnit()) 1137 ->applySubprogramAttributes(SP, SPDie); 1138 return &SPDie; 1139 } 1140 1141 bool DwarfUnit::applySubprogramDefinitionAttributes(const DISubprogram *SP, 1142 DIE &SPDie, bool Minimal) { 1143 DIE *DeclDie = nullptr; 1144 StringRef DeclLinkageName; 1145 if (auto *SPDecl = SP->getDeclaration()) { 1146 if (!Minimal) { 1147 DITypeRefArray DeclArgs, DefinitionArgs; 1148 DeclArgs = SPDecl->getType()->getTypeArray(); 1149 DefinitionArgs = SP->getType()->getTypeArray(); 1150 1151 if (DeclArgs.size() && DefinitionArgs.size()) 1152 if (DefinitionArgs[0] != NULL && DeclArgs[0] != DefinitionArgs[0]) 1153 addType(SPDie, DefinitionArgs[0]); 1154 1155 DeclDie = getDIE(SPDecl); 1156 assert(DeclDie && "This DIE should've already been constructed when the " 1157 "definition DIE was created in " 1158 "getOrCreateSubprogramDIE"); 1159 // Look at the Decl's linkage name only if we emitted it. 1160 if (DD->useAllLinkageNames()) 1161 DeclLinkageName = SPDecl->getLinkageName(); 1162 unsigned DeclID = getOrCreateSourceID(SPDecl->getFile()); 1163 unsigned DefID = getOrCreateSourceID(SP->getFile()); 1164 if (DeclID != DefID) 1165 addUInt(SPDie, dwarf::DW_AT_decl_file, None, DefID); 1166 1167 if (SP->getLine() != SPDecl->getLine()) 1168 addUInt(SPDie, dwarf::DW_AT_decl_line, None, SP->getLine()); 1169 } 1170 } 1171 1172 // Add function template parameters. 1173 addTemplateParams(SPDie, SP->getTemplateParams()); 1174 1175 // Add the linkage name if we have one and it isn't in the Decl. 1176 StringRef LinkageName = SP->getLinkageName(); 1177 assert(((LinkageName.empty() || DeclLinkageName.empty()) || 1178 LinkageName == DeclLinkageName) && 1179 "decl has a linkage name and it is different"); 1180 if (DeclLinkageName.empty() && 1181 // Always emit it for abstract subprograms. 1182 (DD->useAllLinkageNames() || DU->getAbstractSPDies().lookup(SP))) 1183 addLinkageName(SPDie, LinkageName); 1184 1185 if (!DeclDie) 1186 return false; 1187 1188 // Refer to the function declaration where all the other attributes will be 1189 // found. 1190 addDIEEntry(SPDie, dwarf::DW_AT_specification, *DeclDie); 1191 return true; 1192 } 1193 1194 void DwarfUnit::applySubprogramAttributes(const DISubprogram *SP, DIE &SPDie, 1195 bool SkipSPAttributes) { 1196 // If -fdebug-info-for-profiling is enabled, need to emit the subprogram 1197 // and its source location. 1198 bool SkipSPSourceLocation = SkipSPAttributes && 1199 !CUNode->getDebugInfoForProfiling(); 1200 if (!SkipSPSourceLocation) 1201 if (applySubprogramDefinitionAttributes(SP, SPDie, SkipSPAttributes)) 1202 return; 1203 1204 // Constructors and operators for anonymous aggregates do not have names. 1205 if (!SP->getName().empty()) 1206 addString(SPDie, dwarf::DW_AT_name, SP->getName()); 1207 1208 if (!SkipSPSourceLocation) 1209 addSourceLine(SPDie, SP); 1210 1211 // Skip the rest of the attributes under -gmlt to save space. 1212 if (SkipSPAttributes) 1213 return; 1214 1215 // Add the prototype if we have a prototype and we have a C like 1216 // language. 1217 uint16_t Language = getLanguage(); 1218 if (SP->isPrototyped() && 1219 (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 || 1220 Language == dwarf::DW_LANG_ObjC)) 1221 addFlag(SPDie, dwarf::DW_AT_prototyped); 1222 1223 if (SP->isObjCDirect()) 1224 addFlag(SPDie, dwarf::DW_AT_APPLE_objc_direct); 1225 1226 unsigned CC = 0; 1227 DITypeRefArray Args; 1228 if (const DISubroutineType *SPTy = SP->getType()) { 1229 Args = SPTy->getTypeArray(); 1230 CC = SPTy->getCC(); 1231 } 1232 1233 // Add a DW_AT_calling_convention if this has an explicit convention. 1234 if (CC && CC != dwarf::DW_CC_normal) 1235 addUInt(SPDie, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1, CC); 1236 1237 // Add a return type. If this is a type like a C/C++ void type we don't add a 1238 // return type. 1239 if (Args.size()) 1240 if (auto Ty = Args[0]) 1241 addType(SPDie, Ty); 1242 1243 unsigned VK = SP->getVirtuality(); 1244 if (VK) { 1245 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, VK); 1246 if (SP->getVirtualIndex() != -1u) { 1247 DIELoc *Block = getDIELoc(); 1248 addUInt(*Block, dwarf::DW_FORM_data1, dwarf::DW_OP_constu); 1249 addUInt(*Block, dwarf::DW_FORM_udata, SP->getVirtualIndex()); 1250 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, Block); 1251 } 1252 ContainingTypeMap.insert(std::make_pair(&SPDie, SP->getContainingType())); 1253 } 1254 1255 if (!SP->isDefinition()) { 1256 addFlag(SPDie, dwarf::DW_AT_declaration); 1257 1258 // Add arguments. Do not add arguments for subprogram definition. They will 1259 // be handled while processing variables. 1260 constructSubprogramArguments(SPDie, Args); 1261 } 1262 1263 addThrownTypes(SPDie, SP->getThrownTypes()); 1264 1265 if (SP->isArtificial()) 1266 addFlag(SPDie, dwarf::DW_AT_artificial); 1267 1268 if (!SP->isLocalToUnit()) 1269 addFlag(SPDie, dwarf::DW_AT_external); 1270 1271 if (DD->useAppleExtensionAttributes()) { 1272 if (SP->isOptimized()) 1273 addFlag(SPDie, dwarf::DW_AT_APPLE_optimized); 1274 1275 if (unsigned isa = Asm->getISAEncoding()) 1276 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa); 1277 } 1278 1279 if (SP->isLValueReference()) 1280 addFlag(SPDie, dwarf::DW_AT_reference); 1281 1282 if (SP->isRValueReference()) 1283 addFlag(SPDie, dwarf::DW_AT_rvalue_reference); 1284 1285 if (SP->isNoReturn()) 1286 addFlag(SPDie, dwarf::DW_AT_noreturn); 1287 1288 if (SP->isProtected()) 1289 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1290 dwarf::DW_ACCESS_protected); 1291 else if (SP->isPrivate()) 1292 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1293 dwarf::DW_ACCESS_private); 1294 else if (SP->isPublic()) 1295 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1296 dwarf::DW_ACCESS_public); 1297 1298 if (SP->isExplicit()) 1299 addFlag(SPDie, dwarf::DW_AT_explicit); 1300 1301 if (SP->isMainSubprogram()) 1302 addFlag(SPDie, dwarf::DW_AT_main_subprogram); 1303 if (SP->isPure()) 1304 addFlag(SPDie, dwarf::DW_AT_pure); 1305 if (SP->isElemental()) 1306 addFlag(SPDie, dwarf::DW_AT_elemental); 1307 if (SP->isRecursive()) 1308 addFlag(SPDie, dwarf::DW_AT_recursive); 1309 1310 if (DD->getDwarfVersion() >= 5 && SP->isDeleted()) 1311 addFlag(SPDie, dwarf::DW_AT_deleted); 1312 } 1313 1314 void DwarfUnit::constructSubrangeDIE(DIE &Buffer, const DISubrange *SR, 1315 DIE *IndexTy) { 1316 DIE &DW_Subrange = createAndAddDIE(dwarf::DW_TAG_subrange_type, Buffer); 1317 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, *IndexTy); 1318 1319 // The LowerBound value defines the lower bounds which is typically zero for 1320 // C/C++. The Count value is the number of elements. Values are 64 bit. If 1321 // Count == -1 then the array is unbounded and we do not emit 1322 // DW_AT_lower_bound and DW_AT_count attributes. 1323 int64_t DefaultLowerBound = getDefaultLowerBound(); 1324 1325 auto AddBoundTypeEntry = [&](dwarf::Attribute Attr, 1326 DISubrange::BoundType Bound) -> void { 1327 if (auto *BV = Bound.dyn_cast<DIVariable *>()) { 1328 if (auto *VarDIE = getDIE(BV)) 1329 addDIEEntry(DW_Subrange, Attr, *VarDIE); 1330 } else if (auto *BE = Bound.dyn_cast<DIExpression *>()) { 1331 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 1332 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 1333 DwarfExpr.setMemoryLocationKind(); 1334 DwarfExpr.addExpression(BE); 1335 addBlock(DW_Subrange, Attr, DwarfExpr.finalize()); 1336 } else if (auto *BI = Bound.dyn_cast<ConstantInt *>()) { 1337 if (Attr == dwarf::DW_AT_count) { 1338 if (BI->getSExtValue() != -1) 1339 addUInt(DW_Subrange, Attr, None, BI->getSExtValue()); 1340 } else if (Attr != dwarf::DW_AT_lower_bound || DefaultLowerBound == -1 || 1341 BI->getSExtValue() != DefaultLowerBound) 1342 addSInt(DW_Subrange, Attr, dwarf::DW_FORM_sdata, BI->getSExtValue()); 1343 } 1344 }; 1345 1346 AddBoundTypeEntry(dwarf::DW_AT_lower_bound, SR->getLowerBound()); 1347 1348 AddBoundTypeEntry(dwarf::DW_AT_count, SR->getCount()); 1349 1350 AddBoundTypeEntry(dwarf::DW_AT_upper_bound, SR->getUpperBound()); 1351 1352 AddBoundTypeEntry(dwarf::DW_AT_byte_stride, SR->getStride()); 1353 } 1354 1355 void DwarfUnit::constructGenericSubrangeDIE(DIE &Buffer, 1356 const DIGenericSubrange *GSR, 1357 DIE *IndexTy) { 1358 DIE &DwGenericSubrange = 1359 createAndAddDIE(dwarf::DW_TAG_generic_subrange, Buffer); 1360 addDIEEntry(DwGenericSubrange, dwarf::DW_AT_type, *IndexTy); 1361 1362 int64_t DefaultLowerBound = getDefaultLowerBound(); 1363 1364 auto AddBoundTypeEntry = [&](dwarf::Attribute Attr, 1365 DIGenericSubrange::BoundType Bound) -> void { 1366 if (auto *BV = Bound.dyn_cast<DIVariable *>()) { 1367 if (auto *VarDIE = getDIE(BV)) 1368 addDIEEntry(DwGenericSubrange, Attr, *VarDIE); 1369 } else if (auto *BE = Bound.dyn_cast<DIExpression *>()) { 1370 if (BE->isConstant() && 1371 DIExpression::SignedOrUnsignedConstant::SignedConstant == 1372 *BE->isConstant()) { 1373 if (Attr != dwarf::DW_AT_lower_bound || DefaultLowerBound == -1 || 1374 static_cast<int64_t>(BE->getElement(1)) != DefaultLowerBound) 1375 addSInt(DwGenericSubrange, Attr, dwarf::DW_FORM_sdata, 1376 BE->getElement(1)); 1377 } else { 1378 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 1379 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 1380 DwarfExpr.setMemoryLocationKind(); 1381 DwarfExpr.addExpression(BE); 1382 addBlock(DwGenericSubrange, Attr, DwarfExpr.finalize()); 1383 } 1384 } 1385 }; 1386 1387 AddBoundTypeEntry(dwarf::DW_AT_lower_bound, GSR->getLowerBound()); 1388 AddBoundTypeEntry(dwarf::DW_AT_count, GSR->getCount()); 1389 AddBoundTypeEntry(dwarf::DW_AT_upper_bound, GSR->getUpperBound()); 1390 AddBoundTypeEntry(dwarf::DW_AT_byte_stride, GSR->getStride()); 1391 } 1392 1393 DIE *DwarfUnit::getIndexTyDie() { 1394 if (IndexTyDie) 1395 return IndexTyDie; 1396 // Construct an integer type to use for indexes. 1397 IndexTyDie = &createAndAddDIE(dwarf::DW_TAG_base_type, getUnitDie()); 1398 StringRef Name = "__ARRAY_SIZE_TYPE__"; 1399 addString(*IndexTyDie, dwarf::DW_AT_name, Name); 1400 addUInt(*IndexTyDie, dwarf::DW_AT_byte_size, None, sizeof(int64_t)); 1401 addUInt(*IndexTyDie, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1, 1402 dwarf::DW_ATE_unsigned); 1403 DD->addAccelType(*CUNode, Name, *IndexTyDie, /*Flags*/ 0); 1404 return IndexTyDie; 1405 } 1406 1407 /// Returns true if the vector's size differs from the sum of sizes of elements 1408 /// the user specified. This can occur if the vector has been rounded up to 1409 /// fit memory alignment constraints. 1410 static bool hasVectorBeenPadded(const DICompositeType *CTy) { 1411 assert(CTy && CTy->isVector() && "Composite type is not a vector"); 1412 const uint64_t ActualSize = CTy->getSizeInBits(); 1413 1414 // Obtain the size of each element in the vector. 1415 DIType *BaseTy = CTy->getBaseType(); 1416 assert(BaseTy && "Unknown vector element type."); 1417 const uint64_t ElementSize = BaseTy->getSizeInBits(); 1418 1419 // Locate the number of elements in the vector. 1420 const DINodeArray Elements = CTy->getElements(); 1421 assert(Elements.size() == 1 && 1422 Elements[0]->getTag() == dwarf::DW_TAG_subrange_type && 1423 "Invalid vector element array, expected one element of type subrange"); 1424 const auto Subrange = cast<DISubrange>(Elements[0]); 1425 const auto NumVecElements = 1426 Subrange->getCount() 1427 ? Subrange->getCount().get<ConstantInt *>()->getSExtValue() 1428 : 0; 1429 1430 // Ensure we found the element count and that the actual size is wide 1431 // enough to contain the requested size. 1432 assert(ActualSize >= (NumVecElements * ElementSize) && "Invalid vector size"); 1433 return ActualSize != (NumVecElements * ElementSize); 1434 } 1435 1436 void DwarfUnit::constructArrayTypeDIE(DIE &Buffer, const DICompositeType *CTy) { 1437 if (CTy->isVector()) { 1438 addFlag(Buffer, dwarf::DW_AT_GNU_vector); 1439 if (hasVectorBeenPadded(CTy)) 1440 addUInt(Buffer, dwarf::DW_AT_byte_size, None, 1441 CTy->getSizeInBits() / CHAR_BIT); 1442 } 1443 1444 if (DIVariable *Var = CTy->getDataLocation()) { 1445 if (auto *VarDIE = getDIE(Var)) 1446 addDIEEntry(Buffer, dwarf::DW_AT_data_location, *VarDIE); 1447 } else if (DIExpression *Expr = CTy->getDataLocationExp()) { 1448 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 1449 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 1450 DwarfExpr.setMemoryLocationKind(); 1451 DwarfExpr.addExpression(Expr); 1452 addBlock(Buffer, dwarf::DW_AT_data_location, DwarfExpr.finalize()); 1453 } 1454 1455 if (DIVariable *Var = CTy->getAssociated()) { 1456 if (auto *VarDIE = getDIE(Var)) 1457 addDIEEntry(Buffer, dwarf::DW_AT_associated, *VarDIE); 1458 } else if (DIExpression *Expr = CTy->getAssociatedExp()) { 1459 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 1460 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 1461 DwarfExpr.setMemoryLocationKind(); 1462 DwarfExpr.addExpression(Expr); 1463 addBlock(Buffer, dwarf::DW_AT_associated, DwarfExpr.finalize()); 1464 } 1465 1466 if (DIVariable *Var = CTy->getAllocated()) { 1467 if (auto *VarDIE = getDIE(Var)) 1468 addDIEEntry(Buffer, dwarf::DW_AT_allocated, *VarDIE); 1469 } else if (DIExpression *Expr = CTy->getAllocatedExp()) { 1470 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 1471 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 1472 DwarfExpr.setMemoryLocationKind(); 1473 DwarfExpr.addExpression(Expr); 1474 addBlock(Buffer, dwarf::DW_AT_allocated, DwarfExpr.finalize()); 1475 } 1476 1477 if (auto *RankConst = CTy->getRankConst()) { 1478 addSInt(Buffer, dwarf::DW_AT_rank, dwarf::DW_FORM_sdata, 1479 RankConst->getSExtValue()); 1480 } else if (auto *RankExpr = CTy->getRankExp()) { 1481 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 1482 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 1483 DwarfExpr.setMemoryLocationKind(); 1484 DwarfExpr.addExpression(RankExpr); 1485 addBlock(Buffer, dwarf::DW_AT_rank, DwarfExpr.finalize()); 1486 } 1487 1488 // Emit the element type. 1489 addType(Buffer, CTy->getBaseType()); 1490 1491 // Get an anonymous type for index type. 1492 // FIXME: This type should be passed down from the front end 1493 // as different languages may have different sizes for indexes. 1494 DIE *IdxTy = getIndexTyDie(); 1495 1496 // Add subranges to array type. 1497 DINodeArray Elements = CTy->getElements(); 1498 for (DINode *E : Elements) { 1499 // FIXME: Should this really be such a loose cast? 1500 if (auto *Element = dyn_cast_or_null<DINode>(E)) { 1501 if (Element->getTag() == dwarf::DW_TAG_subrange_type) 1502 constructSubrangeDIE(Buffer, cast<DISubrange>(Element), IdxTy); 1503 else if (Element->getTag() == dwarf::DW_TAG_generic_subrange) 1504 constructGenericSubrangeDIE(Buffer, cast<DIGenericSubrange>(Element), 1505 IdxTy); 1506 } 1507 } 1508 } 1509 1510 void DwarfUnit::constructEnumTypeDIE(DIE &Buffer, const DICompositeType *CTy) { 1511 const DIType *DTy = CTy->getBaseType(); 1512 bool IsUnsigned = DTy && DD->isUnsignedDIType(DTy); 1513 if (DTy) { 1514 if (DD->getDwarfVersion() >= 3) 1515 addType(Buffer, DTy); 1516 if (DD->getDwarfVersion() >= 4 && (CTy->getFlags() & DINode::FlagEnumClass)) 1517 addFlag(Buffer, dwarf::DW_AT_enum_class); 1518 } 1519 1520 auto *Context = CTy->getScope(); 1521 bool IndexEnumerators = !Context || isa<DICompileUnit>(Context) || isa<DIFile>(Context) || 1522 isa<DINamespace>(Context) || isa<DICommonBlock>(Context); 1523 DINodeArray Elements = CTy->getElements(); 1524 1525 // Add enumerators to enumeration type. 1526 for (const DINode *E : Elements) { 1527 auto *Enum = dyn_cast_or_null<DIEnumerator>(E); 1528 if (Enum) { 1529 DIE &Enumerator = createAndAddDIE(dwarf::DW_TAG_enumerator, Buffer); 1530 StringRef Name = Enum->getName(); 1531 addString(Enumerator, dwarf::DW_AT_name, Name); 1532 addConstantValue(Enumerator, Enum->getValue(), IsUnsigned); 1533 if (IndexEnumerators) 1534 addGlobalName(Name, Enumerator, Context); 1535 } 1536 } 1537 } 1538 1539 void DwarfUnit::constructContainingTypeDIEs() { 1540 for (auto &P : ContainingTypeMap) { 1541 DIE &SPDie = *P.first; 1542 const DINode *D = P.second; 1543 if (!D) 1544 continue; 1545 DIE *NDie = getDIE(D); 1546 if (!NDie) 1547 continue; 1548 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, *NDie); 1549 } 1550 } 1551 1552 DIE &DwarfUnit::constructMemberDIE(DIE &Buffer, const DIDerivedType *DT) { 1553 DIE &MemberDie = createAndAddDIE(DT->getTag(), Buffer); 1554 StringRef Name = DT->getName(); 1555 if (!Name.empty()) 1556 addString(MemberDie, dwarf::DW_AT_name, Name); 1557 1558 if (DIType *Resolved = DT->getBaseType()) 1559 addType(MemberDie, Resolved); 1560 1561 addSourceLine(MemberDie, DT); 1562 1563 if (DT->getTag() == dwarf::DW_TAG_inheritance && DT->isVirtual()) { 1564 1565 // For C++, virtual base classes are not at fixed offset. Use following 1566 // expression to extract appropriate offset from vtable. 1567 // BaseAddr = ObAddr + *((*ObAddr) - Offset) 1568 1569 DIELoc *VBaseLocationDie = new (DIEValueAllocator) DIELoc; 1570 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_dup); 1571 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref); 1572 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_constu); 1573 addUInt(*VBaseLocationDie, dwarf::DW_FORM_udata, DT->getOffsetInBits()); 1574 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_minus); 1575 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref); 1576 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus); 1577 1578 addBlock(MemberDie, dwarf::DW_AT_data_member_location, VBaseLocationDie); 1579 } else { 1580 uint64_t Size = DT->getSizeInBits(); 1581 uint64_t FieldSize = DD->getBaseTypeSize(DT); 1582 uint32_t AlignInBytes = DT->getAlignInBytes(); 1583 uint64_t OffsetInBytes; 1584 1585 bool IsBitfield = FieldSize && Size != FieldSize; 1586 if (IsBitfield) { 1587 // Handle bitfield, assume bytes are 8 bits. 1588 if (DD->useDWARF2Bitfields()) 1589 addUInt(MemberDie, dwarf::DW_AT_byte_size, None, FieldSize/8); 1590 addUInt(MemberDie, dwarf::DW_AT_bit_size, None, Size); 1591 1592 uint64_t Offset = DT->getOffsetInBits(); 1593 // We can't use DT->getAlignInBits() here: AlignInBits for member type 1594 // is non-zero if and only if alignment was forced (e.g. _Alignas()), 1595 // which can't be done with bitfields. Thus we use FieldSize here. 1596 uint32_t AlignInBits = FieldSize; 1597 uint32_t AlignMask = ~(AlignInBits - 1); 1598 // The bits from the start of the storage unit to the start of the field. 1599 uint64_t StartBitOffset = Offset - (Offset & AlignMask); 1600 // The byte offset of the field's aligned storage unit inside the struct. 1601 OffsetInBytes = (Offset - StartBitOffset) / 8; 1602 1603 if (DD->useDWARF2Bitfields()) { 1604 uint64_t HiMark = (Offset + FieldSize) & AlignMask; 1605 uint64_t FieldOffset = (HiMark - FieldSize); 1606 Offset -= FieldOffset; 1607 1608 // Maybe we need to work from the other end. 1609 if (Asm->getDataLayout().isLittleEndian()) 1610 Offset = FieldSize - (Offset + Size); 1611 1612 addUInt(MemberDie, dwarf::DW_AT_bit_offset, None, Offset); 1613 OffsetInBytes = FieldOffset >> 3; 1614 } else { 1615 addUInt(MemberDie, dwarf::DW_AT_data_bit_offset, None, Offset); 1616 } 1617 } else { 1618 // This is not a bitfield. 1619 OffsetInBytes = DT->getOffsetInBits() / 8; 1620 if (AlignInBytes) 1621 addUInt(MemberDie, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata, 1622 AlignInBytes); 1623 } 1624 1625 if (DD->getDwarfVersion() <= 2) { 1626 DIELoc *MemLocationDie = new (DIEValueAllocator) DIELoc; 1627 addUInt(*MemLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst); 1628 addUInt(*MemLocationDie, dwarf::DW_FORM_udata, OffsetInBytes); 1629 addBlock(MemberDie, dwarf::DW_AT_data_member_location, MemLocationDie); 1630 } else if (!IsBitfield || DD->useDWARF2Bitfields()) { 1631 // In DWARF v3, DW_FORM_data4/8 in DW_AT_data_member_location are 1632 // interpreted as location-list pointers. Interpreting constants as 1633 // pointers is not expected, so we use DW_FORM_udata to encode the 1634 // constants here. 1635 if (DD->getDwarfVersion() == 3) 1636 addUInt(MemberDie, dwarf::DW_AT_data_member_location, 1637 dwarf::DW_FORM_udata, OffsetInBytes); 1638 else 1639 addUInt(MemberDie, dwarf::DW_AT_data_member_location, None, 1640 OffsetInBytes); 1641 } 1642 } 1643 1644 if (DT->isProtected()) 1645 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1646 dwarf::DW_ACCESS_protected); 1647 else if (DT->isPrivate()) 1648 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1649 dwarf::DW_ACCESS_private); 1650 // Otherwise C++ member and base classes are considered public. 1651 else if (DT->isPublic()) 1652 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1653 dwarf::DW_ACCESS_public); 1654 if (DT->isVirtual()) 1655 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, 1656 dwarf::DW_VIRTUALITY_virtual); 1657 1658 // Objective-C properties. 1659 if (DINode *PNode = DT->getObjCProperty()) 1660 if (DIE *PDie = getDIE(PNode)) 1661 addAttribute(MemberDie, dwarf::DW_AT_APPLE_property, 1662 dwarf::DW_FORM_ref4, DIEEntry(*PDie)); 1663 1664 if (DT->isArtificial()) 1665 addFlag(MemberDie, dwarf::DW_AT_artificial); 1666 1667 return MemberDie; 1668 } 1669 1670 DIE *DwarfUnit::getOrCreateStaticMemberDIE(const DIDerivedType *DT) { 1671 if (!DT) 1672 return nullptr; 1673 1674 // Construct the context before querying for the existence of the DIE in case 1675 // such construction creates the DIE. 1676 DIE *ContextDIE = getOrCreateContextDIE(DT->getScope()); 1677 assert(dwarf::isType(ContextDIE->getTag()) && 1678 "Static member should belong to a type."); 1679 1680 if (DIE *StaticMemberDIE = getDIE(DT)) 1681 return StaticMemberDIE; 1682 1683 DIE &StaticMemberDIE = createAndAddDIE(DT->getTag(), *ContextDIE, DT); 1684 1685 const DIType *Ty = DT->getBaseType(); 1686 1687 addString(StaticMemberDIE, dwarf::DW_AT_name, DT->getName()); 1688 addType(StaticMemberDIE, Ty); 1689 addSourceLine(StaticMemberDIE, DT); 1690 addFlag(StaticMemberDIE, dwarf::DW_AT_external); 1691 addFlag(StaticMemberDIE, dwarf::DW_AT_declaration); 1692 1693 // FIXME: We could omit private if the parent is a class_type, and 1694 // public if the parent is something else. 1695 if (DT->isProtected()) 1696 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1697 dwarf::DW_ACCESS_protected); 1698 else if (DT->isPrivate()) 1699 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1700 dwarf::DW_ACCESS_private); 1701 else if (DT->isPublic()) 1702 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1703 dwarf::DW_ACCESS_public); 1704 1705 if (const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(DT->getConstant())) 1706 addConstantValue(StaticMemberDIE, CI, Ty); 1707 if (const ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(DT->getConstant())) 1708 addConstantFPValue(StaticMemberDIE, CFP); 1709 1710 if (uint32_t AlignInBytes = DT->getAlignInBytes()) 1711 addUInt(StaticMemberDIE, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata, 1712 AlignInBytes); 1713 1714 return &StaticMemberDIE; 1715 } 1716 1717 void DwarfUnit::emitCommonHeader(bool UseOffsets, dwarf::UnitType UT) { 1718 // Emit size of content not including length itself 1719 if (!DD->useSectionsAsReferences()) 1720 EndLabel = Asm->emitDwarfUnitLength( 1721 isDwoUnit() ? "debug_info_dwo" : "debug_info", "Length of Unit"); 1722 else 1723 Asm->emitDwarfUnitLength(getHeaderSize() + getUnitDie().getSize(), 1724 "Length of Unit"); 1725 1726 Asm->OutStreamer->AddComment("DWARF version number"); 1727 unsigned Version = DD->getDwarfVersion(); 1728 Asm->emitInt16(Version); 1729 1730 // DWARF v5 reorders the address size and adds a unit type. 1731 if (Version >= 5) { 1732 Asm->OutStreamer->AddComment("DWARF Unit Type"); 1733 Asm->emitInt8(UT); 1734 Asm->OutStreamer->AddComment("Address Size (in bytes)"); 1735 Asm->emitInt8(Asm->MAI->getCodePointerSize()); 1736 } 1737 1738 // We share one abbreviations table across all units so it's always at the 1739 // start of the section. Use a relocatable offset where needed to ensure 1740 // linking doesn't invalidate that offset. 1741 Asm->OutStreamer->AddComment("Offset Into Abbrev. Section"); 1742 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering(); 1743 if (UseOffsets) 1744 Asm->emitDwarfLengthOrOffset(0); 1745 else 1746 Asm->emitDwarfSymbolReference( 1747 TLOF.getDwarfAbbrevSection()->getBeginSymbol(), false); 1748 1749 if (Version <= 4) { 1750 Asm->OutStreamer->AddComment("Address Size (in bytes)"); 1751 Asm->emitInt8(Asm->MAI->getCodePointerSize()); 1752 } 1753 } 1754 1755 void DwarfTypeUnit::emitHeader(bool UseOffsets) { 1756 DwarfUnit::emitCommonHeader(UseOffsets, 1757 DD->useSplitDwarf() ? dwarf::DW_UT_split_type 1758 : dwarf::DW_UT_type); 1759 Asm->OutStreamer->AddComment("Type Signature"); 1760 Asm->OutStreamer->emitIntValue(TypeSignature, sizeof(TypeSignature)); 1761 Asm->OutStreamer->AddComment("Type DIE Offset"); 1762 // In a skeleton type unit there is no type DIE so emit a zero offset. 1763 Asm->emitDwarfLengthOrOffset(Ty ? Ty->getOffset() : 0); 1764 } 1765 1766 void DwarfUnit::addSectionDelta(DIE &Die, dwarf::Attribute Attribute, 1767 const MCSymbol *Hi, const MCSymbol *Lo) { 1768 addAttribute(Die, Attribute, DD->getDwarfSectionOffsetForm(), 1769 new (DIEValueAllocator) DIEDelta(Hi, Lo)); 1770 } 1771 1772 void DwarfUnit::addSectionLabel(DIE &Die, dwarf::Attribute Attribute, 1773 const MCSymbol *Label, const MCSymbol *Sec) { 1774 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) 1775 addLabel(Die, Attribute, DD->getDwarfSectionOffsetForm(), Label); 1776 else 1777 addSectionDelta(Die, Attribute, Label, Sec); 1778 } 1779 1780 bool DwarfTypeUnit::isDwoUnit() const { 1781 // Since there are no skeleton type units, all type units are dwo type units 1782 // when split DWARF is being used. 1783 return DD->useSplitDwarf(); 1784 } 1785 1786 void DwarfTypeUnit::addGlobalName(StringRef Name, const DIE &Die, 1787 const DIScope *Context) { 1788 getCU().addGlobalNameForTypeUnit(Name, Context); 1789 } 1790 1791 void DwarfTypeUnit::addGlobalType(const DIType *Ty, const DIE &Die, 1792 const DIScope *Context) { 1793 getCU().addGlobalTypeUnitType(Ty, Context); 1794 } 1795 1796 const MCSymbol *DwarfUnit::getCrossSectionRelativeBaseAddress() const { 1797 if (!Asm->MAI->doesDwarfUseRelocationsAcrossSections()) 1798 return nullptr; 1799 if (isDwoUnit()) 1800 return nullptr; 1801 return getSection()->getBeginSymbol(); 1802 } 1803 1804 void DwarfUnit::addStringOffsetsStart() { 1805 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering(); 1806 addSectionLabel(getUnitDie(), dwarf::DW_AT_str_offsets_base, 1807 DU->getStringOffsetsStartSym(), 1808 TLOF.getDwarfStrOffSection()->getBeginSymbol()); 1809 } 1810 1811 void DwarfUnit::addRnglistsBase() { 1812 assert(DD->getDwarfVersion() >= 5 && 1813 "DW_AT_rnglists_base requires DWARF version 5 or later"); 1814 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering(); 1815 addSectionLabel(getUnitDie(), dwarf::DW_AT_rnglists_base, 1816 DU->getRnglistsTableBaseSym(), 1817 TLOF.getDwarfRnglistsSection()->getBeginSymbol()); 1818 } 1819 1820 void DwarfTypeUnit::finishNonUnitTypeDIE(DIE& D, const DICompositeType *CTy) { 1821 addFlag(D, dwarf::DW_AT_declaration); 1822 StringRef Name = CTy->getName(); 1823 if (!Name.empty()) 1824 addString(D, dwarf::DW_AT_name, Name); 1825 getCU().createTypeDIE(CTy); 1826 } 1827