lib/DebugInfo/DWARFContext.cpp

   1 //===-- DWARFContext.cpp --------------------------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "DWARFContext.h"
  11 #include "DWARFDebugArangeSet.h"
  12
  13 #include "llvm/ADT/SmallString.h"
  14 #include "llvm/ADT/StringSwitch.h"
  15 #include "llvm/Support/Compression.h"
  16 #include "llvm/Support/Dwarf.h"
  17 #include "llvm/Support/Format.h"
  18 #include "llvm/Support/Path.h"
  19 #include "llvm/Support/raw_ostream.h"
  20 #include <algorithm>
  21 using namespace llvm;
  22 using namespace dwarf;
  23 using namespace object;
  24
  25 #define DEBUG_TYPE "dwarf"
  26
  27 typedef DWARFDebugLine::LineTable DWARFLineTable;
  28
  29 static void dumpPubSection(raw_ostream &OS, StringRef Name, StringRef Data,
  30                            bool LittleEndian, bool GnuStyle) {
  31   OS << "\n." << Name << " contents:\n";
  32   DataExtractor pubNames(Data, LittleEndian, 0);
  33   uint32_t offset = 0;
  34   while (pubNames.isValidOffset(offset)) {
  35     OS << "length = " << format("0x%08x", pubNames.getU32(&offset));
  36     OS << " version = " << format("0x%04x", pubNames.getU16(&offset));
  37     OS << " unit_offset = " << format("0x%08x", pubNames.getU32(&offset));
  38     OS << " unit_size = " << format("0x%08x", pubNames.getU32(&offset)) << '\n';
  39     if (GnuStyle)
  40       OS << "Offset     Linkage  Kind     Name\n";
  41     else
  42       OS << "Offset     Name\n";
  43
  44     while (offset < Data.size()) {
  45       uint32_t dieRef = pubNames.getU32(&offset);
  46       if (dieRef == 0)
  47         break;
  48       OS << format("0x%8.8x ", dieRef);
  49       if (GnuStyle) {
  50         PubIndexEntryDescriptor desc(pubNames.getU8(&offset));
  51         OS << format("%-8s", dwarf::GDBIndexEntryLinkageString(desc.Linkage))
  52            << ' ' << format("%-8s", dwarf::GDBIndexEntryKindString(desc.Kind))
  53            << ' ';
  54       }
  55       OS << '\"' << pubNames.getCStr(&offset) << "\"\n";
  56     }
  57   }
  58 }
  59
  60 void DWARFContext::dump(raw_ostream &OS, DIDumpType DumpType) {
  61   if (DumpType == DIDT_All || DumpType == DIDT_Abbrev) {
  62     OS << ".debug_abbrev contents:\n";
  63     getDebugAbbrev()->dump(OS);
  64   }
  65
  66   if (DumpType == DIDT_All || DumpType == DIDT_AbbrevDwo)
  67     if (const DWARFDebugAbbrev *D = getDebugAbbrevDWO()) {
  68       OS << "\n.debug_abbrev.dwo contents:\n";
  69       D->dump(OS);
  70     }
  71
  72   if (DumpType == DIDT_All || DumpType == DIDT_Info) {
  73     OS << "\n.debug_info contents:\n";
  74     for (const auto &CU : compile_units())
  75       CU->dump(OS);
  76   }
  77
  78   if ((DumpType == DIDT_All || DumpType == DIDT_InfoDwo) &&
  79       getNumDWOCompileUnits()) {
  80     OS << "\n.debug_info.dwo contents:\n";
  81     for (const auto &DWOCU : dwo_compile_units())
  82       DWOCU->dump(OS);
  83   }
  84
  85   if ((DumpType == DIDT_All || DumpType == DIDT_Types) && getNumTypeUnits()) {
  86     OS << "\n.debug_types contents:\n";
  87     for (const auto &TU : type_units())
  88       TU->dump(OS);
  89   }
  90
  91   if ((DumpType == DIDT_All || DumpType == DIDT_TypesDwo) &&
  92       getNumDWOTypeUnits()) {
  93     OS << "\n.debug_types.dwo contents:\n";
  94     for (const auto &DWOTU : dwo_type_units())
  95       DWOTU->dump(OS);
  96   }
  97
  98   if (DumpType == DIDT_All || DumpType == DIDT_Loc) {
  99     OS << "\n.debug_loc contents:\n";
 100     getDebugLoc()->dump(OS);
 101   }
 102
 103   if (DumpType == DIDT_All || DumpType == DIDT_LocDwo) {
 104     OS << "\n.debug_loc.dwo contents:\n";
 105     getDebugLocDWO()->dump(OS);
 106   }
 107
 108   if (DumpType == DIDT_All || DumpType == DIDT_Frames) {
 109     OS << "\n.debug_frame contents:\n";
 110     getDebugFrame()->dump(OS);
 111   }
 112
 113   uint32_t offset = 0;
 114   if (DumpType == DIDT_All || DumpType == DIDT_Aranges) {
 115     OS << "\n.debug_aranges contents:\n";
 116     DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
 117     DWARFDebugArangeSet set;
 118     while (set.extract(arangesData, &offset))
 119       set.dump(OS);
 120   }
 121
 122   uint8_t savedAddressByteSize = 0;
 123   if (DumpType == DIDT_All || DumpType == DIDT_Line) {
 124     OS << "\n.debug_line contents:\n";
 125     for (const auto &CU : compile_units()) {
 126       savedAddressByteSize = CU->getAddressByteSize();
 127       unsigned stmtOffset =
 128           CU->getCompileUnitDIE()->getAttributeValueAsSectionOffset(
 129               CU.get(), DW_AT_stmt_list, -1U);
 130       if (stmtOffset != -1U) {
 131         DataExtractor lineData(getLineSection().Data, isLittleEndian(),
 132                                savedAddressByteSize);
 133         DWARFDebugLine::LineTable LineTable;
 134         LineTable.parse(lineData, &getLineSection().Relocs, &stmtOffset);
 135         LineTable.dump(OS);
 136       }
 137     }
 138   }
 139
 140   if (DumpType == DIDT_All || DumpType == DIDT_LineDwo) {
 141     OS << "\n.debug_line.dwo contents:\n";
 142     unsigned stmtOffset = 0;
 143     DataExtractor lineData(getLineDWOSection().Data, isLittleEndian(),
 144                            savedAddressByteSize);
 145     DWARFDebugLine::LineTable LineTable;
 146     while (LineTable.Prologue.parse(lineData, &stmtOffset)) {
 147       LineTable.dump(OS);
 148       LineTable.clear();
 149     }
 150   }
 151
 152   if (DumpType == DIDT_All || DumpType == DIDT_Str) {
 153     OS << "\n.debug_str contents:\n";
 154     DataExtractor strData(getStringSection(), isLittleEndian(), 0);
 155     offset = 0;
 156     uint32_t strOffset = 0;
 157     while (const char *s = strData.getCStr(&offset)) {
 158       OS << format("0x%8.8x: \"%s\"\n", strOffset, s);
 159       strOffset = offset;
 160     }
 161   }
 162
 163   if ((DumpType == DIDT_All || DumpType == DIDT_StrDwo) &&
 164       !getStringDWOSection().empty()) {
 165     OS << "\n.debug_str.dwo contents:\n";
 166     DataExtractor strDWOData(getStringDWOSection(), isLittleEndian(), 0);
 167     offset = 0;
 168     uint32_t strDWOOffset = 0;
 169     while (const char *s = strDWOData.getCStr(&offset)) {
 170       OS << format("0x%8.8x: \"%s\"\n", strDWOOffset, s);
 171       strDWOOffset = offset;
 172     }
 173   }
 174
 175   if (DumpType == DIDT_All || DumpType == DIDT_Ranges) {
 176     OS << "\n.debug_ranges contents:\n";
 177     // In fact, different compile units may have different address byte
 178     // sizes, but for simplicity we just use the address byte size of the last
 179     // compile unit (there is no easy and fast way to associate address range
 180     // list and the compile unit it describes).
 181     DataExtractor rangesData(getRangeSection(), isLittleEndian(),
 182                              savedAddressByteSize);
 183     offset = 0;
 184     DWARFDebugRangeList rangeList;
 185     while (rangeList.extract(rangesData, &offset))
 186       rangeList.dump(OS);
 187   }
 188
 189   if (DumpType == DIDT_All || DumpType == DIDT_Pubnames)
 190     dumpPubSection(OS, "debug_pubnames", getPubNamesSection(),
 191                    isLittleEndian(), false);
 192
 193   if (DumpType == DIDT_All || DumpType == DIDT_Pubtypes)
 194     dumpPubSection(OS, "debug_pubtypes", getPubTypesSection(),
 195                    isLittleEndian(), false);
 196
 197   if (DumpType == DIDT_All || DumpType == DIDT_GnuPubnames)
 198     dumpPubSection(OS, "debug_gnu_pubnames", getGnuPubNamesSection(),
 199                    isLittleEndian(), true /* GnuStyle */);
 200
 201   if (DumpType == DIDT_All || DumpType == DIDT_GnuPubtypes)
 202     dumpPubSection(OS, "debug_gnu_pubtypes", getGnuPubTypesSection(),
 203                    isLittleEndian(), true /* GnuStyle */);
 204
 205   if ((DumpType == DIDT_All || DumpType == DIDT_StrOffsetsDwo) &&
 206       !getStringOffsetDWOSection().empty()) {
 207     OS << "\n.debug_str_offsets.dwo contents:\n";
 208     DataExtractor strOffsetExt(getStringOffsetDWOSection(), isLittleEndian(),
 209                                0);
 210     offset = 0;
 211     uint64_t size = getStringOffsetDWOSection().size();
 212     while (offset < size) {
 213       OS << format("0x%8.8x: ", offset);
 214       OS << format("%8.8x\n", strOffsetExt.getU32(&offset));
 215     }
 216   }
 217 }
 218
 219 const DWARFDebugAbbrev *DWARFContext::getDebugAbbrev() {
 220   if (Abbrev)
 221     return Abbrev.get();
 222
 223   DataExtractor abbrData(getAbbrevSection(), isLittleEndian(), 0);
 224
 225   Abbrev.reset(new DWARFDebugAbbrev());
 226   Abbrev->extract(abbrData);
 227   return Abbrev.get();
 228 }
 229
 230 const DWARFDebugAbbrev *DWARFContext::getDebugAbbrevDWO() {
 231   if (AbbrevDWO)
 232     return AbbrevDWO.get();
 233
 234   DataExtractor abbrData(getAbbrevDWOSection(), isLittleEndian(), 0);
 235   AbbrevDWO.reset(new DWARFDebugAbbrev());
 236   AbbrevDWO->extract(abbrData);
 237   return AbbrevDWO.get();
 238 }
 239
 240 const DWARFDebugLoc *DWARFContext::getDebugLoc() {
 241   if (Loc)
 242     return Loc.get();
 243
 244   DataExtractor LocData(getLocSection().Data, isLittleEndian(), 0);
 245   Loc.reset(new DWARFDebugLoc(getLocSection().Relocs));
 246   // assume all compile units have the same address byte size
 247   if (getNumCompileUnits())
 248     Loc->parse(LocData, getCompileUnitAtIndex(0)->getAddressByteSize());
 249   return Loc.get();
 250 }
 251
 252 const DWARFDebugLocDWO *DWARFContext::getDebugLocDWO() {
 253   if (LocDWO)
 254     return LocDWO.get();
 255
 256   DataExtractor LocData(getLocDWOSection().Data, isLittleEndian(), 0);
 257   LocDWO.reset(new DWARFDebugLocDWO());
 258   LocDWO->parse(LocData);
 259   return LocDWO.get();
 260 }
 261
 262 const DWARFDebugAranges *DWARFContext::getDebugAranges() {
 263   if (Aranges)
 264     return Aranges.get();
 265
 266   Aranges.reset(new DWARFDebugAranges());
 267   Aranges->generate(this);
 268   return Aranges.get();
 269 }
 270
 271 const DWARFDebugFrame *DWARFContext::getDebugFrame() {
 272   if (DebugFrame)
 273     return DebugFrame.get();
 274
 275   // There's a "bug" in the DWARFv3 standard with respect to the target address
 276   // size within debug frame sections. While DWARF is supposed to be independent
 277   // of its container, FDEs have fields with size being "target address size",
 278   // which isn't specified in DWARF in general. It's only specified for CUs, but
 279   // .eh_frame can appear without a .debug_info section. Follow the example of
 280   // other tools (libdwarf) and extract this from the container (ObjectFile
 281   // provides this information). This problem is fixed in DWARFv4
 282   // See this dwarf-discuss discussion for more details:
 283   // http://lists.dwarfstd.org/htdig.cgi/dwarf-discuss-dwarfstd.org/2011-December/001173.html
 284   DataExtractor debugFrameData(getDebugFrameSection(), isLittleEndian(),
 285                                getAddressSize());
 286   DebugFrame.reset(new DWARFDebugFrame());
 287   DebugFrame->parse(debugFrameData);
 288   return DebugFrame.get();
 289 }
 290
 291 const DWARFLineTable *
 292 DWARFContext::getLineTableForCompileUnit(DWARFCompileUnit *cu) {
 293   if (!Line)
 294     Line.reset(new DWARFDebugLine(&getLineSection().Relocs));
 295
 296   unsigned stmtOffset =
 297       cu->getCompileUnitDIE()->getAttributeValueAsSectionOffset(
 298           cu, DW_AT_stmt_list, -1U);
 299   if (stmtOffset == -1U)
 300     return nullptr; // No line table for this compile unit.
 301
 302   // See if the line table is cached.
 303   if (const DWARFLineTable *lt = Line->getLineTable(stmtOffset))
 304     return lt;
 305
 306   // We have to parse it first.
 307   DataExtractor lineData(getLineSection().Data, isLittleEndian(),
 308                          cu->getAddressByteSize());
 309   return Line->getOrParseLineTable(lineData, stmtOffset);
 310 }
 311
 312 void DWARFContext::parseCompileUnits() {
 313   if (!CUs.empty())
 314     return;
 315   uint32_t offset = 0;
 316   const DataExtractor &DIData = DataExtractor(getInfoSection().Data,
 317                                               isLittleEndian(), 0);
 318   while (DIData.isValidOffset(offset)) {
 319     std::unique_ptr<DWARFCompileUnit> CU(new DWARFCompileUnit(
 320         getDebugAbbrev(), getInfoSection().Data, getRangeSection(),
 321         getStringSection(), StringRef(), getAddrSection(),
 322         &getInfoSection().Relocs, isLittleEndian()));
 323     if (!CU->extract(DIData, &offset)) {
 324       break;
 325     }
 326     CUs.push_back(std::move(CU));
 327     offset = CUs.back()->getNextUnitOffset();
 328   }
 329 }
 330
 331 void DWARFContext::parseTypeUnits() {
 332   if (!TUs.empty())
 333     return;
 334   for (const auto &I : getTypesSections()) {
 335     uint32_t offset = 0;
 336     const DataExtractor &DIData =
 337         DataExtractor(I.second.Data, isLittleEndian(), 0);
 338     while (DIData.isValidOffset(offset)) {
 339       std::unique_ptr<DWARFTypeUnit> TU(
 340           new DWARFTypeUnit(getDebugAbbrev(), I.second.Data, getRangeSection(),
 341                             getStringSection(), StringRef(), getAddrSection(),
 342                             &I.second.Relocs, isLittleEndian()));
 343       if (!TU->extract(DIData, &offset))
 344         break;
 345       TUs.push_back(std::move(TU));
 346       offset = TUs.back()->getNextUnitOffset();
 347     }
 348   }
 349 }
 350
 351 void DWARFContext::parseDWOCompileUnits() {
 352   if (!DWOCUs.empty())
 353     return;
 354   uint32_t offset = 0;
 355   const DataExtractor &DIData =
 356       DataExtractor(getInfoDWOSection().Data, isLittleEndian(), 0);
 357   while (DIData.isValidOffset(offset)) {
 358     std::unique_ptr<DWARFCompileUnit> DWOCU(new DWARFCompileUnit(
 359         getDebugAbbrevDWO(), getInfoDWOSection().Data, getRangeDWOSection(),
 360         getStringDWOSection(), getStringOffsetDWOSection(), getAddrSection(),
 361         &getInfoDWOSection().Relocs, isLittleEndian()));
 362     if (!DWOCU->extract(DIData, &offset)) {
 363       break;
 364     }
 365     DWOCUs.push_back(std::move(DWOCU));
 366     offset = DWOCUs.back()->getNextUnitOffset();
 367   }
 368 }
 369
 370 void DWARFContext::parseDWOTypeUnits() {
 371   if (!DWOTUs.empty())
 372     return;
 373   for (const auto &I : getTypesDWOSections()) {
 374     uint32_t offset = 0;
 375     const DataExtractor &DIData =
 376         DataExtractor(I.second.Data, isLittleEndian(), 0);
 377     while (DIData.isValidOffset(offset)) {
 378       std::unique_ptr<DWARFTypeUnit> TU(new DWARFTypeUnit(
 379           getDebugAbbrevDWO(), I.second.Data, getRangeDWOSection(),
 380           getStringDWOSection(), getStringOffsetDWOSection(), getAddrSection(),
 381           &I.second.Relocs, isLittleEndian()));
 382       if (!TU->extract(DIData, &offset))
 383         break;
 384       DWOTUs.push_back(std::move(TU));
 385       offset = DWOTUs.back()->getNextUnitOffset();
 386     }
 387   }
 388 }
 389
 390 namespace {
 391   struct OffsetComparator {
 392
 393     bool operator()(const std::unique_ptr<DWARFCompileUnit> &LHS,
 394                     const std::unique_ptr<DWARFCompileUnit> &RHS) const {
 395       return LHS->getOffset() < RHS->getOffset();
 396     }
 397     bool operator()(const std::unique_ptr<DWARFCompileUnit> &LHS,
 398                     uint32_t RHS) const {
 399       return LHS->getOffset() < RHS;
 400     }
 401     bool operator()(uint32_t LHS,
 402                     const std::unique_ptr<DWARFCompileUnit> &RHS) const {
 403       return LHS < RHS->getOffset();
 404     }
 405   };
 406 }
 407
 408 DWARFCompileUnit *DWARFContext::getCompileUnitForOffset(uint32_t Offset) {
 409   parseCompileUnits();
 410
 411   std::unique_ptr<DWARFCompileUnit> *CU =
 412       std::lower_bound(CUs.begin(), CUs.end(), Offset, OffsetComparator());
 413   if (CU != CUs.end()) {
 414     return CU->get();
 415   }
 416   return nullptr;
 417 }
 418
 419 DWARFCompileUnit *DWARFContext::getCompileUnitForAddress(uint64_t Address) {
 420   // First, get the offset of the compile unit.
 421   uint32_t CUOffset = getDebugAranges()->findAddress(Address);
 422   // Retrieve the compile unit.
 423   return getCompileUnitForOffset(CUOffset);
 424 }
 425
 426 static bool getFileNameForCompileUnit(DWARFCompileUnit *CU,
 427                                       const DWARFLineTable *LineTable,
 428                                       uint64_t FileIndex,
 429                                       bool NeedsAbsoluteFilePath,
 430                                       std::string &FileName) {
 431   if (!CU || !LineTable ||
 432       !LineTable->getFileNameByIndex(FileIndex, NeedsAbsoluteFilePath,
 433                                      FileName))
 434     return false;
 435   if (NeedsAbsoluteFilePath && sys::path::is_relative(FileName)) {
 436     // We may still need to append compilation directory of compile unit.
 437     SmallString<16> AbsolutePath;
 438     if (const char *CompilationDir = CU->getCompilationDir()) {
 439       sys::path::append(AbsolutePath, CompilationDir);
 440     }
 441     sys::path::append(AbsolutePath, FileName);
 442     FileName = AbsolutePath.str();
 443   }
 444   return true;
 445 }
 446
 447 static bool getFileLineInfoForCompileUnit(DWARFCompileUnit *CU,
 448                                           const DWARFLineTable *LineTable,
 449                                           uint64_t Address,
 450                                           bool NeedsAbsoluteFilePath,
 451                                           DILineInfo &Result) {
 452   if (!CU || !LineTable)
 453     return false;
 454   // Get the index of row we're looking for in the line table.
 455   uint32_t RowIndex = LineTable->lookupAddress(Address);
 456   if (RowIndex == -1U)
 457     return false;
 458   // Take file number and line/column from the row.
 459   const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
 460   if (!getFileNameForCompileUnit(CU, LineTable, Row.File, NeedsAbsoluteFilePath,
 461                                  Result.FileName))
 462     return false;
 463   Result.Line = Row.Line;
 464   Result.Column = Row.Column;
 465   return true;
 466 }
 467
 468 static bool getFunctionNameForAddress(DWARFCompileUnit *CU, uint64_t Address,
 469                                       std::string &FunctionName) {
 470   // The address may correspond to instruction in some inlined function,
 471   // so we have to build the chain of inlined functions and take the
 472   // name of the topmost function in it.
 473   const DWARFDebugInfoEntryInlinedChain &InlinedChain =
 474       CU->getInlinedChainForAddress(Address);
 475   if (InlinedChain.DIEs.size() == 0)
 476     return false;
 477   const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain.DIEs[0];
 478   if (const char *Name = TopFunctionDIE.getSubroutineName(InlinedChain.U)) {
 479     FunctionName = Name;
 480     return true;
 481   }
 482   return false;
 483 }
 484
 485 DILineInfo DWARFContext::getLineInfoForAddress(uint64_t Address,
 486     DILineInfoSpecifier Specifier) {
 487   DILineInfo Result;
 488
 489   DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
 490   if (!CU)
 491     return Result;
 492   if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
 493     getFunctionNameForAddress(CU, Address, Result.FunctionName);
 494   }
 495   if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
 496     const DWARFLineTable *LineTable = getLineTableForCompileUnit(CU);
 497     const bool NeedsAbsoluteFilePath =
 498         Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
 499     getFileLineInfoForCompileUnit(CU, LineTable, Address, NeedsAbsoluteFilePath,
 500                                   Result);
 501   }
 502   return Result;
 503 }
 504
 505 DILineInfoTable DWARFContext::getLineInfoForAddressRange(uint64_t Address,
 506     uint64_t Size,
 507     DILineInfoSpecifier Specifier) {
 508   DILineInfoTable  Lines;
 509   DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
 510   if (!CU)
 511     return Lines;
 512
 513   std::string FunctionName = "<invalid>";
 514   if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
 515     getFunctionNameForAddress(CU, Address, FunctionName);
 516   }
 517
 518   // If the Specifier says we don't need FileLineInfo, just
 519   // return the top-most function at the starting address.
 520   if (!Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
 521     DILineInfo Result;
 522     Result.FunctionName = FunctionName;
 523     Lines.push_back(std::make_pair(Address, Result));
 524     return Lines;
 525   }
 526
 527   const DWARFLineTable *LineTable = getLineTableForCompileUnit(CU);
 528   const bool NeedsAbsoluteFilePath =
 529       Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
 530
 531   // Get the index of row we're looking for in the line table.
 532   std::vector<uint32_t> RowVector;
 533   if (!LineTable->lookupAddressRange(Address, Size, RowVector))
 534     return Lines;
 535
 536   for (uint32_t RowIndex : RowVector) {
 537     // Take file number and line/column from the row.
 538     const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
 539     DILineInfo Result;
 540     getFileNameForCompileUnit(CU, LineTable, Row.File, NeedsAbsoluteFilePath,
 541                               Result.FileName);
 542     Result.FunctionName = FunctionName;
 543     Result.Line = Row.Line;
 544     Result.Column = Row.Column;
 545     Lines.push_back(std::make_pair(Row.Address, Result));
 546   }
 547
 548   return Lines;
 549 }
 550
 551 DIInliningInfo DWARFContext::getInliningInfoForAddress(uint64_t Address,
 552     DILineInfoSpecifier Specifier) {
 553   DIInliningInfo InliningInfo;
 554
 555   DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
 556   if (!CU)
 557     return InliningInfo;
 558
 559   const DWARFLineTable *LineTable = nullptr;
 560   const bool NeedsAbsoluteFilePath =
 561       Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
 562   const DWARFDebugInfoEntryInlinedChain &InlinedChain =
 563       CU->getInlinedChainForAddress(Address);
 564   if (InlinedChain.DIEs.size() == 0) {
 565     // If there is no DIE for address (e.g. it is in unavailable .dwo file),
 566     // try to at least get file/line info from symbol table.
 567     if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
 568       DILineInfo Frame;
 569       LineTable = getLineTableForCompileUnit(CU);
 570       if (getFileLineInfoForCompileUnit(CU, LineTable, Address,
 571                                         NeedsAbsoluteFilePath, Frame)) {
 572         InliningInfo.addFrame(Frame);
 573       }
 574     }
 575     return InliningInfo;
 576   }
 577
 578   uint32_t CallFile = 0, CallLine = 0, CallColumn = 0;
 579   for (uint32_t i = 0, n = InlinedChain.DIEs.size(); i != n; i++) {
 580     const DWARFDebugInfoEntryMinimal &FunctionDIE = InlinedChain.DIEs[i];
 581     DILineInfo Frame;
 582     // Get function name if necessary.
 583     if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
 584       if (const char *Name = FunctionDIE.getSubroutineName(InlinedChain.U))
 585         Frame.FunctionName = Name;
 586     }
 587     if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
 588       if (i == 0) {
 589         // For the topmost frame, initialize the line table of this
 590         // compile unit and fetch file/line info from it.
 591         LineTable = getLineTableForCompileUnit(CU);
 592         // For the topmost routine, get file/line info from line table.
 593         getFileLineInfoForCompileUnit(CU, LineTable, Address,
 594                                       NeedsAbsoluteFilePath, Frame);
 595       } else {
 596         // Otherwise, use call file, call line and call column from
 597         // previous DIE in inlined chain.
 598         getFileNameForCompileUnit(CU, LineTable, CallFile,
 599                                   NeedsAbsoluteFilePath, Frame.FileName);
 600         Frame.Line = CallLine;
 601         Frame.Column = CallColumn;
 602       }
 603       // Get call file/line/column of a current DIE.
 604       if (i + 1 < n) {
 605         FunctionDIE.getCallerFrame(InlinedChain.U, CallFile, CallLine,
 606                                    CallColumn);
 607       }
 608     }
 609     InliningInfo.addFrame(Frame);
 610   }
 611   return InliningInfo;
 612 }
 613
 614 static bool consumeCompressedDebugSectionHeader(StringRef &data,
 615                                                 uint64_t &OriginalSize) {
 616   // Consume "ZLIB" prefix.
 617   if (!data.startswith("ZLIB"))
 618     return false;
 619   data = data.substr(4);
 620   // Consume uncompressed section size (big-endian 8 bytes).
 621   DataExtractor extractor(data, false, 8);
 622   uint32_t Offset = 0;
 623   OriginalSize = extractor.getU64(&Offset);
 624   if (Offset == 0)
 625     return false;
 626   data = data.substr(Offset);
 627   return true;
 628 }
 629
 630 DWARFContextInMemory::DWARFContextInMemory(object::ObjectFile *Obj)
 631     : IsLittleEndian(Obj->isLittleEndian()),
 632       AddressSize(Obj->getBytesInAddress()) {
 633   for (const SectionRef &Section : Obj->sections()) {
 634     StringRef name;
 635     Section.getName(name);
 636     StringRef data;
 637     Section.getContents(data);
 638
 639     name = name.substr(name.find_first_not_of("._")); // Skip . and _ prefixes.
 640
 641     // Check if debug info section is compressed with zlib.
 642     if (name.startswith("zdebug_")) {
 643       uint64_t OriginalSize;
 644       if (!zlib::isAvailable() ||
 645           !consumeCompressedDebugSectionHeader(data, OriginalSize))
 646         continue;
 647       UncompressedSections.resize(UncompressedSections.size() + 1);
 648       if (zlib::uncompress(data, UncompressedSections.back(), OriginalSize) !=
 649           zlib::StatusOK) {
 650         UncompressedSections.pop_back();
 651         continue;
 652       }
 653       // Make data point to uncompressed section contents and save its contents.
 654       name = name.substr(1);
 655       data = UncompressedSections.back();
 656     }
 657
 658     StringRef *SectionData =
 659         StringSwitch<StringRef *>(name)
 660             .Case("debug_info", &InfoSection.Data)
 661             .Case("debug_abbrev", &AbbrevSection)
 662             .Case("debug_loc", &LocSection.Data)
 663             .Case("debug_line", &LineSection.Data)
 664             .Case("debug_aranges", &ARangeSection)
 665             .Case("debug_frame", &DebugFrameSection)
 666             .Case("debug_str", &StringSection)
 667             .Case("debug_ranges", &RangeSection)
 668             .Case("debug_pubnames", &PubNamesSection)
 669             .Case("debug_pubtypes", &PubTypesSection)
 670             .Case("debug_gnu_pubnames", &GnuPubNamesSection)
 671             .Case("debug_gnu_pubtypes", &GnuPubTypesSection)
 672             .Case("debug_info.dwo", &InfoDWOSection.Data)
 673             .Case("debug_abbrev.dwo", &AbbrevDWOSection)
 674             .Case("debug_loc.dwo", &LocDWOSection.Data)
 675             .Case("debug_line.dwo", &LineDWOSection.Data)
 676             .Case("debug_str.dwo", &StringDWOSection)
 677             .Case("debug_str_offsets.dwo", &StringOffsetDWOSection)
 678             .Case("debug_addr", &AddrSection)
 679             // Any more debug info sections go here.
 680             .Default(nullptr);
 681     if (SectionData) {
 682       *SectionData = data;
 683       if (name == "debug_ranges") {
 684         // FIXME: Use the other dwo range section when we emit it.
 685         RangeDWOSection = data;
 686       }
 687     } else if (name == "debug_types") {
 688       // Find debug_types data by section rather than name as there are
 689       // multiple, comdat grouped, debug_types sections.
 690       TypesSections[Section].Data = data;
 691     } else if (name == "debug_types.dwo") {
 692       TypesDWOSections[Section].Data = data;
 693     }
 694
 695     section_iterator RelocatedSection = Section.getRelocatedSection();
 696     if (RelocatedSection == Obj->section_end())
 697       continue;
 698
 699     StringRef RelSecName;
 700     RelocatedSection->getName(RelSecName);
 701     RelSecName = RelSecName.substr(
 702         RelSecName.find_first_not_of("._")); // Skip . and _ prefixes.
 703
 704     // TODO: Add support for relocations in other sections as needed.
 705     // Record relocations for the debug_info and debug_line sections.
 706     RelocAddrMap *Map = StringSwitch<RelocAddrMap*>(RelSecName)
 707         .Case("debug_info", &InfoSection.Relocs)
 708         .Case("debug_loc", &LocSection.Relocs)
 709         .Case("debug_info.dwo", &InfoDWOSection.Relocs)
 710         .Case("debug_line", &LineSection.Relocs)
 711         .Default(nullptr);
 712     if (!Map) {
 713       // Find debug_types relocs by section rather than name as there are
 714       // multiple, comdat grouped, debug_types sections.
 715       if (RelSecName == "debug_types")
 716         Map = &TypesSections[*RelocatedSection].Relocs;
 717       else if (RelSecName == "debug_types.dwo")
 718         Map = &TypesDWOSections[*RelocatedSection].Relocs;
 719       else
 720         continue;
 721     }
 722
 723     if (Section.relocation_begin() != Section.relocation_end()) {
 724       uint64_t SectionSize;
 725       RelocatedSection->getSize(SectionSize);
 726       for (const RelocationRef &Reloc : Section.relocations()) {
 727         uint64_t Address;
 728         Reloc.getOffset(Address);
 729         uint64_t Type;
 730         Reloc.getType(Type);
 731         uint64_t SymAddr = 0;
 732         // ELF relocations may need the symbol address
 733         if (Obj->isELF()) {
 734           object::symbol_iterator Sym = Reloc.getSymbol();
 735           Sym->getAddress(SymAddr);
 736         }
 737
 738         object::RelocVisitor V(Obj->getFileFormatName());
 739         // The section address is always 0 for debug sections.
 740         object::RelocToApply R(V.visit(Type, Reloc, 0, SymAddr));
 741         if (V.error()) {
 742           SmallString<32> Name;
 743           error_code ec(Reloc.getTypeName(Name));
 744           if (ec) {
 745             errs() << "Aaaaaa! Nameless relocation! Aaaaaa!\n";
 746           }
 747           errs() << "error: failed to compute relocation: "
 748                  << Name << "\n";
 749           continue;
 750         }
 751
 752         if (Address + R.Width > SectionSize) {
 753           errs() << "error: " << R.Width << "-byte relocation starting "
 754                  << Address << " bytes into section " << name << " which is "
 755                  << SectionSize << " bytes long.\n";
 756           continue;
 757         }
 758         if (R.Width > 8) {
 759           errs() << "error: can't handle a relocation of more than 8 bytes at "
 760                     "a time.\n";
 761           continue;
 762         }
 763         DEBUG(dbgs() << "Writing " << format("%p", R.Value)
 764                      << " at " << format("%p", Address)
 765                      << " with width " << format("%d", R.Width)
 766                      << "\n");
 767         Map->insert(std::make_pair(Address, std::make_pair(R.Width, R.Value)));
 768       }
 769     }
 770   }
 771 }
 772
 773 void DWARFContextInMemory::anchor() { }