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_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";
155 unsigned llvm::dwarf::getOperationEncoding(StringRef OperationEncodingString) {
156 return StringSwitch<unsigned>(OperationEncodingString)
157 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
158 .Case("DW_OP_" #NAME, DW_OP_##NAME)
159 #include "llvm/BinaryFormat/Dwarf.def"
160 .Case("DW_OP_LLVM_convert", DW_OP_LLVM_convert)
161 .Case("DW_OP_LLVM_fragment", DW_OP_LLVM_fragment)
162 .Case("DW_OP_LLVM_tag_offset", DW_OP_LLVM_tag_offset)
166 unsigned llvm::dwarf::OperationVersion(dwarf::LocationAtom Op) {
170 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
173 #include "llvm/BinaryFormat/Dwarf.def"
177 unsigned llvm::dwarf::OperationVendor(dwarf::LocationAtom Op) {
181 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
183 return DWARF_VENDOR_##VENDOR;
184 #include "llvm/BinaryFormat/Dwarf.def"
188 StringRef llvm::dwarf::AttributeEncodingString(unsigned Encoding) {
192 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
193 case DW_ATE_##NAME: \
194 return "DW_ATE_" #NAME;
195 #include "llvm/BinaryFormat/Dwarf.def"
199 unsigned llvm::dwarf::getAttributeEncoding(StringRef EncodingString) {
200 return StringSwitch<unsigned>(EncodingString)
201 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
202 .Case("DW_ATE_" #NAME, DW_ATE_##NAME)
203 #include "llvm/BinaryFormat/Dwarf.def"
207 unsigned llvm::dwarf::AttributeEncodingVersion(dwarf::TypeKind ATE) {
211 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
212 case DW_ATE_##NAME: \
214 #include "llvm/BinaryFormat/Dwarf.def"
218 unsigned llvm::dwarf::AttributeEncodingVendor(dwarf::TypeKind ATE) {
222 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
223 case DW_ATE_##NAME: \
224 return DWARF_VENDOR_##VENDOR;
225 #include "llvm/BinaryFormat/Dwarf.def"
229 StringRef llvm::dwarf::DecimalSignString(unsigned Sign) {
232 return "DW_DS_unsigned";
233 case DW_DS_leading_overpunch:
234 return "DW_DS_leading_overpunch";
235 case DW_DS_trailing_overpunch:
236 return "DW_DS_trailing_overpunch";
237 case DW_DS_leading_separate:
238 return "DW_DS_leading_separate";
239 case DW_DS_trailing_separate:
240 return "DW_DS_trailing_separate";
245 StringRef llvm::dwarf::EndianityString(unsigned Endian) {
248 return "DW_END_default";
252 return "DW_END_little";
254 return "DW_END_lo_user";
256 return "DW_END_hi_user";
261 StringRef llvm::dwarf::AccessibilityString(unsigned Access) {
263 // Accessibility codes
264 case DW_ACCESS_public:
265 return "DW_ACCESS_public";
266 case DW_ACCESS_protected:
267 return "DW_ACCESS_protected";
268 case DW_ACCESS_private:
269 return "DW_ACCESS_private";
274 StringRef llvm::dwarf::VisibilityString(unsigned Visibility) {
275 switch (Visibility) {
277 return "DW_VIS_local";
278 case DW_VIS_exported:
279 return "DW_VIS_exported";
280 case DW_VIS_qualified:
281 return "DW_VIS_qualified";
286 StringRef llvm::dwarf::VirtualityString(unsigned Virtuality) {
287 switch (Virtuality) {
290 #define HANDLE_DW_VIRTUALITY(ID, NAME) \
291 case DW_VIRTUALITY_##NAME: \
292 return "DW_VIRTUALITY_" #NAME;
293 #include "llvm/BinaryFormat/Dwarf.def"
297 unsigned llvm::dwarf::getVirtuality(StringRef VirtualityString) {
298 return StringSwitch<unsigned>(VirtualityString)
299 #define HANDLE_DW_VIRTUALITY(ID, NAME) \
300 .Case("DW_VIRTUALITY_" #NAME, DW_VIRTUALITY_##NAME)
301 #include "llvm/BinaryFormat/Dwarf.def"
302 .Default(DW_VIRTUALITY_invalid);
305 StringRef llvm::dwarf::LanguageString(unsigned Language) {
309 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
310 case DW_LANG_##NAME: \
311 return "DW_LANG_" #NAME;
312 #include "llvm/BinaryFormat/Dwarf.def"
316 unsigned llvm::dwarf::getLanguage(StringRef LanguageString) {
317 return StringSwitch<unsigned>(LanguageString)
318 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
319 .Case("DW_LANG_" #NAME, DW_LANG_##NAME)
320 #include "llvm/BinaryFormat/Dwarf.def"
324 unsigned llvm::dwarf::LanguageVersion(dwarf::SourceLanguage Lang) {
328 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
329 case DW_LANG_##NAME: \
331 #include "llvm/BinaryFormat/Dwarf.def"
335 unsigned llvm::dwarf::LanguageVendor(dwarf::SourceLanguage Lang) {
339 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
340 case DW_LANG_##NAME: \
341 return DWARF_VENDOR_##VENDOR;
342 #include "llvm/BinaryFormat/Dwarf.def"
346 Optional<unsigned> llvm::dwarf::LanguageLowerBound(dwarf::SourceLanguage Lang) {
350 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
351 case DW_LANG_##NAME: \
353 #include "llvm/BinaryFormat/Dwarf.def"
357 StringRef llvm::dwarf::CaseString(unsigned Case) {
359 case DW_ID_case_sensitive:
360 return "DW_ID_case_sensitive";
362 return "DW_ID_up_case";
363 case DW_ID_down_case:
364 return "DW_ID_down_case";
365 case DW_ID_case_insensitive:
366 return "DW_ID_case_insensitive";
371 StringRef llvm::dwarf::ConventionString(unsigned CC) {
375 #define HANDLE_DW_CC(ID, NAME) \
377 return "DW_CC_" #NAME;
378 #include "llvm/BinaryFormat/Dwarf.def"
382 unsigned llvm::dwarf::getCallingConvention(StringRef CCString) {
383 return StringSwitch<unsigned>(CCString)
384 #define HANDLE_DW_CC(ID, NAME) .Case("DW_CC_" #NAME, DW_CC_##NAME)
385 #include "llvm/BinaryFormat/Dwarf.def"
389 StringRef llvm::dwarf::InlineCodeString(unsigned Code) {
391 case DW_INL_not_inlined:
392 return "DW_INL_not_inlined";
394 return "DW_INL_inlined";
395 case DW_INL_declared_not_inlined:
396 return "DW_INL_declared_not_inlined";
397 case DW_INL_declared_inlined:
398 return "DW_INL_declared_inlined";
403 StringRef llvm::dwarf::ArrayOrderString(unsigned Order) {
405 case DW_ORD_row_major:
406 return "DW_ORD_row_major";
407 case DW_ORD_col_major:
408 return "DW_ORD_col_major";
413 StringRef llvm::dwarf::LNStandardString(unsigned Standard) {
417 #define HANDLE_DW_LNS(ID, NAME) \
418 case DW_LNS_##NAME: \
419 return "DW_LNS_" #NAME;
420 #include "llvm/BinaryFormat/Dwarf.def"
424 StringRef llvm::dwarf::LNExtendedString(unsigned Encoding) {
428 #define HANDLE_DW_LNE(ID, NAME) \
429 case DW_LNE_##NAME: \
430 return "DW_LNE_" #NAME;
431 #include "llvm/BinaryFormat/Dwarf.def"
435 StringRef llvm::dwarf::MacinfoString(unsigned Encoding) {
437 // Macinfo Type Encodings
438 case DW_MACINFO_define:
439 return "DW_MACINFO_define";
440 case DW_MACINFO_undef:
441 return "DW_MACINFO_undef";
442 case DW_MACINFO_start_file:
443 return "DW_MACINFO_start_file";
444 case DW_MACINFO_end_file:
445 return "DW_MACINFO_end_file";
446 case DW_MACINFO_vendor_ext:
447 return "DW_MACINFO_vendor_ext";
448 case DW_MACINFO_invalid:
449 return "DW_MACINFO_invalid";
454 unsigned llvm::dwarf::getMacinfo(StringRef MacinfoString) {
455 return StringSwitch<unsigned>(MacinfoString)
456 .Case("DW_MACINFO_define", DW_MACINFO_define)
457 .Case("DW_MACINFO_undef", DW_MACINFO_undef)
458 .Case("DW_MACINFO_start_file", DW_MACINFO_start_file)
459 .Case("DW_MACINFO_end_file", DW_MACINFO_end_file)
460 .Case("DW_MACINFO_vendor_ext", DW_MACINFO_vendor_ext)
461 .Default(DW_MACINFO_invalid);
464 StringRef llvm::dwarf::RangeListEncodingString(unsigned Encoding) {
468 #define HANDLE_DW_RLE(ID, NAME) \
469 case DW_RLE_##NAME: \
470 return "DW_RLE_" #NAME;
471 #include "llvm/BinaryFormat/Dwarf.def"
475 StringRef llvm::dwarf::CallFrameString(unsigned Encoding,
476 Triple::ArchType Arch) {
477 assert(Arch != llvm::Triple::ArchType::UnknownArch);
478 #define SELECT_AARCH64 (Arch == llvm::Triple::aarch64_be || Arch == llvm::Triple::aarch64)
479 #define SELECT_MIPS64 Arch == llvm::Triple::mips64
480 #define SELECT_SPARC (Arch == llvm::Triple::sparc || Arch == llvm::Triple::sparcv9)
481 #define SELECT_X86 (Arch == llvm::Triple::x86 || Arch == llvm::Triple::x86_64)
482 #define HANDLE_DW_CFA(ID, NAME)
483 #define HANDLE_DW_CFA_PRED(ID, NAME, PRED) \
484 if (ID == Encoding && PRED) \
485 return "DW_CFA_" #NAME;
486 #include "llvm/BinaryFormat/Dwarf.def"
491 #define HANDLE_DW_CFA_PRED(ID, NAME, PRED)
492 #define HANDLE_DW_CFA(ID, NAME) \
493 case DW_CFA_##NAME: \
494 return "DW_CFA_" #NAME;
495 #include "llvm/BinaryFormat/Dwarf.def"
500 #undef SELECT_AARCH64
504 StringRef llvm::dwarf::ApplePropertyString(unsigned Prop) {
508 #define HANDLE_DW_APPLE_PROPERTY(ID, NAME) \
509 case DW_APPLE_PROPERTY_##NAME: \
510 return "DW_APPLE_PROPERTY_" #NAME;
511 #include "llvm/BinaryFormat/Dwarf.def"
515 StringRef llvm::dwarf::UnitTypeString(unsigned UT) {
519 #define HANDLE_DW_UT(ID, NAME) \
521 return "DW_UT_" #NAME;
522 #include "llvm/BinaryFormat/Dwarf.def"
526 StringRef llvm::dwarf::AtomTypeString(unsigned AT) {
528 case dwarf::DW_ATOM_null:
529 return "DW_ATOM_null";
530 case dwarf::DW_ATOM_die_offset:
531 return "DW_ATOM_die_offset";
532 case DW_ATOM_cu_offset:
533 return "DW_ATOM_cu_offset";
534 case DW_ATOM_die_tag:
535 return "DW_ATOM_die_tag";
536 case DW_ATOM_type_flags:
537 case DW_ATOM_type_type_flags:
538 return "DW_ATOM_type_flags";
539 case DW_ATOM_qual_name_hash:
540 return "DW_ATOM_qual_name_hash";
545 StringRef llvm::dwarf::GDBIndexEntryKindString(GDBIndexEntryKind Kind) {
564 llvm_unreachable("Unknown GDBIndexEntryKind value");
568 llvm::dwarf::GDBIndexEntryLinkageString(GDBIndexEntryLinkage Linkage) {
575 llvm_unreachable("Unknown GDBIndexEntryLinkage value");
578 StringRef llvm::dwarf::AttributeValueString(uint16_t Attr, unsigned Val) {
580 case DW_AT_accessibility:
581 return AccessibilityString(Val);
582 case DW_AT_virtuality:
583 return VirtualityString(Val);
585 return LanguageString(Val);
587 return AttributeEncodingString(Val);
588 case DW_AT_decimal_sign:
589 return DecimalSignString(Val);
590 case DW_AT_endianity:
591 return EndianityString(Val);
592 case DW_AT_visibility:
593 return VisibilityString(Val);
594 case DW_AT_identifier_case:
595 return CaseString(Val);
596 case DW_AT_calling_convention:
597 return ConventionString(Val);
599 return InlineCodeString(Val);
601 return ArrayOrderString(Val);
602 case DW_AT_APPLE_runtime_class:
603 return LanguageString(Val);
609 StringRef llvm::dwarf::AtomValueString(uint16_t Atom, unsigned Val) {
613 case DW_ATOM_die_tag:
614 return TagString(Val);
620 StringRef llvm::dwarf::IndexString(unsigned Idx) {
624 #define HANDLE_DW_IDX(ID, NAME) \
625 case DW_IDX_##NAME: \
626 return "DW_IDX_" #NAME;
627 #include "llvm/BinaryFormat/Dwarf.def"
631 Optional<uint8_t> llvm::dwarf::getFixedFormByteSize(dwarf::Form Form,
636 return Params.AddrSize;
639 case DW_FORM_block: // ULEB128 length L followed by L bytes.
640 case DW_FORM_block1: // 1 byte length L followed by L bytes.
641 case DW_FORM_block2: // 2 byte length L followed by L bytes.
642 case DW_FORM_block4: // 4 byte length L followed by L bytes.
643 case DW_FORM_string: // C-string with null terminator.
644 case DW_FORM_sdata: // SLEB128.
645 case DW_FORM_udata: // ULEB128.
646 case DW_FORM_ref_udata: // ULEB128.
647 case DW_FORM_indirect: // ULEB128.
648 case DW_FORM_exprloc: // ULEB128 length L followed by L bytes.
649 case DW_FORM_strx: // ULEB128.
650 case DW_FORM_addrx: // ULEB128.
651 case DW_FORM_loclistx: // ULEB128.
652 case DW_FORM_rnglistx: // ULEB128.
653 case DW_FORM_GNU_addr_index: // ULEB128.
654 case DW_FORM_GNU_str_index: // ULEB128.
657 case DW_FORM_ref_addr:
659 return Params.getRefAddrByteSize();
680 case DW_FORM_ref_sup4:
686 case DW_FORM_GNU_ref_alt:
687 case DW_FORM_GNU_strp_alt:
688 case DW_FORM_line_strp:
689 case DW_FORM_sec_offset:
690 case DW_FORM_strp_sup:
692 return Params.getDwarfOffsetByteSize();
697 case DW_FORM_ref_sig8:
698 case DW_FORM_ref_sup8:
701 case DW_FORM_flag_present:
707 case DW_FORM_implicit_const:
708 // The implicit value is stored in the abbreviation as a SLEB128, and
709 // there no data in debug info.
718 bool llvm::dwarf::isValidFormForVersion(Form F, unsigned Version,
720 if (FormVendor(F) == DWARF_VENDOR_DWARF) {
721 unsigned FV = FormVersion(F);
722 return FV > 0 && FV <= Version;
727 constexpr char llvm::dwarf::EnumTraits<Attribute>::Type[];
728 constexpr char llvm::dwarf::EnumTraits<Form>::Type[];
729 constexpr char llvm::dwarf::EnumTraits<Index>::Type[];
730 constexpr char llvm::dwarf::EnumTraits<Tag>::Type[];