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, KIND) \
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, KIND) \
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, KIND) \
47 #include "llvm/BinaryFormat/Dwarf.def"
51 unsigned llvm::dwarf::TagVendor(dwarf::Tag Tag) {
55 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR, KIND) \
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_convert:
147 return "DW_OP_LLVM_convert";
148 case DW_OP_LLVM_fragment:
149 return "DW_OP_LLVM_fragment";
150 case DW_OP_LLVM_tag_offset:
151 return "DW_OP_LLVM_tag_offset";
152 case DW_OP_LLVM_entry_value:
153 return "DW_OP_LLVM_entry_value";
157 unsigned llvm::dwarf::getOperationEncoding(StringRef OperationEncodingString) {
158 return StringSwitch<unsigned>(OperationEncodingString)
159 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
160 .Case("DW_OP_" #NAME, DW_OP_##NAME)
161 #include "llvm/BinaryFormat/Dwarf.def"
162 .Case("DW_OP_LLVM_convert", DW_OP_LLVM_convert)
163 .Case("DW_OP_LLVM_fragment", DW_OP_LLVM_fragment)
164 .Case("DW_OP_LLVM_tag_offset", DW_OP_LLVM_tag_offset)
165 .Case("DW_OP_LLVM_entry_value", DW_OP_LLVM_entry_value)
169 unsigned llvm::dwarf::OperationVersion(dwarf::LocationAtom Op) {
173 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
176 #include "llvm/BinaryFormat/Dwarf.def"
180 unsigned llvm::dwarf::OperationVendor(dwarf::LocationAtom Op) {
184 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
186 return DWARF_VENDOR_##VENDOR;
187 #include "llvm/BinaryFormat/Dwarf.def"
191 StringRef llvm::dwarf::AttributeEncodingString(unsigned Encoding) {
195 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
196 case DW_ATE_##NAME: \
197 return "DW_ATE_" #NAME;
198 #include "llvm/BinaryFormat/Dwarf.def"
202 unsigned llvm::dwarf::getAttributeEncoding(StringRef EncodingString) {
203 return StringSwitch<unsigned>(EncodingString)
204 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
205 .Case("DW_ATE_" #NAME, DW_ATE_##NAME)
206 #include "llvm/BinaryFormat/Dwarf.def"
210 unsigned llvm::dwarf::AttributeEncodingVersion(dwarf::TypeKind ATE) {
214 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
215 case DW_ATE_##NAME: \
217 #include "llvm/BinaryFormat/Dwarf.def"
221 unsigned llvm::dwarf::AttributeEncodingVendor(dwarf::TypeKind ATE) {
225 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
226 case DW_ATE_##NAME: \
227 return DWARF_VENDOR_##VENDOR;
228 #include "llvm/BinaryFormat/Dwarf.def"
232 StringRef llvm::dwarf::DecimalSignString(unsigned Sign) {
235 return "DW_DS_unsigned";
236 case DW_DS_leading_overpunch:
237 return "DW_DS_leading_overpunch";
238 case DW_DS_trailing_overpunch:
239 return "DW_DS_trailing_overpunch";
240 case DW_DS_leading_separate:
241 return "DW_DS_leading_separate";
242 case DW_DS_trailing_separate:
243 return "DW_DS_trailing_separate";
248 StringRef llvm::dwarf::EndianityString(unsigned Endian) {
251 return "DW_END_default";
255 return "DW_END_little";
257 return "DW_END_lo_user";
259 return "DW_END_hi_user";
264 StringRef llvm::dwarf::AccessibilityString(unsigned Access) {
266 // Accessibility codes
267 case DW_ACCESS_public:
268 return "DW_ACCESS_public";
269 case DW_ACCESS_protected:
270 return "DW_ACCESS_protected";
271 case DW_ACCESS_private:
272 return "DW_ACCESS_private";
277 StringRef llvm::dwarf::DefaultedMemberString(unsigned DefaultedEncodings) {
278 switch (DefaultedEncodings) {
279 // Defaulted Member Encodings codes
280 case DW_DEFAULTED_no:
281 return "DW_DEFAULTED_no";
282 case DW_DEFAULTED_in_class:
283 return "DW_DEFAULTED_in_class";
284 case DW_DEFAULTED_out_of_class:
285 return "DW_DEFAULTED_out_of_class";
290 StringRef llvm::dwarf::VisibilityString(unsigned Visibility) {
291 switch (Visibility) {
293 return "DW_VIS_local";
294 case DW_VIS_exported:
295 return "DW_VIS_exported";
296 case DW_VIS_qualified:
297 return "DW_VIS_qualified";
302 StringRef llvm::dwarf::VirtualityString(unsigned Virtuality) {
303 switch (Virtuality) {
306 #define HANDLE_DW_VIRTUALITY(ID, NAME) \
307 case DW_VIRTUALITY_##NAME: \
308 return "DW_VIRTUALITY_" #NAME;
309 #include "llvm/BinaryFormat/Dwarf.def"
313 unsigned llvm::dwarf::getVirtuality(StringRef VirtualityString) {
314 return StringSwitch<unsigned>(VirtualityString)
315 #define HANDLE_DW_VIRTUALITY(ID, NAME) \
316 .Case("DW_VIRTUALITY_" #NAME, DW_VIRTUALITY_##NAME)
317 #include "llvm/BinaryFormat/Dwarf.def"
318 .Default(DW_VIRTUALITY_invalid);
321 StringRef llvm::dwarf::LanguageString(unsigned Language) {
325 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
326 case DW_LANG_##NAME: \
327 return "DW_LANG_" #NAME;
328 #include "llvm/BinaryFormat/Dwarf.def"
332 unsigned llvm::dwarf::getLanguage(StringRef LanguageString) {
333 return StringSwitch<unsigned>(LanguageString)
334 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
335 .Case("DW_LANG_" #NAME, DW_LANG_##NAME)
336 #include "llvm/BinaryFormat/Dwarf.def"
340 unsigned llvm::dwarf::LanguageVersion(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 unsigned llvm::dwarf::LanguageVendor(dwarf::SourceLanguage Lang) {
355 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
356 case DW_LANG_##NAME: \
357 return DWARF_VENDOR_##VENDOR;
358 #include "llvm/BinaryFormat/Dwarf.def"
362 Optional<unsigned> llvm::dwarf::LanguageLowerBound(dwarf::SourceLanguage Lang) {
366 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
367 case DW_LANG_##NAME: \
369 #include "llvm/BinaryFormat/Dwarf.def"
373 StringRef llvm::dwarf::CaseString(unsigned Case) {
375 case DW_ID_case_sensitive:
376 return "DW_ID_case_sensitive";
378 return "DW_ID_up_case";
379 case DW_ID_down_case:
380 return "DW_ID_down_case";
381 case DW_ID_case_insensitive:
382 return "DW_ID_case_insensitive";
387 StringRef llvm::dwarf::ConventionString(unsigned CC) {
391 #define HANDLE_DW_CC(ID, NAME) \
393 return "DW_CC_" #NAME;
394 #include "llvm/BinaryFormat/Dwarf.def"
398 unsigned llvm::dwarf::getCallingConvention(StringRef CCString) {
399 return StringSwitch<unsigned>(CCString)
400 #define HANDLE_DW_CC(ID, NAME) .Case("DW_CC_" #NAME, DW_CC_##NAME)
401 #include "llvm/BinaryFormat/Dwarf.def"
405 StringRef llvm::dwarf::InlineCodeString(unsigned Code) {
407 case DW_INL_not_inlined:
408 return "DW_INL_not_inlined";
410 return "DW_INL_inlined";
411 case DW_INL_declared_not_inlined:
412 return "DW_INL_declared_not_inlined";
413 case DW_INL_declared_inlined:
414 return "DW_INL_declared_inlined";
419 StringRef llvm::dwarf::ArrayOrderString(unsigned Order) {
421 case DW_ORD_row_major:
422 return "DW_ORD_row_major";
423 case DW_ORD_col_major:
424 return "DW_ORD_col_major";
429 StringRef llvm::dwarf::LNStandardString(unsigned Standard) {
433 #define HANDLE_DW_LNS(ID, NAME) \
434 case DW_LNS_##NAME: \
435 return "DW_LNS_" #NAME;
436 #include "llvm/BinaryFormat/Dwarf.def"
440 StringRef llvm::dwarf::LNExtendedString(unsigned Encoding) {
444 #define HANDLE_DW_LNE(ID, NAME) \
445 case DW_LNE_##NAME: \
446 return "DW_LNE_" #NAME;
447 #include "llvm/BinaryFormat/Dwarf.def"
451 StringRef llvm::dwarf::MacinfoString(unsigned Encoding) {
453 // Macinfo Type Encodings
454 case DW_MACINFO_define:
455 return "DW_MACINFO_define";
456 case DW_MACINFO_undef:
457 return "DW_MACINFO_undef";
458 case DW_MACINFO_start_file:
459 return "DW_MACINFO_start_file";
460 case DW_MACINFO_end_file:
461 return "DW_MACINFO_end_file";
462 case DW_MACINFO_vendor_ext:
463 return "DW_MACINFO_vendor_ext";
464 case DW_MACINFO_invalid:
465 return "DW_MACINFO_invalid";
470 unsigned llvm::dwarf::getMacinfo(StringRef MacinfoString) {
471 return StringSwitch<unsigned>(MacinfoString)
472 .Case("DW_MACINFO_define", DW_MACINFO_define)
473 .Case("DW_MACINFO_undef", DW_MACINFO_undef)
474 .Case("DW_MACINFO_start_file", DW_MACINFO_start_file)
475 .Case("DW_MACINFO_end_file", DW_MACINFO_end_file)
476 .Case("DW_MACINFO_vendor_ext", DW_MACINFO_vendor_ext)
477 .Default(DW_MACINFO_invalid);
480 StringRef llvm::dwarf::MacroString(unsigned Encoding) {
484 #define HANDLE_DW_MACRO(ID, NAME) \
485 case DW_MACRO_##NAME: \
486 return "DW_MACRO_" #NAME;
487 #include "llvm/BinaryFormat/Dwarf.def"
491 unsigned llvm::dwarf::getMacro(StringRef MacroString) {
492 return StringSwitch<unsigned>(MacroString)
493 #define HANDLE_DW_MACRO(ID, NAME) .Case("DW_MACRO_" #NAME, ID)
494 #include "llvm/BinaryFormat/Dwarf.def"
495 .Default(DW_MACINFO_invalid);
497 StringRef llvm::dwarf::RangeListEncodingString(unsigned Encoding) {
501 #define HANDLE_DW_RLE(ID, NAME) \
502 case DW_RLE_##NAME: \
503 return "DW_RLE_" #NAME;
504 #include "llvm/BinaryFormat/Dwarf.def"
508 StringRef llvm::dwarf::LocListEncodingString(unsigned Encoding) {
512 #define HANDLE_DW_LLE(ID, NAME) \
513 case DW_LLE_##NAME: \
514 return "DW_LLE_" #NAME;
515 #include "llvm/BinaryFormat/Dwarf.def"
519 StringRef llvm::dwarf::CallFrameString(unsigned Encoding,
520 Triple::ArchType Arch) {
521 assert(Arch != llvm::Triple::ArchType::UnknownArch);
522 #define SELECT_AARCH64 (Arch == llvm::Triple::aarch64_be || Arch == llvm::Triple::aarch64)
523 #define SELECT_MIPS64 Arch == llvm::Triple::mips64
524 #define SELECT_SPARC (Arch == llvm::Triple::sparc || Arch == llvm::Triple::sparcv9)
525 #define SELECT_X86 (Arch == llvm::Triple::x86 || Arch == llvm::Triple::x86_64)
526 #define HANDLE_DW_CFA(ID, NAME)
527 #define HANDLE_DW_CFA_PRED(ID, NAME, PRED) \
528 if (ID == Encoding && PRED) \
529 return "DW_CFA_" #NAME;
530 #include "llvm/BinaryFormat/Dwarf.def"
535 #define HANDLE_DW_CFA_PRED(ID, NAME, PRED)
536 #define HANDLE_DW_CFA(ID, NAME) \
537 case DW_CFA_##NAME: \
538 return "DW_CFA_" #NAME;
539 #include "llvm/BinaryFormat/Dwarf.def"
544 #undef SELECT_AARCH64
548 StringRef llvm::dwarf::ApplePropertyString(unsigned Prop) {
552 #define HANDLE_DW_APPLE_PROPERTY(ID, NAME) \
553 case DW_APPLE_PROPERTY_##NAME: \
554 return "DW_APPLE_PROPERTY_" #NAME;
555 #include "llvm/BinaryFormat/Dwarf.def"
559 StringRef llvm::dwarf::UnitTypeString(unsigned UT) {
563 #define HANDLE_DW_UT(ID, NAME) \
565 return "DW_UT_" #NAME;
566 #include "llvm/BinaryFormat/Dwarf.def"
570 StringRef llvm::dwarf::AtomTypeString(unsigned AT) {
572 case dwarf::DW_ATOM_null:
573 return "DW_ATOM_null";
574 case dwarf::DW_ATOM_die_offset:
575 return "DW_ATOM_die_offset";
576 case DW_ATOM_cu_offset:
577 return "DW_ATOM_cu_offset";
578 case DW_ATOM_die_tag:
579 return "DW_ATOM_die_tag";
580 case DW_ATOM_type_flags:
581 case DW_ATOM_type_type_flags:
582 return "DW_ATOM_type_flags";
583 case DW_ATOM_qual_name_hash:
584 return "DW_ATOM_qual_name_hash";
589 StringRef llvm::dwarf::GDBIndexEntryKindString(GDBIndexEntryKind Kind) {
608 llvm_unreachable("Unknown GDBIndexEntryKind value");
612 llvm::dwarf::GDBIndexEntryLinkageString(GDBIndexEntryLinkage Linkage) {
619 llvm_unreachable("Unknown GDBIndexEntryLinkage value");
622 StringRef llvm::dwarf::AttributeValueString(uint16_t Attr, unsigned Val) {
624 case DW_AT_accessibility:
625 return AccessibilityString(Val);
626 case DW_AT_virtuality:
627 return VirtualityString(Val);
629 return LanguageString(Val);
631 return AttributeEncodingString(Val);
632 case DW_AT_decimal_sign:
633 return DecimalSignString(Val);
634 case DW_AT_endianity:
635 return EndianityString(Val);
636 case DW_AT_visibility:
637 return VisibilityString(Val);
638 case DW_AT_identifier_case:
639 return CaseString(Val);
640 case DW_AT_calling_convention:
641 return ConventionString(Val);
643 return InlineCodeString(Val);
645 return ArrayOrderString(Val);
646 case DW_AT_APPLE_runtime_class:
647 return LanguageString(Val);
648 case DW_AT_defaulted:
649 return DefaultedMemberString(Val);
655 StringRef llvm::dwarf::AtomValueString(uint16_t Atom, unsigned Val) {
659 case DW_ATOM_die_tag:
660 return TagString(Val);
666 StringRef llvm::dwarf::IndexString(unsigned Idx) {
670 #define HANDLE_DW_IDX(ID, NAME) \
671 case DW_IDX_##NAME: \
672 return "DW_IDX_" #NAME;
673 #include "llvm/BinaryFormat/Dwarf.def"
677 Optional<uint8_t> llvm::dwarf::getFixedFormByteSize(dwarf::Form Form,
682 return Params.AddrSize;
685 case DW_FORM_block: // ULEB128 length L followed by L bytes.
686 case DW_FORM_block1: // 1 byte length L followed by L bytes.
687 case DW_FORM_block2: // 2 byte length L followed by L bytes.
688 case DW_FORM_block4: // 4 byte length L followed by L bytes.
689 case DW_FORM_string: // C-string with null terminator.
690 case DW_FORM_sdata: // SLEB128.
691 case DW_FORM_udata: // ULEB128.
692 case DW_FORM_ref_udata: // ULEB128.
693 case DW_FORM_indirect: // ULEB128.
694 case DW_FORM_exprloc: // ULEB128 length L followed by L bytes.
695 case DW_FORM_strx: // ULEB128.
696 case DW_FORM_addrx: // ULEB128.
697 case DW_FORM_loclistx: // ULEB128.
698 case DW_FORM_rnglistx: // ULEB128.
699 case DW_FORM_GNU_addr_index: // ULEB128.
700 case DW_FORM_GNU_str_index: // ULEB128.
703 case DW_FORM_ref_addr:
705 return Params.getRefAddrByteSize();
726 case DW_FORM_ref_sup4:
732 case DW_FORM_GNU_ref_alt:
733 case DW_FORM_GNU_strp_alt:
734 case DW_FORM_line_strp:
735 case DW_FORM_sec_offset:
736 case DW_FORM_strp_sup:
738 return Params.getDwarfOffsetByteSize();
743 case DW_FORM_ref_sig8:
744 case DW_FORM_ref_sup8:
747 case DW_FORM_flag_present:
753 case DW_FORM_implicit_const:
754 // The implicit value is stored in the abbreviation as a SLEB128, and
755 // there no data in debug info.
764 bool llvm::dwarf::isValidFormForVersion(Form F, unsigned Version,
766 if (FormVendor(F) == DWARF_VENDOR_DWARF) {
767 unsigned FV = FormVersion(F);
768 return FV > 0 && FV <= Version;
773 StringRef llvm::dwarf::FormatString(DwarfFormat Format) {
783 StringRef llvm::dwarf::FormatString(bool IsDWARF64) {
784 return FormatString(IsDWARF64 ? DWARF64 : DWARF32);
787 constexpr char llvm::dwarf::EnumTraits<Attribute>::Type[];
788 constexpr char llvm::dwarf::EnumTraits<Form>::Type[];
789 constexpr char llvm::dwarf::EnumTraits<Index>::Type[];
790 constexpr char llvm::dwarf::EnumTraits<Tag>::Type[];
791 constexpr char llvm::dwarf::EnumTraits<LineNumberOps>::Type[];
792 constexpr char llvm::dwarf::EnumTraits<LocationAtom>::Type[];