1 //===-- DWARFCompileUnit.h --------------------------------------*- C++ -*-===//
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 #ifndef LLVM_DEBUGINFO_DWARFCOMPILEUNIT_H
11 #define LLVM_DEBUGINFO_DWARFCOMPILEUNIT_H
13 #include "DWARFDebugAbbrev.h"
14 #include "DWARFDebugInfoEntry.h"
15 #include "DWARFDebugRangeList.h"
20 class DWARFDebugAbbrev;
23 typedef DenseMap<uint64_t, std::pair<uint8_t, int64_t> > RelocAddrMap;
25 class DWARFCompileUnit {
26 const DWARFDebugAbbrev *Abbrev;
27 StringRef InfoSection;
28 StringRef AbbrevSection;
29 StringRef RangeSection;
30 StringRef StringSection;
31 StringRef StringOffsetSection;
32 const RelocAddrMap *RelocMap;
38 const DWARFAbbreviationDeclarationSet *Abbrevs;
41 // The compile unit debug information entry item.
42 std::vector<DWARFDebugInfoEntryMinimal> DieArray;
45 DWARFCompileUnit(const DWARFDebugAbbrev *DA, StringRef IS, StringRef AS,
46 StringRef RS, StringRef SS, StringRef SOS,
47 const RelocAddrMap *M, bool LE) :
48 Abbrev(DA), InfoSection(IS), AbbrevSection(AS),
49 RangeSection(RS), StringSection(SS), StringOffsetSection(SOS),
50 RelocMap(M), isLittleEndian(LE) {
54 StringRef getStringSection() const { return StringSection; }
55 StringRef getStringOffsetSection() const { return StringOffsetSection; }
56 const RelocAddrMap *getRelocMap() const { return RelocMap; }
57 DataExtractor getDebugInfoExtractor() const;
59 bool extract(DataExtractor debug_info, uint32_t* offset_ptr);
60 uint32_t extract(uint32_t offset, DataExtractor debug_info_data,
61 const DWARFAbbreviationDeclarationSet *abbrevs);
63 /// extractDIEsIfNeeded - Parses a compile unit and indexes its DIEs if it
64 /// hasn't already been done. Returns the number of DIEs parsed at this call.
65 size_t extractDIEsIfNeeded(bool cu_die_only);
66 /// extractRangeList - extracts the range list referenced by this compile
67 /// unit from .debug_ranges section. Returns true on success.
68 /// Requires that compile unit is already extracted.
69 bool extractRangeList(uint32_t RangeListOffset,
70 DWARFDebugRangeList &RangeList) const;
72 void dump(raw_ostream &OS);
73 uint32_t getOffset() const { return Offset; }
74 /// Size in bytes of the compile unit header.
75 uint32_t getSize() const { return 11; }
76 bool containsDIEOffset(uint32_t die_offset) const {
77 return die_offset >= getFirstDIEOffset() &&
78 die_offset < getNextCompileUnitOffset();
80 uint32_t getFirstDIEOffset() const { return Offset + getSize(); }
81 uint32_t getNextCompileUnitOffset() const { return Offset + Length + 4; }
82 /// Size in bytes of the .debug_info data associated with this compile unit.
83 size_t getDebugInfoSize() const { return Length + 4 - getSize(); }
84 uint32_t getLength() const { return Length; }
85 uint16_t getVersion() const { return Version; }
86 const DWARFAbbreviationDeclarationSet *getAbbreviations() const {
89 uint8_t getAddressByteSize() const { return AddrSize; }
90 uint64_t getBaseAddress() const { return BaseAddr; }
92 void setBaseAddress(uint64_t base_addr) {
96 const DWARFDebugInfoEntryMinimal *
97 getCompileUnitDIE(bool extract_cu_die_only = true) {
98 extractDIEsIfNeeded(extract_cu_die_only);
104 const char *getCompilationDir();
106 /// setDIERelations - We read in all of the DIE entries into our flat list
107 /// of DIE entries and now we need to go back through all of them and set the
108 /// parent, sibling and child pointers for quick DIE navigation.
109 void setDIERelations();
111 void addDIE(DWARFDebugInfoEntryMinimal &die) {
112 // The average bytes per DIE entry has been seen to be
113 // around 14-20 so lets pre-reserve the needed memory for
114 // our DIE entries accordingly. Search forward for "Compute
115 // average bytes per DIE" to see #if'ed out code that does
116 // that determination.
118 // Only reserve the memory if we are adding children of
119 // the main compile unit DIE. The compile unit DIE is always
120 // the first entry, so if our size is 1, then we are adding
121 // the first compile unit child DIE and should reserve
123 if (DieArray.empty())
124 DieArray.reserve(getDebugInfoSize() / 14);
125 DieArray.push_back(die);
128 void clearDIEs(bool keep_compile_unit_die);
130 void buildAddressRangeTable(DWARFDebugAranges *debug_aranges,
131 bool clear_dies_if_already_not_parsed);
133 /// getInlinedChainForAddress - fetches inlined chain for a given address.
134 /// Returns empty chain if there is no subprogram containing address.
135 DWARFDebugInfoEntryMinimal::InlinedChain getInlinedChainForAddress(