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