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