1 //===-- DWARFContext.cpp --------------------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "DWARFContext.h"
11 #include "llvm/ADT/SmallString.h"
12 #include "llvm/Support/Dwarf.h"
13 #include "llvm/Support/Format.h"
14 #include "llvm/Support/Path.h"
15 #include "llvm/Support/raw_ostream.h"
18 using namespace dwarf;
20 typedef DWARFDebugLine::LineTable DWARFLineTable;
22 void DWARFContext::dump(raw_ostream &OS) {
23 OS << ".debug_abbrev contents:\n";
24 getDebugAbbrev()->dump(OS);
26 OS << "\n.debug_info contents:\n";
27 for (unsigned i = 0, e = getNumCompileUnits(); i != e; ++i)
28 getCompileUnitAtIndex(i)->dump(OS);
30 OS << "\n.debug_aranges contents:\n";
31 DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
33 DWARFDebugArangeSet set;
34 while (set.extract(arangesData, &offset))
37 uint8_t savedAddressByteSize = 0;
38 OS << "\n.debug_line contents:\n";
39 for (unsigned i = 0, e = getNumCompileUnits(); i != e; ++i) {
40 DWARFCompileUnit *cu = getCompileUnitAtIndex(i);
41 savedAddressByteSize = cu->getAddressByteSize();
43 cu->getCompileUnitDIE()->getAttributeValueAsUnsigned(cu, DW_AT_stmt_list,
45 if (stmtOffset != -1U) {
46 DataExtractor lineData(getLineSection(), isLittleEndian(),
47 savedAddressByteSize);
48 DWARFDebugLine::DumpingState state(OS);
49 DWARFDebugLine::parseStatementTable(lineData, &stmtOffset, state);
53 OS << "\n.debug_str contents:\n";
54 DataExtractor strData(getStringSection(), isLittleEndian(), 0);
56 uint32_t strOffset = 0;
57 while (const char *s = strData.getCStr(&offset)) {
58 OS << format("0x%8.8x: \"%s\"\n", strOffset, s);
62 OS << "\n.debug_ranges contents:\n";
63 // In fact, different compile units may have different address byte
64 // sizes, but for simplicity we just use the address byte size of the last
65 // compile unit (there is no easy and fast way to associate address range
66 // list and the compile unit it describes).
67 DataExtractor rangesData(getRangeSection(), isLittleEndian(),
68 savedAddressByteSize);
70 DWARFDebugRangeList rangeList;
71 while (rangeList.extract(rangesData, &offset))
74 OS << "\n.debug_abbrev.dwo contents:\n";
75 getDebugAbbrevDWO()->dump(OS);
77 OS << "\n.debug_info.dwo contents:\n";
78 for (unsigned i = 0, e = getNumDWOCompileUnits(); i != e; ++i)
79 getDWOCompileUnitAtIndex(i)->dump(OS);
81 OS << "\n.debug_str.dwo contents:\n";
82 DataExtractor strDWOData(getStringDWOSection(), isLittleEndian(), 0);
84 uint32_t strDWOOffset = 0;
85 while (const char *s = strDWOData.getCStr(&offset)) {
86 OS << format("0x%8.8x: \"%s\"\n", strDWOOffset, s);
87 strDWOOffset = offset;
90 OS << "\n.debug_str_offsets.dwo contents:\n";
91 DataExtractor strOffsetExt(getStringOffsetDWOSection(), isLittleEndian(), 0);
93 while (offset < getStringOffsetDWOSection().size()) {
94 OS << format("0x%8.8x: ", offset);
95 OS << format("%8.8x\n", strOffsetExt.getU32(&offset));
99 const DWARFDebugAbbrev *DWARFContext::getDebugAbbrev() {
103 DataExtractor abbrData(getAbbrevSection(), isLittleEndian(), 0);
105 Abbrev.reset(new DWARFDebugAbbrev());
106 Abbrev->parse(abbrData);
110 const DWARFDebugAbbrev *DWARFContext::getDebugAbbrevDWO() {
112 return AbbrevDWO.get();
114 DataExtractor abbrData(getAbbrevDWOSection(), isLittleEndian(), 0);
115 AbbrevDWO.reset(new DWARFDebugAbbrev());
116 AbbrevDWO->parse(abbrData);
117 return AbbrevDWO.get();
120 const DWARFDebugAranges *DWARFContext::getDebugAranges() {
122 return Aranges.get();
124 DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
126 Aranges.reset(new DWARFDebugAranges());
127 Aranges->extract(arangesData);
128 // Generate aranges from DIEs: even if .debug_aranges section is present,
129 // it may describe only a small subset of compilation units, so we need to
130 // manually build aranges for the rest of them.
131 Aranges->generate(this);
132 return Aranges.get();
135 const DWARFLineTable *
136 DWARFContext::getLineTableForCompileUnit(DWARFCompileUnit *cu) {
138 Line.reset(new DWARFDebugLine());
140 unsigned stmtOffset =
141 cu->getCompileUnitDIE()->getAttributeValueAsUnsigned(cu, DW_AT_stmt_list,
143 if (stmtOffset == -1U)
144 return 0; // No line table for this compile unit.
146 // See if the line table is cached.
147 if (const DWARFLineTable *lt = Line->getLineTable(stmtOffset))
150 // We have to parse it first.
151 DataExtractor lineData(getLineSection(), isLittleEndian(),
152 cu->getAddressByteSize());
153 return Line->getOrParseLineTable(lineData, stmtOffset);
156 void DWARFContext::parseCompileUnits() {
158 const DataExtractor &DIData = DataExtractor(getInfoSection(),
159 isLittleEndian(), 0);
160 while (DIData.isValidOffset(offset)) {
161 CUs.push_back(DWARFCompileUnit(getDebugAbbrev(), getInfoSection(),
162 getAbbrevSection(), getRangeSection(),
163 getStringSection(), StringRef(),
167 if (!CUs.back().extract(DIData, &offset)) {
172 offset = CUs.back().getNextCompileUnitOffset();
176 void DWARFContext::parseDWOCompileUnits() {
178 const DataExtractor &DIData = DataExtractor(getInfoDWOSection(),
179 isLittleEndian(), 0);
180 while (DIData.isValidOffset(offset)) {
181 DWOCUs.push_back(DWARFCompileUnit(getDebugAbbrevDWO(), getInfoDWOSection(),
182 getAbbrevDWOSection(),
183 getRangeDWOSection(),
184 getStringDWOSection(),
185 getStringOffsetDWOSection(),
189 if (!DWOCUs.back().extract(DIData, &offset)) {
194 offset = DWOCUs.back().getNextCompileUnitOffset();
199 struct OffsetComparator {
200 bool operator()(const DWARFCompileUnit &LHS,
201 const DWARFCompileUnit &RHS) const {
202 return LHS.getOffset() < RHS.getOffset();
204 bool operator()(const DWARFCompileUnit &LHS, uint32_t RHS) const {
205 return LHS.getOffset() < RHS;
207 bool operator()(uint32_t LHS, const DWARFCompileUnit &RHS) const {
208 return LHS < RHS.getOffset();
213 DWARFCompileUnit *DWARFContext::getCompileUnitForOffset(uint32_t Offset) {
217 DWARFCompileUnit *CU = std::lower_bound(CUs.begin(), CUs.end(), Offset,
224 DWARFCompileUnit *DWARFContext::getCompileUnitForAddress(uint64_t Address) {
225 // First, get the offset of the compile unit.
226 uint32_t CUOffset = getDebugAranges()->findAddress(Address);
227 // Retrieve the compile unit.
228 return getCompileUnitForOffset(CUOffset);
231 static bool getFileNameForCompileUnit(DWARFCompileUnit *CU,
232 const DWARFLineTable *LineTable,
234 bool NeedsAbsoluteFilePath,
235 std::string &FileName) {
238 !LineTable->getFileNameByIndex(FileIndex, NeedsAbsoluteFilePath,
241 if (NeedsAbsoluteFilePath && sys::path::is_relative(FileName)) {
242 // We may still need to append compilation directory of compile unit.
243 SmallString<16> AbsolutePath;
244 if (const char *CompilationDir = CU->getCompilationDir()) {
245 sys::path::append(AbsolutePath, CompilationDir);
247 sys::path::append(AbsolutePath, FileName);
248 FileName = AbsolutePath.str();
253 static bool getFileLineInfoForCompileUnit(DWARFCompileUnit *CU,
254 const DWARFLineTable *LineTable,
256 bool NeedsAbsoluteFilePath,
257 std::string &FileName,
258 uint32_t &Line, uint32_t &Column) {
259 if (CU == 0 || LineTable == 0)
261 // Get the index of row we're looking for in the line table.
262 uint32_t RowIndex = LineTable->lookupAddress(Address);
265 // Take file number and line/column from the row.
266 const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
267 if (!getFileNameForCompileUnit(CU, LineTable, Row.File,
268 NeedsAbsoluteFilePath, FileName))
275 DILineInfo DWARFContext::getLineInfoForAddress(uint64_t Address,
276 DILineInfoSpecifier Specifier) {
277 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
280 std::string FileName = "<invalid>";
281 std::string FunctionName = "<invalid>";
284 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
285 // The address may correspond to instruction in some inlined function,
286 // so we have to build the chain of inlined functions and take the
287 // name of the topmost function in it.
288 const DWARFDebugInfoEntryMinimal::InlinedChain &InlinedChain =
289 CU->getInlinedChainForAddress(Address);
290 if (InlinedChain.size() > 0) {
291 const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain[0];
292 if (const char *Name = TopFunctionDIE.getSubroutineName(CU))
296 if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
297 const DWARFLineTable *LineTable = getLineTableForCompileUnit(CU);
298 const bool NeedsAbsoluteFilePath =
299 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
300 getFileLineInfoForCompileUnit(CU, LineTable, Address,
301 NeedsAbsoluteFilePath,
302 FileName, Line, Column);
304 return DILineInfo(StringRef(FileName), StringRef(FunctionName),
308 DIInliningInfo DWARFContext::getInliningInfoForAddress(uint64_t Address,
309 DILineInfoSpecifier Specifier) {
310 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
312 return DIInliningInfo();
314 const DWARFDebugInfoEntryMinimal::InlinedChain &InlinedChain =
315 CU->getInlinedChainForAddress(Address);
316 if (InlinedChain.size() == 0)
317 return DIInliningInfo();
319 DIInliningInfo InliningInfo;
320 uint32_t CallFile = 0, CallLine = 0, CallColumn = 0;
321 const DWARFLineTable *LineTable = 0;
322 for (uint32_t i = 0, n = InlinedChain.size(); i != n; i++) {
323 const DWARFDebugInfoEntryMinimal &FunctionDIE = InlinedChain[i];
324 std::string FileName = "<invalid>";
325 std::string FunctionName = "<invalid>";
328 // Get function name if necessary.
329 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
330 if (const char *Name = FunctionDIE.getSubroutineName(CU))
333 if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
334 const bool NeedsAbsoluteFilePath =
335 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
337 // For the topmost frame, initialize the line table of this
338 // compile unit and fetch file/line info from it.
339 LineTable = getLineTableForCompileUnit(CU);
340 // For the topmost routine, get file/line info from line table.
341 getFileLineInfoForCompileUnit(CU, LineTable, Address,
342 NeedsAbsoluteFilePath,
343 FileName, Line, Column);
345 // Otherwise, use call file, call line and call column from
346 // previous DIE in inlined chain.
347 getFileNameForCompileUnit(CU, LineTable, CallFile,
348 NeedsAbsoluteFilePath, FileName);
352 // Get call file/line/column of a current DIE.
354 FunctionDIE.getCallerFrame(CU, CallFile, CallLine, CallColumn);
357 DILineInfo Frame(StringRef(FileName), StringRef(FunctionName),
359 InliningInfo.addFrame(Frame);
364 DWARFContextInMemory::DWARFContextInMemory(object::ObjectFile *Obj) :
365 IsLittleEndian(Obj->isLittleEndian()) {
367 for (object::section_iterator i = Obj->begin_sections(),
368 e = Obj->end_sections();
369 i != e; i.increment(ec)) {
373 i->getContents(data);
375 name = name.substr(name.find_first_not_of("._")); // Skip . and _ prefixes.
376 if (name == "debug_info")
378 else if (name == "debug_abbrev")
379 AbbrevSection = data;
380 else if (name == "debug_line")
382 else if (name == "debug_aranges")
383 ARangeSection = data;
384 else if (name == "debug_str")
385 StringSection = data;
386 else if (name == "debug_ranges") {
387 // FIXME: Use the other dwo range section when we emit it.
388 RangeDWOSection = data;
391 else if (name == "debug_info.dwo")
392 InfoDWOSection = data;
393 else if (name == "debug_abbrev.dwo")
394 AbbrevDWOSection = data;
395 else if (name == "debug_str.dwo")
396 StringDWOSection = data;
397 else if (name == "debug_str_offsets.dwo")
398 StringOffsetDWOSection = data;
399 else if (name == "debug_addr")
401 // Any more debug info sections go here.
405 // TODO: For now only handle relocations for the debug_info section.
407 if (name == "debug_info")
409 else if (name == "debug_info.dwo")
410 Map = &InfoDWORelocMap;
414 if (i->begin_relocations() != i->end_relocations()) {
415 uint64_t SectionSize;
416 i->getSize(SectionSize);
417 for (object::relocation_iterator reloc_i = i->begin_relocations(),
418 reloc_e = i->end_relocations();
419 reloc_i != reloc_e; reloc_i.increment(ec)) {
421 reloc_i->getAddress(Address);
423 reloc_i->getType(Type);
425 object::RelocVisitor V(Obj->getFileFormatName());
426 // The section address is always 0 for debug sections.
427 object::RelocToApply R(V.visit(Type, *reloc_i));
429 SmallString<32> Name;
430 error_code ec(reloc_i->getTypeName(Name));
432 errs() << "Aaaaaa! Nameless relocation! Aaaaaa!\n";
434 errs() << "error: failed to compute relocation: "
439 if (Address + R.Width > SectionSize) {
440 errs() << "error: " << R.Width << "-byte relocation starting "
441 << Address << " bytes into section " << name << " which is "
442 << SectionSize << " bytes long.\n";
446 errs() << "error: can't handle a relocation of more than 8 bytes at "
450 DEBUG(dbgs() << "Writing " << format("%p", R.Value)
451 << " at " << format("%p", Address)
452 << " with width " << format("%d", R.Width)
454 Map->insert(std::make_pair(Address, std::make_pair(R.Width, R.Value)));
460 void DWARFContextInMemory::anchor() { }