1 //===-- DWARFContext.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_DWARFCONTEXT_H
11 #define LLVM_DEBUGINFO_DWARFCONTEXT_H
13 #include "DWARFCompileUnit.h"
14 #include "DWARFDebugAranges.h"
15 #include "DWARFDebugLine.h"
16 #include "llvm/DebugInfo/DIContext.h"
17 #include "llvm/ADT/OwningPtr.h"
18 #include "llvm/ADT/SmallVector.h"
23 /// This data structure is the top level entity that deals with dwarf debug
24 /// information parsing. The actual data is supplied through pure virtual
25 /// methods that a concrete implementation provides.
26 class DWARFContext : public DIContext {
29 SmallVector<DWARFCompileUnit, 1> CUs;
30 OwningPtr<DWARFDebugAbbrev> Abbrev;
31 OwningPtr<DWARFDebugAranges> Aranges;
32 OwningPtr<DWARFDebugLine> Line;
34 DWARFContext(DWARFContext &); // = delete
35 DWARFContext &operator=(DWARFContext &); // = delete
37 /// Read compile units from the debug_info section and store them in CUs.
38 void parseCompileUnits();
40 DWARFContext(bool isLittleEndian) : IsLittleEndian(isLittleEndian) {}
42 virtual void dump(raw_ostream &OS);
43 /// Get the number of compile units in this context.
44 unsigned getNumCompileUnits() {
49 /// Get the compile unit at the specified index for this compile unit.
50 DWARFCompileUnit *getCompileUnitAtIndex(unsigned index) {
56 /// Get a pointer to the parsed DebugAbbrev object.
57 const DWARFDebugAbbrev *getDebugAbbrev();
59 /// Get a pointer to the parsed DebugAranges object.
60 const DWARFDebugAranges *getDebugAranges();
62 /// Get a pointer to a parsed line table corresponding to a compile unit.
63 const DWARFDebugLine::LineTable *
64 getLineTableForCompileUnit(DWARFCompileUnit *cu);
66 bool isLittleEndian() const { return IsLittleEndian; }
68 virtual StringRef getInfoSection() = 0;
69 virtual StringRef getAbbrevSection() = 0;
70 virtual StringRef getARangeSection() = 0;
71 virtual StringRef getLineSection() = 0;
72 virtual StringRef getStringSection() = 0;
74 static bool isSupportedVersion(unsigned version) {
75 return version == 2 || version == 3;
80 /// DWARFContextInMemory is the simplest possible implementation of a
81 /// DWARFContext. It assumes all content is available in memory and stores
83 class DWARFContextInMemory : public DWARFContext {
84 StringRef InfoSection;
85 StringRef AbbrevSection;
86 StringRef ARangeSection;
87 StringRef LineSection;
88 StringRef StringSection;
90 DWARFContextInMemory(bool isLittleEndian,
91 StringRef infoSection,
92 StringRef abbrevSection,
93 StringRef aRangeSection,
94 StringRef lineSection,
95 StringRef stringSection)
96 : DWARFContext(isLittleEndian),
97 InfoSection(infoSection),
98 AbbrevSection(abbrevSection),
99 ARangeSection(aRangeSection),
100 LineSection(lineSection),
101 StringSection(stringSection)
104 virtual StringRef getInfoSection() { return InfoSection; }
105 virtual StringRef getAbbrevSection() { return AbbrevSection; }
106 virtual StringRef getARangeSection() { return ARangeSection; }
107 virtual StringRef getLineSection() { return LineSection; }
108 virtual StringRef getStringSection() { return StringSection; }