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