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