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 "DWARFFormValue.h"
13 #include "llvm/Support/Dwarf.h"
14 #include "llvm/Support/Format.h"
15 #include "llvm/Support/raw_ostream.h"
17 using namespace dwarf;
19 DataExtractor DWARFCompileUnit::getDebugInfoExtractor() const {
20 return DataExtractor(Context.getInfoSection(),
21 Context.isLittleEndian(), getAddressByteSize());
24 bool DWARFCompileUnit::extract(DataExtractor debug_info, uint32_t *offset_ptr) {
29 if (debug_info.isValidOffset(*offset_ptr)) {
31 const DWARFDebugAbbrev *abbr = Context.getDebugAbbrev();
32 Length = debug_info.getU32(offset_ptr);
33 Version = debug_info.getU16(offset_ptr);
34 abbrOffset = debug_info.getU32(offset_ptr);
35 AddrSize = debug_info.getU8(offset_ptr);
37 bool lengthOK = debug_info.isValidOffset(getNextCompileUnitOffset()-1);
38 bool versionOK = DWARFContext::isSupportedVersion(Version);
39 bool abbrOffsetOK = Context.getAbbrevSection().size() > abbrOffset;
40 bool addrSizeOK = AddrSize == 4 || AddrSize == 8;
42 if (lengthOK && versionOK && addrSizeOK && abbrOffsetOK && abbr != NULL) {
43 Abbrevs = abbr->getAbbreviationDeclarationSet(abbrOffset);
47 // reset the offset to where we tried to parse from if anything went wrong
55 DWARFCompileUnit::extract(uint32_t offset, DataExtractor debug_info_data,
56 const DWARFAbbreviationDeclarationSet *abbrevs) {
61 if (debug_info_data.isValidOffset(offset)) {
62 Length = debug_info_data.getU32(&offset);
63 Version = debug_info_data.getU16(&offset);
64 bool abbrevsOK = debug_info_data.getU32(&offset) == abbrevs->getOffset();
66 AddrSize = debug_info_data.getU8(&offset);
68 bool versionOK = DWARFContext::isSupportedVersion(Version);
69 bool addrSizeOK = AddrSize == 4 || AddrSize == 8;
71 if (versionOK && addrSizeOK && abbrevsOK &&
72 debug_info_data.isValidOffset(offset))
78 bool DWARFCompileUnit::extractRangeList(uint32_t RangeListOffset,
79 DWARFDebugRangeList &RangeList) const {
80 // Require that compile unit is extracted.
81 assert(DieArray.size() > 0);
82 DataExtractor RangesData(Context.getRangeSection(),
83 Context.isLittleEndian(), AddrSize);
84 return RangeList.extract(RangesData, &RangeListOffset);
87 void DWARFCompileUnit::clear() {
97 void DWARFCompileUnit::dump(raw_ostream &OS) {
98 OS << format("0x%08x", Offset) << ": Compile Unit:"
99 << " length = " << format("0x%08x", Length)
100 << " version = " << format("0x%04x", Version)
101 << " abbr_offset = " << format("0x%04x", Abbrevs->getOffset())
102 << " addr_size = " << format("0x%02x", AddrSize)
103 << " (next CU at " << format("0x%08x", getNextCompileUnitOffset())
106 const DWARFDebugInfoEntryMinimal *CU = getCompileUnitDIE(false);
107 assert(CU && "Null Compile Unit?");
108 CU->dump(OS, this, -1U);
111 const char *DWARFCompileUnit::getCompilationDir() {
112 extractDIEsIfNeeded(true);
113 if (DieArray.empty())
115 return DieArray[0].getAttributeValueAsString(this, DW_AT_comp_dir, 0);
118 void DWARFCompileUnit::setDIERelations() {
119 if (DieArray.empty())
121 DWARFDebugInfoEntryMinimal *die_array_begin = &DieArray.front();
122 DWARFDebugInfoEntryMinimal *die_array_end = &DieArray.back();
123 DWARFDebugInfoEntryMinimal *curr_die;
124 // We purposely are skipping the last element in the array in the loop below
125 // so that we can always have a valid next item
126 for (curr_die = die_array_begin; curr_die < die_array_end; ++curr_die) {
127 // Since our loop doesn't include the last element, we can always
128 // safely access the next die in the array.
129 DWARFDebugInfoEntryMinimal *next_die = curr_die + 1;
131 const DWARFAbbreviationDeclaration *curr_die_abbrev =
132 curr_die->getAbbreviationDeclarationPtr();
134 if (curr_die_abbrev) {
136 if (curr_die_abbrev->hasChildren())
137 next_die->setParent(curr_die);
139 curr_die->setSibling(next_die);
141 // NULL DIE that terminates a sibling chain
142 DWARFDebugInfoEntryMinimal *parent = curr_die->getParent();
144 parent->setSibling(next_die);
148 // Since we skipped the last element, we need to fix it up!
149 if (die_array_begin < die_array_end)
150 curr_die->setParent(die_array_begin);
153 size_t DWARFCompileUnit::extractDIEsIfNeeded(bool cu_die_only) {
154 const size_t initial_die_array_size = DieArray.size();
155 if ((cu_die_only && initial_die_array_size > 0) ||
156 initial_die_array_size > 1)
157 return 0; // Already parsed
159 // Set the offset to that of the first DIE and calculate the start of the
160 // next compilation unit header.
161 uint32_t offset = getFirstDIEOffset();
162 uint32_t next_cu_offset = getNextCompileUnitOffset();
164 DWARFDebugInfoEntryMinimal die;
165 // Keep a flat array of the DIE for binary lookup by DIE offset
167 // We are in our compile unit, parse starting at the offset
168 // we were told to parse
170 const uint8_t *fixed_form_sizes =
171 DWARFFormValue::getFixedFormSizesForAddressSize(getAddressByteSize());
173 while (offset < next_cu_offset &&
174 die.extractFast(this, fixed_form_sizes, &offset)) {
178 die.getAttributeValueAsUnsigned(this, DW_AT_low_pc, -1U);
179 if (base_addr == -1U)
180 base_addr = die.getAttributeValueAsUnsigned(this, DW_AT_entry_pc, 0);
181 setBaseAddress(base_addr);
188 else if (depth == 0 && initial_die_array_size == 1)
189 // Don't append the CU die as we already did that
194 const DWARFAbbreviationDeclaration *abbrDecl =
195 die.getAbbreviationDeclarationPtr();
198 if (abbrDecl->hasChildren())
205 break; // We are done with this compile unit!
210 // Give a little bit of info if we encounter corrupt DWARF (our offset
211 // should always terminate at or before the start of the next compilation
213 if (offset > next_cu_offset)
214 fprintf(stderr, "warning: DWARF compile unit extends beyond its"
215 "bounds cu 0x%8.8x at 0x%8.8x'\n", getOffset(), offset);
218 return DieArray.size();
221 void DWARFCompileUnit::clearDIEs(bool keep_compile_unit_die) {
222 if (DieArray.size() > (unsigned)keep_compile_unit_die) {
223 // std::vectors never get any smaller when resized to a smaller size,
224 // or when clear() or erase() are called, the size will report that it
225 // is smaller, but the memory allocated remains intact (call capacity()
226 // to see this). So we need to create a temporary vector and swap the
227 // contents which will cause just the internal pointers to be swapped
228 // so that when "tmp_array" goes out of scope, it will destroy the
231 // Save at least the compile unit DIE
232 std::vector<DWARFDebugInfoEntryMinimal> tmpArray;
233 DieArray.swap(tmpArray);
234 if (keep_compile_unit_die)
235 DieArray.push_back(tmpArray.front());
240 DWARFCompileUnit::buildAddressRangeTable(DWARFDebugAranges *debug_aranges,
241 bool clear_dies_if_already_not_parsed){
242 // This function is usually called if there in no .debug_aranges section
243 // in order to produce a compile unit level set of address ranges that
244 // is accurate. If the DIEs weren't parsed, then we don't want all dies for
245 // all compile units to stay loaded when they weren't needed. So we can end
246 // up parsing the DWARF and then throwing them all away to keep memory usage
248 const bool clear_dies = extractDIEsIfNeeded(false) > 1 &&
249 clear_dies_if_already_not_parsed;
250 DieArray[0].buildAddressRangeTable(this, debug_aranges);
252 // Keep memory down by clearing DIEs if this generate function
253 // caused them to be parsed.
258 DWARFDebugInfoEntryMinimal::InlinedChain
259 DWARFCompileUnit::getInlinedChainForAddress(uint64_t Address) {
260 // First, find a subprogram that contains the given address (the root
261 // of inlined chain).
262 extractDIEsIfNeeded(false);
263 const DWARFDebugInfoEntryMinimal *SubprogramDIE = 0;
264 for (size_t i = 0, n = DieArray.size(); i != n; i++) {
265 if (DieArray[i].isSubprogramDIE() &&
266 DieArray[i].addressRangeContainsAddress(this, Address)) {
267 SubprogramDIE = &DieArray[i];
271 // Get inlined chain rooted at this subprogram DIE.
273 return DWARFDebugInfoEntryMinimal::InlinedChain();
274 return SubprogramDIE->getInlinedChainForAddress(this, Address);