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