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 (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j) 104 DIEBlocks[j]->~DIEBlock(); 105 for (unsigned j = 0, M = DIELocs.size(); j < M; ++j) 106 DIELocs[j]->~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 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_flag_present, 223 DIEInteger(1)); 224 else 225 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_flag, 226 DIEInteger(1)); 227 } 228 229 void DwarfUnit::addUInt(DIEValueList &Die, dwarf::Attribute Attribute, 230 Optional<dwarf::Form> Form, uint64_t Integer) { 231 if (!Form) 232 Form = DIEInteger::BestForm(false, Integer); 233 assert(Form != dwarf::DW_FORM_implicit_const && 234 "DW_FORM_implicit_const is used only for signed integers"); 235 Die.addValue(DIEValueAllocator, Attribute, *Form, DIEInteger(Integer)); 236 } 237 238 void DwarfUnit::addUInt(DIEValueList &Block, dwarf::Form Form, 239 uint64_t Integer) { 240 addUInt(Block, (dwarf::Attribute)0, Form, Integer); 241 } 242 243 void DwarfUnit::addSInt(DIEValueList &Die, dwarf::Attribute Attribute, 244 Optional<dwarf::Form> Form, int64_t Integer) { 245 if (!Form) 246 Form = DIEInteger::BestForm(true, Integer); 247 Die.addValue(DIEValueAllocator, Attribute, *Form, DIEInteger(Integer)); 248 } 249 250 void DwarfUnit::addSInt(DIELoc &Die, Optional<dwarf::Form> Form, 251 int64_t Integer) { 252 addSInt(Die, (dwarf::Attribute)0, Form, Integer); 253 } 254 255 void DwarfUnit::addString(DIE &Die, dwarf::Attribute Attribute, 256 StringRef String) { 257 if (CUNode->isDebugDirectivesOnly()) 258 return; 259 260 if (DD->useInlineStrings()) { 261 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_string, 262 new (DIEValueAllocator) 263 DIEInlineString(String, DIEValueAllocator)); 264 return; 265 } 266 dwarf::Form IxForm = 267 isDwoUnit() ? dwarf::DW_FORM_GNU_str_index : dwarf::DW_FORM_strp; 268 269 auto StringPoolEntry = 270 useSegmentedStringOffsetsTable() || IxForm == dwarf::DW_FORM_GNU_str_index 271 ? DU->getStringPool().getIndexedEntry(*Asm, String) 272 : DU->getStringPool().getEntry(*Asm, String); 273 274 // For DWARF v5 and beyond, use the smallest strx? form possible. 275 if (useSegmentedStringOffsetsTable()) { 276 IxForm = dwarf::DW_FORM_strx1; 277 unsigned Index = StringPoolEntry.getIndex(); 278 if (Index > 0xffffff) 279 IxForm = dwarf::DW_FORM_strx4; 280 else if (Index > 0xffff) 281 IxForm = dwarf::DW_FORM_strx3; 282 else if (Index > 0xff) 283 IxForm = dwarf::DW_FORM_strx2; 284 } 285 Die.addValue(DIEValueAllocator, Attribute, IxForm, 286 DIEString(StringPoolEntry)); 287 } 288 289 DIEValueList::value_iterator DwarfUnit::addLabel(DIEValueList &Die, 290 dwarf::Attribute Attribute, 291 dwarf::Form Form, 292 const MCSymbol *Label) { 293 return Die.addValue(DIEValueAllocator, Attribute, Form, DIELabel(Label)); 294 } 295 296 void DwarfUnit::addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label) { 297 addLabel(Die, (dwarf::Attribute)0, Form, Label); 298 } 299 300 void DwarfUnit::addSectionOffset(DIE &Die, dwarf::Attribute Attribute, 301 uint64_t Integer) { 302 addUInt(Die, Attribute, DD->getDwarfSectionOffsetForm(), Integer); 303 } 304 305 unsigned DwarfTypeUnit::getOrCreateSourceID(const DIFile *File) { 306 if (!SplitLineTable) 307 return getCU().getOrCreateSourceID(File); 308 if (!UsedLineTable) { 309 UsedLineTable = true; 310 // This is a split type unit that needs a line table. 311 addSectionOffset(getUnitDie(), dwarf::DW_AT_stmt_list, 0); 312 } 313 return SplitLineTable->getFile( 314 File->getDirectory(), File->getFilename(), DD->getMD5AsBytes(File), 315 Asm->OutContext.getDwarfVersion(), File->getSource()); 316 } 317 318 void DwarfUnit::addPoolOpAddress(DIEValueList &Die, const MCSymbol *Label) { 319 const MCSymbol *Base = nullptr; 320 if (Label->isInSection() && DD->useAddrOffsetExpressions()) 321 Base = DD->getSectionLabel(&Label->getSection()); 322 323 uint32_t Index = DD->getAddressPool().getIndex(Base ? Base : Label); 324 325 if (DD->getDwarfVersion() >= 5) { 326 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_addrx); 327 addUInt(Die, dwarf::DW_FORM_addrx, Index); 328 } else { 329 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_addr_index); 330 addUInt(Die, dwarf::DW_FORM_GNU_addr_index, Index); 331 } 332 333 if (Base && Base != Label) { 334 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_const4u); 335 addLabelDelta(Die, (dwarf::Attribute)0, Label, Base); 336 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_plus); 337 } 338 } 339 340 void DwarfUnit::addOpAddress(DIELoc &Die, const MCSymbol *Sym) { 341 if (DD->getDwarfVersion() >= 5) { 342 addPoolOpAddress(Die, Sym); 343 return; 344 } 345 346 if (DD->useSplitDwarf()) { 347 addPoolOpAddress(Die, Sym); 348 return; 349 } 350 351 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_addr); 352 addLabel(Die, dwarf::DW_FORM_addr, Sym); 353 } 354 355 void DwarfUnit::addLabelDelta(DIEValueList &Die, dwarf::Attribute Attribute, 356 const MCSymbol *Hi, const MCSymbol *Lo) { 357 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_data4, 358 new (DIEValueAllocator) DIEDelta(Hi, Lo)); 359 } 360 361 void DwarfUnit::addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry) { 362 addDIEEntry(Die, Attribute, DIEEntry(Entry)); 363 } 364 365 void DwarfUnit::addDIETypeSignature(DIE &Die, uint64_t Signature) { 366 // Flag the type unit reference as a declaration so that if it contains 367 // members (implicit special members, static data member definitions, member 368 // declarations for definitions in this CU, etc) consumers don't get confused 369 // and think this is a full definition. 370 addFlag(Die, dwarf::DW_AT_declaration); 371 372 Die.addValue(DIEValueAllocator, dwarf::DW_AT_signature, 373 dwarf::DW_FORM_ref_sig8, DIEInteger(Signature)); 374 } 375 376 void DwarfUnit::addDIEEntry(DIE &Die, dwarf::Attribute Attribute, 377 DIEEntry Entry) { 378 const DIEUnit *CU = Die.getUnit(); 379 const DIEUnit *EntryCU = Entry.getEntry().getUnit(); 380 if (!CU) 381 // We assume that Die belongs to this CU, if it is not linked to any CU yet. 382 CU = getUnitDie().getUnit(); 383 if (!EntryCU) 384 EntryCU = getUnitDie().getUnit(); 385 Die.addValue(DIEValueAllocator, Attribute, 386 EntryCU == CU ? dwarf::DW_FORM_ref4 : dwarf::DW_FORM_ref_addr, 387 Entry); 388 } 389 390 DIE &DwarfUnit::createAndAddDIE(unsigned Tag, DIE &Parent, const DINode *N) { 391 DIE &Die = Parent.addChild(DIE::get(DIEValueAllocator, (dwarf::Tag)Tag)); 392 if (N) 393 insertDIE(N, &Die); 394 return Die; 395 } 396 397 void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Loc) { 398 Loc->ComputeSize(Asm); 399 DIELocs.push_back(Loc); // Memoize so we can call the destructor later on. 400 Die.addValue(DIEValueAllocator, Attribute, 401 Loc->BestForm(DD->getDwarfVersion()), Loc); 402 } 403 404 void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form, 405 DIEBlock *Block) { 406 Block->ComputeSize(Asm); 407 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on. 408 Die.addValue(DIEValueAllocator, Attribute, Form, Block); 409 } 410 411 void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute, 412 DIEBlock *Block) { 413 addBlock(Die, Attribute, Block->BestForm(), Block); 414 } 415 416 void DwarfUnit::addSourceLine(DIE &Die, unsigned Line, const DIFile *File) { 417 if (Line == 0) 418 return; 419 420 unsigned FileID = getOrCreateSourceID(File); 421 addUInt(Die, dwarf::DW_AT_decl_file, None, FileID); 422 addUInt(Die, dwarf::DW_AT_decl_line, None, Line); 423 } 424 425 void DwarfUnit::addSourceLine(DIE &Die, const DILocalVariable *V) { 426 assert(V); 427 428 addSourceLine(Die, V->getLine(), V->getFile()); 429 } 430 431 void DwarfUnit::addSourceLine(DIE &Die, const DIGlobalVariable *G) { 432 assert(G); 433 434 addSourceLine(Die, G->getLine(), G->getFile()); 435 } 436 437 void DwarfUnit::addSourceLine(DIE &Die, const DISubprogram *SP) { 438 assert(SP); 439 440 addSourceLine(Die, SP->getLine(), SP->getFile()); 441 } 442 443 void DwarfUnit::addSourceLine(DIE &Die, const DILabel *L) { 444 assert(L); 445 446 addSourceLine(Die, L->getLine(), L->getFile()); 447 } 448 449 void DwarfUnit::addSourceLine(DIE &Die, const DIType *Ty) { 450 assert(Ty); 451 452 addSourceLine(Die, Ty->getLine(), Ty->getFile()); 453 } 454 455 void DwarfUnit::addSourceLine(DIE &Die, const DIObjCProperty *Ty) { 456 assert(Ty); 457 458 addSourceLine(Die, Ty->getLine(), Ty->getFile()); 459 } 460 461 void DwarfUnit::addConstantFPValue(DIE &Die, const ConstantFP *CFP) { 462 // Pass this down to addConstantValue as an unsigned bag of bits. 463 addConstantValue(Die, CFP->getValueAPF().bitcastToAPInt(), true); 464 } 465 466 void DwarfUnit::addConstantValue(DIE &Die, const ConstantInt *CI, 467 const DIType *Ty) { 468 addConstantValue(Die, CI->getValue(), Ty); 469 } 470 471 void DwarfUnit::addConstantValue(DIE &Die, uint64_t Val, const DIType *Ty) { 472 addConstantValue(Die, DD->isUnsignedDIType(Ty), Val); 473 } 474 475 void DwarfUnit::addConstantValue(DIE &Die, bool Unsigned, uint64_t Val) { 476 // FIXME: This is a bit conservative/simple - it emits negative values always 477 // sign extended to 64 bits rather than minimizing the number of bytes. 478 addUInt(Die, dwarf::DW_AT_const_value, 479 Unsigned ? dwarf::DW_FORM_udata : dwarf::DW_FORM_sdata, Val); 480 } 481 482 void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, const DIType *Ty) { 483 addConstantValue(Die, Val, DD->isUnsignedDIType(Ty)); 484 } 485 486 void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, bool Unsigned) { 487 unsigned CIBitWidth = Val.getBitWidth(); 488 if (CIBitWidth <= 64) { 489 addConstantValue(Die, Unsigned, 490 Unsigned ? Val.getZExtValue() : Val.getSExtValue()); 491 return; 492 } 493 494 DIEBlock *Block = new (DIEValueAllocator) DIEBlock; 495 496 // Get the raw data form of the large APInt. 497 const uint64_t *Ptr64 = Val.getRawData(); 498 499 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte. 500 bool LittleEndian = Asm->getDataLayout().isLittleEndian(); 501 502 // Output the constant to DWARF one byte at a time. 503 for (int i = 0; i < NumBytes; i++) { 504 uint8_t c; 505 if (LittleEndian) 506 c = Ptr64[i / 8] >> (8 * (i & 7)); 507 else 508 c = Ptr64[(NumBytes - 1 - i) / 8] >> (8 * ((NumBytes - 1 - i) & 7)); 509 addUInt(*Block, dwarf::DW_FORM_data1, c); 510 } 511 512 addBlock(Die, dwarf::DW_AT_const_value, Block); 513 } 514 515 void DwarfUnit::addLinkageName(DIE &Die, StringRef LinkageName) { 516 if (!LinkageName.empty()) 517 addString(Die, 518 DD->getDwarfVersion() >= 4 ? dwarf::DW_AT_linkage_name 519 : dwarf::DW_AT_MIPS_linkage_name, 520 GlobalValue::dropLLVMManglingEscape(LinkageName)); 521 } 522 523 void DwarfUnit::addTemplateParams(DIE &Buffer, DINodeArray TParams) { 524 // Add template parameters. 525 for (const auto *Element : TParams) { 526 if (auto *TTP = dyn_cast<DITemplateTypeParameter>(Element)) 527 constructTemplateTypeParameterDIE(Buffer, TTP); 528 else if (auto *TVP = dyn_cast<DITemplateValueParameter>(Element)) 529 constructTemplateValueParameterDIE(Buffer, TVP); 530 } 531 } 532 533 /// Add thrown types. 534 void DwarfUnit::addThrownTypes(DIE &Die, DINodeArray ThrownTypes) { 535 for (const auto *Ty : ThrownTypes) { 536 DIE &TT = createAndAddDIE(dwarf::DW_TAG_thrown_type, Die); 537 addType(TT, cast<DIType>(Ty)); 538 } 539 } 540 541 DIE *DwarfUnit::getOrCreateContextDIE(const DIScope *Context) { 542 if (!Context || isa<DIFile>(Context)) 543 return &getUnitDie(); 544 if (auto *T = dyn_cast<DIType>(Context)) 545 return getOrCreateTypeDIE(T); 546 if (auto *NS = dyn_cast<DINamespace>(Context)) 547 return getOrCreateNameSpace(NS); 548 if (auto *SP = dyn_cast<DISubprogram>(Context)) 549 return getOrCreateSubprogramDIE(SP); 550 if (auto *M = dyn_cast<DIModule>(Context)) 551 return getOrCreateModule(M); 552 return getDIE(Context); 553 } 554 555 DIE *DwarfUnit::createTypeDIE(const DICompositeType *Ty) { 556 auto *Context = Ty->getScope(); 557 DIE *ContextDIE = getOrCreateContextDIE(Context); 558 559 if (DIE *TyDIE = getDIE(Ty)) 560 return TyDIE; 561 562 // Create new type. 563 DIE &TyDIE = createAndAddDIE(Ty->getTag(), *ContextDIE, Ty); 564 565 constructTypeDIE(TyDIE, cast<DICompositeType>(Ty)); 566 567 updateAcceleratorTables(Context, Ty, TyDIE); 568 return &TyDIE; 569 } 570 571 DIE *DwarfUnit::createTypeDIE(const DIScope *Context, DIE &ContextDIE, 572 const DIType *Ty) { 573 // Create new type. 574 DIE &TyDIE = createAndAddDIE(Ty->getTag(), ContextDIE, Ty); 575 576 updateAcceleratorTables(Context, Ty, TyDIE); 577 578 if (auto *BT = dyn_cast<DIBasicType>(Ty)) 579 constructTypeDIE(TyDIE, BT); 580 else if (auto *ST = dyn_cast<DIStringType>(Ty)) 581 constructTypeDIE(TyDIE, ST); 582 else if (auto *STy = dyn_cast<DISubroutineType>(Ty)) 583 constructTypeDIE(TyDIE, STy); 584 else if (auto *CTy = dyn_cast<DICompositeType>(Ty)) { 585 if (DD->generateTypeUnits() && !Ty->isForwardDecl() && 586 (Ty->getRawName() || CTy->getRawIdentifier())) { 587 // Skip updating the accelerator tables since this is not the full type. 588 if (MDString *TypeId = CTy->getRawIdentifier()) 589 DD->addDwarfTypeUnitType(getCU(), TypeId->getString(), TyDIE, CTy); 590 else { 591 auto X = DD->enterNonTypeUnitContext(); 592 finishNonUnitTypeDIE(TyDIE, CTy); 593 } 594 return &TyDIE; 595 } 596 constructTypeDIE(TyDIE, CTy); 597 } else { 598 constructTypeDIE(TyDIE, cast<DIDerivedType>(Ty)); 599 } 600 601 return &TyDIE; 602 } 603 604 DIE *DwarfUnit::getOrCreateTypeDIE(const MDNode *TyNode) { 605 if (!TyNode) 606 return nullptr; 607 608 auto *Ty = cast<DIType>(TyNode); 609 610 // DW_TAG_restrict_type is not supported in DWARF2 611 if (Ty->getTag() == dwarf::DW_TAG_restrict_type && DD->getDwarfVersion() <= 2) 612 return getOrCreateTypeDIE(cast<DIDerivedType>(Ty)->getBaseType()); 613 614 // DW_TAG_atomic_type is not supported in DWARF < 5 615 if (Ty->getTag() == dwarf::DW_TAG_atomic_type && DD->getDwarfVersion() < 5) 616 return getOrCreateTypeDIE(cast<DIDerivedType>(Ty)->getBaseType()); 617 618 // Construct the context before querying for the existence of the DIE in case 619 // such construction creates the DIE. 620 auto *Context = Ty->getScope(); 621 DIE *ContextDIE = getOrCreateContextDIE(Context); 622 assert(ContextDIE); 623 624 if (DIE *TyDIE = getDIE(Ty)) 625 return TyDIE; 626 627 return static_cast<DwarfUnit *>(ContextDIE->getUnit()) 628 ->createTypeDIE(Context, *ContextDIE, Ty); 629 } 630 631 void DwarfUnit::updateAcceleratorTables(const DIScope *Context, 632 const DIType *Ty, const DIE &TyDIE) { 633 if (!Ty->getName().empty() && !Ty->isForwardDecl()) { 634 bool IsImplementation = false; 635 if (auto *CT = dyn_cast<DICompositeType>(Ty)) { 636 // A runtime language of 0 actually means C/C++ and that any 637 // non-negative value is some version of Objective-C/C++. 638 IsImplementation = CT->getRuntimeLang() == 0 || CT->isObjcClassComplete(); 639 } 640 unsigned Flags = IsImplementation ? dwarf::DW_FLAG_type_implementation : 0; 641 DD->addAccelType(*CUNode, Ty->getName(), TyDIE, Flags); 642 643 if (!Context || isa<DICompileUnit>(Context) || isa<DIFile>(Context) || 644 isa<DINamespace>(Context) || isa<DICommonBlock>(Context)) 645 addGlobalType(Ty, TyDIE, Context); 646 } 647 } 648 649 void DwarfUnit::addType(DIE &Entity, const DIType *Ty, 650 dwarf::Attribute Attribute) { 651 assert(Ty && "Trying to add a type that doesn't exist?"); 652 addDIEEntry(Entity, Attribute, DIEEntry(*getOrCreateTypeDIE(Ty))); 653 } 654 655 std::string DwarfUnit::getParentContextString(const DIScope *Context) const { 656 if (!Context) 657 return ""; 658 659 // FIXME: Decide whether to implement this for non-C++ languages. 660 if (!dwarf::isCPlusPlus((dwarf::SourceLanguage)getLanguage())) 661 return ""; 662 663 std::string CS; 664 SmallVector<const DIScope *, 1> Parents; 665 while (!isa<DICompileUnit>(Context)) { 666 Parents.push_back(Context); 667 if (const DIScope *S = Context->getScope()) 668 Context = S; 669 else 670 // Structure, etc types will have a NULL context if they're at the top 671 // level. 672 break; 673 } 674 675 // Reverse iterate over our list to go from the outermost construct to the 676 // innermost. 677 for (const DIScope *Ctx : make_range(Parents.rbegin(), Parents.rend())) { 678 StringRef Name = Ctx->getName(); 679 if (Name.empty() && isa<DINamespace>(Ctx)) 680 Name = "(anonymous namespace)"; 681 if (!Name.empty()) { 682 CS += Name; 683 CS += "::"; 684 } 685 } 686 return CS; 687 } 688 689 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIBasicType *BTy) { 690 // Get core information. 691 StringRef Name = BTy->getName(); 692 // Add name if not anonymous or intermediate type. 693 if (!Name.empty()) 694 addString(Buffer, dwarf::DW_AT_name, Name); 695 696 // An unspecified type only has a name attribute. 697 if (BTy->getTag() == dwarf::DW_TAG_unspecified_type) 698 return; 699 700 if (BTy->getTag() != dwarf::DW_TAG_string_type) 701 addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1, 702 BTy->getEncoding()); 703 704 uint64_t Size = BTy->getSizeInBits() >> 3; 705 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size); 706 707 if (BTy->isBigEndian()) 708 addUInt(Buffer, dwarf::DW_AT_endianity, None, dwarf::DW_END_big); 709 else if (BTy->isLittleEndian()) 710 addUInt(Buffer, dwarf::DW_AT_endianity, None, dwarf::DW_END_little); 711 } 712 713 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIStringType *STy) { 714 // Get core information. 715 StringRef Name = STy->getName(); 716 // Add name if not anonymous or intermediate type. 717 if (!Name.empty()) 718 addString(Buffer, dwarf::DW_AT_name, Name); 719 720 if (DIVariable *Var = STy->getStringLength()) { 721 if (auto *VarDIE = getDIE(Var)) 722 addDIEEntry(Buffer, dwarf::DW_AT_string_length, *VarDIE); 723 } else if (DIExpression *Expr = STy->getStringLengthExp()) { 724 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 725 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 726 // This is to describe the memory location of the 727 // length of a Fortran deferred length string, so 728 // lock it down as such. 729 DwarfExpr.setMemoryLocationKind(); 730 DwarfExpr.addExpression(Expr); 731 addBlock(Buffer, dwarf::DW_AT_string_length, DwarfExpr.finalize()); 732 } else { 733 uint64_t Size = STy->getSizeInBits() >> 3; 734 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size); 735 } 736 737 if (STy->getEncoding()) { 738 // For eventual Unicode support. 739 addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1, 740 STy->getEncoding()); 741 } 742 } 743 744 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIDerivedType *DTy) { 745 // Get core information. 746 StringRef Name = DTy->getName(); 747 uint64_t Size = DTy->getSizeInBits() >> 3; 748 uint16_t Tag = Buffer.getTag(); 749 750 // Map to main type, void will not have a type. 751 const DIType *FromTy = DTy->getBaseType(); 752 if (FromTy) 753 addType(Buffer, FromTy); 754 755 // Add name if not anonymous or intermediate type. 756 if (!Name.empty()) 757 addString(Buffer, dwarf::DW_AT_name, Name); 758 759 // If alignment is specified for a typedef , create and insert DW_AT_alignment 760 // attribute in DW_TAG_typedef DIE. 761 if (Tag == dwarf::DW_TAG_typedef && DD->getDwarfVersion() >= 5) { 762 uint32_t AlignInBytes = DTy->getAlignInBytes(); 763 if (AlignInBytes > 0) 764 addUInt(Buffer, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata, 765 AlignInBytes); 766 } 767 768 // Add size if non-zero (derived types might be zero-sized.) 769 if (Size && Tag != dwarf::DW_TAG_pointer_type 770 && Tag != dwarf::DW_TAG_ptr_to_member_type 771 && Tag != dwarf::DW_TAG_reference_type 772 && Tag != dwarf::DW_TAG_rvalue_reference_type) 773 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size); 774 775 if (Tag == dwarf::DW_TAG_ptr_to_member_type) 776 addDIEEntry(Buffer, dwarf::DW_AT_containing_type, 777 *getOrCreateTypeDIE(cast<DIDerivedType>(DTy)->getClassType())); 778 // Add source line info if available and TyDesc is not a forward declaration. 779 if (!DTy->isForwardDecl()) 780 addSourceLine(Buffer, DTy); 781 782 // If DWARF address space value is other than None, add it. The IR 783 // verifier checks that DWARF address space only exists for pointer 784 // or reference types. 785 if (DTy->getDWARFAddressSpace()) 786 addUInt(Buffer, dwarf::DW_AT_address_class, dwarf::DW_FORM_data4, 787 DTy->getDWARFAddressSpace().getValue()); 788 } 789 790 void DwarfUnit::constructSubprogramArguments(DIE &Buffer, DITypeRefArray Args) { 791 for (unsigned i = 1, N = Args.size(); i < N; ++i) { 792 const DIType *Ty = Args[i]; 793 if (!Ty) { 794 assert(i == N-1 && "Unspecified parameter must be the last argument"); 795 createAndAddDIE(dwarf::DW_TAG_unspecified_parameters, Buffer); 796 } else { 797 DIE &Arg = createAndAddDIE(dwarf::DW_TAG_formal_parameter, Buffer); 798 addType(Arg, Ty); 799 if (Ty->isArtificial()) 800 addFlag(Arg, dwarf::DW_AT_artificial); 801 } 802 } 803 } 804 805 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DISubroutineType *CTy) { 806 // Add return type. A void return won't have a type. 807 auto Elements = cast<DISubroutineType>(CTy)->getTypeArray(); 808 if (Elements.size()) 809 if (auto RTy = Elements[0]) 810 addType(Buffer, RTy); 811 812 bool isPrototyped = true; 813 if (Elements.size() == 2 && !Elements[1]) 814 isPrototyped = false; 815 816 constructSubprogramArguments(Buffer, Elements); 817 818 // Add prototype flag if we're dealing with a C language and the function has 819 // been prototyped. 820 uint16_t Language = getLanguage(); 821 if (isPrototyped && 822 (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 || 823 Language == dwarf::DW_LANG_ObjC)) 824 addFlag(Buffer, dwarf::DW_AT_prototyped); 825 826 // Add a DW_AT_calling_convention if this has an explicit convention. 827 if (CTy->getCC() && CTy->getCC() != dwarf::DW_CC_normal) 828 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1, 829 CTy->getCC()); 830 831 if (CTy->isLValueReference()) 832 addFlag(Buffer, dwarf::DW_AT_reference); 833 834 if (CTy->isRValueReference()) 835 addFlag(Buffer, dwarf::DW_AT_rvalue_reference); 836 } 837 838 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DICompositeType *CTy) { 839 // Add name if not anonymous or intermediate type. 840 StringRef Name = CTy->getName(); 841 842 uint64_t Size = CTy->getSizeInBits() >> 3; 843 uint16_t Tag = Buffer.getTag(); 844 845 switch (Tag) { 846 case dwarf::DW_TAG_array_type: 847 constructArrayTypeDIE(Buffer, CTy); 848 break; 849 case dwarf::DW_TAG_enumeration_type: 850 constructEnumTypeDIE(Buffer, CTy); 851 break; 852 case dwarf::DW_TAG_variant_part: 853 case dwarf::DW_TAG_structure_type: 854 case dwarf::DW_TAG_union_type: 855 case dwarf::DW_TAG_class_type: { 856 // Emit the discriminator for a variant part. 857 DIDerivedType *Discriminator = nullptr; 858 if (Tag == dwarf::DW_TAG_variant_part) { 859 Discriminator = CTy->getDiscriminator(); 860 if (Discriminator) { 861 // DWARF says: 862 // If the variant part has a discriminant, the discriminant is 863 // represented by a separate debugging information entry which is 864 // a child of the variant part entry. 865 DIE &DiscMember = constructMemberDIE(Buffer, Discriminator); 866 addDIEEntry(Buffer, dwarf::DW_AT_discr, DiscMember); 867 } 868 } 869 870 // Add template parameters to a class, structure or union types. 871 if (Tag == dwarf::DW_TAG_class_type || 872 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type) 873 addTemplateParams(Buffer, CTy->getTemplateParams()); 874 875 // Add elements to structure type. 876 DINodeArray Elements = CTy->getElements(); 877 for (const auto *Element : Elements) { 878 if (!Element) 879 continue; 880 if (auto *SP = dyn_cast<DISubprogram>(Element)) 881 getOrCreateSubprogramDIE(SP); 882 else if (auto *DDTy = dyn_cast<DIDerivedType>(Element)) { 883 if (DDTy->getTag() == dwarf::DW_TAG_friend) { 884 DIE &ElemDie = createAndAddDIE(dwarf::DW_TAG_friend, Buffer); 885 addType(ElemDie, DDTy->getBaseType(), dwarf::DW_AT_friend); 886 } else if (DDTy->isStaticMember()) { 887 getOrCreateStaticMemberDIE(DDTy); 888 } else if (Tag == dwarf::DW_TAG_variant_part) { 889 // When emitting a variant part, wrap each member in 890 // DW_TAG_variant. 891 DIE &Variant = createAndAddDIE(dwarf::DW_TAG_variant, Buffer); 892 if (const ConstantInt *CI = 893 dyn_cast_or_null<ConstantInt>(DDTy->getDiscriminantValue())) { 894 if (DD->isUnsignedDIType(Discriminator->getBaseType())) 895 addUInt(Variant, dwarf::DW_AT_discr_value, None, CI->getZExtValue()); 896 else 897 addSInt(Variant, dwarf::DW_AT_discr_value, None, CI->getSExtValue()); 898 } 899 constructMemberDIE(Variant, DDTy); 900 } else { 901 constructMemberDIE(Buffer, DDTy); 902 } 903 } else if (auto *Property = dyn_cast<DIObjCProperty>(Element)) { 904 DIE &ElemDie = createAndAddDIE(Property->getTag(), Buffer); 905 StringRef PropertyName = Property->getName(); 906 addString(ElemDie, dwarf::DW_AT_APPLE_property_name, PropertyName); 907 if (Property->getType()) 908 addType(ElemDie, Property->getType()); 909 addSourceLine(ElemDie, Property); 910 StringRef GetterName = Property->getGetterName(); 911 if (!GetterName.empty()) 912 addString(ElemDie, dwarf::DW_AT_APPLE_property_getter, GetterName); 913 StringRef SetterName = Property->getSetterName(); 914 if (!SetterName.empty()) 915 addString(ElemDie, dwarf::DW_AT_APPLE_property_setter, SetterName); 916 if (unsigned PropertyAttributes = Property->getAttributes()) 917 addUInt(ElemDie, dwarf::DW_AT_APPLE_property_attribute, None, 918 PropertyAttributes); 919 } else if (auto *Composite = dyn_cast<DICompositeType>(Element)) { 920 if (Composite->getTag() == dwarf::DW_TAG_variant_part) { 921 DIE &VariantPart = createAndAddDIE(Composite->getTag(), Buffer); 922 constructTypeDIE(VariantPart, Composite); 923 } 924 } 925 } 926 927 if (CTy->isAppleBlockExtension()) 928 addFlag(Buffer, dwarf::DW_AT_APPLE_block); 929 930 if (CTy->getExportSymbols()) 931 addFlag(Buffer, dwarf::DW_AT_export_symbols); 932 933 // This is outside the DWARF spec, but GDB expects a DW_AT_containing_type 934 // inside C++ composite types to point to the base class with the vtable. 935 // Rust uses DW_AT_containing_type to link a vtable to the type 936 // for which it was created. 937 if (auto *ContainingType = CTy->getVTableHolder()) 938 addDIEEntry(Buffer, dwarf::DW_AT_containing_type, 939 *getOrCreateTypeDIE(ContainingType)); 940 941 if (CTy->isObjcClassComplete()) 942 addFlag(Buffer, dwarf::DW_AT_APPLE_objc_complete_type); 943 944 // Add the type's non-standard calling convention. 945 uint8_t CC = 0; 946 if (CTy->isTypePassByValue()) 947 CC = dwarf::DW_CC_pass_by_value; 948 else if (CTy->isTypePassByReference()) 949 CC = dwarf::DW_CC_pass_by_reference; 950 if (CC) 951 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1, 952 CC); 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 int64_t Count = -1; 1314 if (auto *CI = SR->getCount().dyn_cast<ConstantInt*>()) 1315 Count = CI->getSExtValue(); 1316 1317 auto AddBoundTypeEntry = [&](dwarf::Attribute Attr, 1318 DISubrange::BoundType Bound) -> void { 1319 if (auto *BV = Bound.dyn_cast<DIVariable *>()) { 1320 if (auto *VarDIE = getDIE(BV)) 1321 addDIEEntry(DW_Subrange, Attr, *VarDIE); 1322 } else if (auto *BE = Bound.dyn_cast<DIExpression *>()) { 1323 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 1324 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 1325 DwarfExpr.setMemoryLocationKind(); 1326 DwarfExpr.addExpression(BE); 1327 addBlock(DW_Subrange, Attr, DwarfExpr.finalize()); 1328 } else if (auto *BI = Bound.dyn_cast<ConstantInt *>()) { 1329 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 if (auto *CV = SR->getCount().dyn_cast<DIVariable*>()) { 1338 if (auto *CountVarDIE = getDIE(CV)) 1339 addDIEEntry(DW_Subrange, dwarf::DW_AT_count, *CountVarDIE); 1340 } else if (Count != -1) 1341 addUInt(DW_Subrange, dwarf::DW_AT_count, None, Count); 1342 1343 AddBoundTypeEntry(dwarf::DW_AT_upper_bound, SR->getUpperBound()); 1344 1345 AddBoundTypeEntry(dwarf::DW_AT_byte_stride, SR->getStride()); 1346 } 1347 1348 void DwarfUnit::constructGenericSubrangeDIE(DIE &Buffer, 1349 const DIGenericSubrange *GSR, 1350 DIE *IndexTy) { 1351 DIE &DwGenericSubrange = 1352 createAndAddDIE(dwarf::DW_TAG_generic_subrange, Buffer); 1353 addDIEEntry(DwGenericSubrange, dwarf::DW_AT_type, *IndexTy); 1354 1355 int64_t DefaultLowerBound = getDefaultLowerBound(); 1356 1357 auto AddBoundTypeEntry = [&](dwarf::Attribute Attr, 1358 DIGenericSubrange::BoundType Bound) -> void { 1359 if (auto *BV = Bound.dyn_cast<DIVariable *>()) { 1360 if (auto *VarDIE = getDIE(BV)) 1361 addDIEEntry(DwGenericSubrange, Attr, *VarDIE); 1362 } else if (auto *BE = Bound.dyn_cast<DIExpression *>()) { 1363 if (BE->isSignedConstant()) { 1364 if (Attr != dwarf::DW_AT_lower_bound || DefaultLowerBound == -1 || 1365 static_cast<int64_t>(BE->getElement(1)) != DefaultLowerBound) 1366 addSInt(DwGenericSubrange, Attr, dwarf::DW_FORM_sdata, 1367 BE->getElement(1)); 1368 } else { 1369 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 1370 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 1371 DwarfExpr.setMemoryLocationKind(); 1372 DwarfExpr.addExpression(BE); 1373 addBlock(DwGenericSubrange, Attr, DwarfExpr.finalize()); 1374 } 1375 } 1376 }; 1377 1378 AddBoundTypeEntry(dwarf::DW_AT_lower_bound, GSR->getLowerBound()); 1379 AddBoundTypeEntry(dwarf::DW_AT_count, GSR->getCount()); 1380 AddBoundTypeEntry(dwarf::DW_AT_upper_bound, GSR->getUpperBound()); 1381 AddBoundTypeEntry(dwarf::DW_AT_byte_stride, GSR->getStride()); 1382 } 1383 1384 DIE *DwarfUnit::getIndexTyDie() { 1385 if (IndexTyDie) 1386 return IndexTyDie; 1387 // Construct an integer type to use for indexes. 1388 IndexTyDie = &createAndAddDIE(dwarf::DW_TAG_base_type, getUnitDie()); 1389 StringRef Name = "__ARRAY_SIZE_TYPE__"; 1390 addString(*IndexTyDie, dwarf::DW_AT_name, Name); 1391 addUInt(*IndexTyDie, dwarf::DW_AT_byte_size, None, sizeof(int64_t)); 1392 addUInt(*IndexTyDie, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1, 1393 dwarf::DW_ATE_unsigned); 1394 DD->addAccelType(*CUNode, Name, *IndexTyDie, /*Flags*/ 0); 1395 return IndexTyDie; 1396 } 1397 1398 /// Returns true if the vector's size differs from the sum of sizes of elements 1399 /// the user specified. This can occur if the vector has been rounded up to 1400 /// fit memory alignment constraints. 1401 static bool hasVectorBeenPadded(const DICompositeType *CTy) { 1402 assert(CTy && CTy->isVector() && "Composite type is not a vector"); 1403 const uint64_t ActualSize = CTy->getSizeInBits(); 1404 1405 // Obtain the size of each element in the vector. 1406 DIType *BaseTy = CTy->getBaseType(); 1407 assert(BaseTy && "Unknown vector element type."); 1408 const uint64_t ElementSize = BaseTy->getSizeInBits(); 1409 1410 // Locate the number of elements in the vector. 1411 const DINodeArray Elements = CTy->getElements(); 1412 assert(Elements.size() == 1 && 1413 Elements[0]->getTag() == dwarf::DW_TAG_subrange_type && 1414 "Invalid vector element array, expected one element of type subrange"); 1415 const auto Subrange = cast<DISubrange>(Elements[0]); 1416 const auto NumVecElements = 1417 Subrange->getCount() 1418 ? Subrange->getCount().get<ConstantInt *>()->getSExtValue() 1419 : 0; 1420 1421 // Ensure we found the element count and that the actual size is wide 1422 // enough to contain the requested size. 1423 assert(ActualSize >= (NumVecElements * ElementSize) && "Invalid vector size"); 1424 return ActualSize != (NumVecElements * ElementSize); 1425 } 1426 1427 void DwarfUnit::constructArrayTypeDIE(DIE &Buffer, const DICompositeType *CTy) { 1428 if (CTy->isVector()) { 1429 addFlag(Buffer, dwarf::DW_AT_GNU_vector); 1430 if (hasVectorBeenPadded(CTy)) 1431 addUInt(Buffer, dwarf::DW_AT_byte_size, None, 1432 CTy->getSizeInBits() / CHAR_BIT); 1433 } 1434 1435 if (DIVariable *Var = CTy->getDataLocation()) { 1436 if (auto *VarDIE = getDIE(Var)) 1437 addDIEEntry(Buffer, dwarf::DW_AT_data_location, *VarDIE); 1438 } else if (DIExpression *Expr = CTy->getDataLocationExp()) { 1439 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 1440 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 1441 DwarfExpr.setMemoryLocationKind(); 1442 DwarfExpr.addExpression(Expr); 1443 addBlock(Buffer, dwarf::DW_AT_data_location, DwarfExpr.finalize()); 1444 } 1445 1446 if (DIVariable *Var = CTy->getAssociated()) { 1447 if (auto *VarDIE = getDIE(Var)) 1448 addDIEEntry(Buffer, dwarf::DW_AT_associated, *VarDIE); 1449 } else if (DIExpression *Expr = CTy->getAssociatedExp()) { 1450 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 1451 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 1452 DwarfExpr.setMemoryLocationKind(); 1453 DwarfExpr.addExpression(Expr); 1454 addBlock(Buffer, dwarf::DW_AT_associated, DwarfExpr.finalize()); 1455 } 1456 1457 if (DIVariable *Var = CTy->getAllocated()) { 1458 if (auto *VarDIE = getDIE(Var)) 1459 addDIEEntry(Buffer, dwarf::DW_AT_allocated, *VarDIE); 1460 } else if (DIExpression *Expr = CTy->getAllocatedExp()) { 1461 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 1462 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 1463 DwarfExpr.setMemoryLocationKind(); 1464 DwarfExpr.addExpression(Expr); 1465 addBlock(Buffer, dwarf::DW_AT_allocated, DwarfExpr.finalize()); 1466 } 1467 1468 if (auto *RankConst = CTy->getRankConst()) { 1469 addSInt(Buffer, dwarf::DW_AT_rank, dwarf::DW_FORM_sdata, 1470 RankConst->getSExtValue()); 1471 } else if (auto *RankExpr = CTy->getRankExp()) { 1472 DIELoc *Loc = new (DIEValueAllocator) DIELoc; 1473 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc); 1474 DwarfExpr.setMemoryLocationKind(); 1475 DwarfExpr.addExpression(RankExpr); 1476 addBlock(Buffer, dwarf::DW_AT_rank, DwarfExpr.finalize()); 1477 } 1478 1479 // Emit the element type. 1480 addType(Buffer, CTy->getBaseType()); 1481 1482 // Get an anonymous type for index type. 1483 // FIXME: This type should be passed down from the front end 1484 // as different languages may have different sizes for indexes. 1485 DIE *IdxTy = getIndexTyDie(); 1486 1487 // Add subranges to array type. 1488 DINodeArray Elements = CTy->getElements(); 1489 for (unsigned i = 0, N = Elements.size(); i < N; ++i) { 1490 // FIXME: Should this really be such a loose cast? 1491 if (auto *Element = dyn_cast_or_null<DINode>(Elements[i])) { 1492 if (Element->getTag() == dwarf::DW_TAG_subrange_type) 1493 constructSubrangeDIE(Buffer, cast<DISubrange>(Element), IdxTy); 1494 else if (Element->getTag() == dwarf::DW_TAG_generic_subrange) 1495 constructGenericSubrangeDIE(Buffer, cast<DIGenericSubrange>(Element), 1496 IdxTy); 1497 } 1498 } 1499 } 1500 1501 void DwarfUnit::constructEnumTypeDIE(DIE &Buffer, const DICompositeType *CTy) { 1502 const DIType *DTy = CTy->getBaseType(); 1503 bool IsUnsigned = DTy && DD->isUnsignedDIType(DTy); 1504 if (DTy) { 1505 if (DD->getDwarfVersion() >= 3) 1506 addType(Buffer, DTy); 1507 if (DD->getDwarfVersion() >= 4 && (CTy->getFlags() & DINode::FlagEnumClass)) 1508 addFlag(Buffer, dwarf::DW_AT_enum_class); 1509 } 1510 1511 auto *Context = CTy->getScope(); 1512 bool IndexEnumerators = !Context || isa<DICompileUnit>(Context) || isa<DIFile>(Context) || 1513 isa<DINamespace>(Context) || isa<DICommonBlock>(Context); 1514 DINodeArray Elements = CTy->getElements(); 1515 1516 // Add enumerators to enumeration type. 1517 for (unsigned i = 0, N = Elements.size(); i < N; ++i) { 1518 auto *Enum = dyn_cast_or_null<DIEnumerator>(Elements[i]); 1519 if (Enum) { 1520 DIE &Enumerator = createAndAddDIE(dwarf::DW_TAG_enumerator, Buffer); 1521 StringRef Name = Enum->getName(); 1522 addString(Enumerator, dwarf::DW_AT_name, Name); 1523 addConstantValue(Enumerator, Enum->getValue(), IsUnsigned); 1524 if (IndexEnumerators) 1525 addGlobalName(Name, Enumerator, Context); 1526 } 1527 } 1528 } 1529 1530 void DwarfUnit::constructContainingTypeDIEs() { 1531 for (auto CI = ContainingTypeMap.begin(), CE = ContainingTypeMap.end(); 1532 CI != CE; ++CI) { 1533 DIE &SPDie = *CI->first; 1534 const DINode *D = CI->second; 1535 if (!D) 1536 continue; 1537 DIE *NDie = getDIE(D); 1538 if (!NDie) 1539 continue; 1540 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, *NDie); 1541 } 1542 } 1543 1544 DIE &DwarfUnit::constructMemberDIE(DIE &Buffer, const DIDerivedType *DT) { 1545 DIE &MemberDie = createAndAddDIE(DT->getTag(), Buffer); 1546 StringRef Name = DT->getName(); 1547 if (!Name.empty()) 1548 addString(MemberDie, dwarf::DW_AT_name, Name); 1549 1550 if (DIType *Resolved = DT->getBaseType()) 1551 addType(MemberDie, Resolved); 1552 1553 addSourceLine(MemberDie, DT); 1554 1555 if (DT->getTag() == dwarf::DW_TAG_inheritance && DT->isVirtual()) { 1556 1557 // For C++, virtual base classes are not at fixed offset. Use following 1558 // expression to extract appropriate offset from vtable. 1559 // BaseAddr = ObAddr + *((*ObAddr) - Offset) 1560 1561 DIELoc *VBaseLocationDie = new (DIEValueAllocator) DIELoc; 1562 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_dup); 1563 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref); 1564 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_constu); 1565 addUInt(*VBaseLocationDie, dwarf::DW_FORM_udata, DT->getOffsetInBits()); 1566 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_minus); 1567 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref); 1568 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus); 1569 1570 addBlock(MemberDie, dwarf::DW_AT_data_member_location, VBaseLocationDie); 1571 } else { 1572 uint64_t Size = DT->getSizeInBits(); 1573 uint64_t FieldSize = DD->getBaseTypeSize(DT); 1574 uint32_t AlignInBytes = DT->getAlignInBytes(); 1575 uint64_t OffsetInBytes; 1576 1577 bool IsBitfield = FieldSize && Size != FieldSize; 1578 if (IsBitfield) { 1579 // Handle bitfield, assume bytes are 8 bits. 1580 if (DD->useDWARF2Bitfields()) 1581 addUInt(MemberDie, dwarf::DW_AT_byte_size, None, FieldSize/8); 1582 addUInt(MemberDie, dwarf::DW_AT_bit_size, None, Size); 1583 1584 uint64_t Offset = DT->getOffsetInBits(); 1585 // We can't use DT->getAlignInBits() here: AlignInBits for member type 1586 // is non-zero if and only if alignment was forced (e.g. _Alignas()), 1587 // which can't be done with bitfields. Thus we use FieldSize here. 1588 uint32_t AlignInBits = FieldSize; 1589 uint32_t AlignMask = ~(AlignInBits - 1); 1590 // The bits from the start of the storage unit to the start of the field. 1591 uint64_t StartBitOffset = Offset - (Offset & AlignMask); 1592 // The byte offset of the field's aligned storage unit inside the struct. 1593 OffsetInBytes = (Offset - StartBitOffset) / 8; 1594 1595 if (DD->useDWARF2Bitfields()) { 1596 uint64_t HiMark = (Offset + FieldSize) & AlignMask; 1597 uint64_t FieldOffset = (HiMark - FieldSize); 1598 Offset -= FieldOffset; 1599 1600 // Maybe we need to work from the other end. 1601 if (Asm->getDataLayout().isLittleEndian()) 1602 Offset = FieldSize - (Offset + Size); 1603 1604 addUInt(MemberDie, dwarf::DW_AT_bit_offset, None, Offset); 1605 OffsetInBytes = FieldOffset >> 3; 1606 } else { 1607 addUInt(MemberDie, dwarf::DW_AT_data_bit_offset, None, Offset); 1608 } 1609 } else { 1610 // This is not a bitfield. 1611 OffsetInBytes = DT->getOffsetInBits() / 8; 1612 if (AlignInBytes) 1613 addUInt(MemberDie, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata, 1614 AlignInBytes); 1615 } 1616 1617 if (DD->getDwarfVersion() <= 2) { 1618 DIELoc *MemLocationDie = new (DIEValueAllocator) DIELoc; 1619 addUInt(*MemLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst); 1620 addUInt(*MemLocationDie, dwarf::DW_FORM_udata, OffsetInBytes); 1621 addBlock(MemberDie, dwarf::DW_AT_data_member_location, MemLocationDie); 1622 } else if (!IsBitfield || DD->useDWARF2Bitfields()) 1623 addUInt(MemberDie, dwarf::DW_AT_data_member_location, None, 1624 OffsetInBytes); 1625 } 1626 1627 if (DT->isProtected()) 1628 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1629 dwarf::DW_ACCESS_protected); 1630 else if (DT->isPrivate()) 1631 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1632 dwarf::DW_ACCESS_private); 1633 // Otherwise C++ member and base classes are considered public. 1634 else if (DT->isPublic()) 1635 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1636 dwarf::DW_ACCESS_public); 1637 if (DT->isVirtual()) 1638 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, 1639 dwarf::DW_VIRTUALITY_virtual); 1640 1641 // Objective-C properties. 1642 if (DINode *PNode = DT->getObjCProperty()) 1643 if (DIE *PDie = getDIE(PNode)) 1644 MemberDie.addValue(DIEValueAllocator, dwarf::DW_AT_APPLE_property, 1645 dwarf::DW_FORM_ref4, DIEEntry(*PDie)); 1646 1647 if (DT->isArtificial()) 1648 addFlag(MemberDie, dwarf::DW_AT_artificial); 1649 1650 return MemberDie; 1651 } 1652 1653 DIE *DwarfUnit::getOrCreateStaticMemberDIE(const DIDerivedType *DT) { 1654 if (!DT) 1655 return nullptr; 1656 1657 // Construct the context before querying for the existence of the DIE in case 1658 // such construction creates the DIE. 1659 DIE *ContextDIE = getOrCreateContextDIE(DT->getScope()); 1660 assert(dwarf::isType(ContextDIE->getTag()) && 1661 "Static member should belong to a type."); 1662 1663 if (DIE *StaticMemberDIE = getDIE(DT)) 1664 return StaticMemberDIE; 1665 1666 DIE &StaticMemberDIE = createAndAddDIE(DT->getTag(), *ContextDIE, DT); 1667 1668 const DIType *Ty = DT->getBaseType(); 1669 1670 addString(StaticMemberDIE, dwarf::DW_AT_name, DT->getName()); 1671 addType(StaticMemberDIE, Ty); 1672 addSourceLine(StaticMemberDIE, DT); 1673 addFlag(StaticMemberDIE, dwarf::DW_AT_external); 1674 addFlag(StaticMemberDIE, dwarf::DW_AT_declaration); 1675 1676 // FIXME: We could omit private if the parent is a class_type, and 1677 // public if the parent is something else. 1678 if (DT->isProtected()) 1679 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1680 dwarf::DW_ACCESS_protected); 1681 else if (DT->isPrivate()) 1682 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1683 dwarf::DW_ACCESS_private); 1684 else if (DT->isPublic()) 1685 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1, 1686 dwarf::DW_ACCESS_public); 1687 1688 if (const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(DT->getConstant())) 1689 addConstantValue(StaticMemberDIE, CI, Ty); 1690 if (const ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(DT->getConstant())) 1691 addConstantFPValue(StaticMemberDIE, CFP); 1692 1693 if (uint32_t AlignInBytes = DT->getAlignInBytes()) 1694 addUInt(StaticMemberDIE, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata, 1695 AlignInBytes); 1696 1697 return &StaticMemberDIE; 1698 } 1699 1700 void DwarfUnit::emitCommonHeader(bool UseOffsets, dwarf::UnitType UT) { 1701 // Emit size of content not including length itself 1702 if (!DD->useSectionsAsReferences()) { 1703 StringRef Prefix = isDwoUnit() ? "debug_info_dwo_" : "debug_info_"; 1704 MCSymbol *BeginLabel = Asm->createTempSymbol(Prefix + "start"); 1705 EndLabel = Asm->createTempSymbol(Prefix + "end"); 1706 Asm->emitDwarfUnitLength(EndLabel, BeginLabel, "Length of Unit"); 1707 Asm->OutStreamer->emitLabel(BeginLabel); 1708 } else 1709 Asm->emitDwarfUnitLength(getHeaderSize() + getUnitDie().getSize(), 1710 "Length of Unit"); 1711 1712 Asm->OutStreamer->AddComment("DWARF version number"); 1713 unsigned Version = DD->getDwarfVersion(); 1714 Asm->emitInt16(Version); 1715 1716 // DWARF v5 reorders the address size and adds a unit type. 1717 if (Version >= 5) { 1718 Asm->OutStreamer->AddComment("DWARF Unit Type"); 1719 Asm->emitInt8(UT); 1720 Asm->OutStreamer->AddComment("Address Size (in bytes)"); 1721 Asm->emitInt8(Asm->MAI->getCodePointerSize()); 1722 } 1723 1724 // We share one abbreviations table across all units so it's always at the 1725 // start of the section. Use a relocatable offset where needed to ensure 1726 // linking doesn't invalidate that offset. 1727 Asm->OutStreamer->AddComment("Offset Into Abbrev. Section"); 1728 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering(); 1729 if (UseOffsets) 1730 Asm->emitDwarfLengthOrOffset(0); 1731 else 1732 Asm->emitDwarfSymbolReference( 1733 TLOF.getDwarfAbbrevSection()->getBeginSymbol(), false); 1734 1735 if (Version <= 4) { 1736 Asm->OutStreamer->AddComment("Address Size (in bytes)"); 1737 Asm->emitInt8(Asm->MAI->getCodePointerSize()); 1738 } 1739 } 1740 1741 void DwarfTypeUnit::emitHeader(bool UseOffsets) { 1742 DwarfUnit::emitCommonHeader(UseOffsets, 1743 DD->useSplitDwarf() ? dwarf::DW_UT_split_type 1744 : dwarf::DW_UT_type); 1745 Asm->OutStreamer->AddComment("Type Signature"); 1746 Asm->OutStreamer->emitIntValue(TypeSignature, sizeof(TypeSignature)); 1747 Asm->OutStreamer->AddComment("Type DIE Offset"); 1748 // In a skeleton type unit there is no type DIE so emit a zero offset. 1749 Asm->emitDwarfLengthOrOffset(Ty ? Ty->getOffset() : 0); 1750 } 1751 1752 DIE::value_iterator 1753 DwarfUnit::addSectionDelta(DIE &Die, dwarf::Attribute Attribute, 1754 const MCSymbol *Hi, const MCSymbol *Lo) { 1755 return Die.addValue(DIEValueAllocator, Attribute, 1756 DD->getDwarfSectionOffsetForm(), 1757 new (DIEValueAllocator) DIEDelta(Hi, Lo)); 1758 } 1759 1760 DIE::value_iterator 1761 DwarfUnit::addSectionLabel(DIE &Die, dwarf::Attribute Attribute, 1762 const MCSymbol *Label, const MCSymbol *Sec) { 1763 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) 1764 return addLabel(Die, Attribute, DD->getDwarfSectionOffsetForm(), Label); 1765 return addSectionDelta(Die, Attribute, Label, Sec); 1766 } 1767 1768 bool DwarfTypeUnit::isDwoUnit() const { 1769 // Since there are no skeleton type units, all type units are dwo type units 1770 // when split DWARF is being used. 1771 return DD->useSplitDwarf(); 1772 } 1773 1774 void DwarfTypeUnit::addGlobalName(StringRef Name, const DIE &Die, 1775 const DIScope *Context) { 1776 getCU().addGlobalNameForTypeUnit(Name, Context); 1777 } 1778 1779 void DwarfTypeUnit::addGlobalType(const DIType *Ty, const DIE &Die, 1780 const DIScope *Context) { 1781 getCU().addGlobalTypeUnitType(Ty, Context); 1782 } 1783 1784 const MCSymbol *DwarfUnit::getCrossSectionRelativeBaseAddress() const { 1785 if (!Asm->MAI->doesDwarfUseRelocationsAcrossSections()) 1786 return nullptr; 1787 if (isDwoUnit()) 1788 return nullptr; 1789 return getSection()->getBeginSymbol(); 1790 } 1791 1792 void DwarfUnit::addStringOffsetsStart() { 1793 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering(); 1794 addSectionLabel(getUnitDie(), dwarf::DW_AT_str_offsets_base, 1795 DU->getStringOffsetsStartSym(), 1796 TLOF.getDwarfStrOffSection()->getBeginSymbol()); 1797 } 1798 1799 void DwarfUnit::addRnglistsBase() { 1800 assert(DD->getDwarfVersion() >= 5 && 1801 "DW_AT_rnglists_base requires DWARF version 5 or later"); 1802 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering(); 1803 addSectionLabel(getUnitDie(), dwarf::DW_AT_rnglists_base, 1804 DU->getRnglistsTableBaseSym(), 1805 TLOF.getDwarfRnglistsSection()->getBeginSymbol()); 1806 } 1807 1808 void DwarfTypeUnit::finishNonUnitTypeDIE(DIE& D, const DICompositeType *CTy) { 1809 addFlag(D, dwarf::DW_AT_declaration); 1810 StringRef Name = CTy->getName(); 1811 if (!Name.empty()) 1812 addString(D, dwarf::DW_AT_name, Name); 1813 getCU().createTypeDIE(CTy); 1814 } 1815