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