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, getRangeSection(),
 316         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(
 335           new DWARFTypeUnit(getDebugAbbrev(), I.second.Data, getRangeSection(),
 336                             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, getRangeDWOSection(),
 355         getStringDWOSection(), getStringOffsetDWOSection(), getAddrSection(),
 356         &getInfoDWOSection().Relocs, isLittleEndian()));
 357     if (!DWOCU->extract(DIData, &offset)) {
 358       break;
 359     }
 360     DWOCUs.push_back(std::move(DWOCU));
 361     offset = DWOCUs.back()->getNextUnitOffset();
 362   }
 363 }
 364
 365 void DWARFContext::parseDWOTypeUnits() {
 366   if (!DWOTUs.empty())
 367     return;
 368   for (const auto &I : getTypesDWOSections()) {
 369     uint32_t offset = 0;
 370     const DataExtractor &DIData =
 371         DataExtractor(I.second.Data, isLittleEndian(), 0);
 372     while (DIData.isValidOffset(offset)) {
 373       std::unique_ptr<DWARFTypeUnit> TU(new DWARFTypeUnit(
 374           getDebugAbbrevDWO(), I.second.Data, getRangeDWOSection(),
 375           getStringDWOSection(), getStringOffsetDWOSection(), getAddrSection(),
 376           &I.second.Relocs, isLittleEndian()));
 377       if (!TU->extract(DIData, &offset))
 378         break;
 379       DWOTUs.push_back(std::move(TU));
 380       offset = DWOTUs.back()->getNextUnitOffset();
 381     }
 382   }
 383 }
 384
 385 namespace {
 386   struct OffsetComparator {
 387
 388     bool operator()(const std::unique_ptr<DWARFCompileUnit> &LHS,
 389                     const std::unique_ptr<DWARFCompileUnit> &RHS) const {
 390       return LHS->getOffset() < RHS->getOffset();
 391     }
 392     bool operator()(const std::unique_ptr<DWARFCompileUnit> &LHS,
 393                     uint32_t RHS) const {
 394       return LHS->getOffset() < RHS;
 395     }
 396     bool operator()(uint32_t LHS,
 397                     const std::unique_ptr<DWARFCompileUnit> &RHS) const {
 398       return LHS < RHS->getOffset();
 399     }
 400   };
 401 }
 402
 403 DWARFCompileUnit *DWARFContext::getCompileUnitForOffset(uint32_t Offset) {
 404   parseCompileUnits();
 405
 406   std::unique_ptr<DWARFCompileUnit> *CU =
 407       std::lower_bound(CUs.begin(), CUs.end(), Offset, OffsetComparator());
 408   if (CU != CUs.end()) {
 409     return CU->get();
 410   }
 411   return nullptr;
 412 }
 413
 414 DWARFCompileUnit *DWARFContext::getCompileUnitForAddress(uint64_t Address) {
 415   // First, get the offset of the compile unit.
 416   uint32_t CUOffset = getDebugAranges()->findAddress(Address);
 417   // Retrieve the compile unit.
 418   return getCompileUnitForOffset(CUOffset);
 419 }
 420
 421 static bool getFileNameForCompileUnit(DWARFCompileUnit *CU,
 422                                       const DWARFLineTable *LineTable,
 423                                       uint64_t FileIndex,
 424                                       bool NeedsAbsoluteFilePath,
 425                                       std::string &FileName) {
 426   if (!CU || !LineTable ||
 427       !LineTable->getFileNameByIndex(FileIndex, NeedsAbsoluteFilePath,
 428                                      FileName))
 429     return false;
 430   if (NeedsAbsoluteFilePath && sys::path::is_relative(FileName)) {
 431     // We may still need to append compilation directory of compile unit.
 432     SmallString<16> AbsolutePath;
 433     if (const char *CompilationDir = CU->getCompilationDir()) {
 434       sys::path::append(AbsolutePath, CompilationDir);
 435     }
 436     sys::path::append(AbsolutePath, FileName);
 437     FileName = AbsolutePath.str();
 438   }
 439   return true;
 440 }
 441
 442 static bool getFileLineInfoForCompileUnit(DWARFCompileUnit *CU,
 443                                           const DWARFLineTable *LineTable,
 444                                           uint64_t Address,
 445                                           bool NeedsAbsoluteFilePath,
 446                                           DILineInfo &Result) {
 447   if (!CU || !LineTable)
 448     return false;
 449   // Get the index of row we're looking for in the line table.
 450   uint32_t RowIndex = LineTable->lookupAddress(Address);
 451   if (RowIndex == -1U)
 452     return false;
 453   // Take file number and line/column from the row.
 454   const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
 455   if (!getFileNameForCompileUnit(CU, LineTable, Row.File, NeedsAbsoluteFilePath,
 456                                  Result.FileName))
 457     return false;
 458   Result.Line = Row.Line;
 459   Result.Column = Row.Column;
 460   return true;
 461 }
 462
 463 static bool getFunctionNameForAddress(DWARFCompileUnit *CU, uint64_t Address,
 464                                       std::string &FunctionName) {
 465   // The address may correspond to instruction in some inlined function,
 466   // so we have to build the chain of inlined functions and take the
 467   // name of the topmost function in it.
 468   const DWARFDebugInfoEntryInlinedChain &InlinedChain =
 469       CU->getInlinedChainForAddress(Address);
 470   if (InlinedChain.DIEs.size() == 0)
 471     return false;
 472   const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain.DIEs[0];
 473   if (const char *Name = TopFunctionDIE.getSubroutineName(InlinedChain.U)) {
 474     FunctionName = Name;
 475     return true;
 476   }
 477   return false;
 478 }
 479
 480 DILineInfo DWARFContext::getLineInfoForAddress(uint64_t Address,
 481     DILineInfoSpecifier Specifier) {
 482   DILineInfo Result;
 483
 484   DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
 485   if (!CU)
 486     return Result;
 487   if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
 488     getFunctionNameForAddress(CU, Address, Result.FunctionName);
 489   }
 490   if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
 491     const DWARFLineTable *LineTable = getLineTableForCompileUnit(CU);
 492     const bool NeedsAbsoluteFilePath =
 493         Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
 494     getFileLineInfoForCompileUnit(CU, LineTable, Address, NeedsAbsoluteFilePath,
 495                                   Result);
 496   }
 497   return Result;
 498 }
 499
 500 DILineInfoTable DWARFContext::getLineInfoForAddressRange(uint64_t Address,
 501     uint64_t Size,
 502     DILineInfoSpecifier Specifier) {
 503   DILineInfoTable  Lines;
 504   DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
 505   if (!CU)
 506     return Lines;
 507
 508   std::string FunctionName = "<invalid>";
 509   if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
 510     getFunctionNameForAddress(CU, Address, FunctionName);
 511   }
 512
 513   // If the Specifier says we don't need FileLineInfo, just
 514   // return the top-most function at the starting address.
 515   if (!Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
 516     DILineInfo Result;
 517     Result.FunctionName = FunctionName;
 518     Lines.push_back(std::make_pair(Address, Result));
 519     return Lines;
 520   }
 521
 522   const DWARFLineTable *LineTable = getLineTableForCompileUnit(CU);
 523   const bool NeedsAbsoluteFilePath =
 524       Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
 525
 526   // Get the index of row we're looking for in the line table.
 527   std::vector<uint32_t> RowVector;
 528   if (!LineTable->lookupAddressRange(Address, Size, RowVector))
 529     return Lines;
 530
 531   for (uint32_t RowIndex : RowVector) {
 532     // Take file number and line/column from the row.
 533     const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
 534     DILineInfo Result;
 535     getFileNameForCompileUnit(CU, LineTable, Row.File, NeedsAbsoluteFilePath,
 536                               Result.FileName);
 537     Result.FunctionName = FunctionName;
 538     Result.Line = Row.Line;
 539     Result.Column = Row.Column;
 540     Lines.push_back(std::make_pair(Row.Address, Result));
 541   }
 542
 543   return Lines;
 544 }
 545
 546 DIInliningInfo DWARFContext::getInliningInfoForAddress(uint64_t Address,
 547     DILineInfoSpecifier Specifier) {
 548   DIInliningInfo InliningInfo;
 549
 550   DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
 551   if (!CU)
 552     return InliningInfo;
 553
 554   const DWARFLineTable *LineTable = nullptr;
 555   const bool NeedsAbsoluteFilePath =
 556       Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
 557   const DWARFDebugInfoEntryInlinedChain &InlinedChain =
 558       CU->getInlinedChainForAddress(Address);
 559   if (InlinedChain.DIEs.size() == 0) {
 560     // If there is no DIE for address (e.g. it is in unavailable .dwo file),
 561     // try to at least get file/line info from symbol table.
 562     if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
 563       DILineInfo Frame;
 564       LineTable = getLineTableForCompileUnit(CU);
 565       if (getFileLineInfoForCompileUnit(CU, LineTable, Address,
 566                                         NeedsAbsoluteFilePath, Frame)) {
 567         InliningInfo.addFrame(Frame);
 568       }
 569     }
 570     return InliningInfo;
 571   }
 572
 573   uint32_t CallFile = 0, CallLine = 0, CallColumn = 0;
 574   for (uint32_t i = 0, n = InlinedChain.DIEs.size(); i != n; i++) {
 575     const DWARFDebugInfoEntryMinimal &FunctionDIE = InlinedChain.DIEs[i];
 576     DILineInfo Frame;
 577     // Get function name if necessary.
 578     if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
 579       if (const char *Name = FunctionDIE.getSubroutineName(InlinedChain.U))
 580         Frame.FunctionName = Name;
 581     }
 582     if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
 583       if (i == 0) {
 584         // For the topmost frame, initialize the line table of this
 585         // compile unit and fetch file/line info from it.
 586         LineTable = getLineTableForCompileUnit(CU);
 587         // For the topmost routine, get file/line info from line table.
 588         getFileLineInfoForCompileUnit(CU, LineTable, Address,
 589                                       NeedsAbsoluteFilePath, Frame);
 590       } else {
 591         // Otherwise, use call file, call line and call column from
 592         // previous DIE in inlined chain.
 593         getFileNameForCompileUnit(CU, LineTable, CallFile,
 594                                   NeedsAbsoluteFilePath, Frame.FileName);
 595         Frame.Line = CallLine;
 596         Frame.Column = CallColumn;
 597       }
 598       // Get call file/line/column of a current DIE.
 599       if (i + 1 < n) {
 600         FunctionDIE.getCallerFrame(InlinedChain.U, CallFile, CallLine,
 601                                    CallColumn);
 602       }
 603     }
 604     InliningInfo.addFrame(Frame);
 605   }
 606   return InliningInfo;
 607 }
 608
 609 static bool consumeCompressedDebugSectionHeader(StringRef &data,
 610                                                 uint64_t &OriginalSize) {
 611   // Consume "ZLIB" prefix.
 612   if (!data.startswith("ZLIB"))
 613     return false;
 614   data = data.substr(4);
 615   // Consume uncompressed section size (big-endian 8 bytes).
 616   DataExtractor extractor(data, false, 8);
 617   uint32_t Offset = 0;
 618   OriginalSize = extractor.getU64(&Offset);
 619   if (Offset == 0)
 620     return false;
 621   data = data.substr(Offset);
 622   return true;
 623 }
 624
 625 DWARFContextInMemory::DWARFContextInMemory(object::ObjectFile *Obj)
 626     : IsLittleEndian(Obj->isLittleEndian()),
 627       AddressSize(Obj->getBytesInAddress()) {
 628   for (const SectionRef &Section : Obj->sections()) {
 629     StringRef name;
 630     Section.getName(name);
 631     StringRef data;
 632     Section.getContents(data);
 633
 634     name = name.substr(name.find_first_not_of("._")); // Skip . and _ prefixes.
 635
 636     // Check if debug info section is compressed with zlib.
 637     if (name.startswith("zdebug_")) {
 638       uint64_t OriginalSize;
 639       if (!zlib::isAvailable() ||
 640           !consumeCompressedDebugSectionHeader(data, OriginalSize))
 641         continue;
 642       UncompressedSections.resize(UncompressedSections.size() + 1);
 643       if (zlib::uncompress(data, UncompressedSections.back(), OriginalSize) !=
 644           zlib::StatusOK) {
 645         UncompressedSections.pop_back();
 646         continue;
 647       }
 648       // Make data point to uncompressed section contents and save its contents.
 649       name = name.substr(1);
 650       data = UncompressedSections.back();
 651     }
 652
 653     StringRef *SectionData =
 654         StringSwitch<StringRef *>(name)
 655             .Case("debug_info", &InfoSection.Data)
 656             .Case("debug_abbrev", &AbbrevSection)
 657             .Case("debug_loc", &LocSection.Data)
 658             .Case("debug_line", &LineSection.Data)
 659             .Case("debug_aranges", &ARangeSection)
 660             .Case("debug_frame", &DebugFrameSection)
 661             .Case("debug_str", &StringSection)
 662             .Case("debug_ranges", &RangeSection)
 663             .Case("debug_pubnames", &PubNamesSection)
 664             .Case("debug_pubtypes", &PubTypesSection)
 665             .Case("debug_gnu_pubnames", &GnuPubNamesSection)
 666             .Case("debug_gnu_pubtypes", &GnuPubTypesSection)
 667             .Case("debug_info.dwo", &InfoDWOSection.Data)
 668             .Case("debug_abbrev.dwo", &AbbrevDWOSection)
 669             .Case("debug_loc.dwo", &LocDWOSection.Data)
 670             .Case("debug_line.dwo", &LineDWOSection.Data)
 671             .Case("debug_str.dwo", &StringDWOSection)
 672             .Case("debug_str_offsets.dwo", &StringOffsetDWOSection)
 673             .Case("debug_addr", &AddrSection)
 674             // Any more debug info sections go here.
 675             .Default(nullptr);
 676     if (SectionData) {
 677       *SectionData = data;
 678       if (name == "debug_ranges") {
 679         // FIXME: Use the other dwo range section when we emit it.
 680         RangeDWOSection = data;
 681       }
 682     } else if (name == "debug_types") {
 683       // Find debug_types data by section rather than name as there are
 684       // multiple, comdat grouped, debug_types sections.
 685       TypesSections[Section].Data = data;
 686     } else if (name == "debug_types.dwo") {
 687       TypesDWOSections[Section].Data = data;
 688     }
 689
 690     section_iterator RelocatedSection = Section.getRelocatedSection();
 691     if (RelocatedSection == Obj->section_end())
 692       continue;
 693
 694     StringRef RelSecName;
 695     RelocatedSection->getName(RelSecName);
 696     RelSecName = RelSecName.substr(
 697         RelSecName.find_first_not_of("._")); // Skip . and _ prefixes.
 698
 699     // TODO: Add support for relocations in other sections as needed.
 700     // Record relocations for the debug_info and debug_line sections.
 701     RelocAddrMap *Map = StringSwitch<RelocAddrMap*>(RelSecName)
 702         .Case("debug_info", &InfoSection.Relocs)
 703         .Case("debug_loc", &LocSection.Relocs)
 704         .Case("debug_info.dwo", &InfoDWOSection.Relocs)
 705         .Case("debug_line", &LineSection.Relocs)
 706         .Default(nullptr);
 707     if (!Map) {
 708       // Find debug_types relocs by section rather than name as there are
 709       // multiple, comdat grouped, debug_types sections.
 710       if (RelSecName == "debug_types")
 711         Map = &TypesSections[*RelocatedSection].Relocs;
 712       else if (RelSecName == "debug_types.dwo")
 713         Map = &TypesDWOSections[*RelocatedSection].Relocs;
 714       else
 715         continue;
 716     }
 717
 718     if (Section.relocation_begin() != Section.relocation_end()) {
 719       uint64_t SectionSize;
 720       RelocatedSection->getSize(SectionSize);
 721       for (const RelocationRef &Reloc : Section.relocations()) {
 722         uint64_t Address;
 723         Reloc.getOffset(Address);
 724         uint64_t Type;
 725         Reloc.getType(Type);
 726         uint64_t SymAddr = 0;
 727         // ELF relocations may need the symbol address
 728         if (Obj->isELF()) {
 729           object::symbol_iterator Sym = Reloc.getSymbol();
 730           Sym->getAddress(SymAddr);
 731         }
 732
 733         object::RelocVisitor V(Obj->getFileFormatName());
 734         // The section address is always 0 for debug sections.
 735         object::RelocToApply R(V.visit(Type, Reloc, 0, SymAddr));
 736         if (V.error()) {
 737           SmallString<32> Name;
 738           error_code ec(Reloc.getTypeName(Name));
 739           if (ec) {
 740             errs() << "Aaaaaa! Nameless relocation! Aaaaaa!\n";
 741           }
 742           errs() << "error: failed to compute relocation: "
 743                  << Name << "\n";
 744           continue;
 745         }
 746
 747         if (Address + R.Width > SectionSize) {
 748           errs() << "error: " << R.Width << "-byte relocation starting "
 749                  << Address << " bytes into section " << name << " which is "
 750                  << SectionSize << " bytes long.\n";
 751           continue;
 752         }
 753         if (R.Width > 8) {
 754           errs() << "error: can't handle a relocation of more than 8 bytes at "
 755                     "a time.\n";
 756           continue;
 757         }
 758         DEBUG(dbgs() << "Writing " << format("%p", R.Value)
 759                      << " at " << format("%p", Address)
 760                      << " with width " << format("%d", R.Width)
 761                      << "\n");
 762         Map->insert(std::make_pair(Address, std::make_pair(R.Width, R.Value)));
 763       }
 764     }
 765   }
 766 }
 767
 768 void DWARFContextInMemory::anchor() { }