LLVM  17.0.0git
Dwarf.h
Go to the documentation of this file.
1 //===-- llvm/BinaryFormat/Dwarf.h ---Dwarf Constants-------------*- C++ -*-===//
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 /// \file
10 /// This file contains constants used for implementing Dwarf
11 /// debug support.
12 ///
13 /// For details on the Dwarf specfication see the latest DWARF Debugging
14 /// Information Format standard document on http://www.dwarfstd.org. This
15 /// file often includes support for non-released standard features.
16 //
17 //===----------------------------------------------------------------------===//
18 
19 #ifndef LLVM_BINARYFORMAT_DWARF_H
20 #define LLVM_BINARYFORMAT_DWARF_H
21 
22 #include "llvm/Support/Compiler.h"
23 #include "llvm/Support/DataTypes.h"
25 #include "llvm/Support/Format.h"
27 #include "llvm/ADT/Triple.h"
28 
29 #include <limits>
30 
31 namespace llvm {
32 class StringRef;
33 
34 namespace dwarf {
35 
36 //===----------------------------------------------------------------------===//
37 // DWARF constants as gleaned from the DWARF Debugging Information Format V.5
38 // reference manual http://www.dwarfstd.org/.
39 //
40 
41 // Do not mix the following two enumerations sets. DW_TAG_invalid changes the
42 // enumeration base type.
43 
45  /// LLVM mock tags (see also llvm/BinaryFormat/Dwarf.def).
46  /// \{
47  DW_TAG_invalid = ~0U, ///< Tag for invalid results.
48  DW_VIRTUALITY_invalid = ~0U, ///< Virtuality for invalid results.
49  DW_MACINFO_invalid = ~0U, ///< Macinfo type for invalid results.
50  /// \}
51 
52  /// Special values for an initial length field.
53  /// \{
54  DW_LENGTH_lo_reserved = 0xfffffff0, ///< Lower bound of the reserved range.
55  DW_LENGTH_DWARF64 = 0xffffffff, ///< Indicator of 64-bit DWARF format.
56  DW_LENGTH_hi_reserved = 0xffffffff, ///< Upper bound of the reserved range.
57  /// \}
58 
59  /// Other constants.
60  /// \{
61  DWARF_VERSION = 4, ///< Default dwarf version we output.
62  DW_PUBTYPES_VERSION = 2, ///< Section version number for .debug_pubtypes.
63  DW_PUBNAMES_VERSION = 2, ///< Section version number for .debug_pubnames.
64  DW_ARANGES_VERSION = 2, ///< Section version number for .debug_aranges.
65  /// \}
66 
67  /// Identifiers we use to distinguish vendor extensions.
68  /// \{
69  DWARF_VENDOR_DWARF = 0, ///< Defined in v2 or later of the DWARF standard.
87  ///\}
88 };
89 
90 /// Constants that define the DWARF format as 32 or 64 bit.
91 enum DwarfFormat : uint8_t { DWARF32, DWARF64 };
92 
93 /// Special ID values that distinguish a CIE from a FDE in DWARF CFI.
94 /// Not inside an enum because a 64-bit value is needed.
95 /// @{
96 const uint32_t DW_CIE_ID = UINT32_MAX;
98 /// @}
99 
100 /// Identifier of an invalid DIE offset in the .debug_info section.
101 const uint32_t DW_INVALID_OFFSET = UINT32_MAX;
102 
103 enum Tag : uint16_t {
104 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR, KIND) DW_TAG_##NAME = ID,
105 #include "llvm/BinaryFormat/Dwarf.def"
106  DW_TAG_lo_user = 0x4080,
107  DW_TAG_hi_user = 0xffff,
108  DW_TAG_user_base = 0x1000 ///< Recommended base for user tags.
109 };
110 
111 inline bool isType(Tag T) {
112  switch (T) {
113  default:
114  return false;
115 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR, KIND) \
116  case DW_TAG_##NAME: \
117  return (KIND == DW_KIND_TYPE);
118 #include "llvm/BinaryFormat/Dwarf.def"
119  }
120 }
121 
122 /// Attributes.
124 #define HANDLE_DW_AT(ID, NAME, VERSION, VENDOR) DW_AT_##NAME = ID,
125 #include "llvm/BinaryFormat/Dwarf.def"
126  DW_AT_lo_user = 0x2000,
127  DW_AT_hi_user = 0x3fff,
128 };
129 
130 enum Form : uint16_t {
131 #define HANDLE_DW_FORM(ID, NAME, VERSION, VENDOR) DW_FORM_##NAME = ID,
132 #include "llvm/BinaryFormat/Dwarf.def"
133  DW_FORM_lo_user = 0x1f00, ///< Not specified by DWARF.
134 };
135 
137 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) DW_OP_##NAME = ID,
138 #include "llvm/BinaryFormat/Dwarf.def"
141  DW_OP_LLVM_fragment = 0x1000, ///< Only used in LLVM metadata.
142  DW_OP_LLVM_convert = 0x1001, ///< Only used in LLVM metadata.
143  DW_OP_LLVM_tag_offset = 0x1002, ///< Only used in LLVM metadata.
144  DW_OP_LLVM_entry_value = 0x1003, ///< Only used in LLVM metadata.
145  DW_OP_LLVM_implicit_pointer = 0x1004, ///< Only used in LLVM metadata.
146  DW_OP_LLVM_arg = 0x1005, ///< Only used in LLVM metadata.
147 };
148 
149 enum TypeKind : uint8_t {
150 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) DW_ATE_##NAME = ID,
151 #include "llvm/BinaryFormat/Dwarf.def"
154 };
155 
157  // Decimal sign attribute values
163 };
164 
166  // Endianity attribute values
167 #define HANDLE_DW_END(ID, NAME) DW_END_##NAME = ID,
168 #include "llvm/BinaryFormat/Dwarf.def"
171 };
172 
174  // Accessibility codes
178 };
179 
181  // Visibility codes
182  DW_VIS_local = 0x01,
185 };
186 
188 #define HANDLE_DW_VIRTUALITY(ID, NAME) DW_VIRTUALITY_##NAME = ID,
189 #include "llvm/BinaryFormat/Dwarf.def"
191 };
192 
194 #define HANDLE_DW_DEFAULTED(ID, NAME) DW_DEFAULTED_##NAME = ID,
195 #include "llvm/BinaryFormat/Dwarf.def"
197 };
198 
200 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
201  DW_LANG_##NAME = ID,
202 #include "llvm/BinaryFormat/Dwarf.def"
203  DW_LANG_lo_user = 0x8000,
205 };
206 
208  bool result = false;
209  // Deliberately enumerate all the language options so we get a warning when
210  // new language options are added (-Wswitch) that'll hopefully help keep this
211  // switch up-to-date when new C++ versions are added.
212  switch (S) {
213  case DW_LANG_C_plus_plus:
214  case DW_LANG_C_plus_plus_03:
215  case DW_LANG_C_plus_plus_11:
216  case DW_LANG_C_plus_plus_14:
217  case DW_LANG_C_plus_plus_17:
218  case DW_LANG_C_plus_plus_20:
219  result = true;
220  break;
221  case DW_LANG_C89:
222  case DW_LANG_C:
223  case DW_LANG_Ada83:
224  case DW_LANG_Cobol74:
225  case DW_LANG_Cobol85:
226  case DW_LANG_Fortran77:
227  case DW_LANG_Fortran90:
228  case DW_LANG_Pascal83:
229  case DW_LANG_Modula2:
230  case DW_LANG_Java:
231  case DW_LANG_C99:
232  case DW_LANG_Ada95:
233  case DW_LANG_Fortran95:
234  case DW_LANG_PLI:
235  case DW_LANG_ObjC:
236  case DW_LANG_ObjC_plus_plus:
237  case DW_LANG_UPC:
238  case DW_LANG_D:
239  case DW_LANG_Python:
240  case DW_LANG_OpenCL:
241  case DW_LANG_Go:
242  case DW_LANG_Modula3:
243  case DW_LANG_Haskell:
244  case DW_LANG_OCaml:
245  case DW_LANG_Rust:
246  case DW_LANG_C11:
247  case DW_LANG_Swift:
248  case DW_LANG_Julia:
249  case DW_LANG_Dylan:
250  case DW_LANG_Fortran03:
251  case DW_LANG_Fortran08:
252  case DW_LANG_RenderScript:
253  case DW_LANG_BLISS:
254  case DW_LANG_Mips_Assembler:
255  case DW_LANG_GOOGLE_RenderScript:
256  case DW_LANG_BORLAND_Delphi:
257  case DW_LANG_lo_user:
258  case DW_LANG_hi_user:
259  case DW_LANG_Kotlin:
260  case DW_LANG_Zig:
261  case DW_LANG_Crystal:
262  case DW_LANG_C17:
263  case DW_LANG_Fortran18:
264  case DW_LANG_Ada2005:
265  case DW_LANG_Ada2012:
266  result = false;
267  break;
268  }
269 
270  return result;
271 }
272 
273 inline bool isFortran(SourceLanguage S) {
274  bool result = false;
275  // Deliberately enumerate all the language options so we get a warning when
276  // new language options are added (-Wswitch) that'll hopefully help keep this
277  // switch up-to-date when new Fortran versions are added.
278  switch (S) {
279  case DW_LANG_Fortran77:
280  case DW_LANG_Fortran90:
281  case DW_LANG_Fortran95:
282  case DW_LANG_Fortran03:
283  case DW_LANG_Fortran08:
284  case DW_LANG_Fortran18:
285  result = true;
286  break;
287  case DW_LANG_C89:
288  case DW_LANG_C:
289  case DW_LANG_Ada83:
290  case DW_LANG_C_plus_plus:
291  case DW_LANG_Cobol74:
292  case DW_LANG_Cobol85:
293  case DW_LANG_Pascal83:
294  case DW_LANG_Modula2:
295  case DW_LANG_Java:
296  case DW_LANG_C99:
297  case DW_LANG_Ada95:
298  case DW_LANG_PLI:
299  case DW_LANG_ObjC:
300  case DW_LANG_ObjC_plus_plus:
301  case DW_LANG_UPC:
302  case DW_LANG_D:
303  case DW_LANG_Python:
304  case DW_LANG_OpenCL:
305  case DW_LANG_Go:
306  case DW_LANG_Modula3:
307  case DW_LANG_Haskell:
308  case DW_LANG_C_plus_plus_03:
309  case DW_LANG_C_plus_plus_11:
310  case DW_LANG_OCaml:
311  case DW_LANG_Rust:
312  case DW_LANG_C11:
313  case DW_LANG_Swift:
314  case DW_LANG_Julia:
315  case DW_LANG_Dylan:
316  case DW_LANG_C_plus_plus_14:
317  case DW_LANG_RenderScript:
318  case DW_LANG_BLISS:
319  case DW_LANG_Mips_Assembler:
320  case DW_LANG_GOOGLE_RenderScript:
321  case DW_LANG_BORLAND_Delphi:
322  case DW_LANG_lo_user:
323  case DW_LANG_hi_user:
324  case DW_LANG_Kotlin:
325  case DW_LANG_Zig:
326  case DW_LANG_Crystal:
327  case DW_LANG_C_plus_plus_17:
328  case DW_LANG_C_plus_plus_20:
329  case DW_LANG_C17:
330  case DW_LANG_Ada2005:
331  case DW_LANG_Ada2012:
332  result = false;
333  break;
334  }
335 
336  return result;
337 }
338 
339 inline bool isC(SourceLanguage S) {
340  // Deliberately enumerate all the language options so we get a warning when
341  // new language options are added (-Wswitch) that'll hopefully help keep this
342  // switch up-to-date when new C++ versions are added.
343  switch (S) {
344  case DW_LANG_C11:
345  case DW_LANG_C17:
346  case DW_LANG_C89:
347  case DW_LANG_C99:
348  case DW_LANG_C:
349  case DW_LANG_ObjC:
350  return true;
351  case DW_LANG_C_plus_plus:
352  case DW_LANG_C_plus_plus_03:
353  case DW_LANG_C_plus_plus_11:
354  case DW_LANG_C_plus_plus_14:
355  case DW_LANG_C_plus_plus_17:
356  case DW_LANG_C_plus_plus_20:
357  case DW_LANG_Ada83:
358  case DW_LANG_Cobol74:
359  case DW_LANG_Cobol85:
360  case DW_LANG_Fortran77:
361  case DW_LANG_Fortran90:
362  case DW_LANG_Pascal83:
363  case DW_LANG_Modula2:
364  case DW_LANG_Java:
365  case DW_LANG_Ada95:
366  case DW_LANG_Fortran95:
367  case DW_LANG_PLI:
368  case DW_LANG_ObjC_plus_plus:
369  case DW_LANG_UPC:
370  case DW_LANG_D:
371  case DW_LANG_Python:
372  case DW_LANG_OpenCL:
373  case DW_LANG_Go:
374  case DW_LANG_Modula3:
375  case DW_LANG_Haskell:
376  case DW_LANG_OCaml:
377  case DW_LANG_Rust:
378  case DW_LANG_Swift:
379  case DW_LANG_Julia:
380  case DW_LANG_Dylan:
381  case DW_LANG_Fortran03:
382  case DW_LANG_Fortran08:
383  case DW_LANG_RenderScript:
384  case DW_LANG_BLISS:
385  case DW_LANG_Mips_Assembler:
386  case DW_LANG_GOOGLE_RenderScript:
387  case DW_LANG_BORLAND_Delphi:
388  case DW_LANG_lo_user:
389  case DW_LANG_hi_user:
390  case DW_LANG_Kotlin:
391  case DW_LANG_Zig:
392  case DW_LANG_Crystal:
393  case DW_LANG_Fortran18:
394  case DW_LANG_Ada2005:
395  case DW_LANG_Ada2012:
396  return false;
397  }
398  llvm_unreachable("Unknown language kind.");
399 }
400 
402  return isFortran(S) ? DW_ATE_signed : DW_ATE_unsigned;
403 }
404 
406  // Identifier case codes
411 };
412 
414 // Calling convention codes
415 #define HANDLE_DW_CC(ID, NAME) DW_CC_##NAME = ID,
416 #include "llvm/BinaryFormat/Dwarf.def"
419 };
420 
422  // Inline codes
427 };
428 
430  // Array ordering
433 };
434 
436  // Discriminant descriptor values
437  DW_DSC_label = 0x00,
439 };
440 
441 /// Line Number Standard Opcode Encodings.
442 enum LineNumberOps : uint8_t {
443 #define HANDLE_DW_LNS(ID, NAME) DW_LNS_##NAME = ID,
444 #include "llvm/BinaryFormat/Dwarf.def"
445 };
446 
447 /// Line Number Extended Opcode Encodings.
449 #define HANDLE_DW_LNE(ID, NAME) DW_LNE_##NAME = ID,
450 #include "llvm/BinaryFormat/Dwarf.def"
453 };
454 
456 #define HANDLE_DW_LNCT(ID, NAME) DW_LNCT_##NAME = ID,
457 #include "llvm/BinaryFormat/Dwarf.def"
458  DW_LNCT_lo_user = 0x2000,
459  DW_LNCT_hi_user = 0x3fff,
460 };
461 
463  // Macinfo Type Encodings
469 };
470 
471 /// DWARF v5 macro information entry type encodings.
473 #define HANDLE_DW_MACRO(ID, NAME) DW_MACRO_##NAME = ID,
474 #include "llvm/BinaryFormat/Dwarf.def"
477 };
478 
479 /// GNU .debug_macro macro information entry type encodings.
481 #define HANDLE_DW_MACRO_GNU(ID, NAME) DW_MACRO_GNU_##NAME = ID,
482 #include "llvm/BinaryFormat/Dwarf.def"
485 };
486 
487 /// DWARF v5 range list entry encoding values.
489 #define HANDLE_DW_RLE(ID, NAME) DW_RLE_##NAME = ID,
490 #include "llvm/BinaryFormat/Dwarf.def"
491 };
492 
493 /// DWARF v5 loc list entry encoding values.
495 #define HANDLE_DW_LLE(ID, NAME) DW_LLE_##NAME = ID,
496 #include "llvm/BinaryFormat/Dwarf.def"
497 };
498 
499 /// Call frame instruction encodings.
501 #define HANDLE_DW_CFA(ID, NAME) DW_CFA_##NAME = ID,
502 #define HANDLE_DW_CFA_PRED(ID, NAME, ARCH) DW_CFA_##NAME = ID,
503 #include "llvm/BinaryFormat/Dwarf.def"
505 
508 };
509 
510 enum Constants {
511  // Children flag
514 
532 };
533 
534 /// Constants for the DW_APPLE_PROPERTY_attributes attribute.
535 /// Keep this list in sync with clang's DeclObjCCommon.h
536 /// ObjCPropertyAttribute::Kind!
538 #define HANDLE_DW_APPLE_PROPERTY(ID, NAME) DW_APPLE_PROPERTY_##NAME = ID,
539 #include "llvm/BinaryFormat/Dwarf.def"
540 };
541 
542 /// Constants for unit types in DWARF v5.
543 enum UnitType : unsigned char {
544 #define HANDLE_DW_UT(ID, NAME) DW_UT_##NAME = ID,
545 #include "llvm/BinaryFormat/Dwarf.def"
548 };
549 
550 enum Index {
551 #define HANDLE_DW_IDX(ID, NAME) DW_IDX_##NAME = ID,
552 #include "llvm/BinaryFormat/Dwarf.def"
553  DW_IDX_lo_user = 0x2000,
554  DW_IDX_hi_user = 0x3fff
555 };
556 
557 inline bool isUnitType(uint8_t UnitType) {
558  switch (UnitType) {
559  case DW_UT_compile:
560  case DW_UT_type:
561  case DW_UT_partial:
562  case DW_UT_skeleton:
563  case DW_UT_split_compile:
564  case DW_UT_split_type:
565  return true;
566  default:
567  return false;
568  }
569 }
570 
571 inline bool isUnitType(dwarf::Tag T) {
572  switch (T) {
573  case DW_TAG_compile_unit:
574  case DW_TAG_type_unit:
575  case DW_TAG_partial_unit:
576  case DW_TAG_skeleton_unit:
577  return true;
578  default:
579  return false;
580  }
581 }
582 
583 // Constants for the DWARF v5 Accelerator Table Proposal
585  // Data layout descriptors.
586  DW_ATOM_null = 0u, /// Marker as the end of a list of atoms.
587  DW_ATOM_die_offset = 1u, // DIE offset in the debug_info section.
588  DW_ATOM_cu_offset = 2u, // Offset of the compile unit header that contains the
589  // item in question.
590  DW_ATOM_die_tag = 3u, // A tag entry.
591  DW_ATOM_type_flags = 4u, // Set of flags for a type.
592 
593  DW_ATOM_type_type_flags = 5u, // Dsymutil type extension.
594  DW_ATOM_qual_name_hash = 6u, // Dsymutil qualified hash extension.
595 
596  // DW_ATOM_type_flags values.
597 
598  // Always set for C++, only set for ObjC if this is the @implementation for a
599  // class.
601 
602  // Hash functions.
603 
604  // Daniel J. Bernstein hash.
606 };
607 
608 // Constants for the GNU pubnames/pubtypes extensions supporting gdb index.
618 };
619 
621 
622 /// \defgroup DwarfConstantsDumping Dwarf constants dumping functions
623 ///
624 /// All these functions map their argument's value back to the
625 /// corresponding enumerator name or return an empty StringRef if the value
626 /// isn't known.
627 ///
628 /// @{
629 StringRef TagString(unsigned Tag);
630 StringRef ChildrenString(unsigned Children);
632 StringRef FormEncodingString(unsigned Encoding);
633 StringRef OperationEncodingString(unsigned Encoding);
634 StringRef AttributeEncodingString(unsigned Encoding);
635 StringRef DecimalSignString(unsigned Sign);
636 StringRef EndianityString(unsigned Endian);
637 StringRef AccessibilityString(unsigned Access);
638 StringRef DefaultedMemberString(unsigned DefaultedEncodings);
639 StringRef VisibilityString(unsigned Visibility);
640 StringRef VirtualityString(unsigned Virtuality);
642 StringRef CaseString(unsigned Case);
643 StringRef ConventionString(unsigned Convention);
644 StringRef InlineCodeString(unsigned Code);
645 StringRef ArrayOrderString(unsigned Order);
646 StringRef LNStandardString(unsigned Standard);
647 StringRef LNExtendedString(unsigned Encoding);
648 StringRef MacinfoString(unsigned Encoding);
649 StringRef MacroString(unsigned Encoding);
650 StringRef GnuMacroString(unsigned Encoding);
651 StringRef RangeListEncodingString(unsigned Encoding);
652 StringRef LocListEncodingString(unsigned Encoding);
653 StringRef CallFrameString(unsigned Encoding, Triple::ArchType Arch);
655 StringRef UnitTypeString(unsigned);
656 StringRef AtomTypeString(unsigned Atom);
659 StringRef IndexString(unsigned Idx);
661 StringRef FormatString(bool IsDWARF64);
662 StringRef RLEString(unsigned RLE);
663 /// @}
664 
665 /// \defgroup DwarfConstantsParsing Dwarf constants parsing functions
666 ///
667 /// These functions map their strings back to the corresponding enumeration
668 /// value or return 0 if there is none, except for these exceptions:
669 ///
670 /// \li \a getTag() returns \a DW_TAG_invalid on invalid input.
671 /// \li \a getVirtuality() returns \a DW_VIRTUALITY_invalid on invalid input.
672 /// \li \a getMacinfo() returns \a DW_MACINFO_invalid on invalid input.
673 ///
674 /// @{
675 unsigned getTag(StringRef TagString);
680 unsigned getAttributeEncoding(StringRef EncodingString);
682 unsigned getMacro(StringRef MacroString);
683 /// @}
684 
685 /// \defgroup DwarfConstantsVersioning Dwarf version for constants
686 ///
687 /// For constants defined by DWARF, returns the DWARF version when the constant
688 /// was first defined. For vendor extensions, if there is a version-related
689 /// policy for when to emit it, returns a version number for that policy.
690 /// Otherwise returns 0.
691 ///
692 /// @{
693 unsigned TagVersion(Tag T);
694 unsigned AttributeVersion(Attribute A);
695 unsigned FormVersion(Form F);
698 unsigned LanguageVersion(SourceLanguage L);
699 /// @}
700 
701 /// \defgroup DwarfConstantsVendor Dwarf "vendor" for constants
702 ///
703 /// These functions return an identifier describing "who" defined the constant,
704 /// either the DWARF standard itself or the vendor who defined the extension.
705 ///
706 /// @{
707 unsigned TagVendor(Tag T);
708 unsigned AttributeVendor(Attribute A);
709 unsigned FormVendor(Form F);
710 unsigned OperationVendor(LocationAtom O);
712 unsigned LanguageVendor(SourceLanguage L);
713 /// @}
714 
715 std::optional<unsigned> LanguageLowerBound(SourceLanguage L);
716 
717 /// The size of a reference determined by the DWARF 32/64-bit format.
718 inline uint8_t getDwarfOffsetByteSize(DwarfFormat Format) {
719  switch (Format) {
721  return 4;
723  return 8;
724  }
725  llvm_unreachable("Invalid Format value");
726 }
727 
728 /// A helper struct providing information about the byte size of DW_FORM
729 /// values that vary in size depending on the DWARF version, address byte
730 /// size, or DWARF32/DWARF64.
731 struct FormParams {
733  uint8_t AddrSize;
735  /// True if DWARF v2 output generally uses relocations for references
736  /// to other .debug_* sections.
738 
739  /// The definition of the size of form DW_FORM_ref_addr depends on the
740  /// version. In DWARF v2 it's the size of an address; after that, it's the
741  /// size of a reference.
742  uint8_t getRefAddrByteSize() const {
743  if (Version == 2)
744  return AddrSize;
745  return getDwarfOffsetByteSize();
746  }
747 
748  /// The size of a reference is determined by the DWARF 32/64-bit format.
749  uint8_t getDwarfOffsetByteSize() const {
751  }
752 
753  explicit operator bool() const { return Version && AddrSize; }
754 };
755 
756 /// Get the byte size of the unit length field depending on the DWARF format.
757 inline uint8_t getUnitLengthFieldByteSize(DwarfFormat Format) {
758  switch (Format) {
760  return 4;
762  return 12;
763  }
764  llvm_unreachable("Invalid Format value");
765 }
766 
767 /// Get the fixed byte size for a given form.
768 ///
769 /// If the form has a fixed byte size, then an Optional with a value will be
770 /// returned. If the form is always encoded using a variable length storage
771 /// format (ULEB or SLEB numbers or blocks) then std::nullopt will be returned.
772 ///
773 /// \param Form DWARF form to get the fixed byte size for.
774 /// \param Params DWARF parameters to help interpret forms.
775 /// \returns std::optional<uint8_t> value with the fixed byte size or
776 /// std::nullopt if \p Form doesn't have a fixed byte size.
777 std::optional<uint8_t> getFixedFormByteSize(dwarf::Form Form,
778  FormParams Params);
779 
780 /// Tells whether the specified form is defined in the specified version,
781 /// or is an extension if extensions are allowed.
782 bool isValidFormForVersion(Form F, unsigned Version, bool ExtensionsOk = true);
783 
784 /// Returns the symbolic string representing Val when used as a value
785 /// for attribute Attr.
786 StringRef AttributeValueString(uint16_t Attr, unsigned Val);
787 
788 /// Returns the symbolic string representing Val when used as a value
789 /// for atom Atom.
790 StringRef AtomValueString(uint16_t Atom, unsigned Val);
791 
792 /// Describes an entry of the various gnu_pub* debug sections.
793 ///
794 /// The gnu_pub* kind looks like:
795 ///
796 /// 0-3 reserved
797 /// 4-6 symbol kind
798 /// 7 0 == global, 1 == static
799 ///
800 /// A gdb_index descriptor includes the above kind, shifted 24 bits up with the
801 /// offset of the cu within the debug_info section stored in those 24 bits.
806  : Kind(Kind), Linkage(Linkage) {}
809  explicit PubIndexEntryDescriptor(uint8_t Value)
810  : Kind(
811  static_cast<GDBIndexEntryKind>((Value & KIND_MASK) >> KIND_OFFSET)),
812  Linkage(static_cast<GDBIndexEntryLinkage>((Value & LINKAGE_MASK) >>
813  LINKAGE_OFFSET)) {}
814  uint8_t toBits() const {
815  return Kind << KIND_OFFSET | Linkage << LINKAGE_OFFSET;
816  }
817 
818 private:
819  enum {
820  KIND_OFFSET = 4,
821  KIND_MASK = 7 << KIND_OFFSET,
822  LINKAGE_OFFSET = 7,
823  LINKAGE_MASK = 1 << LINKAGE_OFFSET
824  };
825 };
826 
827 template <typename Enum> struct EnumTraits : public std::false_type {};
828 
829 template <> struct EnumTraits<Attribute> : public std::true_type {
830  static constexpr char Type[3] = "AT";
831  static constexpr StringRef (*StringFn)(unsigned) = &AttributeString;
832 };
833 
834 template <> struct EnumTraits<Form> : public std::true_type {
835  static constexpr char Type[5] = "FORM";
836  static constexpr StringRef (*StringFn)(unsigned) = &FormEncodingString;
837 };
838 
839 template <> struct EnumTraits<Index> : public std::true_type {
840  static constexpr char Type[4] = "IDX";
841  static constexpr StringRef (*StringFn)(unsigned) = &IndexString;
842 };
843 
844 template <> struct EnumTraits<Tag> : public std::true_type {
845  static constexpr char Type[4] = "TAG";
846  static constexpr StringRef (*StringFn)(unsigned) = &TagString;
847 };
848 
849 template <> struct EnumTraits<LineNumberOps> : public std::true_type {
850  static constexpr char Type[4] = "LNS";
851  static constexpr StringRef (*StringFn)(unsigned) = &LNStandardString;
852 };
853 
854 template <> struct EnumTraits<LocationAtom> : public std::true_type {
855  static constexpr char Type[3] = "OP";
856  static constexpr StringRef (*StringFn)(unsigned) = &OperationEncodingString;
857 };
858 
859 inline uint64_t computeTombstoneAddress(uint8_t AddressByteSize) {
860  return std::numeric_limits<uint64_t>::max() >> (8 - AddressByteSize) * 8;
861 }
862 
863 } // End of namespace dwarf
864 
865 /// Dwarf constants format_provider
866 ///
867 /// Specialization of the format_provider template for dwarf enums. Unlike the
868 /// dumping functions above, these format unknown enumerator values as
869 /// DW_TYPE_unknown_1234 (e.g. DW_TAG_unknown_ffff).
870 template <typename Enum>
871 struct format_provider<Enum, std::enable_if_t<dwarf::EnumTraits<Enum>::value>> {
872  static void format(const Enum &E, raw_ostream &OS, StringRef Style) {
874  if (Str.empty()) {
875  OS << "DW_" << dwarf::EnumTraits<Enum>::Type << "_unknown_"
876  << llvm::format("%x", E);
877  } else
878  OS << Str;
879  }
880 };
881 } // End of namespace llvm
882 
883 #endif
llvm::dwarf::CallingConvention
CallingConvention
Definition: Dwarf.h:413
llvm::dwarf::DW_VIRTUALITY_max
@ DW_VIRTUALITY_max
Definition: Dwarf.h:190
llvm::dwarf::AttributeEncodingString
StringRef AttributeEncodingString(unsigned Encoding)
Definition: Dwarf.cpp:197
llvm::dwarf::AttributeEncodingVendor
unsigned AttributeEncodingVendor(TypeKind E)
Definition: Dwarf.cpp:227
llvm::dwarf::LineNumberEntryFormat
LineNumberEntryFormat
Definition: Dwarf.h:455
llvm::dwarf::DWARF_VENDOR_GNU
@ DWARF_VENDOR_GNU
Definition: Dwarf.h:72
llvm::dwarf::DW_LENGTH_hi_reserved
@ DW_LENGTH_hi_reserved
Upper bound of the reserved range.
Definition: Dwarf.h:56
llvm::dwarf::DW_VIS_qualified
@ DW_VIS_qualified
Definition: Dwarf.h:184
llvm::dwarf::DW_ATOM_null
@ DW_ATOM_null
Definition: Dwarf.h:586
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
llvm::dwarf::GIEK_TYPE
@ GIEK_TYPE
Definition: Dwarf.h:611
llvm::dwarf::Constants
Constants
Definition: Dwarf.h:510
llvm::dwarf::DW_AT_lo_user
@ DW_AT_lo_user
Definition: Dwarf.h:126
llvm::dwarf::MacroString
StringRef MacroString(unsigned Encoding)
Definition: Dwarf.cpp:487
llvm::dwarf::DW_EH_PE_sdata4
@ DW_EH_PE_sdata4
Definition: Dwarf.h:523
llvm::dwarf::DW_PUBTYPES_VERSION
@ DW_PUBTYPES_VERSION
Section version number for .debug_pubtypes.
Definition: Dwarf.h:62
llvm::dwarf::DW_MACRO_hi_user
@ DW_MACRO_hi_user
Definition: Dwarf.h:476
llvm::dwarf::CallFrameInfo
CallFrameInfo
Call frame instruction encodings.
Definition: Dwarf.h:500
llvm::format_provider
Definition: FormatVariadicDetails.h:19
llvm::dwarf::DW_ACCESS_protected
@ DW_ACCESS_protected
Definition: Dwarf.h:176
llvm::dwarf::DW_LNCT_lo_user
@ DW_LNCT_lo_user
Definition: Dwarf.h:458
llvm::Attribute
Definition: Attributes.h:67
llvm::dwarf::DW_ATE_lo_user
@ DW_ATE_lo_user
Definition: Dwarf.h:152
llvm::dwarf::DW_ATOM_die_offset
@ DW_ATOM_die_offset
Marker as the end of a list of atoms.
Definition: Dwarf.h:587
llvm::dwarf::DW_ORD_col_major
@ DW_ORD_col_major
Definition: Dwarf.h:432
llvm::dwarf::DWARF_VENDOR_APPLE
@ DWARF_VENDOR_APPLE
Definition: Dwarf.h:70
llvm::dwarf::DW_MACRO_lo_user
@ DW_MACRO_lo_user
Definition: Dwarf.h:475
llvm::dwarf::PubIndexEntryDescriptor::PubIndexEntryDescriptor
PubIndexEntryDescriptor(GDBIndexEntryKind Kind)
Definition: Dwarf.h:807
llvm::dwarf::GIEL_EXTERNAL
@ GIEL_EXTERNAL
Definition: Dwarf.h:620
llvm::dwarf::GDBIndexEntryLinkageString
StringRef GDBIndexEntryLinkageString(GDBIndexEntryLinkage Linkage)
Definition: Dwarf.cpp:630
llvm::dwarf::DW_UT_hi_user
@ DW_UT_hi_user
Definition: Dwarf.h:547
llvm::dwarf::DWARF_VENDOR_MIPS
@ DWARF_VENDOR_MIPS
Definition: Dwarf.h:75
llvm::dwarf::LLVMConstants
LLVMConstants
Definition: Dwarf.h:44
llvm::dwarf::Form
Form
Definition: Dwarf.h:130
ErrorHandling.h
llvm::dwarf::DecimalSignEncoding
DecimalSignEncoding
Definition: Dwarf.h:156
llvm::dwarf::getVirtuality
unsigned getVirtuality(StringRef VirtualityString)
Definition: Dwarf.cpp:319
llvm::dwarf::DWARF_VENDOR_PGI
@ DWARF_VENDOR_PGI
Definition: Dwarf.h:84
llvm::dwarf::DW_OP_hi_user
@ DW_OP_hi_user
Definition: Dwarf.h:140
llvm::dwarf::DW_EH_PE_sdata8
@ DW_EH_PE_sdata8
Definition: Dwarf.h:524
llvm::dwarf::DW_OP_LLVM_tag_offset
@ DW_OP_LLVM_tag_offset
Only used in LLVM metadata.
Definition: Dwarf.h:143
llvm::dwarf::InlineAttribute
InlineAttribute
Definition: Dwarf.h:421
llvm::dwarf::DW_LENGTH_DWARF64
@ DW_LENGTH_DWARF64
Indicator of 64-bit DWARF format.
Definition: Dwarf.h:55
llvm::dwarf::DWARF_VENDOR_COMPAQ
@ DWARF_VENDOR_COMPAQ
Definition: Dwarf.h:78
llvm::dwarf::DW_ATOM_qual_name_hash
@ DW_ATOM_qual_name_hash
Definition: Dwarf.h:594
llvm::Type
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
llvm::dwarf::DW_VIS_exported
@ DW_VIS_exported
Definition: Dwarf.h:183
llvm::dwarf::DW_INL_not_inlined
@ DW_INL_not_inlined
Definition: Dwarf.h:423
llvm::dwarf::FormParams::AddrSize
uint8_t AddrSize
Definition: Dwarf.h:733
llvm::dwarf::DWARF_VERSION
@ DWARF_VERSION
Other constants.
Definition: Dwarf.h:61
llvm::dwarf::RangeListEncodingString
StringRef RangeListEncodingString(unsigned Encoding)
Definition: Dwarf.cpp:515
llvm::dwarf::DW_CHILDREN_yes
@ DW_CHILDREN_yes
Definition: Dwarf.h:513
llvm::dwarf::FormVersion
unsigned FormVersion(Form F)
Definition: Dwarf.cpp:116
T
#define T
Definition: Mips16ISelLowering.cpp:341
llvm::dwarf::isC
bool isC(SourceLanguage S)
Definition: Dwarf.h:339
llvm::dwarf::GIEK_VARIABLE
@ GIEK_VARIABLE
Definition: Dwarf.h:612
llvm::max
Expected< ExpressionValue > max(const ExpressionValue &Lhs, const ExpressionValue &Rhs)
Definition: FileCheck.cpp:337
llvm::dwarf::GDBIndexEntryKind
GDBIndexEntryKind
Definition: Dwarf.h:609
llvm::dwarf::ArrayDimensionOrdering
ArrayDimensionOrdering
Definition: Dwarf.h:429
llvm::dwarf::DW_INL_declared_not_inlined
@ DW_INL_declared_not_inlined
Definition: Dwarf.h:425
llvm::dwarf::AttributeVendor
unsigned AttributeVendor(Attribute A)
Definition: Dwarf.cpp:94
llvm::dwarf::Tag
Tag
Definition: Dwarf.h:103
llvm::dwarf::getCallingConvention
unsigned getCallingConvention(StringRef LanguageString)
Definition: Dwarf.cpp:405
llvm::dwarf::LoclistEntries
LoclistEntries
DWARF v5 loc list entry encoding values.
Definition: Dwarf.h:494
Format.h
llvm::dwarf::VirtualityString
StringRef VirtualityString(unsigned Virtuality)
Definition: Dwarf.cpp:308
llvm::dwarf::FormParams::Format
DwarfFormat Format
Definition: Dwarf.h:734
llvm::dwarf::DW_TAG_lo_user
@ DW_TAG_lo_user
Definition: Dwarf.h:106
llvm::dwarf::isUnitType
bool isUnitType(uint8_t UnitType)
Definition: Dwarf.h:557
llvm::dwarf::GIEL_STATIC
@ GIEL_STATIC
Definition: Dwarf.h:620
llvm::dwarf::PubIndexEntryDescriptor::PubIndexEntryDescriptor
PubIndexEntryDescriptor(uint8_t Value)
Definition: Dwarf.h:809
llvm::dwarf::IndexString
StringRef IndexString(unsigned Idx)
Definition: Dwarf.cpp:684
llvm::dwarf::DW_LNE_lo_user
@ DW_LNE_lo_user
Definition: Dwarf.h:451
llvm::dwarf::DW_EH_PE_textrel
@ DW_EH_PE_textrel
Definition: Dwarf.h:527
llvm::dwarf::Attribute
Attribute
Attributes.
Definition: Dwarf.h:123
llvm::dwarf::AccessibilityString
StringRef AccessibilityString(unsigned Access)
Definition: Dwarf.cpp:270
F
#define F(x, y, z)
Definition: MD5.cpp:55
llvm::dwarf::GnuMacroString
StringRef GnuMacroString(unsigned Encoding)
Definition: Dwarf.cpp:498
llvm::dwarf::DW_MACINFO_end_file
@ DW_MACINFO_end_file
Definition: Dwarf.h:467
llvm::dwarf::GnuMacroEntryType
GnuMacroEntryType
GNU .debug_macro macro information entry type encodings.
Definition: Dwarf.h:480
result
It looks like we only need to define PPCfmarto for these because according to these instructions perform RTO on fma s result
Definition: README_P9.txt:256
llvm::dwarf::TagVendor
unsigned TagVendor(Tag T)
Definition: Dwarf.cpp:51
llvm::dwarf::AtomTypeString
StringRef AtomTypeString(unsigned Atom)
Definition: Dwarf.cpp:588
llvm::dwarf::DW_INVALID_OFFSET
const uint32_t DW_INVALID_OFFSET
Identifier of an invalid DIE offset in the .debug_info section.
Definition: Dwarf.h:101
llvm::dwarf::CallFrameString
StringRef CallFrameString(unsigned Encoding, Triple::ArchType Arch)
Definition: Dwarf.cpp:537
llvm::dwarf::GIEK_UNUSED6
@ GIEK_UNUSED6
Definition: Dwarf.h:616
llvm::dwarf::DW_CC_lo_user
@ DW_CC_lo_user
Definition: Dwarf.h:417
llvm::dwarf::LNExtendedString
StringRef LNExtendedString(unsigned Encoding)
Definition: Dwarf.cpp:447
llvm::dwarf::DW_CFA_hi_user
@ DW_CFA_hi_user
Definition: Dwarf.h:507
llvm::Triple::ArchType
ArchType
Definition: Triple.h:46
llvm::dwarf::DW_EH_PE_indirect
@ DW_EH_PE_indirect
Definition: Dwarf.h:531
llvm::dwarf::LanguageString
StringRef LanguageString(unsigned Language)
Definition: Dwarf.cpp:327
llvm::dwarf::DW_TAG_hi_user
@ DW_TAG_hi_user
Definition: Dwarf.h:107
llvm::dwarf::computeTombstoneAddress
uint64_t computeTombstoneAddress(uint8_t AddressByteSize)
Definition: Dwarf.h:859
E
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
llvm::dwarf::AttributeValueString
StringRef AttributeValueString(uint16_t Attr, unsigned Val)
Returns the symbolic string representing Val when used as a value for attribute Attr.
Definition: Dwarf.cpp:640
llvm::dwarf::DW_DS_trailing_overpunch
@ DW_DS_trailing_overpunch
Definition: Dwarf.h:160
llvm::dwarf::DW_ATOM_die_tag
@ DW_ATOM_die_tag
Definition: Dwarf.h:590
llvm::AMDGPU::HSAMD::Kernel::Key::Language
constexpr char Language[]
Key for Kernel::Metadata::mLanguage.
Definition: AMDGPUMetadata.h:388
llvm::dwarf::DW_EH_PE_udata2
@ DW_EH_PE_udata2
Definition: Dwarf.h:518
llvm::dwarf::PubIndexEntryDescriptor::toBits
uint8_t toBits() const
Definition: Dwarf.h:814
llvm::dwarf::DW_ATOM_type_type_flags
@ DW_ATOM_type_type_flags
Definition: Dwarf.h:593
llvm::dwarf::getTag
unsigned getTag(StringRef TagString)
Definition: Dwarf.cpp:32
llvm::dwarf::DW_LNE_hi_user
@ DW_LNE_hi_user
Definition: Dwarf.h:452
llvm::dwarf::DW_FLAG_type_implementation
@ DW_FLAG_type_implementation
Definition: Dwarf.h:600
llvm::dwarf::DW_ATOM_cu_offset
@ DW_ATOM_cu_offset
Definition: Dwarf.h:588
llvm::dwarf::LanguageVersion
unsigned LanguageVersion(SourceLanguage L)
Definition: Dwarf.cpp:346
llvm::dwarf::DWARF_VENDOR_SUN
@ DWARF_VENDOR_SUN
Definition: Dwarf.h:85
UINT64_MAX
#define UINT64_MAX
Definition: DataTypes.h:77
llvm::dwarf::DW_CC_hi_user
@ DW_CC_hi_user
Definition: Dwarf.h:418
llvm::dwarf::Index
Index
Definition: Dwarf.h:550
llvm::dwarf::LanguageLowerBound
std::optional< unsigned > LanguageLowerBound(SourceLanguage L)
Definition: Dwarf.cpp:369
llvm::dwarf::MacroEntryType
MacroEntryType
DWARF v5 macro information entry type encodings.
Definition: Dwarf.h:472
llvm::dwarf::FormatString
StringRef FormatString(DwarfFormat Format)
Definition: Dwarf.cpp:791
llvm::dwarf::DW_LENGTH_lo_reserved
@ DW_LENGTH_lo_reserved
Special values for an initial length field.
Definition: Dwarf.h:54
llvm::dwarf::VisibilityString
StringRef VisibilityString(unsigned Visibility)
Definition: Dwarf.cpp:296
llvm::dwarf::DW_CFA_lo_user
@ DW_CFA_lo_user
Definition: Dwarf.h:506
llvm::dwarf::EndianityEncoding
EndianityEncoding
Definition: Dwarf.h:165
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::IndexedInstrProf::Version
const uint64_t Version
Definition: InstrProf.h:1058
llvm::dwarf::LineNumberExtendedOps
LineNumberExtendedOps
Line Number Extended Opcode Encodings.
Definition: Dwarf.h:448
llvm::dwarf::AccessAttribute
AccessAttribute
Definition: Dwarf.h:173
llvm::dwarf::GDBIndexEntryKindString
StringRef GDBIndexEntryKindString(GDBIndexEntryKind Kind)
Definition: Dwarf.cpp:607
llvm::dwarf::DwarfFormat
DwarfFormat
Constants that define the DWARF format as 32 or 64 bit.
Definition: Dwarf.h:91
llvm::dwarf::DWARF_VENDOR_INTEL
@ DWARF_VENDOR_INTEL
Definition: Dwarf.h:83
llvm::dwarf::FormEncodingString
StringRef FormEncodingString(unsigned Encoding)
Definition: Dwarf.cpp:105
llvm::dwarf::DW_EH_PE_funcrel
@ DW_EH_PE_funcrel
Definition: Dwarf.h:529
llvm::dwarf::DWARF_VENDOR_IBM
@ DWARF_VENDOR_IBM
Definition: Dwarf.h:82
llvm::dwarf::DW_FORM_lo_user
@ DW_FORM_lo_user
Not specified by DWARF.
Definition: Dwarf.h:133
llvm::dwarf::DW_IDX_hi_user
@ DW_IDX_hi_user
Definition: Dwarf.h:554
llvm::dwarf::DW_EH_PE_udata4
@ DW_EH_PE_udata4
Definition: Dwarf.h:519
llvm::dwarf::DW_UT_lo_user
@ DW_UT_lo_user
Definition: Dwarf.h:546
llvm::dwarf::DWARF_VENDOR_GHS
@ DWARF_VENDOR_GHS
Definition: Dwarf.h:79
llvm::dwarf::DW_LANG_lo_user
@ DW_LANG_lo_user
Definition: Dwarf.h:203
llvm::dwarf::PubIndexEntryDescriptor::Linkage
GDBIndexEntryLinkage Linkage
Definition: Dwarf.h:804
llvm::dwarf::DW_ORD_row_major
@ DW_ORD_row_major
Definition: Dwarf.h:431
llvm::RISCVFenceField::O
@ O
Definition: RISCVBaseInfo.h:274
llvm::dwarf::DW_OP_LLVM_entry_value
@ DW_OP_LLVM_entry_value
Only used in LLVM metadata.
Definition: Dwarf.h:144
llvm::dwarf::DW_INL_inlined
@ DW_INL_inlined
Definition: Dwarf.h:424
llvm::dwarf::DW_EH_PE_udata8
@ DW_EH_PE_udata8
Definition: Dwarf.h:520
llvm::dwarf::getLanguage
unsigned getLanguage(StringRef LanguageString)
Definition: Dwarf.cpp:338
llvm::dwarf::VisibilityAttribute
VisibilityAttribute
Definition: Dwarf.h:180
llvm::dwarf::isType
bool isType(Tag T)
Definition: Dwarf.h:111
uint64_t
llvm::dwarf::DW_EH_PE_pcrel
@ DW_EH_PE_pcrel
Definition: Dwarf.h:526
llvm::dwarf::DW_ID_down_case
@ DW_ID_down_case
Definition: Dwarf.h:409
llvm::dwarf::FormParams::DwarfUsesRelocationsAcrossSections
bool DwarfUsesRelocationsAcrossSections
True if DWARF v2 output generally uses relocations for references to other .debug_* sections.
Definition: Dwarf.h:737
llvm::dwarf::TagVersion
unsigned TagVersion(Tag T)
Definition: Dwarf.cpp:40
llvm::dwarf::DW_VIS_local
@ DW_VIS_local
Definition: Dwarf.h:182
llvm::dwarf::DefaultedMemberString
StringRef DefaultedMemberString(unsigned DefaultedEncodings)
Definition: Dwarf.cpp:283
llvm::dwarf::getUnitLengthFieldByteSize
uint8_t getUnitLengthFieldByteSize(DwarfFormat Format)
Get the byte size of the unit length field depending on the DWARF format.
Definition: Dwarf.h:757
llvm::format_provider< Enum, std::enable_if_t< dwarf::EnumTraits< Enum >::value > >::format
static void format(const Enum &E, raw_ostream &OS, StringRef Style)
Definition: Dwarf.h:872
llvm::HexStyle::Style
Style
Definition: MCInstPrinter.h:33
llvm::dwarf::DWARF_VENDOR_UPC
@ DWARF_VENDOR_UPC
Definition: Dwarf.h:86
llvm::dwarf::DW_ACCESS_public
@ DW_ACCESS_public
Definition: Dwarf.h:175
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
llvm::dwarf::UnitType
UnitType
Constants for unit types in DWARF v5.
Definition: Dwarf.h:543
llvm::dwarf::AttributeVersion
unsigned AttributeVersion(Attribute A)
Definition: Dwarf.cpp:83
FormatVariadicDetails.h
llvm::dwarf::DWARF_VENDOR_HP
@ DWARF_VENDOR_HP
Definition: Dwarf.h:81
llvm::dwarf::DW_ARANGES_VERSION
@ DW_ARANGES_VERSION
Section version number for .debug_aranges.
Definition: Dwarf.h:64
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:749
llvm::dwarf::DW_OP_lo_user
@ DW_OP_lo_user
Definition: Dwarf.h:139
llvm::dwarf::FormVendor
unsigned FormVendor(Form F)
Definition: Dwarf.cpp:127
llvm::dwarf::DW_IDX_lo_user
@ DW_IDX_lo_user
Definition: Dwarf.h:553
llvm::dwarf::DW_MACRO_GNU_lo_user
@ DW_MACRO_GNU_lo_user
Definition: Dwarf.h:483
llvm::dwarf::PubIndexEntryDescriptor::PubIndexEntryDescriptor
PubIndexEntryDescriptor(GDBIndexEntryKind Kind, GDBIndexEntryLinkage Linkage)
Definition: Dwarf.h:805
llvm::dwarf::GIEK_UNUSED5
@ GIEK_UNUSED5
Definition: Dwarf.h:615
llvm::dwarf::DW_END_lo_user
@ DW_END_lo_user
Definition: Dwarf.h:169
llvm::dwarf::DW_INL_declared_inlined
@ DW_INL_declared_inlined
Definition: Dwarf.h:426
llvm::dwarf::DW_EH_PE_datarel
@ DW_EH_PE_datarel
Definition: Dwarf.h:528
llvm::dwarf::SourceLanguage
SourceLanguage
Definition: Dwarf.h:199
llvm::dwarf::DW_OP_LLVM_arg
@ DW_OP_LLVM_arg
Only used in LLVM metadata.
Definition: Dwarf.h:146
llvm::dwarf::getAttributeEncoding
unsigned getAttributeEncoding(StringRef EncodingString)
Definition: Dwarf.cpp:208
llvm::dwarf::isFortran
bool isFortran(SourceLanguage S)
Definition: Dwarf.h:273
llvm::dwarf::ArrayOrderString
StringRef ArrayOrderString(unsigned Order)
Definition: Dwarf.cpp:426
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::CaseString
StringRef CaseString(unsigned Case)
Definition: Dwarf.cpp:380
llvm::dwarf::DW_OP_LLVM_fragment
@ DW_OP_LLVM_fragment
Only used in LLVM metadata.
Definition: Dwarf.h:141
llvm::dwarf::DW_EH_PE_uleb128
@ DW_EH_PE_uleb128
Definition: Dwarf.h:517
llvm::dwarf::DW_DS_unsigned
@ DW_DS_unsigned
Definition: Dwarf.h:158
llvm::dwarf::DW_OP_LLVM_implicit_pointer
@ DW_OP_LLVM_implicit_pointer
Only used in LLVM metadata.
Definition: Dwarf.h:145
Triple.h
llvm::dwarf::DW_TAG_invalid
@ DW_TAG_invalid
LLVM mock tags (see also llvm/BinaryFormat/Dwarf.def).
Definition: Dwarf.h:47
llvm::dwarf::DW_ACCESS_private
@ DW_ACCESS_private
Definition: Dwarf.h:177
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
llvm::dwarf::DW_LNCT_hi_user
@ DW_LNCT_hi_user
Definition: Dwarf.h:459
llvm_unreachable
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
Definition: ErrorHandling.h:143
llvm::dwarf::LanguageVendor
unsigned LanguageVendor(SourceLanguage L)
Definition: Dwarf.cpp:357
uint32_t
llvm::dwarf::DW_MACINFO_vendor_ext
@ DW_MACINFO_vendor_ext
Definition: Dwarf.h:468
Compiler.h
llvm::dwarf::ApplePropertyAttributes
ApplePropertyAttributes
Constants for the DW_APPLE_PROPERTY_attributes attribute.
Definition: Dwarf.h:537
llvm::dwarf::ApplePropertyString
StringRef ApplePropertyString(unsigned)
Definition: Dwarf.cpp:566
S
add sub stmia L5 ldr r0 bl L_printf $stub Instead of a and a wouldn t it be better to do three moves *Return an aggregate type is even return S
Definition: README.txt:210
llvm::dwarf::AtomValueString
StringRef AtomValueString(uint16_t Atom, unsigned Val)
Returns the symbolic string representing Val when used as a value for atom Atom.
Definition: Dwarf.cpp:673
llvm::dwarf::PubIndexEntryDescriptor::Kind
GDBIndexEntryKind Kind
Definition: Dwarf.h:803
llvm::dwarf::DW_MACINFO_define
@ DW_MACINFO_define
Definition: Dwarf.h:464
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::RnglistEntries
RnglistEntries
DWARF v5 range list entry encoding values.
Definition: Dwarf.h:488
llvm::dwarf::ChildrenString
StringRef ChildrenString(unsigned Children)
Definition: Dwarf.cpp:62
llvm::dwarf::GIEK_UNUSED7
@ GIEK_UNUSED7
Definition: Dwarf.h:617
llvm::dwarf::getArrayIndexTypeEncoding
TypeKind getArrayIndexTypeEncoding(SourceLanguage S)
Definition: Dwarf.h:401
llvm::dwarf::DWARF_VENDOR_GOOGLE
@ DWARF_VENDOR_GOOGLE
Definition: Dwarf.h:73
llvm::dwarf::ConventionString
StringRef ConventionString(unsigned Convention)
Definition: Dwarf.cpp:394
llvm::dwarf::DW_CFA_extended
@ DW_CFA_extended
Definition: Dwarf.h:504
llvm::dwarf::DW_EH_PE_sleb128
@ DW_EH_PE_sleb128
Definition: Dwarf.h:521
llvm::dwarf::DW_EH_PE_absptr
@ DW_EH_PE_absptr
Definition: Dwarf.h:515
llvm::dwarf::GIEK_FUNCTION
@ GIEK_FUNCTION
Definition: Dwarf.h:613
llvm::dwarf::TypeKind
TypeKind
Definition: Dwarf.h:149
std
Definition: BitVector.h:851
llvm::dwarf::getOperationEncoding
unsigned getOperationEncoding(StringRef OperationEncodingString)
Definition: Dwarf.cpp:161
uint16_t
llvm::dwarf::DW_END_hi_user
@ DW_END_hi_user
Definition: Dwarf.h:170
llvm::dwarf::DW_CIE_ID
const uint32_t DW_CIE_ID
Special ID values that distinguish a CIE from a FDE in DWARF CFI.
Definition: Dwarf.h:96
llvm::dwarf::DWARF_VENDOR_GO
@ DWARF_VENDOR_GO
Definition: Dwarf.h:80
llvm::dwarf::DW_PUBNAMES_VERSION
@ DW_PUBNAMES_VERSION
Section version number for .debug_pubnames.
Definition: Dwarf.h:63
llvm::dwarf::GIEK_NONE
@ GIEK_NONE
Definition: Dwarf.h:610
llvm::dwarf::DWARF_VENDOR_ALTIUM
@ DWARF_VENDOR_ALTIUM
Definition: Dwarf.h:77
llvm::dwarf::DW_DS_leading_separate
@ DW_DS_leading_separate
Definition: Dwarf.h:161
llvm::dwarf::DW_MACINFO_start_file
@ DW_MACINFO_start_file
Definition: Dwarf.h:466
llvm::dwarf::EndianityString
StringRef EndianityString(unsigned Endian)
Definition: Dwarf.cpp:254
llvm::dwarf::DW_MACRO_GNU_hi_user
@ DW_MACRO_GNU_hi_user
Definition: Dwarf.h:484
llvm::dwarf::DW_VIRTUALITY_invalid
@ DW_VIRTUALITY_invalid
Virtuality for invalid results.
Definition: Dwarf.h:48
llvm::dwarf::DW_DEFAULTED_max
@ DW_DEFAULTED_max
Definition: Dwarf.h:196
llvm::dwarf::DW_DS_trailing_separate
@ DW_DS_trailing_separate
Definition: Dwarf.h:162
llvm::dwarf::DW_MACINFO_undef
@ DW_MACINFO_undef
Definition: Dwarf.h:465
llvm::dwarf::DWARF_VENDOR_DWARF
@ DWARF_VENDOR_DWARF
Identifiers we use to distinguish vendor extensions.
Definition: Dwarf.h:69
llvm::dwarf::isCPlusPlus
bool isCPlusPlus(SourceLanguage S)
Definition: Dwarf.h:207
llvm::dwarf::DW_ID_case_insensitive
@ DW_ID_case_insensitive
Definition: Dwarf.h:410
llvm::dwarf::DWARF_VENDOR_BORLAND
@ DWARF_VENDOR_BORLAND
Definition: Dwarf.h:71
llvm::dwarf::VirtualityAttribute
VirtualityAttribute
Definition: Dwarf.h:187
llvm::dwarf::DW_OP_LLVM_convert
@ DW_OP_LLVM_convert
Only used in LLVM metadata.
Definition: Dwarf.h:142
llvm::dwarf::AcceleratorTable
AcceleratorTable
Definition: Dwarf.h:584
llvm::dwarf::PubIndexEntryDescriptor
Describes an entry of the various gnu_pub* debug sections.
Definition: Dwarf.h:802
llvm::dwarf::LNStandardString
StringRef LNStandardString(unsigned Standard)
Definition: Dwarf.cpp:436
llvm::dwarf::isValidFormForVersion
bool isValidFormForVersion(Form F, unsigned Version, bool ExtensionsOk=true)
Tells whether the specified form is defined in the specified version, or is an extension if extension...
Definition: Dwarf.cpp:782
llvm::dwarf::FormParams::Version
uint16_t Version
Definition: Dwarf.h:732
llvm::dwarf::DW_CHILDREN_no
@ DW_CHILDREN_no
Definition: Dwarf.h:512
llvm::dwarf::DiscriminantList
DiscriminantList
Definition: Dwarf.h:435
llvm::dwarf::OperationVendor
unsigned OperationVendor(LocationAtom O)
Definition: Dwarf.cpp:186
llvm::dwarf::DW_hash_function_djb
@ DW_hash_function_djb
Definition: Dwarf.h:605
llvm::dwarf::MacinfoString
StringRef MacinfoString(unsigned Encoding)
Definition: Dwarf.cpp:458
llvm::dwarf::DWARF_VENDOR_WASM
@ DWARF_VENDOR_WASM
Definition: Dwarf.h:76
llvm::dwarf::DW_TAG_user_base
@ DW_TAG_user_base
Recommended base for user tags.
Definition: Dwarf.h:108
llvm::dwarf::DW_ID_case_sensitive
@ DW_ID_case_sensitive
Definition: Dwarf.h:407
llvm::dwarf::DW_MACINFO_invalid
@ DW_MACINFO_invalid
Macinfo type for invalid results.
Definition: Dwarf.h:49
llvm::dwarf::getMacro
unsigned getMacro(StringRef MacroString)
Definition: Dwarf.cpp:509
llvm::dwarf::DWARF_VENDOR_LLVM
@ DWARF_VENDOR_LLVM
Definition: Dwarf.h:74
llvm::dwarf::DW_EH_PE_omit
@ DW_EH_PE_omit
Definition: Dwarf.h:516
llvm::dwarf::DW_LANG_hi_user
@ DW_LANG_hi_user
Definition: Dwarf.h:204
llvm::dwarf::GIEK_OTHER
@ GIEK_OTHER
Definition: Dwarf.h:614
llvm::dwarf::DW_EH_PE_sdata2
@ DW_EH_PE_sdata2
Definition: Dwarf.h:522
llvm::dwarf::OperationVersion
unsigned OperationVersion(LocationAtom O)
Definition: Dwarf.cpp:175
llvm::dwarf::DW_ATE_hi_user
@ DW_ATE_hi_user
Definition: Dwarf.h:153
llvm::dwarf::RLEString
StringRef RLEString(unsigned RLE)
Definition: Dwarf.cpp:805
llvm::dwarf::LineNumberOps
LineNumberOps
Line Number Standard Opcode Encodings.
Definition: Dwarf.h:442
DataTypes.h
llvm::dwarf::DW_EH_PE_aligned
@ DW_EH_PE_aligned
Definition: Dwarf.h:530
llvm::dwarf::InlineCodeString
StringRef InlineCodeString(unsigned Code)
Definition: Dwarf.cpp:412
llvm::dwarf::DWARF64
@ DWARF64
Definition: Dwarf.h:91
llvm::dwarf::DW_ATOM_type_flags
@ DW_ATOM_type_flags
Definition: Dwarf.h:591
llvm::dwarf::DefaultedMemberAttribute
DefaultedMemberAttribute
Definition: Dwarf.h:193
llvm::dwarf::TagString
StringRef TagString(unsigned Tag)
Definition: Dwarf.cpp:21
llvm::dwarf::DW_DS_leading_overpunch
@ DW_DS_leading_overpunch
Definition: Dwarf.h:159
llvm::dwarf::DW_AT_hi_user
@ DW_AT_hi_user
Definition: Dwarf.h:127
llvm::dwarf::DW64_CIE_ID
const uint64_t DW64_CIE_ID
Definition: Dwarf.h:97
llvm::dwarf::DW_EH_PE_signed
@ DW_EH_PE_signed
Definition: Dwarf.h:525
llvm::dwarf::DW_DSC_range
@ DW_DSC_range
Definition: Dwarf.h:438
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::dwarf::DecimalSignString
StringRef DecimalSignString(unsigned Sign)
Definition: Dwarf.cpp:238
llvm::dwarf::AttributeEncodingVersion
unsigned AttributeEncodingVersion(TypeKind E)
Definition: Dwarf.cpp:216
llvm::dwarf::getMacinfo
unsigned getMacinfo(StringRef MacinfoString)
Definition: Dwarf.cpp:477
llvm::dwarf::UnitTypeString
StringRef UnitTypeString(unsigned)
Definition: Dwarf.cpp:577
llvm::Value
LLVM Value Representation.
Definition: Value.h:74
llvm::dwarf::GDBIndexEntryLinkage
GDBIndexEntryLinkage
Definition: Dwarf.h:620
llvm::dwarf::AttributeString
StringRef AttributeString(unsigned Attribute)
Definition: Dwarf.cpp:72
llvm::dwarf::DW_ID_up_case
@ DW_ID_up_case
Definition: Dwarf.h:408
llvm::dwarf::OperationEncodingString
StringRef OperationEncodingString(unsigned Encoding)
Definition: Dwarf.cpp:138
llvm::dwarf::LocListEncodingString
StringRef LocListEncodingString(unsigned Encoding)
Definition: Dwarf.cpp:526
llvm::dwarf::LocationAtom
LocationAtom
Definition: Dwarf.h:136
llvm::dwarf::DWARF32
@ DWARF32
Definition: Dwarf.h:91
llvm::dwarf::EnumTraits
Definition: Dwarf.h:827
llvm::dwarf::MacinfoRecordType
MacinfoRecordType
Definition: Dwarf.h:462
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:742
llvm::dwarf::CaseSensitivity
CaseSensitivity
Definition: Dwarf.h:405
llvm::dwarf::DW_DSC_label
@ DW_DSC_label
Definition: Dwarf.h:437