1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
|
//===- DWARFDebugLoc.cpp --------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "llvm/DebugInfo/DWARF/DWARFDebugLoc.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/BinaryFormat/Dwarf.h"
#include "llvm/DebugInfo/DWARF/DWARFContext.h"
#include "llvm/DebugInfo/DWARF/DWARFExpression.h"
#include "llvm/DebugInfo/DWARF/DWARFRelocMap.h"
#include "llvm/DebugInfo/DWARF/DWARFUnit.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/Format.h"
#include "llvm/Support/WithColor.h"
#include "llvm/Support/raw_ostream.h"
#include <algorithm>
#include <cinttypes>
#include <cstdint>
using namespace llvm;
// When directly dumping the .debug_loc without a compile unit, we have to guess
// at the DWARF version. This only affects DW_OP_call_ref, which is a rare
// expression that LLVM doesn't produce. Guessing the wrong version means we
// won't be able to pretty print expressions in DWARF2 binaries produced by
// non-LLVM tools.
static void dumpExpression(raw_ostream &OS, ArrayRef<uint8_t> Data,
bool IsLittleEndian, unsigned AddressSize,
const MCRegisterInfo *MRI, DWARFUnit *U) {
DWARFDataExtractor Extractor(toStringRef(Data), IsLittleEndian, AddressSize);
DWARFExpression(Extractor, dwarf::DWARF_VERSION, AddressSize).print(OS, MRI, U);
}
void DWARFDebugLoc::LocationList::dump(raw_ostream &OS, uint64_t BaseAddress,
bool IsLittleEndian,
unsigned AddressSize,
const MCRegisterInfo *MRI, DWARFUnit *U,
DIDumpOptions DumpOpts,
unsigned Indent) const {
for (const Entry &E : Entries) {
OS << '\n';
OS.indent(Indent);
OS << format("[0x%*.*" PRIx64 ", ", AddressSize * 2, AddressSize * 2,
BaseAddress + E.Begin);
OS << format(" 0x%*.*" PRIx64 ")", AddressSize * 2, AddressSize * 2,
BaseAddress + E.End);
OS << ": ";
dumpExpression(OS, E.Loc, IsLittleEndian, AddressSize, MRI, U);
}
}
DWARFDebugLoc::LocationList const *
DWARFDebugLoc::getLocationListAtOffset(uint64_t Offset) const {
auto It = partition_point(
Locations, [=](const LocationList &L) { return L.Offset < Offset; });
if (It != Locations.end() && It->Offset == Offset)
return &(*It);
return nullptr;
}
void DWARFDebugLoc::dump(raw_ostream &OS, const MCRegisterInfo *MRI, DIDumpOptions DumpOpts,
Optional<uint64_t> Offset) const {
auto DumpLocationList = [&](const LocationList &L) {
OS << format("0x%8.8" PRIx64 ": ", L.Offset);
L.dump(OS, 0, IsLittleEndian, AddressSize, MRI, nullptr, DumpOpts, 12);
OS << "\n";
};
if (Offset) {
if (auto *L = getLocationListAtOffset(*Offset))
DumpLocationList(*L);
return;
}
for (const LocationList &L : Locations) {
DumpLocationList(L);
if (&L != &Locations.back())
OS << '\n';
}
}
Expected<DWARFDebugLoc::LocationList>
DWARFDebugLoc::parseOneLocationList(const DWARFDataExtractor &Data,
uint64_t *Offset) {
LocationList LL;
LL.Offset = *Offset;
AddressSize = Data.getAddressSize();
DataExtractor::Cursor C(*Offset);
// 2.6.2 Location Lists
// A location list entry consists of:
while (true) {
Entry E;
// 1. A beginning address offset. ...
E.Begin = Data.getRelocatedAddress(C);
// 2. An ending address offset. ...
E.End = Data.getRelocatedAddress(C);
if (Error Err = C.takeError())
return std::move(Err);
// The end of any given location list is marked by an end of list entry,
// which consists of a 0 for the beginning address offset and a 0 for the
// ending address offset.
if (E.Begin == 0 && E.End == 0) {
*Offset = C.tell();
return LL;
}
if (E.Begin != (AddressSize == 4 ? -1U : -1ULL)) {
unsigned Bytes = Data.getU16(C);
// A single location description describing the location of the object...
Data.getU8(C, E.Loc, Bytes);
}
LL.Entries.push_back(std::move(E));
}
}
void DWARFDebugLoc::parse(const DWARFDataExtractor &data) {
IsLittleEndian = data.isLittleEndian();
AddressSize = data.getAddressSize();
uint64_t Offset = 0;
while (Offset < data.getData().size()) {
if (auto LL = parseOneLocationList(data, &Offset))
Locations.push_back(std::move(*LL));
else {
logAllUnhandledErrors(LL.takeError(), WithColor::error());
break;
}
}
}
Error DWARFDebugLoclists::visitLocationList(
const DWARFDataExtractor &Data, uint64_t *Offset, uint16_t Version,
llvm::function_ref<bool(const Entry &)> F) {
DataExtractor::Cursor C(*Offset);
bool Continue = true;
while (Continue) {
Entry E;
E.Offset = C.tell();
E.Kind = Data.getU8(C);
switch (E.Kind) {
case dwarf::DW_LLE_end_of_list:
break;
case dwarf::DW_LLE_base_addressx:
E.Value0 = Data.getULEB128(C);
break;
case dwarf::DW_LLE_startx_length:
E.Value0 = Data.getULEB128(C);
// Pre-DWARF 5 has different interpretation of the length field. We have
// to support both pre- and standartized styles for the compatibility.
if (Version < 5)
E.Value1 = Data.getU32(C);
else
E.Value1 = Data.getULEB128(C);
break;
case dwarf::DW_LLE_offset_pair:
E.Value0 = Data.getULEB128(C);
E.Value1 = Data.getULEB128(C);
break;
case dwarf::DW_LLE_base_address:
E.Value0 = Data.getRelocatedAddress(C);
break;
case dwarf::DW_LLE_start_length:
E.Value0 = Data.getRelocatedAddress(C);
E.Value1 = Data.getULEB128(C);
break;
case dwarf::DW_LLE_startx_endx:
case dwarf::DW_LLE_default_location:
case dwarf::DW_LLE_start_end:
default:
cantFail(C.takeError());
return createStringError(errc::illegal_byte_sequence,
"LLE of kind %x not supported", (int)E.Kind);
}
if (E.Kind != dwarf::DW_LLE_base_address &&
E.Kind != dwarf::DW_LLE_base_addressx &&
E.Kind != dwarf::DW_LLE_end_of_list) {
unsigned Bytes = Version >= 5 ? Data.getULEB128(C) : Data.getU16(C);
// A single location description describing the location of the object...
Data.getU8(C, E.Loc, Bytes);
}
if (!C)
return C.takeError();
Continue = F(E) && E.Kind != dwarf::DW_LLE_end_of_list;
}
*Offset = C.tell();
return Error::success();
}
bool DWARFDebugLoclists::dumpLocationList(const DWARFDataExtractor &Data,
uint64_t *Offset, uint16_t Version,
raw_ostream &OS, uint64_t BaseAddr,
const MCRegisterInfo *MRI,
DWARFUnit *U, DIDumpOptions DumpOpts,
unsigned Indent) {
size_t MaxEncodingStringLength = 0;
if (DumpOpts.Verbose) {
#define HANDLE_DW_LLE(ID, NAME) \
MaxEncodingStringLength = std::max(MaxEncodingStringLength, \
dwarf::LocListEncodingString(ID).size());
#include "llvm/BinaryFormat/Dwarf.def"
}
OS << format("0x%8.8" PRIx64 ": ", *Offset);
Error E = visitLocationList(Data, Offset, Version, [&](const Entry &E) {
E.dump(OS, BaseAddr, Data.isLittleEndian(), Data.getAddressSize(), MRI, U,
DumpOpts, Indent, MaxEncodingStringLength);
return true;
});
if (E) {
OS << "\n";
OS.indent(Indent);
OS << "error: " << toString(std::move(E));
return false;
}
return true;
}
void DWARFDebugLoclists::Entry::dump(raw_ostream &OS, uint64_t &BaseAddr,
bool IsLittleEndian, unsigned AddressSize,
const MCRegisterInfo *MRI, DWARFUnit *U,
DIDumpOptions DumpOpts, unsigned Indent,
size_t MaxEncodingStringLength) const {
if (DumpOpts.Verbose) {
OS << "\n";
OS.indent(Indent);
auto EncodingString = dwarf::LocListEncodingString(Kind);
// Unsupported encodings should have been reported during parsing.
assert(!EncodingString.empty() && "Unknown loclist entry encoding");
OS << format("%s%*c", EncodingString.data(),
MaxEncodingStringLength - EncodingString.size() + 1, '(');
switch (Kind) {
case dwarf::DW_LLE_startx_length:
case dwarf::DW_LLE_start_length:
case dwarf::DW_LLE_offset_pair:
OS << format("0x%*.*" PRIx64 ", 0x%*.*" PRIx64, AddressSize * 2,
AddressSize * 2, Value0, AddressSize * 2, AddressSize * 2,
Value1);
break;
case dwarf::DW_LLE_base_addressx:
case dwarf::DW_LLE_base_address:
OS << format("0x%*.*" PRIx64, AddressSize * 2, AddressSize * 2,
Value0);
break;
case dwarf::DW_LLE_end_of_list:
break;
}
OS << ')';
}
auto PrintPrefix = [&] {
OS << "\n";
OS.indent(Indent);
if (DumpOpts.Verbose)
OS << format("%*s", MaxEncodingStringLength, (const char *)"=> ");
};
switch (Kind) {
case dwarf::DW_LLE_startx_length:
PrintPrefix();
OS << "Addr idx " << Value0 << " (w/ length " << Value1 << "): ";
break;
case dwarf::DW_LLE_start_length:
PrintPrefix();
DWARFAddressRange(Value0, Value0 + Value1)
.dump(OS, AddressSize, DumpOpts);
OS << ": ";
break;
case dwarf::DW_LLE_offset_pair:
PrintPrefix();
DWARFAddressRange(BaseAddr + Value0, BaseAddr + Value1)
.dump(OS, AddressSize, DumpOpts);
OS << ": ";
break;
case dwarf::DW_LLE_base_addressx:
if (!DumpOpts.Verbose)
return;
break;
case dwarf::DW_LLE_end_of_list:
if (!DumpOpts.Verbose)
return;
break;
case dwarf::DW_LLE_base_address:
BaseAddr = Value0;
if (!DumpOpts.Verbose)
return;
break;
default:
llvm_unreachable("unreachable locations list kind");
}
dumpExpression(OS, Loc, IsLittleEndian, AddressSize, MRI, U);
}
void DWARFDebugLoclists::dumpRange(const DWARFDataExtractor &Data,
uint64_t StartOffset, uint64_t Size,
uint16_t Version, raw_ostream &OS,
uint64_t BaseAddr, const MCRegisterInfo *MRI,
DIDumpOptions DumpOpts) {
if (!Data.isValidOffsetForDataOfSize(StartOffset, Size)) {
OS << "Invalid dump range\n";
return;
}
uint64_t Offset = StartOffset;
StringRef Separator;
bool CanContinue = true;
while (CanContinue && Offset < StartOffset + Size) {
OS << Separator;
Separator = "\n";
CanContinue = dumpLocationList(Data, &Offset, Version, OS, BaseAddr, MRI,
nullptr, DumpOpts, /*Indent=*/12);
OS << '\n';
}
}
|