1 //===-- DWARFCompileUnit.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 "DWARFCompileUnit.h"
11 #include "DWARFContext.h"
12 #include "llvm/DebugInfo/DWARFFormValue.h"
13 #include "llvm/Support/Dwarf.h"
14 #include "llvm/Support/Format.h"
15 #include "llvm/Support/Path.h"
16 #include "llvm/Support/raw_ostream.h"
18 using namespace dwarf;
20 bool DWARFCompileUnit::getAddrOffsetSectionItem(uint32_t Index,
21 uint64_t &Result) const {
22 uint32_t Offset = AddrOffsetSectionBase + Index * AddrSize;
23 if (AddrOffsetSection.size() < Offset + AddrSize)
25 DataExtractor DA(AddrOffsetSection, isLittleEndian, AddrSize);
26 Result = DA.getAddress(&Offset);
30 bool DWARFCompileUnit::getStringOffsetSectionItem(uint32_t Index,
31 uint32_t &Result) const {
32 // FIXME: string offset section entries are 8-byte for DWARF64.
33 const uint32_t ItemSize = 4;
34 uint32_t Offset = Index * ItemSize;
35 if (StringOffsetSection.size() < Offset + ItemSize)
37 DataExtractor DA(StringOffsetSection, isLittleEndian, 0);
38 Result = DA.getU32(&Offset);
42 bool DWARFCompileUnit::extract(DataExtractor debug_info, uint32_t *offset_ptr) {
47 if (debug_info.isValidOffset(*offset_ptr)) {
49 Length = debug_info.getU32(offset_ptr);
50 Version = debug_info.getU16(offset_ptr);
51 abbrOffset = debug_info.getU32(offset_ptr);
52 AddrSize = debug_info.getU8(offset_ptr);
54 bool lengthOK = debug_info.isValidOffset(getNextCompileUnitOffset()-1);
55 bool versionOK = DWARFContext::isSupportedVersion(Version);
56 bool abbrOffsetOK = AbbrevSection.size() > abbrOffset;
57 bool addrSizeOK = AddrSize == 4 || AddrSize == 8;
59 if (lengthOK && versionOK && addrSizeOK && abbrOffsetOK && Abbrev != NULL) {
60 Abbrevs = Abbrev->getAbbreviationDeclarationSet(abbrOffset);
64 // reset the offset to where we tried to parse from if anything went wrong
72 DWARFCompileUnit::extract(uint32_t offset, DataExtractor debug_info_data,
73 const DWARFAbbreviationDeclarationSet *abbrevs) {
78 if (debug_info_data.isValidOffset(offset)) {
79 Length = debug_info_data.getU32(&offset);
80 Version = debug_info_data.getU16(&offset);
81 bool abbrevsOK = debug_info_data.getU32(&offset) == abbrevs->getOffset();
83 AddrSize = debug_info_data.getU8(&offset);
85 bool versionOK = DWARFContext::isSupportedVersion(Version);
86 bool addrSizeOK = AddrSize == 4 || AddrSize == 8;
88 if (versionOK && addrSizeOK && abbrevsOK &&
89 debug_info_data.isValidOffset(offset))
95 bool DWARFCompileUnit::extractRangeList(uint32_t RangeListOffset,
96 DWARFDebugRangeList &RangeList) const {
97 // Require that compile unit is extracted.
98 assert(DieArray.size() > 0);
99 DataExtractor RangesData(RangeSection, isLittleEndian, AddrSize);
100 uint32_t ActualRangeListOffset = RangeSectionBase + RangeListOffset;
101 return RangeList.extract(RangesData, &ActualRangeListOffset);
104 void DWARFCompileUnit::clear() {
111 RangeSectionBase = 0;
112 AddrOffsetSectionBase = 0;
117 void DWARFCompileUnit::dump(raw_ostream &OS) {
118 OS << format("0x%08x", Offset) << ": Compile Unit:"
119 << " length = " << format("0x%08x", Length)
120 << " version = " << format("0x%04x", Version)
121 << " abbr_offset = " << format("0x%04x", Abbrevs->getOffset())
122 << " addr_size = " << format("0x%02x", AddrSize)
123 << " (next CU at " << format("0x%08x", getNextCompileUnitOffset())
126 const DWARFDebugInfoEntryMinimal *CU = getCompileUnitDIE(false);
127 assert(CU && "Null Compile Unit?");
128 CU->dump(OS, this, -1U);
131 const char *DWARFCompileUnit::getCompilationDir() {
132 extractDIEsIfNeeded(true);
133 if (DieArray.empty())
135 return DieArray[0].getAttributeValueAsString(this, DW_AT_comp_dir, 0);
138 uint64_t DWARFCompileUnit::getDWOId() {
139 extractDIEsIfNeeded(true);
140 const uint64_t FailValue = -1ULL;
141 if (DieArray.empty())
144 .getAttributeValueAsUnsigned(this, DW_AT_GNU_dwo_id, FailValue);
147 void DWARFCompileUnit::setDIERelations() {
148 if (DieArray.empty())
150 DWARFDebugInfoEntryMinimal *die_array_begin = &DieArray.front();
151 DWARFDebugInfoEntryMinimal *die_array_end = &DieArray.back();
152 DWARFDebugInfoEntryMinimal *curr_die;
153 // We purposely are skipping the last element in the array in the loop below
154 // so that we can always have a valid next item
155 for (curr_die = die_array_begin; curr_die < die_array_end; ++curr_die) {
156 // Since our loop doesn't include the last element, we can always
157 // safely access the next die in the array.
158 DWARFDebugInfoEntryMinimal *next_die = curr_die + 1;
160 const DWARFAbbreviationDeclaration *curr_die_abbrev =
161 curr_die->getAbbreviationDeclarationPtr();
163 if (curr_die_abbrev) {
165 if (curr_die_abbrev->hasChildren())
166 next_die->setParent(curr_die);
168 curr_die->setSibling(next_die);
170 // NULL DIE that terminates a sibling chain
171 DWARFDebugInfoEntryMinimal *parent = curr_die->getParent();
173 parent->setSibling(next_die);
177 // Since we skipped the last element, we need to fix it up!
178 if (die_array_begin < die_array_end)
179 curr_die->setParent(die_array_begin);
182 void DWARFCompileUnit::extractDIEsToVector(
183 bool AppendCUDie, bool AppendNonCUDies,
184 std::vector<DWARFDebugInfoEntryMinimal> &Dies) const {
185 if (!AppendCUDie && !AppendNonCUDies)
188 // Set the offset to that of the first DIE and calculate the start of the
189 // next compilation unit header.
190 uint32_t Offset = getFirstDIEOffset();
191 uint32_t NextCUOffset = getNextCompileUnitOffset();
192 DWARFDebugInfoEntryMinimal DIE;
194 const uint8_t *FixedFormSizes =
195 DWARFFormValue::getFixedFormSizes(getAddressByteSize(), getVersion());
198 while (Offset < NextCUOffset &&
199 DIE.extractFast(this, FixedFormSizes, &Offset)) {
203 if (!AppendNonCUDies)
205 // The average bytes per DIE entry has been seen to be
206 // around 14-20 so let's pre-reserve the needed memory for
207 // our DIE entries accordingly.
208 Dies.reserve(Dies.size() + getDebugInfoSize() / 14);
214 const DWARFAbbreviationDeclaration *AbbrDecl =
215 DIE.getAbbreviationDeclarationPtr();
218 if (AbbrDecl->hasChildren())
225 break; // We are done with this compile unit!
229 // Give a little bit of info if we encounter corrupt DWARF (our offset
230 // should always terminate at or before the start of the next compilation
232 if (Offset > NextCUOffset)
233 fprintf(stderr, "warning: DWARF compile unit extends beyond its "
234 "bounds cu 0x%8.8x at 0x%8.8x'\n", getOffset(), Offset);
237 size_t DWARFCompileUnit::extractDIEsIfNeeded(bool CUDieOnly) {
238 if ((CUDieOnly && DieArray.size() > 0) ||
240 return 0; // Already parsed.
242 bool HasCUDie = DieArray.size() > 0;
243 extractDIEsToVector(!HasCUDie, !CUDieOnly, DieArray);
245 if (DieArray.empty())
248 // If CU DIE was just parsed, copy several attribute values from it.
251 DieArray[0].getAttributeValueAsUnsigned(this, DW_AT_low_pc, -1U);
253 BaseAddr = DieArray[0].getAttributeValueAsUnsigned(this, DW_AT_entry_pc, 0);
254 setBaseAddress(BaseAddr);
255 AddrOffsetSectionBase =
256 DieArray[0].getAttributeValueAsReference(this, DW_AT_GNU_addr_base, 0);
258 DieArray[0].getAttributeValueAsReference(this, DW_AT_GNU_ranges_base, 0);
262 return DieArray.size();
265 DWARFCompileUnit::DWOHolder::DWOHolder(object::ObjectFile *DWOFile)
267 DWOContext(cast<DWARFContext>(DIContext::getDWARFContext(DWOFile))),
269 if (DWOContext->getNumDWOCompileUnits() > 0)
270 DWOCU = DWOContext->getDWOCompileUnitAtIndex(0);
273 bool DWARFCompileUnit::parseDWO() {
276 extractDIEsIfNeeded(true);
277 if (DieArray.empty())
279 const char *DWOFileName =
280 DieArray[0].getAttributeValueAsString(this, DW_AT_GNU_dwo_name, 0);
281 if (DWOFileName == 0)
283 const char *CompilationDir =
284 DieArray[0].getAttributeValueAsString(this, DW_AT_comp_dir, 0);
285 SmallString<16> AbsolutePath;
286 if (sys::path::is_relative(DWOFileName) && CompilationDir != 0) {
287 sys::path::append(AbsolutePath, CompilationDir);
289 sys::path::append(AbsolutePath, DWOFileName);
290 object::ObjectFile *DWOFile =
291 object::ObjectFile::createObjectFile(AbsolutePath);
295 DWO.reset(new DWOHolder(DWOFile));
296 DWARFCompileUnit *DWOCU = DWO->getCU();
297 // Verify that compile unit in .dwo file is valid.
298 if (DWOCU == 0 || DWOCU->getDWOId() != getDWOId()) {
302 // Share .debug_addr and .debug_ranges section with compile unit in .dwo
303 DWOCU->setAddrOffsetSection(AddrOffsetSection, AddrOffsetSectionBase);
304 DWOCU->setRangesSection(RangeSection, RangeSectionBase);
308 void DWARFCompileUnit::clearDIEs(bool KeepCUDie) {
309 if (DieArray.size() > (unsigned)KeepCUDie) {
310 // std::vectors never get any smaller when resized to a smaller size,
311 // or when clear() or erase() are called, the size will report that it
312 // is smaller, but the memory allocated remains intact (call capacity()
313 // to see this). So we need to create a temporary vector and swap the
314 // contents which will cause just the internal pointers to be swapped
315 // so that when temporary vector goes out of scope, it will destroy the
317 std::vector<DWARFDebugInfoEntryMinimal> TmpArray;
318 DieArray.swap(TmpArray);
319 // Save at least the compile unit DIE
321 DieArray.push_back(TmpArray.front());
326 DWARFCompileUnit::buildAddressRangeTable(DWARFDebugAranges *debug_aranges,
327 bool clear_dies_if_already_not_parsed,
328 uint32_t CUOffsetInAranges) {
329 // This function is usually called if there in no .debug_aranges section
330 // in order to produce a compile unit level set of address ranges that
331 // is accurate. If the DIEs weren't parsed, then we don't want all dies for
332 // all compile units to stay loaded when they weren't needed. So we can end
333 // up parsing the DWARF and then throwing them all away to keep memory usage
335 const bool clear_dies = extractDIEsIfNeeded(false) > 1 &&
336 clear_dies_if_already_not_parsed;
337 DieArray[0].buildAddressRangeTable(this, debug_aranges, CUOffsetInAranges);
338 bool DWOCreated = parseDWO();
340 // If there is a .dwo file for this compile unit, then skeleton CU DIE
341 // doesn't have children, and we should instead build address range table
342 // from DIEs in the .debug_info.dwo section of .dwo file.
343 DWO->getCU()->buildAddressRangeTable(
344 debug_aranges, clear_dies_if_already_not_parsed, CUOffsetInAranges);
346 if (DWOCreated && clear_dies_if_already_not_parsed)
349 // Keep memory down by clearing DIEs if this generate function
350 // caused them to be parsed.
355 const DWARFDebugInfoEntryMinimal *
356 DWARFCompileUnit::getSubprogramForAddress(uint64_t Address) {
357 extractDIEsIfNeeded(false);
358 for (size_t i = 0, n = DieArray.size(); i != n; i++)
359 if (DieArray[i].isSubprogramDIE() &&
360 DieArray[i].addressRangeContainsAddress(this, Address)) {
366 DWARFDebugInfoEntryInlinedChain
367 DWARFCompileUnit::getInlinedChainForAddress(uint64_t Address) {
368 // First, find a subprogram that contains the given address (the root
369 // of inlined chain).
370 const DWARFCompileUnit *ChainCU = 0;
371 const DWARFDebugInfoEntryMinimal *SubprogramDIE =
372 getSubprogramForAddress(Address);
376 // Try to look for subprogram DIEs in the DWO file.
379 SubprogramDIE = DWO->getCU()->getSubprogramForAddress(Address);
381 ChainCU = DWO->getCU();
385 // Get inlined chain rooted at this subprogram DIE.
387 return DWARFDebugInfoEntryInlinedChain();
388 return SubprogramDIE->getInlinedChainForAddress(ChainCU, Address);