LLVM  10.0.0svn
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/None.h"
12 #include "llvm/ADT/Optional.h"
13 #include "llvm/ADT/StringRef.h"
14 #include "llvm/BinaryFormat/Dwarf.h"
15 #include "llvm/DebugInfo/DWARF/DWARFContext.h"
16 #include "llvm/DebugInfo/DWARF/DWARFRelocMap.h"
17 #include "llvm/DebugInfo/DWARF/DWARFUnit.h"
18 #include "llvm/Support/ErrorHandling.h"
19 #include "llvm/Support/Format.h"
20 #include "llvm/Support/WithColor.h"
21 #include "llvm/Support/raw_ostream.h"
22 #include <cinttypes>
23 #include <cstdint>
24 #include <limits>
25 
26 using namespace llvm;
27 using namespace dwarf;
28 
29 static const DWARFFormValue::FormClass DWARF5FormClasses[] = {
30  DWARFFormValue::FC_Unknown, // 0x0
31  DWARFFormValue::FC_Address, // 0x01 DW_FORM_addr
32  DWARFFormValue::FC_Unknown, // 0x02 unused
33  DWARFFormValue::FC_Block, // 0x03 DW_FORM_block2
34  DWARFFormValue::FC_Block, // 0x04 DW_FORM_block4
35  DWARFFormValue::FC_Constant, // 0x05 DW_FORM_data2
36  // --- These can be FC_SectionOffset in DWARF3 and below:
37  DWARFFormValue::FC_Constant, // 0x06 DW_FORM_data4
38  DWARFFormValue::FC_Constant, // 0x07 DW_FORM_data8
39  // ---
40  DWARFFormValue::FC_String, // 0x08 DW_FORM_string
41  DWARFFormValue::FC_Block, // 0x09 DW_FORM_block
42  DWARFFormValue::FC_Block, // 0x0a DW_FORM_block1
43  DWARFFormValue::FC_Constant, // 0x0b DW_FORM_data1
44  DWARFFormValue::FC_Flag, // 0x0c DW_FORM_flag
45  DWARFFormValue::FC_Constant, // 0x0d DW_FORM_sdata
46  DWARFFormValue::FC_String, // 0x0e DW_FORM_strp
47  DWARFFormValue::FC_Constant, // 0x0f DW_FORM_udata
48  DWARFFormValue::FC_Reference, // 0x10 DW_FORM_ref_addr
49  DWARFFormValue::FC_Reference, // 0x11 DW_FORM_ref1
50  DWARFFormValue::FC_Reference, // 0x12 DW_FORM_ref2
51  DWARFFormValue::FC_Reference, // 0x13 DW_FORM_ref4
52  DWARFFormValue::FC_Reference, // 0x14 DW_FORM_ref8
53  DWARFFormValue::FC_Reference, // 0x15 DW_FORM_ref_udata
54  DWARFFormValue::FC_Indirect, // 0x16 DW_FORM_indirect
55  DWARFFormValue::FC_SectionOffset, // 0x17 DW_FORM_sec_offset
56  DWARFFormValue::FC_Exprloc, // 0x18 DW_FORM_exprloc
57  DWARFFormValue::FC_Flag, // 0x19 DW_FORM_flag_present
58  DWARFFormValue::FC_String, // 0x1a DW_FORM_strx
59  DWARFFormValue::FC_Address, // 0x1b DW_FORM_addrx
60  DWARFFormValue::FC_Reference, // 0x1c DW_FORM_ref_sup4
61  DWARFFormValue::FC_String, // 0x1d DW_FORM_strp_sup
62  DWARFFormValue::FC_Constant, // 0x1e DW_FORM_data16
63  DWARFFormValue::FC_String, // 0x1f DW_FORM_line_strp
64  DWARFFormValue::FC_Reference, // 0x20 DW_FORM_ref_sig8
65  DWARFFormValue::FC_Constant, // 0x21 DW_FORM_implicit_const
66  DWARFFormValue::FC_SectionOffset, // 0x22 DW_FORM_loclistx
67  DWARFFormValue::FC_SectionOffset, // 0x23 DW_FORM_rnglistx
68  DWARFFormValue::FC_Reference, // 0x24 DW_FORM_ref_sup8
69  DWARFFormValue::FC_String, // 0x25 DW_FORM_strx1
70  DWARFFormValue::FC_String, // 0x26 DW_FORM_strx2
71  DWARFFormValue::FC_String, // 0x27 DW_FORM_strx3
72  DWARFFormValue::FC_String, // 0x28 DW_FORM_strx4
73  DWARFFormValue::FC_Address, // 0x29 DW_FORM_addrx1
74  DWARFFormValue::FC_Address, // 0x2a DW_FORM_addrx2
75  DWARFFormValue::FC_Address, // 0x2b DW_FORM_addrx3
76  DWARFFormValue::FC_Address, // 0x2c DW_FORM_addrx4
77 
78 };
79 
80 DWARFFormValue DWARFFormValue::createFromSValue(dwarf::Form F, int64_t V) {
81  return DWARFFormValue(F, ValueType(V));
82 }
83 
84 DWARFFormValue DWARFFormValue::createFromUValue(dwarf::Form F, uint64_t V) {
85  return DWARFFormValue(F, ValueType(V));
86 }
87 
88 DWARFFormValue DWARFFormValue::createFromPValue(dwarf::Form F, const char *V) {
89  return DWARFFormValue(F, ValueType(V));
90 }
91 
92 DWARFFormValue DWARFFormValue::createFromBlockValue(dwarf::Form F,
93  ArrayRef<uint8_t> D) {
94  ValueType V;
95  V.uval = D.size();
96  V.data = D.data();
97  return DWARFFormValue(F, V);
98 }
99 
100 DWARFFormValue DWARFFormValue::createFromUnit(dwarf::Form F, const DWARFUnit *U,
101  uint64_t *OffsetPtr) {
102  DWARFFormValue FormValue(F);
103  FormValue.extractValue(U->getDebugInfoExtractor(), OffsetPtr,
104  U->getFormParams(), U);
105  return FormValue;
106 }
107 
108 bool DWARFFormValue::skipValue(dwarf::Form Form, DataExtractor DebugInfoData,
109  uint64_t *OffsetPtr,
110  const dwarf::FormParams Params) {
111  bool Indirect = false;
112  do {
113  switch (Form) {
114  // Blocks of inlined data that have a length field and the data bytes
115  // inlined in the .debug_info.
116  case DW_FORM_exprloc:
117  case DW_FORM_block: {
118  uint64_t size = DebugInfoData.getULEB128(OffsetPtr);
119  *OffsetPtr += size;
120  return true;
121  }
122  case DW_FORM_block1: {
123  uint8_t size = DebugInfoData.getU8(OffsetPtr);
124  *OffsetPtr += size;
125  return true;
126  }
127  case DW_FORM_block2: {
128  uint16_t size = DebugInfoData.getU16(OffsetPtr);
129  *OffsetPtr += size;
130  return true;
131  }
132  case DW_FORM_block4: {
133  uint32_t size = DebugInfoData.getU32(OffsetPtr);
134  *OffsetPtr += size;
135  return true;
136  }
137 
138  // Inlined NULL terminated C-strings.
139  case DW_FORM_string:
140  DebugInfoData.getCStr(OffsetPtr);
141  return true;
142 
143  case DW_FORM_addr:
144  case DW_FORM_ref_addr:
145  case DW_FORM_flag_present:
146  case DW_FORM_data1:
147  case DW_FORM_data2:
148  case DW_FORM_data4:
149  case DW_FORM_data8:
150  case DW_FORM_data16:
151  case DW_FORM_flag:
152  case DW_FORM_ref1:
153  case DW_FORM_ref2:
154  case DW_FORM_ref4:
155  case DW_FORM_ref8:
156  case DW_FORM_ref_sig8:
157  case DW_FORM_ref_sup4:
158  case DW_FORM_ref_sup8:
159  case DW_FORM_strx1:
160  case DW_FORM_strx2:
161  case DW_FORM_strx4:
162  case DW_FORM_addrx1:
163  case DW_FORM_addrx2:
164  case DW_FORM_addrx4:
165  case DW_FORM_sec_offset:
166  case DW_FORM_strp:
167  case DW_FORM_strp_sup:
168  case DW_FORM_line_strp:
169  case DW_FORM_GNU_ref_alt:
170  case DW_FORM_GNU_strp_alt:
171  if (Optional<uint8_t> FixedSize =
172  dwarf::getFixedFormByteSize(Form, Params)) {
173  *OffsetPtr += *FixedSize;
174  return true;
175  }
176  return false;
177 
178  // signed or unsigned LEB 128 values.
179  case DW_FORM_sdata:
180  DebugInfoData.getSLEB128(OffsetPtr);
181  return true;
182 
183  case DW_FORM_udata:
184  case DW_FORM_ref_udata:
185  case DW_FORM_strx:
186  case DW_FORM_addrx:
187  case DW_FORM_loclistx:
188  case DW_FORM_rnglistx:
189  case DW_FORM_GNU_addr_index:
190  case DW_FORM_GNU_str_index:
191  DebugInfoData.getULEB128(OffsetPtr);
192  return true;
193 
194  case DW_FORM_indirect:
195  Indirect = true;
196  Form = static_cast<dwarf::Form>(DebugInfoData.getULEB128(OffsetPtr));
197  break;
198 
199  default:
200  return false;
201  }
202  } while (Indirect);
203  return true;
204 }
205 
206 bool DWARFFormValue::isFormClass(DWARFFormValue::FormClass FC) const {
207  // First, check DWARF5 form classes.
208  if (Form < makeArrayRef(DWARF5FormClasses).size() &&
209  DWARF5FormClasses[Form] == FC)
210  return true;
211  // Check more forms from extensions and proposals.
212  switch (Form) {
213  case DW_FORM_GNU_ref_alt:
214  return (FC == FC_Reference);
215  case DW_FORM_GNU_addr_index:
216  return (FC == FC_Address);
217  case DW_FORM_GNU_str_index:
218  case DW_FORM_GNU_strp_alt:
219  return (FC == FC_String);
220  default:
221  break;
222  }
223 
224  if (FC == FC_SectionOffset) {
225  if (Form == DW_FORM_strp || Form == DW_FORM_line_strp)
226  return true;
227  // In DWARF3 DW_FORM_data4 and DW_FORM_data8 served also as a section
228  // offset. If we don't have a DWARFUnit, default to the old behavior.
229  if (Form == DW_FORM_data4 || Form == DW_FORM_data8)
230  return !U || U->getVersion() <= 3;
231  }
232 
233  return false;
234 }
235 
236 bool DWARFFormValue::extractValue(const DWARFDataExtractor &Data,
237  uint64_t *OffsetPtr, dwarf::FormParams FP,
238  const DWARFContext *Ctx,
239  const DWARFUnit *CU) {
240  if (!Ctx && CU)
241  Ctx = &CU->getContext();
242  C = Ctx;
243  U = CU;
244  bool Indirect = false;
245  bool IsBlock = false;
246  Value.data = nullptr;
247  // Read the value for the form into value and follow and DW_FORM_indirect
248  // instances we run into
249  do {
250  Indirect = false;
251  switch (Form) {
252  case DW_FORM_addr:
253  case DW_FORM_ref_addr: {
254  uint16_t Size =
255  (Form == DW_FORM_addr) ? FP.AddrSize : FP.getRefAddrByteSize();
256  Value.uval = Data.getRelocatedValue(Size, OffsetPtr, &Value.SectionIndex);
257  break;
258  }
259  case DW_FORM_exprloc:
260  case DW_FORM_block:
261  Value.uval = Data.getULEB128(OffsetPtr);
262  IsBlock = true;
263  break;
264  case DW_FORM_block1:
265  Value.uval = Data.getU8(OffsetPtr);
266  IsBlock = true;
267  break;
268  case DW_FORM_block2:
269  Value.uval = Data.getU16(OffsetPtr);
270  IsBlock = true;
271  break;
272  case DW_FORM_block4:
273  Value.uval = Data.getU32(OffsetPtr);
274  IsBlock = true;
275  break;
276  case DW_FORM_data1:
277  case DW_FORM_ref1:
278  case DW_FORM_flag:
279  case DW_FORM_strx1:
280  case DW_FORM_addrx1:
281  Value.uval = Data.getU8(OffsetPtr);
282  break;
283  case DW_FORM_data2:
284  case DW_FORM_ref2:
285  case DW_FORM_strx2:
286  case DW_FORM_addrx2:
287  Value.uval = Data.getU16(OffsetPtr);
288  break;
289  case DW_FORM_strx3:
290  Value.uval = Data.getU24(OffsetPtr);
291  break;
292  case DW_FORM_data4:
293  case DW_FORM_ref4:
294  case DW_FORM_ref_sup4:
295  case DW_FORM_strx4:
296  case DW_FORM_addrx4:
297  Value.uval = Data.getRelocatedValue(4, OffsetPtr);
298  break;
299  case DW_FORM_data8:
300  case DW_FORM_ref8:
301  case DW_FORM_ref_sup8:
302  Value.uval = Data.getRelocatedValue(8, OffsetPtr);
303  break;
304  case DW_FORM_data16:
305  // Treat this like a 16-byte block.
306  Value.uval = 16;
307  IsBlock = true;
308  break;
309  case DW_FORM_sdata:
310  Value.sval = Data.getSLEB128(OffsetPtr);
311  break;
312  case DW_FORM_udata:
313  case DW_FORM_ref_udata:
314  case DW_FORM_rnglistx:
315  Value.uval = Data.getULEB128(OffsetPtr);
316  break;
317  case DW_FORM_string:
318  Value.cstr = Data.getCStr(OffsetPtr);
319  break;
320  case DW_FORM_indirect:
321  Form = static_cast<dwarf::Form>(Data.getULEB128(OffsetPtr));
322  Indirect = true;
323  break;
324  case DW_FORM_strp:
325  case DW_FORM_sec_offset:
326  case DW_FORM_GNU_ref_alt:
327  case DW_FORM_GNU_strp_alt:
328  case DW_FORM_line_strp:
329  case DW_FORM_strp_sup: {
330  Value.uval =
331  Data.getRelocatedValue(FP.getDwarfOffsetByteSize(), OffsetPtr);
332  break;
333  }
334  case DW_FORM_flag_present:
335  Value.uval = 1;
336  break;
337  case DW_FORM_ref_sig8:
338  Value.uval = Data.getU64(OffsetPtr);
339  break;
340  case DW_FORM_GNU_addr_index:
341  case DW_FORM_GNU_str_index:
342  case DW_FORM_addrx:
343  case DW_FORM_strx:
344  Value.uval = Data.getULEB128(OffsetPtr);
345  break;
346  default:
347  // DWARFFormValue::skipValue() will have caught this and caused all
348  // DWARF DIEs to fail to be parsed, so this code is not be reachable.
349  llvm_unreachable("unsupported form");
350  }
351  } while (Indirect);
352 
353  if (IsBlock) {
354  StringRef Str = Data.getData().substr(*OffsetPtr, Value.uval);
355  Value.data = nullptr;
356  if (!Str.empty()) {
357  Value.data = Str.bytes_begin();
358  *OffsetPtr += Value.uval;
359  }
360  }
361 
362  return true;
363 }
364 
365 void DWARFFormValue::dumpSectionedAddress(raw_ostream &OS,
366  DIDumpOptions DumpOpts,
367  object::SectionedAddress SA) const {
368  OS << format("0x%016" PRIx64, SA.Address);
369  dumpAddressSection(U->getContext().getDWARFObj(), OS, DumpOpts,
370  SA.SectionIndex);
371 }
372 
373 void DWARFFormValue::dumpAddressSection(const DWARFObject &Obj, raw_ostream &OS,
374  DIDumpOptions DumpOpts,
375  uint64_t SectionIndex) {
376  if (!DumpOpts.Verbose || SectionIndex == -1ULL)
377  return;
378  ArrayRef<SectionName> SectionNames = Obj.getSectionNames();
379  const auto &SecRef = SectionNames[SectionIndex];
380 
381  OS << " \"" << SecRef.Name << '\"';
382 
383  // Print section index if name is not unique.
384  if (!SecRef.IsNameUnique)
385  OS << format(" [%" PRIu64 "]", SectionIndex);
386 }
387 
388 void DWARFFormValue::dump(raw_ostream &OS, DIDumpOptions DumpOpts) const {
389  uint64_t UValue = Value.uval;
390  bool CURelativeOffset = false;
391  raw_ostream &AddrOS = DumpOpts.ShowAddresses
392  ? WithColor(OS, HighlightColor::Address).get()
393  : nulls();
394  switch (Form) {
395  case DW_FORM_addr:
396  dumpSectionedAddress(AddrOS, DumpOpts, {Value.uval, Value.SectionIndex});
397  break;
398  case DW_FORM_addrx:
399  case DW_FORM_addrx1:
400  case DW_FORM_addrx2:
401  case DW_FORM_addrx3:
402  case DW_FORM_addrx4:
403  case DW_FORM_GNU_addr_index: {
404  if (U == nullptr) {
405  OS << "<invalid dwarf unit>";
406  break;
407  }
408  Optional<object::SectionedAddress> A = U->getAddrOffsetSectionItem(UValue);
409  if (!A || DumpOpts.Verbose)
410  AddrOS << format("indexed (%8.8x) address = ", (uint32_t)UValue);
411  if (A)
412  dumpSectionedAddress(AddrOS, DumpOpts, *A);
413  else
414  OS << "<no .debug_addr section>";
415  break;
416  }
417  case DW_FORM_flag_present:
418  OS << "true";
419  break;
420  case DW_FORM_flag:
421  case DW_FORM_data1:
422  OS << format("0x%02x", (uint8_t)UValue);
423  break;
424  case DW_FORM_data2:
425  OS << format("0x%04x", (uint16_t)UValue);
426  break;
427  case DW_FORM_data4:
428  OS << format("0x%08x", (uint32_t)UValue);
429  break;
430  case DW_FORM_ref_sig8:
431  AddrOS << format("0x%016" PRIx64, UValue);
432  break;
433  case DW_FORM_data8:
434  OS << format("0x%016" PRIx64, UValue);
435  break;
436  case DW_FORM_data16:
437  OS << format_bytes(ArrayRef<uint8_t>(Value.data, 16), None, 16, 16);
438  break;
439  case DW_FORM_string:
440  OS << '"';
441  OS.write_escaped(Value.cstr);
442  OS << '"';
443  break;
444  case DW_FORM_exprloc:
445  case DW_FORM_block:
446  case DW_FORM_block1:
447  case DW_FORM_block2:
448  case DW_FORM_block4:
449  if (UValue > 0) {
450  switch (Form) {
451  case DW_FORM_exprloc:
452  case DW_FORM_block:
453  AddrOS << format("<0x%" PRIx64 "> ", UValue);
454  break;
455  case DW_FORM_block1:
456  AddrOS << format("<0x%2.2x> ", (uint8_t)UValue);
457  break;
458  case DW_FORM_block2:
459  AddrOS << format("<0x%4.4x> ", (uint16_t)UValue);
460  break;
461  case DW_FORM_block4:
462  AddrOS << format("<0x%8.8x> ", (uint32_t)UValue);
463  break;
464  default:
465  break;
466  }
467 
468  const uint8_t *DataPtr = Value.data;
469  if (DataPtr) {
470  // UValue contains size of block
471  const uint8_t *EndDataPtr = DataPtr + UValue;
472  while (DataPtr < EndDataPtr) {
473  AddrOS << format("%2.2x ", *DataPtr);
474  ++DataPtr;
475  }
476  } else
477  OS << "NULL";
478  }
479  break;
480 
481  case DW_FORM_sdata:
482  OS << Value.sval;
483  break;
484  case DW_FORM_udata:
485  OS << Value.uval;
486  break;
487  case DW_FORM_strp:
488  if (DumpOpts.Verbose)
489  OS << format(" .debug_str[0x%8.8x] = ", (uint32_t)UValue);
490  dumpString(OS);
491  break;
492  case DW_FORM_line_strp:
493  if (DumpOpts.Verbose)
494  OS << format(" .debug_line_str[0x%8.8x] = ", (uint32_t)UValue);
495  dumpString(OS);
496  break;
497  case DW_FORM_strx:
498  case DW_FORM_strx1:
499  case DW_FORM_strx2:
500  case DW_FORM_strx3:
501  case DW_FORM_strx4:
502  case DW_FORM_GNU_str_index:
503  if (DumpOpts.Verbose)
504  OS << format("indexed (%8.8x) string = ", (uint32_t)UValue);
505  dumpString(OS);
506  break;
507  case DW_FORM_GNU_strp_alt:
508  if (DumpOpts.Verbose)
509  OS << format("alt indirect string, offset: 0x%" PRIx64 "", UValue);
510  dumpString(OS);
511  break;
512  case DW_FORM_ref_addr:
513  AddrOS << format("0x%016" PRIx64, UValue);
514  break;
515  case DW_FORM_ref1:
516  CURelativeOffset = true;
517  if (DumpOpts.Verbose)
518  AddrOS << format("cu + 0x%2.2x", (uint8_t)UValue);
519  break;
520  case DW_FORM_ref2:
521  CURelativeOffset = true;
522  if (DumpOpts.Verbose)
523  AddrOS << format("cu + 0x%4.4x", (uint16_t)UValue);
524  break;
525  case DW_FORM_ref4:
526  CURelativeOffset = true;
527  if (DumpOpts.Verbose)
528  AddrOS << format("cu + 0x%4.4x", (uint32_t)UValue);
529  break;
530  case DW_FORM_ref8:
531  CURelativeOffset = true;
532  if (DumpOpts.Verbose)
533  AddrOS << format("cu + 0x%8.8" PRIx64, UValue);
534  break;
535  case DW_FORM_ref_udata:
536  CURelativeOffset = true;
537  if (DumpOpts.Verbose)
538  AddrOS << format("cu + 0x%" PRIx64, UValue);
539  break;
540  case DW_FORM_GNU_ref_alt:
541  AddrOS << format("<alt 0x%" PRIx64 ">", UValue);
542  break;
543 
544  // All DW_FORM_indirect attributes should be resolved prior to calling
545  // this function
546  case DW_FORM_indirect:
547  OS << "DW_FORM_indirect";
548  break;
549 
550  case DW_FORM_rnglistx:
551  OS << format("indexed (0x%x) rangelist = ", (uint32_t)UValue);
552  break;
553 
554  // Should be formatted to 64-bit for DWARF64.
555  case DW_FORM_sec_offset:
556  AddrOS << format("0x%08x", (uint32_t)UValue);
557  break;
558 
559  default:
560  OS << format("DW_FORM(0x%4.4x)", Form);
561  break;
562  }
563 
564  if (CURelativeOffset) {
565  if (DumpOpts.Verbose)
566  OS << " => {";
567  if (DumpOpts.ShowAddresses)
568  WithColor(OS, HighlightColor::Address).get()
569  << format("0x%8.8" PRIx64, UValue + (U ? U->getOffset() : 0));
570  if (DumpOpts.Verbose)
571  OS << "}";
572  }
573 }
574 
575 void DWARFFormValue::dumpString(raw_ostream &OS) const {
576  Optional<const char *> DbgStr = getAsCString();
577  if (DbgStr.hasValue()) {
578  auto COS = WithColor(OS, HighlightColor::String);
579  COS.get() << '"';
580  COS.get().write_escaped(DbgStr.getValue());
581  COS.get() << '"';
582  }
583 }
584 
585 Optional<const char *> DWARFFormValue::getAsCString() const {
586  if (!isFormClass(FC_String))
587  return None;
588  if (Form == DW_FORM_string)
589  return Value.cstr;
590  // FIXME: Add support for DW_FORM_GNU_strp_alt
591  if (Form == DW_FORM_GNU_strp_alt || C == nullptr)
592  return None;
593  uint64_t Offset = Value.uval;
594  if (Form == DW_FORM_line_strp) {
595  // .debug_line_str is tracked in the Context.
596  if (const char *Str = C->getLineStringExtractor().getCStr(&Offset))
597  return Str;
598  return None;
599  }
600  if (Form == DW_FORM_GNU_str_index || Form == DW_FORM_strx ||
601  Form == DW_FORM_strx1 || Form == DW_FORM_strx2 || Form == DW_FORM_strx3 ||
602  Form == DW_FORM_strx4) {
603  if (!U)
604  return None;
605  Optional<uint64_t> StrOffset = U->getStringOffsetSectionItem(Offset);
606  if (!StrOffset)
607  return None;
608  Offset = *StrOffset;
609  }
610  // Prefer the Unit's string extractor, because for .dwo it will point to
611  // .debug_str.dwo, while the Context's extractor always uses .debug_str.
612  if (U) {
613  if (const char *Str = U->getStringExtractor().getCStr(&Offset))
614  return Str;
615  return None;
616  }
617  if (const char *Str = C->getStringExtractor().getCStr(&Offset))
618  return Str;
619  return None;
620 }
621 
622 Optional<uint64_t> DWARFFormValue::getAsAddress() const {
623  if (auto SA = getAsSectionedAddress())
624  return SA->Address;
625  return None;
626 }
627 
628 Optional<object::SectionedAddress>
629 DWARFFormValue::getAsSectionedAddress() const {
630  if (!isFormClass(FC_Address))
631  return None;
632  if (Form == DW_FORM_GNU_addr_index || Form == DW_FORM_addrx) {
633  uint32_t Index = Value.uval;
634  if (!U)
635  return None;
636  Optional<object::SectionedAddress> SA = U->getAddrOffsetSectionItem(Index);
637  if (!SA)
638  return None;
639  return SA;
640  }
641  return {{Value.uval, Value.SectionIndex}};
642 }
643 
644 Optional<uint64_t> DWARFFormValue::getAsReference() const {
645  if (auto R = getAsRelativeReference())
646  return R->Unit ? R->Unit->getOffset() + R->Offset : R->Offset;
647  return None;
648 }
649 
650 Optional<DWARFFormValue::UnitOffset> DWARFFormValue::getAsRelativeReference() const {
651  if (!isFormClass(FC_Reference))
652  return None;
653  switch (Form) {
654  case DW_FORM_ref1:
655  case DW_FORM_ref2:
656  case DW_FORM_ref4:
657  case DW_FORM_ref8:
658  case DW_FORM_ref_udata:
659  if (!U)
660  return None;
661  return UnitOffset{const_cast<DWARFUnit*>(U), Value.uval};
662  case DW_FORM_ref_addr:
663  case DW_FORM_ref_sig8:
664  case DW_FORM_GNU_ref_alt:
665  return UnitOffset{nullptr, Value.uval};
666  default:
667  return None;
668  }
669 }
670 
671 Optional<uint64_t> DWARFFormValue::getAsSectionOffset() const {
672  if (!isFormClass(FC_SectionOffset))
673  return None;
674  return Value.uval;
675 }
676 
677 Optional<uint64_t> DWARFFormValue::getAsUnsignedConstant() const {
678  if ((!isFormClass(FC_Constant) && !isFormClass(FC_Flag)) ||
679  Form == DW_FORM_sdata)
680  return None;
681  return Value.uval;
682 }
683 
684 Optional<int64_t> DWARFFormValue::getAsSignedConstant() const {
685  if ((!isFormClass(FC_Constant) && !isFormClass(FC_Flag)) ||
686  (Form == DW_FORM_udata &&
687  uint64_t(std::numeric_limits<int64_t>::max()) < Value.uval))
688  return None;
689  switch (Form) {
690  case DW_FORM_data4:
691  return int32_t(Value.uval);
692  case DW_FORM_data2:
693  return int16_t(Value.uval);
694  case DW_FORM_data1:
695  return int8_t(Value.uval);
696  case DW_FORM_sdata:
697  case DW_FORM_data8:
698  default:
699  return Value.sval;
700  }
701 }
702 
703 Optional<ArrayRef<uint8_t>> DWARFFormValue::getAsBlock() const {
704  if (!isFormClass(FC_Block) && !isFormClass(FC_Exprloc) &&
705  Form != DW_FORM_data16)
706  return None;
707  return makeArrayRef(Value.data, Value.uval);
708 }
709 
710 Optional<uint64_t> DWARFFormValue::getAsCStringOffset() const {
711  if (!isFormClass(FC_String) && Form == DW_FORM_string)
712  return None;
713  return Value.uval;
714 }
715 
716 Optional<uint64_t> DWARFFormValue::getAsReferenceUVal() const {
717  if (!isFormClass(FC_Reference))
718  return None;
719  return Value.uval;
720 }
llvm::DWARFFormValue::dump
void dump(raw_ostream &OS, DIDumpOptions DumpOpts=DIDumpOptions()) const
Definition: DWARFFormValue.cpp:388
llvm::None
const NoneType None
Definition: None.h:23
C
uint64_t CallInst * C
Definition: NVVMIntrRange.cpp:66
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:72
R600_InstFlag::FC
Definition: R600Defines.h:34
llvm::DataExtractor::getU24
uint32_t getU24(uint64_t *offset_ptr) const
Extract a 24-bit unsigned value from *offset_ptr and return it in a uint32_t.
Definition: DataExtractor.cpp:97
llvm::dwarf::FormParams
A helper struct providing information about the byte size of DW_FORM values that vary in size dependi...
Definition: Dwarf.h:536
llvm::ValueType
PointerUnion< const Value *, const PseudoSourceValue * > ValueType
Definition: ScheduleDAGInstrs.h:106
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:87
llvm::DWARFFormValue::getAsRelativeReference
Optional< UnitOffset > getAsRelativeReference() const
Definition: DWARFFormValue.cpp:650
llvm
This class represents lattice values for constants.
Definition: AllocatorList.h:23
DWARF5FormClasses
static const DWARFFormValue::FormClass DWARF5FormClasses[]
Definition: DWARFFormValue.cpp:29
llvm::WithColor
An RAII object that temporarily switches an output stream to a specific color.
Definition: WithColor.h:37
llvm::DataExtractor::getCStr
const char * getCStr(uint64_t *offset_ptr) const
Extract a C string from *offset_ptr.
Definition: DataExtractor.cpp:154
llvm::DWARFFormValue::createFromBlockValue
static DWARFFormValue createFromBlockValue(dwarf::Form F, ArrayRef< uint8_t > D)
Definition: DWARFFormValue.cpp:92
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
llvm::dwarf::FormParams::getRefAddrByteSize
uint8_t getRefAddrByteSize() const
The definition of the size of form DW_FORM_ref_addr depends on the version.
Definition: Dwarf.h:544
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:104
llvm::DataExtractor::getData
StringRef getData() const
Get the data pointed to by this extractor.
Definition: DataExtractor.h:92
F
F(f)
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:236
llvm::DWARFFormValue::isFormClass
bool isFormClass(FormClass FC) const
Definition: DWARFFormValue.cpp:206
llvm::DWARFUnit::getFormParams
const dwarf::FormParams & getFormParams() const
Definition: DWARFUnit.h:280
llvm::DWARFFormValue::createFromUnit
static DWARFFormValue createFromUnit(dwarf::Form F, const DWARFUnit *Unit, uint64_t *OffsetPtr)
Definition: DWARFFormValue.cpp:100
llvm::DataExtractor::getSLEB128
int64_t getSLEB128(uint64_t *offset_ptr) const
Extract a signed LEB128 value from *offset_ptr.
Definition: DataExtractor.cpp:195
llvm::DWARFFormValue::getAsReference
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:644
llvm::makeArrayRef
ArrayRef< T > makeArrayRef(const T &OneElt)
Construct an ArrayRef from a single element.
Definition: ArrayRef.h:450
llvm::DWARFFormValue::getAsBlock
Optional< ArrayRef< uint8_t > > getAsBlock() const
Definition: DWARFFormValue.cpp:703
llvm::StringRef::substr
LLVM_NODISCARD StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
Definition: StringRef.h:592
llvm::StringRef::empty
LLVM_NODISCARD bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:140
llvm::Optional::getValue
const T & getValue() const LLVM_LVALUE_FUNCTION
Definition: Optional.h:255
llvm::DWARFDataExtractor::getRelocatedValue
uint64_t getRelocatedValue(uint32_t Size, uint64_t *Off, uint64_t *SectionIndex=nullptr, Error *Err=nullptr) const
Extracts a value and applies a relocation to the result if one exists for the given offset...
Definition: DWARFDataExtractor.cpp:15
llvm::DIDumpOptions
Container for dump options that control which debug information will be dumped.
Definition: DIContext.h:171
llvm::WithColor::get
raw_ostream & get()
Definition: WithColor.h:64
llvm::DWARFFormValue::dumpSectionedAddress
void dumpSectionedAddress(raw_ostream &OS, DIDumpOptions DumpOpts, object::SectionedAddress SA) const
Definition: DWARFFormValue.cpp:365
llvm::DWARFFormValue::getAsSectionedAddress
Optional< object::SectionedAddress > getAsSectionedAddress() const
Definition: DWARFFormValue.cpp:629
llvm::ArrayRef::size
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:148
llvm::DWARFFormValue::dumpAddressSection
static void dumpAddressSection(const DWARFObject &Obj, raw_ostream &OS, DIDumpOptions DumpOpts, uint64_t SectionIndex)
Definition: DWARFFormValue.cpp:373
llvm::DWARFFormValue::getAsAddress
Optional< uint64_t > getAsAddress() const
Definition: DWARFFormValue.cpp:622
llvm::DWARFFormValue::getAsUnsignedConstant
Optional< uint64_t > getAsUnsignedConstant() const
Definition: DWARFFormValue.cpp:677
llvm::DWARFUnit::getContext
DWARFContext & getContext() const
Definition: DWARFUnit.h:275
llvm::DWARFFormValue::createFromUValue
static DWARFFormValue createFromUValue(dwarf::Form F, uint64_t V)
Definition: DWARFFormValue.cpp:84
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:174
llvm::DWARFFormValue::getAsReferenceUVal
Optional< uint64_t > getAsReferenceUVal() const
Definition: DWARFFormValue.cpp:716
llvm_unreachable
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
Definition: ErrorHandling.h:135
llvm::ArrayRef::data
const T * data() const
Definition: ArrayRef.h:145
llvm::DWARFDataExtractor
A DataExtractor (typically for an in-memory copy of an object-file section) plus a relocation map for...
Definition: DWARFDataExtractor.h:20
uint32_t
llvm::raw_ostream::write_escaped
raw_ostream & write_escaped(StringRef Str, bool UseHexEscapes=false)
Output Str, turning &#39;\&#39;, &#39;&#39;, &#39; &#39;, &#39;"&#39;, and anything that doesn&#39;t satisfy llvm::isPrint into an escape...
Definition: raw_ostream.cpp:165
llvm::size
auto size(R &&Range, typename std::enable_if< std::is_same< typename std::iterator_traits< decltype(Range.begin())>::iterator_category, std::random_access_iterator_tag >::value, void >::type *=nullptr) -> decltype(std::distance(Range.begin(), Range.end()))
Get the size of a range.
Definition: STLExtras.h:1146
llvm::max
Align max(MaybeAlign Lhs, Align Rhs)
Definition: Alignment.h:390
llvm::DWARFContext
DWARFContext This data structure is the top level entity that deals with dwarf debug information pars...
Definition: DWARFContext.h:58
D
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
llvm::DWARFFormValue::getAsCStringOffset
Optional< uint64_t > getAsCStringOffset() const
Definition: DWARFFormValue.cpp:710
Dwarf.h
This file contains constants used for implementing Dwarf debug support.
llvm::DWARFUnit::getDebugInfoExtractor
DWARFDataExtractor getDebugInfoExtractor() const
Definition: DWARFUnit.cpp:195
llvm::DWARFFormValue::createFromPValue
static DWARFFormValue createFromPValue(dwarf::Form F, const char *V)
Definition: DWARFFormValue.cpp:88
llvm::dwarf::getFixedFormByteSize
Optional< uint8_t > getFixedFormByteSize(dwarf::Form Form, FormParams Params)
Get the fixed byte size for a given form.
Definition: Dwarf.cpp:645
llvm::Optional::hasValue
bool hasValue() const
Definition: Optional.h:259
llvm::StringRef::bytes_begin
const unsigned char * bytes_begin() const
Definition: StringRef.h:119
llvm::DWARFFormValue::getAsCString
Optional< const char * > getAsCString() const
Definition: DWARFFormValue.cpp:585
llvm::DWARFObject::getSectionNames
virtual ArrayRef< SectionName > getSectionNames() const
Definition: DWARFObject.h:32
Size
uint32_t Size
Definition: Profile.cpp:46
llvm::DWARFFormValue::getAsSignedConstant
Optional< int64_t > getAsSignedConstant() const
Definition: DWARFFormValue.cpp:684
llvm::Value
LLVM Value Representation.
Definition: Value.h:74
llvm::nulls
raw_ostream & nulls()
This returns a reference to a raw_ostream which simply discards output.
Definition: raw_ostream.cpp:889
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:45
llvm::DataExtractor::getU64
uint64_t getU64(uint64_t *offset_ptr, Error *Err=nullptr) const
Extract a uint64_t value from *offset_ptr.
Definition: DataExtractor.cpp:114
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
llvm::DWARFFormValue::skipValue
bool skipValue(DataExtractor DebugInfoData, uint64_t *OffsetPtr, const dwarf::FormParams Params) const
Skip a form&#39;s value in DebugInfoData at the offset specified by OffsetPtr.
Definition: DWARFFormValue.h:131
raw_ostream.h
llvm::DWARFFormValue::createFromSValue
static DWARFFormValue createFromSValue(dwarf::Form F, int64_t V)
Definition: DWARFFormValue.cpp:80
llvm::dwarf::FormParams::getDwarfOffsetByteSize
uint8_t getDwarfOffsetByteSize() const
The size of a reference is determined by the DWARF 32/64-bit format.
Definition: Dwarf.h:551
llvm::DWARFFormValue::getAsSectionOffset
Optional< uint64_t > getAsSectionOffset() const
Definition: DWARFFormValue.cpp:671
Generated on Mon Nov 4 2019 00:36:10 for LLVM by   doxygen 1.8.13