1 //===-- llvm/BinaryFormat/Dwarf.cpp - Dwarf Framework ------------*- C++-*-===//
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
7 //===----------------------------------------------------------------------===//
9 // This file contains support for generic dwarf information.
11 //===----------------------------------------------------------------------===//
13 #include "llvm/BinaryFormat/Dwarf.h"
14 #include "llvm/ADT/StringSwitch.h"
15 #include "llvm/ADT/Triple.h"
16 #include "llvm/Support/ErrorHandling.h"
19 using namespace dwarf
;
21 StringRef
llvm::dwarf::TagString(unsigned Tag
) {
25 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR) \
27 return "DW_TAG_" #NAME;
28 #include "llvm/BinaryFormat/Dwarf.def"
32 unsigned llvm::dwarf::getTag(StringRef TagString
) {
33 return StringSwitch
<unsigned>(TagString
)
34 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR) \
35 .Case("DW_TAG_" #NAME, DW_TAG_##NAME)
36 #include "llvm/BinaryFormat/Dwarf.def"
37 .Default(DW_TAG_invalid
);
40 unsigned llvm::dwarf::TagVersion(dwarf::Tag Tag
) {
44 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR) \
47 #include "llvm/BinaryFormat/Dwarf.def"
51 unsigned llvm::dwarf::TagVendor(dwarf::Tag Tag
) {
55 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR) \
57 return DWARF_VENDOR_##VENDOR;
58 #include "llvm/BinaryFormat/Dwarf.def"
62 StringRef
llvm::dwarf::ChildrenString(unsigned Children
) {
65 return "DW_CHILDREN_no";
67 return "DW_CHILDREN_yes";
72 StringRef
llvm::dwarf::AttributeString(unsigned Attribute
) {
76 #define HANDLE_DW_AT(ID, NAME, VERSION, VENDOR) \
78 return "DW_AT_" #NAME;
79 #include "llvm/BinaryFormat/Dwarf.def"
83 unsigned llvm::dwarf::AttributeVersion(dwarf::Attribute Attribute
) {
87 #define HANDLE_DW_AT(ID, NAME, VERSION, VENDOR) \
90 #include "llvm/BinaryFormat/Dwarf.def"
94 unsigned llvm::dwarf::AttributeVendor(dwarf::Attribute Attribute
) {
98 #define HANDLE_DW_AT(ID, NAME, VERSION, VENDOR) \
100 return DWARF_VENDOR_##VENDOR;
101 #include "llvm/BinaryFormat/Dwarf.def"
105 StringRef
llvm::dwarf::FormEncodingString(unsigned Encoding
) {
109 #define HANDLE_DW_FORM(ID, NAME, VERSION, VENDOR) \
110 case DW_FORM_##NAME: \
111 return "DW_FORM_" #NAME;
112 #include "llvm/BinaryFormat/Dwarf.def"
116 unsigned llvm::dwarf::FormVersion(dwarf::Form Form
) {
120 #define HANDLE_DW_FORM(ID, NAME, VERSION, VENDOR) \
121 case DW_FORM_##NAME: \
123 #include "llvm/BinaryFormat/Dwarf.def"
127 unsigned llvm::dwarf::FormVendor(dwarf::Form Form
) {
131 #define HANDLE_DW_FORM(ID, NAME, VERSION, VENDOR) \
132 case DW_FORM_##NAME: \
133 return DWARF_VENDOR_##VENDOR;
134 #include "llvm/BinaryFormat/Dwarf.def"
138 StringRef
llvm::dwarf::OperationEncodingString(unsigned Encoding
) {
142 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
144 return "DW_OP_" #NAME;
145 #include "llvm/BinaryFormat/Dwarf.def"
146 case DW_OP_LLVM_fragment
:
147 return "DW_OP_LLVM_fragment";
151 unsigned llvm::dwarf::getOperationEncoding(StringRef OperationEncodingString
) {
152 return StringSwitch
<unsigned>(OperationEncodingString
)
153 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
154 .Case("DW_OP_" #NAME, DW_OP_##NAME)
155 #include "llvm/BinaryFormat/Dwarf.def"
156 .Case("DW_OP_LLVM_fragment", DW_OP_LLVM_fragment
)
160 unsigned llvm::dwarf::OperationVersion(dwarf::LocationAtom Op
) {
164 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
167 #include "llvm/BinaryFormat/Dwarf.def"
171 unsigned llvm::dwarf::OperationVendor(dwarf::LocationAtom Op
) {
175 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
177 return DWARF_VENDOR_##VENDOR;
178 #include "llvm/BinaryFormat/Dwarf.def"
182 StringRef
llvm::dwarf::AttributeEncodingString(unsigned Encoding
) {
186 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
187 case DW_ATE_##NAME: \
188 return "DW_ATE_" #NAME;
189 #include "llvm/BinaryFormat/Dwarf.def"
193 unsigned llvm::dwarf::getAttributeEncoding(StringRef EncodingString
) {
194 return StringSwitch
<unsigned>(EncodingString
)
195 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
196 .Case("DW_ATE_" #NAME, DW_ATE_##NAME)
197 #include "llvm/BinaryFormat/Dwarf.def"
201 unsigned llvm::dwarf::AttributeEncodingVersion(dwarf::TypeKind ATE
) {
205 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
206 case DW_ATE_##NAME: \
208 #include "llvm/BinaryFormat/Dwarf.def"
212 unsigned llvm::dwarf::AttributeEncodingVendor(dwarf::TypeKind ATE
) {
216 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
217 case DW_ATE_##NAME: \
218 return DWARF_VENDOR_##VENDOR;
219 #include "llvm/BinaryFormat/Dwarf.def"
223 StringRef
llvm::dwarf::DecimalSignString(unsigned Sign
) {
226 return "DW_DS_unsigned";
227 case DW_DS_leading_overpunch
:
228 return "DW_DS_leading_overpunch";
229 case DW_DS_trailing_overpunch
:
230 return "DW_DS_trailing_overpunch";
231 case DW_DS_leading_separate
:
232 return "DW_DS_leading_separate";
233 case DW_DS_trailing_separate
:
234 return "DW_DS_trailing_separate";
239 StringRef
llvm::dwarf::EndianityString(unsigned Endian
) {
242 return "DW_END_default";
246 return "DW_END_little";
248 return "DW_END_lo_user";
250 return "DW_END_hi_user";
255 StringRef
llvm::dwarf::AccessibilityString(unsigned Access
) {
257 // Accessibility codes
258 case DW_ACCESS_public
:
259 return "DW_ACCESS_public";
260 case DW_ACCESS_protected
:
261 return "DW_ACCESS_protected";
262 case DW_ACCESS_private
:
263 return "DW_ACCESS_private";
268 StringRef
llvm::dwarf::VisibilityString(unsigned Visibility
) {
269 switch (Visibility
) {
271 return "DW_VIS_local";
272 case DW_VIS_exported
:
273 return "DW_VIS_exported";
274 case DW_VIS_qualified
:
275 return "DW_VIS_qualified";
280 StringRef
llvm::dwarf::VirtualityString(unsigned Virtuality
) {
281 switch (Virtuality
) {
284 #define HANDLE_DW_VIRTUALITY(ID, NAME) \
285 case DW_VIRTUALITY_##NAME: \
286 return "DW_VIRTUALITY_" #NAME;
287 #include "llvm/BinaryFormat/Dwarf.def"
291 unsigned llvm::dwarf::getVirtuality(StringRef VirtualityString
) {
292 return StringSwitch
<unsigned>(VirtualityString
)
293 #define HANDLE_DW_VIRTUALITY(ID, NAME) \
294 .Case("DW_VIRTUALITY_" #NAME, DW_VIRTUALITY_##NAME)
295 #include "llvm/BinaryFormat/Dwarf.def"
296 .Default(DW_VIRTUALITY_invalid
);
299 StringRef
llvm::dwarf::LanguageString(unsigned Language
) {
303 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
304 case DW_LANG_##NAME: \
305 return "DW_LANG_" #NAME;
306 #include "llvm/BinaryFormat/Dwarf.def"
310 unsigned llvm::dwarf::getLanguage(StringRef LanguageString
) {
311 return StringSwitch
<unsigned>(LanguageString
)
312 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
313 .Case("DW_LANG_" #NAME, DW_LANG_##NAME)
314 #include "llvm/BinaryFormat/Dwarf.def"
318 unsigned llvm::dwarf::LanguageVersion(dwarf::SourceLanguage Lang
) {
322 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
323 case DW_LANG_##NAME: \
325 #include "llvm/BinaryFormat/Dwarf.def"
329 unsigned llvm::dwarf::LanguageVendor(dwarf::SourceLanguage Lang
) {
333 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
334 case DW_LANG_##NAME: \
335 return DWARF_VENDOR_##VENDOR;
336 #include "llvm/BinaryFormat/Dwarf.def"
340 Optional
<unsigned> llvm::dwarf::LanguageLowerBound(dwarf::SourceLanguage Lang
) {
344 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
345 case DW_LANG_##NAME: \
347 #include "llvm/BinaryFormat/Dwarf.def"
351 StringRef
llvm::dwarf::CaseString(unsigned Case
) {
353 case DW_ID_case_sensitive
:
354 return "DW_ID_case_sensitive";
356 return "DW_ID_up_case";
357 case DW_ID_down_case
:
358 return "DW_ID_down_case";
359 case DW_ID_case_insensitive
:
360 return "DW_ID_case_insensitive";
365 StringRef
llvm::dwarf::ConventionString(unsigned CC
) {
369 #define HANDLE_DW_CC(ID, NAME) \
371 return "DW_CC_" #NAME;
372 #include "llvm/BinaryFormat/Dwarf.def"
376 unsigned llvm::dwarf::getCallingConvention(StringRef CCString
) {
377 return StringSwitch
<unsigned>(CCString
)
378 #define HANDLE_DW_CC(ID, NAME) .Case("DW_CC_" #NAME, DW_CC_##NAME)
379 #include "llvm/BinaryFormat/Dwarf.def"
383 StringRef
llvm::dwarf::InlineCodeString(unsigned Code
) {
385 case DW_INL_not_inlined
:
386 return "DW_INL_not_inlined";
388 return "DW_INL_inlined";
389 case DW_INL_declared_not_inlined
:
390 return "DW_INL_declared_not_inlined";
391 case DW_INL_declared_inlined
:
392 return "DW_INL_declared_inlined";
397 StringRef
llvm::dwarf::ArrayOrderString(unsigned Order
) {
399 case DW_ORD_row_major
:
400 return "DW_ORD_row_major";
401 case DW_ORD_col_major
:
402 return "DW_ORD_col_major";
407 StringRef
llvm::dwarf::LNStandardString(unsigned Standard
) {
411 #define HANDLE_DW_LNS(ID, NAME) \
412 case DW_LNS_##NAME: \
413 return "DW_LNS_" #NAME;
414 #include "llvm/BinaryFormat/Dwarf.def"
418 StringRef
llvm::dwarf::LNExtendedString(unsigned Encoding
) {
422 #define HANDLE_DW_LNE(ID, NAME) \
423 case DW_LNE_##NAME: \
424 return "DW_LNE_" #NAME;
425 #include "llvm/BinaryFormat/Dwarf.def"
429 StringRef
llvm::dwarf::MacinfoString(unsigned Encoding
) {
431 // Macinfo Type Encodings
432 case DW_MACINFO_define
:
433 return "DW_MACINFO_define";
434 case DW_MACINFO_undef
:
435 return "DW_MACINFO_undef";
436 case DW_MACINFO_start_file
:
437 return "DW_MACINFO_start_file";
438 case DW_MACINFO_end_file
:
439 return "DW_MACINFO_end_file";
440 case DW_MACINFO_vendor_ext
:
441 return "DW_MACINFO_vendor_ext";
442 case DW_MACINFO_invalid
:
443 return "DW_MACINFO_invalid";
448 unsigned llvm::dwarf::getMacinfo(StringRef MacinfoString
) {
449 return StringSwitch
<unsigned>(MacinfoString
)
450 .Case("DW_MACINFO_define", DW_MACINFO_define
)
451 .Case("DW_MACINFO_undef", DW_MACINFO_undef
)
452 .Case("DW_MACINFO_start_file", DW_MACINFO_start_file
)
453 .Case("DW_MACINFO_end_file", DW_MACINFO_end_file
)
454 .Case("DW_MACINFO_vendor_ext", DW_MACINFO_vendor_ext
)
455 .Default(DW_MACINFO_invalid
);
458 StringRef
llvm::dwarf::RangeListEncodingString(unsigned Encoding
) {
462 #define HANDLE_DW_RLE(ID, NAME) \
463 case DW_RLE_##NAME: \
464 return "DW_RLE_" #NAME;
465 #include "llvm/BinaryFormat/Dwarf.def"
469 StringRef
llvm::dwarf::CallFrameString(unsigned Encoding
,
470 Triple::ArchType Arch
) {
471 assert(Arch
!= llvm::Triple::ArchType::UnknownArch
);
472 #define SELECT_AARCH64 (Arch == llvm::Triple::aarch64_be || Arch == llvm::Triple::aarch64)
473 #define SELECT_MIPS64 Arch == llvm::Triple::mips64
474 #define SELECT_SPARC (Arch == llvm::Triple::sparc || Arch == llvm::Triple::sparcv9)
475 #define SELECT_X86 (Arch == llvm::Triple::x86 || Arch == llvm::Triple::x86_64)
476 #define HANDLE_DW_CFA(ID, NAME)
477 #define HANDLE_DW_CFA_PRED(ID, NAME, PRED) \
478 if (ID == Encoding && PRED) \
479 return "DW_CFA_" #NAME;
480 #include "llvm/BinaryFormat/Dwarf.def"
485 #define HANDLE_DW_CFA_PRED(ID, NAME, PRED)
486 #define HANDLE_DW_CFA(ID, NAME) \
487 case DW_CFA_##NAME: \
488 return "DW_CFA_" #NAME;
489 #include "llvm/BinaryFormat/Dwarf.def"
494 #undef SELECT_AARCH64
498 StringRef
llvm::dwarf::ApplePropertyString(unsigned Prop
) {
502 #define HANDLE_DW_APPLE_PROPERTY(ID, NAME) \
503 case DW_APPLE_PROPERTY_##NAME: \
504 return "DW_APPLE_PROPERTY_" #NAME;
505 #include "llvm/BinaryFormat/Dwarf.def"
509 StringRef
llvm::dwarf::UnitTypeString(unsigned UT
) {
513 #define HANDLE_DW_UT(ID, NAME) \
515 return "DW_UT_" #NAME;
516 #include "llvm/BinaryFormat/Dwarf.def"
520 StringRef
llvm::dwarf::AtomTypeString(unsigned AT
) {
522 case dwarf::DW_ATOM_null
:
523 return "DW_ATOM_null";
524 case dwarf::DW_ATOM_die_offset
:
525 return "DW_ATOM_die_offset";
526 case DW_ATOM_cu_offset
:
527 return "DW_ATOM_cu_offset";
528 case DW_ATOM_die_tag
:
529 return "DW_ATOM_die_tag";
530 case DW_ATOM_type_flags
:
531 case DW_ATOM_type_type_flags
:
532 return "DW_ATOM_type_flags";
533 case DW_ATOM_qual_name_hash
:
534 return "DW_ATOM_qual_name_hash";
539 StringRef
llvm::dwarf::GDBIndexEntryKindString(GDBIndexEntryKind Kind
) {
558 llvm_unreachable("Unknown GDBIndexEntryKind value");
562 llvm::dwarf::GDBIndexEntryLinkageString(GDBIndexEntryLinkage Linkage
) {
569 llvm_unreachable("Unknown GDBIndexEntryLinkage value");
572 StringRef
llvm::dwarf::AttributeValueString(uint16_t Attr
, unsigned Val
) {
574 case DW_AT_accessibility
:
575 return AccessibilityString(Val
);
576 case DW_AT_virtuality
:
577 return VirtualityString(Val
);
579 return LanguageString(Val
);
581 return AttributeEncodingString(Val
);
582 case DW_AT_decimal_sign
:
583 return DecimalSignString(Val
);
584 case DW_AT_endianity
:
585 return EndianityString(Val
);
586 case DW_AT_visibility
:
587 return VisibilityString(Val
);
588 case DW_AT_identifier_case
:
589 return CaseString(Val
);
590 case DW_AT_calling_convention
:
591 return ConventionString(Val
);
593 return InlineCodeString(Val
);
595 return ArrayOrderString(Val
);
596 case DW_AT_APPLE_runtime_class
:
597 return LanguageString(Val
);
603 StringRef
llvm::dwarf::AtomValueString(uint16_t Atom
, unsigned Val
) {
607 case DW_ATOM_die_tag
:
608 return TagString(Val
);
614 StringRef
llvm::dwarf::IndexString(unsigned Idx
) {
618 #define HANDLE_DW_IDX(ID, NAME) \
619 case DW_IDX_##NAME: \
620 return "DW_IDX_" #NAME;
621 #include "llvm/BinaryFormat/Dwarf.def"
625 Optional
<uint8_t> llvm::dwarf::getFixedFormByteSize(dwarf::Form Form
,
630 return Params
.AddrSize
;
633 case DW_FORM_block
: // ULEB128 length L followed by L bytes.
634 case DW_FORM_block1
: // 1 byte length L followed by L bytes.
635 case DW_FORM_block2
: // 2 byte length L followed by L bytes.
636 case DW_FORM_block4
: // 4 byte length L followed by L bytes.
637 case DW_FORM_string
: // C-string with null terminator.
638 case DW_FORM_sdata
: // SLEB128.
639 case DW_FORM_udata
: // ULEB128.
640 case DW_FORM_ref_udata
: // ULEB128.
641 case DW_FORM_indirect
: // ULEB128.
642 case DW_FORM_exprloc
: // ULEB128 length L followed by L bytes.
643 case DW_FORM_strx
: // ULEB128.
644 case DW_FORM_addrx
: // ULEB128.
645 case DW_FORM_loclistx
: // ULEB128.
646 case DW_FORM_rnglistx
: // ULEB128.
647 case DW_FORM_GNU_addr_index
: // ULEB128.
648 case DW_FORM_GNU_str_index
: // ULEB128.
651 case DW_FORM_ref_addr
:
653 return Params
.getRefAddrByteSize();
674 case DW_FORM_ref_sup4
:
680 case DW_FORM_GNU_ref_alt
:
681 case DW_FORM_GNU_strp_alt
:
682 case DW_FORM_line_strp
:
683 case DW_FORM_sec_offset
:
684 case DW_FORM_strp_sup
:
686 return Params
.getDwarfOffsetByteSize();
691 case DW_FORM_ref_sig8
:
692 case DW_FORM_ref_sup8
:
695 case DW_FORM_flag_present
:
701 case DW_FORM_implicit_const
:
702 // The implicit value is stored in the abbreviation as a SLEB128, and
703 // there no data in debug info.
712 bool llvm::dwarf::isValidFormForVersion(Form F
, unsigned Version
,
714 if (FormVendor(F
) == DWARF_VENDOR_DWARF
) {
715 unsigned FV
= FormVersion(F
);
716 return FV
> 0 && FV
<= Version
;
721 constexpr char llvm::dwarf::EnumTraits
<Attribute
>::Type
[];
722 constexpr char llvm::dwarf::EnumTraits
<Form
>::Type
[];
723 constexpr char llvm::dwarf::EnumTraits
<Index
>::Type
[];
724 constexpr char llvm::dwarf::EnumTraits
<Tag
>::Type
[];