1 //===- DWARFDebugLoc.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 "llvm/DebugInfo/DWARF/DWARFDebugLoc.h"
11 #include "llvm/ADT/StringRef.h"
12 #include "llvm/BinaryFormat/Dwarf.h"
13 #include "llvm/DebugInfo/DWARF/DWARFContext.h"
14 #include "llvm/DebugInfo/DWARF/DWARFExpression.h"
15 #include "llvm/DebugInfo/DWARF/DWARFRelocMap.h"
16 #include "llvm/DebugInfo/DWARF/DWARFUnit.h"
17 #include "llvm/Support/Compiler.h"
18 #include "llvm/Support/Format.h"
19 #include "llvm/Support/raw_ostream.h"
26 // When directly dumping the .debug_loc without a compile unit, we have to guess
27 // at the DWARF version. This only affects DW_OP_call_ref, which is a rare
28 // expression that LLVM doesn't produce. Guessing the wrong version means we
29 // won't be able to pretty print expressions in DWARF2 binaries produced by
31 static void dumpExpression(raw_ostream &OS, ArrayRef<char> Data,
32 bool IsLittleEndian, unsigned AddressSize,
33 const MCRegisterInfo *MRI) {
34 DWARFDataExtractor Extractor(StringRef(Data.data(), Data.size()),
35 IsLittleEndian, AddressSize);
36 DWARFExpression(Extractor, AddressSize, dwarf::DWARF_VERSION).print(OS, MRI);
39 void DWARFDebugLoc::LocationList::dump(raw_ostream &OS, bool IsLittleEndian,
41 const MCRegisterInfo *MRI,
42 unsigned Indent) const {
43 for (const Entry &E : Entries) {
46 OS << format("0x%016" PRIx64, E.Begin) << " - "
47 << format("0x%016" PRIx64, E.End) << ": ";
49 dumpExpression(OS, E.Loc, IsLittleEndian, AddressSize, MRI);
53 DWARFDebugLoc::LocationList const *
54 DWARFDebugLoc::getLocationListAtOffset(uint64_t Offset) const {
55 auto It = std::lower_bound(
56 Locations.begin(), Locations.end(), Offset,
57 [](const LocationList &L, uint64_t Offset) { return L.Offset < Offset; });
58 if (It != Locations.end() && It->Offset == Offset)
63 void DWARFDebugLoc::dump(raw_ostream &OS, const MCRegisterInfo *MRI,
64 Optional<uint64_t> Offset) const {
65 auto DumpLocationList = [&](const LocationList &L) {
66 OS << format("0x%8.8x: ", L.Offset);
67 L.dump(OS, IsLittleEndian, AddressSize, MRI, 12);
72 if (auto *L = getLocationListAtOffset(*Offset))
77 for (const LocationList &L : Locations) {
82 Optional<DWARFDebugLoc::LocationList>
83 DWARFDebugLoc::parseOneLocationList(DWARFDataExtractor Data, unsigned *Offset) {
87 // 2.6.2 Location Lists
88 // A location list entry consists of:
91 if (!Data.isValidOffsetForDataOfSize(*Offset, 2 * Data.getAddressSize())) {
92 llvm::errs() << "Location list overflows the debug_loc section.\n";
96 // 1. A beginning address offset. ...
97 E.Begin = Data.getRelocatedAddress(Offset);
99 // 2. An ending address offset. ...
100 E.End = Data.getRelocatedAddress(Offset);
102 // The end of any given location list is marked by an end of list entry,
103 // which consists of a 0 for the beginning address offset and a 0 for the
104 // ending address offset.
105 if (E.Begin == 0 && E.End == 0)
108 if (!Data.isValidOffsetForDataOfSize(*Offset, 2)) {
109 llvm::errs() << "Location list overflows the debug_loc section.\n";
113 unsigned Bytes = Data.getU16(Offset);
114 if (!Data.isValidOffsetForDataOfSize(*Offset, Bytes)) {
115 llvm::errs() << "Location list overflows the debug_loc section.\n";
118 // A single location description describing the location of the object...
119 StringRef str = Data.getData().substr(*Offset, Bytes);
121 E.Loc.reserve(str.size());
122 std::copy(str.begin(), str.end(), std::back_inserter(E.Loc));
123 LL.Entries.push_back(std::move(E));
127 void DWARFDebugLoc::parse(const DWARFDataExtractor &data) {
128 IsLittleEndian = data.isLittleEndian();
129 AddressSize = data.getAddressSize();
132 while (data.isValidOffset(Offset + data.getAddressSize() - 1)) {
133 if (auto LL = parseOneLocationList(data, &Offset))
134 Locations.push_back(std::move(*LL));
138 if (data.isValidOffset(Offset))
139 errs() << "error: failed to consume entire .debug_loc section\n";
142 Optional<DWARFDebugLocDWO::LocationList>
143 DWARFDebugLocDWO::parseOneLocationList(DataExtractor Data, unsigned *Offset) {
147 // dwarf::DW_LLE_end_of_list_entry is 0 and indicates the end of the list.
149 static_cast<dwarf::LocationListEntry>(Data.getU8(Offset))) {
150 if (Kind != dwarf::DW_LLE_startx_length) {
151 llvm::errs() << "error: dumping support for LLE of kind " << (int)Kind
152 << " not implemented\n";
157 E.Start = Data.getULEB128(Offset);
158 E.Length = Data.getU32(Offset);
160 unsigned Bytes = Data.getU16(Offset);
161 // A single location description describing the location of the object...
162 StringRef str = Data.getData().substr(*Offset, Bytes);
164 E.Loc.resize(str.size());
165 std::copy(str.begin(), str.end(), E.Loc.begin());
167 LL.Entries.push_back(std::move(E));
172 void DWARFDebugLocDWO::parse(DataExtractor data) {
173 IsLittleEndian = data.isLittleEndian();
174 AddressSize = data.getAddressSize();
177 while (data.isValidOffset(Offset)) {
178 if (auto LL = parseOneLocationList(data, &Offset))
179 Locations.push_back(std::move(*LL));
185 DWARFDebugLocDWO::LocationList const *
186 DWARFDebugLocDWO::getLocationListAtOffset(uint64_t Offset) const {
187 auto It = std::lower_bound(
188 Locations.begin(), Locations.end(), Offset,
189 [](const LocationList &L, uint64_t Offset) { return L.Offset < Offset; });
190 if (It != Locations.end() && It->Offset == Offset)
195 void DWARFDebugLocDWO::LocationList::dump(raw_ostream &OS, bool IsLittleEndian,
196 unsigned AddressSize,
197 const MCRegisterInfo *MRI,
198 unsigned Indent) const {
199 for (const Entry &E : Entries) {
202 OS << "Addr idx " << E.Start << " (w/ length " << E.Length << "): ";
203 dumpExpression(OS, E.Loc, IsLittleEndian, AddressSize, MRI);
207 void DWARFDebugLocDWO::dump(raw_ostream &OS, const MCRegisterInfo *MRI,
208 Optional<uint64_t> Offset) const {
209 auto DumpLocationList = [&](const LocationList &L) {
210 OS << format("0x%8.8x: ", L.Offset);
211 L.dump(OS, IsLittleEndian, AddressSize, MRI, /*Indent=*/12);
216 if (auto *L = getLocationListAtOffset(*Offset))
217 DumpLocationList(*L);
221 for (const LocationList &L : Locations) {