LLVM 17.0.0git
DWARFFormValue.cpp
Go to the documentation of this file.
1//===- DWARFFormValue.cpp -------------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "llvm/DebugInfo/DWARF/DWARFFormValue.h"
10#include "llvm/ADT/ArrayRef.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/DWARFDataExtractor.h"
15#include "llvm/DebugInfo/DWARF/DWARFDebugLine.h"
16#include "llvm/DebugInfo/DWARF/DWARFObject.h"
17#include "llvm/DebugInfo/DWARF/DWARFSection.h"
18#include "llvm/DebugInfo/DWARF/DWARFUnit.h"
19#include "llvm/Support/ErrorHandling.h"
20#include "llvm/Support/Format.h"
21#include "llvm/Support/WithColor.h"
22#include "llvm/Support/raw_ostream.h"
23#include <cinttypes>
24#include <cstdint>
25#include <limits>
26#include <optional>
27
28using namespace llvm;
29using namespace dwarf;
30
31static const DWARFFormValue::FormClass DWARF5FormClasses[] = {
32 DWARFFormValue::FC_Unknown, // 0x0
33 DWARFFormValue::FC_Address, // 0x01 DW_FORM_addr
34 DWARFFormValue::FC_Unknown, // 0x02 unused
35 DWARFFormValue::FC_Block, // 0x03 DW_FORM_block2
36 DWARFFormValue::FC_Block, // 0x04 DW_FORM_block4
37 DWARFFormValue::FC_Constant, // 0x05 DW_FORM_data2
38 // --- These can be FC_SectionOffset in DWARF3 and below:
39 DWARFFormValue::FC_Constant, // 0x06 DW_FORM_data4
40 DWARFFormValue::FC_Constant, // 0x07 DW_FORM_data8
41 // ---
42 DWARFFormValue::FC_String, // 0x08 DW_FORM_string
43 DWARFFormValue::FC_Block, // 0x09 DW_FORM_block
44 DWARFFormValue::FC_Block, // 0x0a DW_FORM_block1
45 DWARFFormValue::FC_Constant, // 0x0b DW_FORM_data1
46 DWARFFormValue::FC_Flag, // 0x0c DW_FORM_flag
47 DWARFFormValue::FC_Constant, // 0x0d DW_FORM_sdata
48 DWARFFormValue::FC_String, // 0x0e DW_FORM_strp
49 DWARFFormValue::FC_Constant, // 0x0f DW_FORM_udata
50 DWARFFormValue::FC_Reference, // 0x10 DW_FORM_ref_addr
51 DWARFFormValue::FC_Reference, // 0x11 DW_FORM_ref1
52 DWARFFormValue::FC_Reference, // 0x12 DW_FORM_ref2
53 DWARFFormValue::FC_Reference, // 0x13 DW_FORM_ref4
54 DWARFFormValue::FC_Reference, // 0x14 DW_FORM_ref8
55 DWARFFormValue::FC_Reference, // 0x15 DW_FORM_ref_udata
56 DWARFFormValue::FC_Indirect, // 0x16 DW_FORM_indirect
57 DWARFFormValue::FC_SectionOffset, // 0x17 DW_FORM_sec_offset
58 DWARFFormValue::FC_Exprloc, // 0x18 DW_FORM_exprloc
59 DWARFFormValue::FC_Flag, // 0x19 DW_FORM_flag_present
60 DWARFFormValue::FC_String, // 0x1a DW_FORM_strx
61 DWARFFormValue::FC_Address, // 0x1b DW_FORM_addrx
62 DWARFFormValue::FC_Reference, // 0x1c DW_FORM_ref_sup4
63 DWARFFormValue::FC_String, // 0x1d DW_FORM_strp_sup
64 DWARFFormValue::FC_Constant, // 0x1e DW_FORM_data16
65 DWARFFormValue::FC_String, // 0x1f DW_FORM_line_strp
66 DWARFFormValue::FC_Reference, // 0x20 DW_FORM_ref_sig8
67 DWARFFormValue::FC_Constant, // 0x21 DW_FORM_implicit_const
68 DWARFFormValue::FC_SectionOffset, // 0x22 DW_FORM_loclistx
69 DWARFFormValue::FC_SectionOffset, // 0x23 DW_FORM_rnglistx
70 DWARFFormValue::FC_Reference, // 0x24 DW_FORM_ref_sup8
71 DWARFFormValue::FC_String, // 0x25 DW_FORM_strx1
72 DWARFFormValue::FC_String, // 0x26 DW_FORM_strx2
73 DWARFFormValue::FC_String, // 0x27 DW_FORM_strx3
74 DWARFFormValue::FC_String, // 0x28 DW_FORM_strx4
75 DWARFFormValue::FC_Address, // 0x29 DW_FORM_addrx1
76 DWARFFormValue::FC_Address, // 0x2a DW_FORM_addrx2
77 DWARFFormValue::FC_Address, // 0x2b DW_FORM_addrx3
78 DWARFFormValue::FC_Address, // 0x2c DW_FORM_addrx4
79 DWARFFormValue::FC_Address, // 0x2001 DW_FORM_addrx_offset
80};
81
82DWARFFormValue DWARFFormValue::createFromSValue(dwarf::Form F, int64_t V) {
83 return DWARFFormValue(F, ValueType(V));
84}
85
86DWARFFormValue DWARFFormValue::createFromUValue(dwarf::Form F, uint64_t V) {
87 return DWARFFormValue(F, ValueType(V));
88}
89
90DWARFFormValue DWARFFormValue::createFromPValue(dwarf::Form F, const char *V) {
91 return DWARFFormValue(F, ValueType(V));
92}
93
94DWARFFormValue DWARFFormValue::createFromBlockValue(dwarf::Form F,
95 ArrayRef<uint8_t> D) {
96 ValueType V;
97 V.uval = D.size();
98 V.data = D.data();
99 return DWARFFormValue(F, V);
100}
101
102DWARFFormValue DWARFFormValue::createFromUnit(dwarf::Form F, const DWARFUnit *U,
103 uint64_t *OffsetPtr) {
104 DWARFFormValue FormValue(F);
105 FormValue.extractValue(U->getDebugInfoExtractor(), OffsetPtr,
106 U->getFormParams(), U);
107 return FormValue;
108}
109
110bool DWARFFormValue::skipValue(dwarf::Form Form, DataExtractor DebugInfoData,
111 uint64_t *OffsetPtr,
112 const dwarf::FormParams Params) {
113 bool Indirect = false;
114 do {
115 switch (Form) {
116 // Blocks of inlined data that have a length field and the data bytes
117 // inlined in the .debug_info.
118 case DW_FORM_exprloc:
119 case DW_FORM_block: {
120 uint64_t size = DebugInfoData.getULEB128(OffsetPtr);
121 *OffsetPtr += size;
122 return true;
123 }
124 case DW_FORM_block1: {
125 uint8_t size = DebugInfoData.getU8(OffsetPtr);
126 *OffsetPtr += size;
127 return true;
128 }
129 case DW_FORM_block2: {
130 uint16_t size = DebugInfoData.getU16(OffsetPtr);
131 *OffsetPtr += size;
132 return true;
133 }
134 case DW_FORM_block4: {
135 uint32_t size = DebugInfoData.getU32(OffsetPtr);
136 *OffsetPtr += size;
137 return true;
138 }
139
140 // Inlined NULL terminated C-strings.
141 case DW_FORM_string:
142 DebugInfoData.getCStr(OffsetPtr);
143 return true;
144
145 case DW_FORM_addr:
146 case DW_FORM_ref_addr:
147 case DW_FORM_flag_present:
148 case DW_FORM_data1:
149 case DW_FORM_data2:
150 case DW_FORM_data4:
151 case DW_FORM_data8:
152 case DW_FORM_data16:
153 case DW_FORM_flag:
154 case DW_FORM_ref1:
155 case DW_FORM_ref2:
156 case DW_FORM_ref4:
157 case DW_FORM_ref8:
158 case DW_FORM_ref_sig8:
159 case DW_FORM_ref_sup4:
160 case DW_FORM_ref_sup8:
161 case DW_FORM_strx1:
162 case DW_FORM_strx2:
163 case DW_FORM_strx3:
164 case DW_FORM_strx4:
165 case DW_FORM_addrx1:
166 case DW_FORM_addrx2:
167 case DW_FORM_addrx3:
168 case DW_FORM_addrx4:
169 case DW_FORM_sec_offset:
170 case DW_FORM_strp:
171 case DW_FORM_strp_sup:
172 case DW_FORM_line_strp:
173 case DW_FORM_GNU_ref_alt:
174 case DW_FORM_GNU_strp_alt:
175 case DW_FORM_implicit_const:
176 if (std::optional<uint8_t> FixedSize =
177 dwarf::getFixedFormByteSize(Form, Params)) {
178 *OffsetPtr += *FixedSize;
179 return true;
180 }
181 return false;
182
183 // signed or unsigned LEB 128 values.
184 case DW_FORM_sdata:
185 DebugInfoData.getSLEB128(OffsetPtr);
186 return true;
187
188 case DW_FORM_udata:
189 case DW_FORM_ref_udata:
190 case DW_FORM_strx:
191 case DW_FORM_addrx:
192 case DW_FORM_loclistx:
193 case DW_FORM_rnglistx:
194 case DW_FORM_GNU_addr_index:
195 case DW_FORM_GNU_str_index:
196 DebugInfoData.getULEB128(OffsetPtr);
197 return true;
198
199 case DW_FORM_LLVM_addrx_offset:
200 DebugInfoData.getULEB128(OffsetPtr);
201 *OffsetPtr += 4;
202 return true;
203
204 case DW_FORM_indirect:
205 Indirect = true;
206 Form = static_cast<dwarf::Form>(DebugInfoData.getULEB128(OffsetPtr));
207 break;
208
209 default:
210 return false;
211 }
212 } while (Indirect);
213 return true;
214}
215
216bool DWARFFormValue::isFormClass(DWARFFormValue::FormClass FC) const {
217 return doesFormBelongToClass(Form, FC, U ? U->getVersion() : 3);
218}
219
220bool DWARFFormValue::extractValue(const DWARFDataExtractor &Data,
221 uint64_t *OffsetPtr, dwarf::FormParams FP,
222 const DWARFContext *Ctx,
223 const DWARFUnit *CU) {
224 if (!Ctx && CU)
225 Ctx = &CU->getContext();
226 C = Ctx;
227 U = CU;
228 Format = FP.Format;
229 bool Indirect = false;
230 bool IsBlock = false;
231 Value.data = nullptr;
232 // Read the value for the form into value and follow and DW_FORM_indirect
233 // instances we run into
234 Error Err = Error::success();
235 do {
236 Indirect = false;
237 switch (Form) {
238 case DW_FORM_addr:
239 case DW_FORM_ref_addr: {
240 uint16_t Size =
241 (Form == DW_FORM_addr) ? FP.AddrSize : FP.getRefAddrByteSize();
242 Value.uval =
243 Data.getRelocatedValue(Size, OffsetPtr, &Value.SectionIndex, &Err);
244 break;
245 }
246 case DW_FORM_exprloc:
247 case DW_FORM_block:
248 Value.uval = Data.getULEB128(OffsetPtr, &Err);
249 IsBlock = true;
250 break;
251 case DW_FORM_block1:
252 Value.uval = Data.getU8(OffsetPtr, &Err);
253 IsBlock = true;
254 break;
255 case DW_FORM_block2:
256 Value.uval = Data.getU16(OffsetPtr, &Err);
257 IsBlock = true;
258 break;
259 case DW_FORM_block4:
260 Value.uval = Data.getU32(OffsetPtr, &Err);
261 IsBlock = true;
262 break;
263 case DW_FORM_data1:
264 case DW_FORM_ref1:
265 case DW_FORM_flag:
266 case DW_FORM_strx1:
267 case DW_FORM_addrx1:
268 Value.uval = Data.getU8(OffsetPtr, &Err);
269 break;
270 case DW_FORM_data2:
271 case DW_FORM_ref2:
272 case DW_FORM_strx2:
273 case DW_FORM_addrx2:
274 Value.uval = Data.getU16(OffsetPtr, &Err);
275 break;
276 case DW_FORM_strx3:
277 case DW_FORM_addrx3:
278 Value.uval = Data.getU24(OffsetPtr, &Err);
279 break;
280 case DW_FORM_data4:
281 case DW_FORM_ref4:
282 case DW_FORM_ref_sup4:
283 case DW_FORM_strx4:
284 case DW_FORM_addrx4:
285 Value.uval = Data.getRelocatedValue(4, OffsetPtr, nullptr, &Err);
286 break;
287 case DW_FORM_data8:
288 case DW_FORM_ref8:
289 case DW_FORM_ref_sup8:
290 Value.uval = Data.getRelocatedValue(8, OffsetPtr, nullptr, &Err);
291 break;
292 case DW_FORM_data16:
293 // Treat this like a 16-byte block.
294 Value.uval = 16;
295 IsBlock = true;
296 break;
297 case DW_FORM_sdata:
298 Value.sval = Data.getSLEB128(OffsetPtr, &Err);
299 break;
300 case DW_FORM_udata:
301 case DW_FORM_ref_udata:
302 case DW_FORM_rnglistx:
303 case DW_FORM_loclistx:
304 case DW_FORM_GNU_addr_index:
305 case DW_FORM_GNU_str_index:
306 case DW_FORM_addrx:
307 case DW_FORM_strx:
308 Value.uval = Data.getULEB128(OffsetPtr, &Err);
309 break;
310 case DW_FORM_LLVM_addrx_offset:
311 Value.uval = Data.getULEB128(OffsetPtr, &Err) << 32;
312 Value.uval |= Data.getU32(OffsetPtr, &Err);
313 break;
314 case DW_FORM_string:
315 Value.cstr = Data.getCStr(OffsetPtr, &Err);
316 break;
317 case DW_FORM_indirect:
318 Form = static_cast<dwarf::Form>(Data.getULEB128(OffsetPtr, &Err));
319 Indirect = true;
320 break;
321 case DW_FORM_strp:
322 case DW_FORM_sec_offset:
323 case DW_FORM_GNU_ref_alt:
324 case DW_FORM_GNU_strp_alt:
325 case DW_FORM_line_strp:
326 case DW_FORM_strp_sup: {
327 Value.uval = Data.getRelocatedValue(FP.getDwarfOffsetByteSize(),
328 OffsetPtr, nullptr, &Err);
329 break;
330 }
331 case DW_FORM_flag_present:
332 Value.uval = 1;
333 break;
334 case DW_FORM_ref_sig8:
335 Value.uval = Data.getU64(OffsetPtr, &Err);
336 break;
337 case DW_FORM_implicit_const:
338 // Value has been already set by DWARFFormValue::createFromSValue.
339 break;
340 default:
341 // DWARFFormValue::skipValue() will have caught this and caused all
342 // DWARF DIEs to fail to be parsed, so this code is not be reachable.
343 llvm_unreachable("unsupported form");
344 }
345 } while (Indirect && !Err);
346
347 if (IsBlock)
348 Value.data = Data.getBytes(OffsetPtr, Value.uval, &Err).bytes_begin();
349
350 return !errorToBool(std::move(Err));
351}
352
353void DWARFFormValue::dumpAddress(raw_ostream &OS, uint8_t AddressSize,
354 uint64_t Address) {
355 uint8_t HexDigits = AddressSize * 2;
356 OS << format("0x%*.*" PRIx64, HexDigits, HexDigits, Address);
357}
358
359void DWARFFormValue::dumpSectionedAddress(raw_ostream &OS,
360 DIDumpOptions DumpOpts,
361 object::SectionedAddress SA) const {
362 dumpAddress(OS, U->getAddressByteSize(), SA.Address);
363 dumpAddressSection(U->getContext().getDWARFObj(), OS, DumpOpts,
364 SA.SectionIndex);
365}
366
367void DWARFFormValue::dumpAddressSection(const DWARFObject &Obj, raw_ostream &OS,
368 DIDumpOptions DumpOpts,
369 uint64_t SectionIndex) {
370 if (!DumpOpts.Verbose || SectionIndex == -1ULL)
371 return;
372 ArrayRef<SectionName> SectionNames = Obj.getSectionNames();
373 const auto &SecRef = SectionNames[SectionIndex];
374
375 OS << " \"" << SecRef.Name << '\"';
376
377 // Print section index if name is not unique.
378 if (!SecRef.IsNameUnique)
379 OS << format(" [%" PRIu64 "]", SectionIndex);
380}
381
382void DWARFFormValue::dump(raw_ostream &OS, DIDumpOptions DumpOpts) const {
383 uint64_t UValue = Value.uval;
384 bool CURelativeOffset = false;
385 raw_ostream &AddrOS = DumpOpts.ShowAddresses
386 ? WithColor(OS, HighlightColor::Address).get()
387 : nulls();
388 int OffsetDumpWidth = 2 * dwarf::getDwarfOffsetByteSize(Format);
389 switch (Form) {
390 case DW_FORM_addr:
391 dumpSectionedAddress(AddrOS, DumpOpts, {Value.uval, Value.SectionIndex});
392 break;
393 case DW_FORM_addrx:
394 case DW_FORM_addrx1:
395 case DW_FORM_addrx2:
396 case DW_FORM_addrx3:
397 case DW_FORM_addrx4:
398 case DW_FORM_GNU_addr_index:
399 case DW_FORM_LLVM_addrx_offset: {
400 if (U == nullptr) {
401 OS << "<invalid dwarf unit>";
402 break;
403 }
404 std::optional<object::SectionedAddress> A = getAsSectionedAddress();
405 if (!A || DumpOpts.Verbose) {
406 if (Form == DW_FORM_LLVM_addrx_offset) {
407 uint32_t Index = UValue >> 32;
408 uint32_t Offset = UValue & 0xffffffff;
409 AddrOS << format("indexed (%8.8x) + 0x%x address = ", Index, Offset);
410 } else
411 AddrOS << format("indexed (%8.8x) address = ", (uint32_t)UValue);
412 }
413 if (A)
414 dumpSectionedAddress(AddrOS, DumpOpts, *A);
415 else
416 OS << "<unresolved>";
417 break;
418 }
419 case DW_FORM_flag_present:
420 OS << "true";
421 break;
422 case DW_FORM_flag:
423 case DW_FORM_data1:
424 OS << format("0x%02x", (uint8_t)UValue);
425 break;
426 case DW_FORM_data2:
427 OS << format("0x%04x", (uint16_t)UValue);
428 break;
429 case DW_FORM_data4:
430 OS << format("0x%08x", (uint32_t)UValue);
431 break;
432 case DW_FORM_ref_sig8:
433 AddrOS << format("0x%016" PRIx64, UValue);
434 break;
435 case DW_FORM_data8:
436 OS << format("0x%016" PRIx64, UValue);
437 break;
438 case DW_FORM_data16:
439 OS << format_bytes(ArrayRef<uint8_t>(Value.data, 16), std::nullopt, 16, 16);
440 break;
441 case DW_FORM_string:
442 OS << '"';
443 OS.write_escaped(Value.cstr);
444 OS << '"';
445 break;
446 case DW_FORM_exprloc:
447 case DW_FORM_block:
448 case DW_FORM_block1:
449 case DW_FORM_block2:
450 case DW_FORM_block4:
451 if (UValue > 0) {
452 switch (Form) {
453 case DW_FORM_exprloc:
454 case DW_FORM_block:
455 AddrOS << format("<0x%" PRIx64 "> ", UValue);
456 break;
457 case DW_FORM_block1:
458 AddrOS << format("<0x%2.2x> ", (uint8_t)UValue);
459 break;
460 case DW_FORM_block2:
461 AddrOS << format("<0x%4.4x> ", (uint16_t)UValue);
462 break;
463 case DW_FORM_block4:
464 AddrOS << format("<0x%8.8x> ", (uint32_t)UValue);
465 break;
466 default:
467 break;
468 }
469
470 const uint8_t *DataPtr = Value.data;
471 if (DataPtr) {
472 // UValue contains size of block
473 const uint8_t *EndDataPtr = DataPtr + UValue;
474 while (DataPtr < EndDataPtr) {
475 AddrOS << format("%2.2x ", *DataPtr);
476 ++DataPtr;
477 }
478 } else
479 OS << "NULL";
480 }
481 break;
482
483 case DW_FORM_sdata:
484 case DW_FORM_implicit_const:
485 OS << Value.sval;
486 break;
487 case DW_FORM_udata:
488 OS << Value.uval;
489 break;
490 case DW_FORM_strp:
491 if (DumpOpts.Verbose)
492 OS << format(" .debug_str[0x%0*" PRIx64 "] = ", OffsetDumpWidth, UValue);
493 dumpString(OS);
494 break;
495 case DW_FORM_line_strp:
496 if (DumpOpts.Verbose)
497 OS << format(" .debug_line_str[0x%0*" PRIx64 "] = ", OffsetDumpWidth,
498 UValue);
499 dumpString(OS);
500 break;
501 case DW_FORM_strx:
502 case DW_FORM_strx1:
503 case DW_FORM_strx2:
504 case DW_FORM_strx3:
505 case DW_FORM_strx4:
506 case DW_FORM_GNU_str_index:
507 if (DumpOpts.Verbose)
508 OS << format("indexed (%8.8x) string = ", (uint32_t)UValue);
509 dumpString(OS);
510 break;
511 case DW_FORM_GNU_strp_alt:
512 if (DumpOpts.Verbose)
513 OS << format("alt indirect string, offset: 0x%" PRIx64 "", UValue);
514 dumpString(OS);
515 break;
516 case DW_FORM_ref_addr:
517 AddrOS << format("0x%016" PRIx64, UValue);
518 break;
519 case DW_FORM_ref1:
520 CURelativeOffset = true;
521 if (DumpOpts.Verbose)
522 AddrOS << format("cu + 0x%2.2x", (uint8_t)UValue);
523 break;
524 case DW_FORM_ref2:
525 CURelativeOffset = true;
526 if (DumpOpts.Verbose)
527 AddrOS << format("cu + 0x%4.4x", (uint16_t)UValue);
528 break;
529 case DW_FORM_ref4:
530 CURelativeOffset = true;
531 if (DumpOpts.Verbose)
532 AddrOS << format("cu + 0x%4.4x", (uint32_t)UValue);
533 break;
534 case DW_FORM_ref8:
535 CURelativeOffset = true;
536 if (DumpOpts.Verbose)
537 AddrOS << format("cu + 0x%8.8" PRIx64, UValue);
538 break;
539 case DW_FORM_ref_udata:
540 CURelativeOffset = true;
541 if (DumpOpts.Verbose)
542 AddrOS << format("cu + 0x%" PRIx64, UValue);
543 break;
544 case DW_FORM_GNU_ref_alt:
545 AddrOS << format("<alt 0x%" PRIx64 ">", UValue);
546 break;
547
548 // All DW_FORM_indirect attributes should be resolved prior to calling
549 // this function
550 case DW_FORM_indirect:
551 OS << "DW_FORM_indirect";
552 break;
553
554 case DW_FORM_rnglistx:
555 OS << format("indexed (0x%x) rangelist = ", (uint32_t)UValue);
556 break;
557
558 case DW_FORM_loclistx:
559 OS << format("indexed (0x%x) loclist = ", (uint32_t)UValue);
560 break;
561
562 case DW_FORM_sec_offset:
563 AddrOS << format("0x%0*" PRIx64, OffsetDumpWidth, UValue);
564 break;
565
566 default:
567 OS << format("DW_FORM(0x%4.4x)", Form);
568 break;
569 }
570
571 if (CURelativeOffset) {
572 if (DumpOpts.Verbose)
573 OS << " => {";
574 if (DumpOpts.ShowAddresses)
575 WithColor(OS, HighlightColor::Address).get()
576 << format("0x%8.8" PRIx64, UValue + (U ? U->getOffset() : 0));
577 if (DumpOpts.Verbose)
578 OS << "}";
579 }
580}
581
582void DWARFFormValue::dumpString(raw_ostream &OS) const {
583 if (auto DbgStr = dwarf::toString(*this)) {
584 auto COS = WithColor(OS, HighlightColor::String);
585 COS.get() << '"';
586 COS.get().write_escaped(*DbgStr);
587 COS.get() << '"';
588 }
589}
590
591Expected<const char *> DWARFFormValue::getAsCString() const {
592 if (!isFormClass(FC_String))
593 return make_error<StringError>("Invalid form for string attribute",
594 inconvertibleErrorCode());
595 if (Form == DW_FORM_string)
596 return Value.cstr;
597 // FIXME: Add support for DW_FORM_GNU_strp_alt
598 if (Form == DW_FORM_GNU_strp_alt || C == nullptr)
599 return make_error<StringError>("Unsupported form for string attribute",
600 inconvertibleErrorCode());
601 uint64_t Offset = Value.uval;
602 std::optional<uint32_t> Index;
603 if (Form == DW_FORM_GNU_str_index || Form == DW_FORM_strx ||
604 Form == DW_FORM_strx1 || Form == DW_FORM_strx2 || Form == DW_FORM_strx3 ||
605 Form == DW_FORM_strx4) {
606 if (!U)
607 return make_error<StringError>("API limitation - string extraction not "
608 "available without a DWARFUnit",
609 inconvertibleErrorCode());
610 Expected<uint64_t> StrOffset = U->getStringOffsetSectionItem(Offset);
611 Index = Offset;
612 if (!StrOffset)
613 return StrOffset.takeError();
614 Offset = *StrOffset;
615 }
616 // Prefer the Unit's string extractor, because for .dwo it will point to
617 // .debug_str.dwo, while the Context's extractor always uses .debug_str.
618 DataExtractor StrData = Form == DW_FORM_line_strp
619 ? C->getLineStringExtractor()
620 : U ? U->getStringExtractor()
621 : C->getStringExtractor();
622 if (const char *Str = StrData.getCStr(&Offset))
623 return Str;
624 std::string Msg = FormEncodingString(Form).str();
625 if (Index)
626 Msg += (" uses index " + Twine(*Index) + ", but the referenced string").str();
627 Msg += (" offset " + Twine(Offset) + " is beyond .debug_str bounds").str();
628 return make_error<StringError>(Msg,
629 inconvertibleErrorCode());
630}
631
632std::optional<uint64_t> DWARFFormValue::getAsAddress() const {
633 if (auto SA = getAsSectionedAddress())
634 return SA->Address;
635 return std::nullopt;
636}
637
638std::optional<object::SectionedAddress>
639DWARFFormValue::getAsSectionedAddress() const {
640 if (!isFormClass(FC_Address))
641 return std::nullopt;
642 bool AddrOffset = Form == dwarf::DW_FORM_LLVM_addrx_offset;
643 if (Form == DW_FORM_GNU_addr_index || Form == DW_FORM_addrx ||
644 Form == DW_FORM_addrx1 || Form == DW_FORM_addrx2 ||
645 Form == DW_FORM_addrx3 || Form == DW_FORM_addrx4 || AddrOffset) {
646
647 uint32_t Index = AddrOffset ? (Value.uval >> 32) : Value.uval;
648 if (!U)
649 return std::nullopt;
650 std::optional<object::SectionedAddress> SA =
651 U->getAddrOffsetSectionItem(Index);
652 if (!SA)
653 return std::nullopt;
654 if (AddrOffset)
655 SA->Address += (Value.uval & 0xffffffff);
656 return SA;
657 }
658 return {{Value.uval, Value.SectionIndex}};
659}
660
661std::optional<uint64_t> DWARFFormValue::getAsReference() const {
662 if (auto R = getAsRelativeReference())
663 return R->Unit ? R->Unit->getOffset() + R->Offset : R->Offset;
664 return std::nullopt;
665}
666
667std::optional<DWARFFormValue::UnitOffset>
668DWARFFormValue::getAsRelativeReference() const {
669 if (!isFormClass(FC_Reference))
670 return std::nullopt;
671 switch (Form) {
672 case DW_FORM_ref1:
673 case DW_FORM_ref2:
674 case DW_FORM_ref4:
675 case DW_FORM_ref8:
676 case DW_FORM_ref_udata:
677 if (!U)
678 return std::nullopt;
679 return UnitOffset{const_cast<DWARFUnit*>(U), Value.uval};
680 case DW_FORM_ref_addr:
681 case DW_FORM_ref_sig8:
682 case DW_FORM_GNU_ref_alt:
683 return UnitOffset{nullptr, Value.uval};
684 default:
685 return std::nullopt;
686 }
687}
688
689std::optional<uint64_t> DWARFFormValue::getAsSectionOffset() const {
690 if (!isFormClass(FC_SectionOffset))
691 return std::nullopt;
692 return Value.uval;
693}
694
695std::optional<uint64_t> DWARFFormValue::getAsUnsignedConstant() const {
696 if ((!isFormClass(FC_Constant) && !isFormClass(FC_Flag)) ||
697 Form == DW_FORM_sdata)
698 return std::nullopt;
699 return Value.uval;
700}
701
702std::optional<int64_t> DWARFFormValue::getAsSignedConstant() const {
703 if ((!isFormClass(FC_Constant) && !isFormClass(FC_Flag)) ||
704 (Form == DW_FORM_udata &&
705 uint64_t(std::numeric_limits<int64_t>::max()) < Value.uval))
706 return std::nullopt;
707 switch (Form) {
708 case DW_FORM_data4:
709 return int32_t(Value.uval);
710 case DW_FORM_data2:
711 return int16_t(Value.uval);
712 case DW_FORM_data1:
713 return int8_t(Value.uval);
714 case DW_FORM_sdata:
715 case DW_FORM_data8:
716 default:
717 return Value.sval;
718 }
719}
720
721std::optional<ArrayRef<uint8_t>> DWARFFormValue::getAsBlock() const {
722 if (!isFormClass(FC_Block) && !isFormClass(FC_Exprloc) &&
723 Form != DW_FORM_data16)
724 return std::nullopt;
725 return ArrayRef(Value.data, Value.uval);
726}
727
728std::optional<uint64_t> DWARFFormValue::getAsCStringOffset() const {
729 if (!isFormClass(FC_String) && Form == DW_FORM_string)
730 return std::nullopt;
731 return Value.uval;
732}
733
734std::optional<uint64_t> DWARFFormValue::getAsReferenceUVal() const {
735 if (!isFormClass(FC_Reference))
736 return std::nullopt;
737 return Value.uval;
738}
739
740std::optional<std::string>
741DWARFFormValue::getAsFile(DILineInfoSpecifier::FileLineInfoKind Kind) const {
742 if (U == nullptr || !isFormClass(FC_Constant))
743 return std::nullopt;
744 DWARFUnit *DLU = const_cast<DWARFUnit *>(U)->getLinkedUnit();
745 if (auto *LT = DLU->getContext().getLineTableForUnit(DLU)) {
746 std::string FileName;
747 if (LT->getFileNameByIndex(Value.uval, DLU->getCompilationDir(), Kind,
748 FileName))
749 return FileName;
750 }
751 return std::nullopt;
752}
753
754bool llvm::dwarf::doesFormBelongToClass(dwarf::Form Form, DWARFFormValue::FormClass FC,
755 uint16_t DwarfVersion) {
756 // First, check DWARF5 form classes.
757 if (Form < ArrayRef(DWARF5FormClasses).size() &&
758 DWARF5FormClasses[Form] == FC)
759 return true;
760 // Check more forms from extensions and proposals.
761 switch (Form) {
762 case DW_FORM_GNU_ref_alt:
763 return (FC == DWARFFormValue::FC_Reference);
764 case DW_FORM_GNU_addr_index:
765 return (FC == DWARFFormValue::FC_Address);
766 case DW_FORM_GNU_str_index:
767 case DW_FORM_GNU_strp_alt:
768 return (FC == DWARFFormValue::FC_String);
769 case DW_FORM_LLVM_addrx_offset:
770 return (FC == DWARFFormValue::FC_Address);
771 case DW_FORM_strp:
772 case DW_FORM_line_strp:
773 return (FC == DWARFFormValue::FC_SectionOffset);
774 case DW_FORM_data4:
775 case DW_FORM_data8:
776 // In DWARF3 DW_FORM_data4 and DW_FORM_data8 served also as a section
777 // offset.
778 return (FC == DWARFFormValue::FC_SectionOffset) && (DwarfVersion <= 3);
779 default:
780 return false;
781 }
782}
A
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
D
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
DWARF5FormClasses
static const DWARFFormValue::FormClass DWARF5FormClasses[]
Definition: DWARFFormValue.cpp:31
Dwarf.h
This file contains constants used for implementing Dwarf debug support.
Size
uint64_t Size
Definition: ELFObjHandler.cpp:81
F
#define F(x, y, z)
Definition: MD5.cpp:55
if
if(VerifyEach)
Definition: PassBuilderBindings.cpp:71
OS
raw_pwrite_stream & OS
Definition: SampleProfWriter.cpp:53
llvm::ArrayRef
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
llvm::DWARFContext
DWARFContext This data structure is the top level entity that deals with dwarf debug information pars...
Definition: DWARFContext.h:46
llvm::DWARFContext::getStringExtractor
DataExtractor getStringExtractor() const
Definition: DWARFContext.h:340
llvm::DWARFContext::getLineTableForUnit
const DWARFDebugLine::LineTable * getLineTableForUnit(DWARFUnit *U)
Get a pointer to a parsed line table corresponding to a compile unit.
Definition: DWARFContext.cpp:1036
llvm::DWARFContext::getLineStringExtractor
DataExtractor getLineStringExtractor() const
Definition: DWARFContext.h:346
llvm::DWARFContext::getDWARFObj
const DWARFObject & getDWARFObj() const
Definition: DWARFContext.h:126
llvm::DWARFDataExtractor
A DataExtractor (typically for an in-memory copy of an object-file section) plus a relocation map for...
Definition: DWARFDataExtractor.h:21
llvm::DWARFFormValue::dumpAddress
void dumpAddress(raw_ostream &OS, uint64_t Address) const
llvm::DWARFFormValue::dumpAddressSection
static void dumpAddressSection(const DWARFObject &Obj, raw_ostream &OS, DIDumpOptions DumpOpts, uint64_t SectionIndex)
Definition: DWARFFormValue.cpp:367
llvm::DWARFFormValue::createFromPValue
static DWARFFormValue createFromPValue(dwarf::Form F, const char *V)
Definition: DWARFFormValue.cpp:90
llvm::DWARFFormValue::getAsCStringOffset
std::optional< uint64_t > getAsCStringOffset() const
Definition: DWARFFormValue.cpp:728
llvm::DWARFFormValue::createFromUValue
static DWARFFormValue createFromUValue(dwarf::Form F, uint64_t V)
Definition: DWARFFormValue.cpp:86
llvm::DWARFFormValue::getAsFile
std::optional< std::string > getAsFile(DILineInfoSpecifier::FileLineInfoKind Kind) const
Correctly extract any file paths from a form value.
Definition: DWARFFormValue.cpp:741
llvm::DWARFFormValue::getAsBlock
std::optional< ArrayRef< uint8_t > > getAsBlock() const
Definition: DWARFFormValue.cpp:721
llvm::DWARFFormValue::getAsSectionOffset
std::optional< uint64_t > getAsSectionOffset() const
Definition: DWARFFormValue.cpp:689
llvm::DWARFFormValue::dumpSectionedAddress
void dumpSectionedAddress(raw_ostream &OS, DIDumpOptions DumpOpts, object::SectionedAddress SA) const
Definition: DWARFFormValue.cpp:359
llvm::DWARFFormValue::getAsReference
std::optional< uint64_t > getAsReference() const
getAsFoo functions below return the extracted value as Foo if only DWARFFormValue has form class is s...
Definition: DWARFFormValue.cpp:661
llvm::DWARFFormValue::isFormClass
bool isFormClass(FormClass FC) const
Definition: DWARFFormValue.cpp:216
llvm::DWARFFormValue::getAsSectionedAddress
std::optional< object::SectionedAddress > getAsSectionedAddress() const
Definition: DWARFFormValue.cpp:639
llvm::DWARFFormValue::getAsReferenceUVal
std::optional< uint64_t > getAsReferenceUVal() const
Definition: DWARFFormValue.cpp:734
llvm::DWARFFormValue::getAsSignedConstant
std::optional< int64_t > getAsSignedConstant() const
Definition: DWARFFormValue.cpp:702
llvm::DWARFFormValue::getAsAddress
std::optional< uint64_t > getAsAddress() const
Definition: DWARFFormValue.cpp:632
llvm::DWARFFormValue::getAsRelativeReference
std::optional< UnitOffset > getAsRelativeReference() const
Definition: DWARFFormValue.cpp:668
llvm::DWARFFormValue::extractValue
bool extractValue(const DWARFDataExtractor &Data, uint64_t *OffsetPtr, dwarf::FormParams FormParams, const DWARFContext *Context=nullptr, const DWARFUnit *Unit=nullptr)
Extracts a value in Data at offset *OffsetPtr.
Definition: DWARFFormValue.cpp:220
llvm::DWARFFormValue::createFromBlockValue
static DWARFFormValue createFromBlockValue(dwarf::Form F, ArrayRef< uint8_t > D)
Definition: DWARFFormValue.cpp:94
llvm::DWARFFormValue::dump
void dump(raw_ostream &OS, DIDumpOptions DumpOpts=DIDumpOptions()) const
Definition: DWARFFormValue.cpp:382
llvm::DWARFFormValue::createFromSValue
static DWARFFormValue createFromSValue(dwarf::Form F, int64_t V)
Definition: DWARFFormValue.cpp:82
llvm::DWARFFormValue::getAsUnsignedConstant
std::optional< uint64_t > getAsUnsignedConstant() const
Definition: DWARFFormValue.cpp:695
llvm::DWARFFormValue::skipValue
bool skipValue(DataExtractor DebugInfoData, uint64_t *OffsetPtr, const dwarf::FormParams Params) const
Skip a form's value in DebugInfoData at the offset specified by OffsetPtr.
Definition: DWARFFormValue.h:145
llvm::DWARFFormValue::createFromUnit
static DWARFFormValue createFromUnit(dwarf::Form F, const DWARFUnit *Unit, uint64_t *OffsetPtr)
Definition: DWARFFormValue.cpp:102
llvm::DWARFFormValue::getAsCString
Expected< const char * > getAsCString() const
Definition: DWARFFormValue.cpp:591
llvm::DWARFObject::getSectionNames
virtual ArrayRef< SectionName > getSectionNames() const
Definition: DWARFObject.h:33
llvm::DWARFUnit::getStringExtractor
DataExtractor getStringExtractor() const
Definition: DWARFUnit.h:374
llvm::DWARFUnit::getContext
DWARFContext & getContext() const
Definition: DWARFUnit.h:312
llvm::DWARFUnit::getAddressByteSize
uint8_t getAddressByteSize() const
Definition: DWARFUnit.h:319
llvm::DWARFUnit::getCompilationDir
const char * getCompilationDir()
Definition: DWARFUnit.cpp:389
llvm::DWARFUnit::getVersion
uint16_t getVersion() const
Definition: DWARFUnit.h:318
llvm::DWARFUnit::getStringOffsetSectionItem
Expected< uint64_t > getStringOffsetSectionItem(uint32_t Index) const
Definition: DWARFUnit.cpp:231
llvm::DWARFUnit::getAddrOffsetSectionItem
std::optional< object::SectionedAddress > getAddrOffsetSectionItem(uint32_t Index) const
Definition: DWARFUnit.cpp:208
llvm::DWARFUnit::getOffset
uint64_t getOffset() const
Definition: DWARFUnit.h:314
llvm::DataExtractor::getU32
uint32_t getU32(uint64_t *offset_ptr, Error *Err=nullptr) const
Extract a uint32_t value from *offset_ptr.
Definition: DataExtractor.cpp:107
llvm::DataExtractor::getCStr
const char * getCStr(uint64_t *OffsetPtr, Error *Err=nullptr) const
Extract a C string from *offset_ptr.
Definition: DataExtractor.h:129
llvm::DataExtractor::getU8
uint8_t getU8(uint64_t *offset_ptr, Error *Err=nullptr) const
Extract a uint8_t value from *offset_ptr.
Definition: DataExtractor.cpp:79
llvm::DataExtractor::getULEB128
uint64_t getULEB128(uint64_t *offset_ptr, llvm::Error *Err=nullptr) const
Extract a unsigned LEB128 value from *offset_ptr.
Definition: DataExtractor.cpp:220
llvm::DataExtractor::getSLEB128
int64_t getSLEB128(uint64_t *OffsetPtr, Error *Err=nullptr) const
Extract a signed LEB128 value from *offset_ptr.
Definition: DataExtractor.cpp:224
llvm::DataExtractor::getU16
uint16_t getU16(uint64_t *offset_ptr, Error *Err=nullptr) const
Extract a uint16_t value from *offset_ptr.
Definition: DataExtractor.cpp:92
llvm::Error
Lightweight error class with error context and mandatory checking.
Definition: Error.h:156
llvm::Error::success
static ErrorSuccess success()
Create a success value.
Definition: Error.h:330
llvm::Expected
Tagged union holding either a T or a Error.
Definition: Error.h:470
llvm::Expected::takeError
Error takeError()
Take ownership of the stored error.
Definition: Error.h:597
llvm::StringRef::str
std::string str() const
str - Get the contents as an std::string.
Definition: StringRef.h:222
llvm::Twine
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
llvm::Value
LLVM Value Representation.
Definition: Value.h:74
llvm::WithColor
An RAII object that temporarily switches an output stream to a specific color.
Definition: WithColor.h:53
llvm::WithColor::get
raw_ostream & get()
Definition: WithColor.h:79
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
llvm::raw_ostream::write_escaped
raw_ostream & write_escaped(StringRef Str, bool UseHexEscapes=false)
Output Str, turning '\', '\t', ' ', '"', and anything that doesn't satisfy llvm::isPrint into an esca...
Definition: raw_ostream.cpp:162
uint16_t
uint32_t
uint64_t
llvm::dwarf::FormEncodingString
StringRef FormEncodingString(unsigned Encoding)
Definition: Dwarf.cpp:105
llvm_unreachable
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
Definition: ErrorHandling.h:143
llvm::dwarf::toString
std::optional< const char * > toString(const std::optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract a string value from it.
Definition: DWARFFormValue.h:176
llvm::dwarf::doesFormBelongToClass
bool doesFormBelongToClass(dwarf::Form Form, DWARFFormValue::FormClass FC, uint16_t DwarfVersion)
Check whether specified Form belongs to the FC class.
Definition: DWARFFormValue.cpp:754
llvm::dwarf::getFixedFormByteSize
std::optional< uint8_t > getFixedFormByteSize(dwarf::Form Form, FormParams Params)
Get the fixed byte size for a given form.
Definition: Dwarf.cpp:695
llvm::dwarf::getDwarfOffsetByteSize
uint8_t getDwarfOffsetByteSize(DwarfFormat Format)
The size of a reference determined by the DWARF 32/64-bit format.
Definition: Dwarf.h:718
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
llvm::errorToBool
bool errorToBool(Error Err)
Helper for converting an Error to a bool.
Definition: Error.h:1073
llvm::Offset
@ Offset
Definition: DWP.cpp:406
llvm::size
auto size(R &&Range, std::enable_if_t< std::is_base_of< std::random_access_iterator_tag, typename std::iterator_traits< decltype(Range.begin())>::iterator_category >::value, void > *=nullptr)
Get the size of a range.
Definition: STLExtras.h:1777
llvm::inconvertibleErrorCode
std::error_code inconvertibleErrorCode()
The value returned by this function can be returned from convertToErrorCode for Error values where no...
Definition: Error.cpp:79
llvm::nulls
raw_ostream & nulls()
This returns a reference to a raw_ostream which simply discards output.
Definition: raw_ostream.cpp:906
llvm::format
format_object< Ts... > format(const char *Fmt, const Ts &... Vals)
These are helper functions used to produce formatted output.
Definition: Format.h:124
raw_ostream.h
llvm::DIDumpOptions
Container for dump options that control which debug information will be dumped.
Definition: DIContext.h:189
llvm::dwarf::FormParams
A helper struct providing information about the byte size of DW_FORM values that vary in size dependi...
Definition: Dwarf.h:731
Generated on Sun Mar 26 2023 01:04:02 for LLVM by doxygen 1.9.6