1 //===-- llvm/BinaryFormat/Dwarf.cpp - Dwarf Framework ------------*- C++-*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for generic dwarf information.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/BinaryFormat/Dwarf.h"
15 #include "llvm/ADT/StringSwitch.h"
16 #include "llvm/ADT/Triple.h"
17 #include "llvm/Support/ErrorHandling.h"
20 using namespace dwarf;
22 StringRef llvm::dwarf::TagString(unsigned Tag) {
26 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR) \
28 return "DW_TAG_" #NAME;
29 #include "llvm/BinaryFormat/Dwarf.def"
33 unsigned llvm::dwarf::getTag(StringRef TagString) {
34 return StringSwitch<unsigned>(TagString)
35 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR) \
36 .Case("DW_TAG_" #NAME, DW_TAG_##NAME)
37 #include "llvm/BinaryFormat/Dwarf.def"
38 .Default(DW_TAG_invalid);
41 unsigned llvm::dwarf::TagVersion(dwarf::Tag Tag) {
45 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR) \
48 #include "llvm/BinaryFormat/Dwarf.def"
52 unsigned llvm::dwarf::TagVendor(dwarf::Tag Tag) {
56 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR) \
58 return DWARF_VENDOR_##VENDOR;
59 #include "llvm/BinaryFormat/Dwarf.def"
63 StringRef llvm::dwarf::ChildrenString(unsigned Children) {
66 return "DW_CHILDREN_no";
68 return "DW_CHILDREN_yes";
73 StringRef llvm::dwarf::AttributeString(unsigned Attribute) {
77 #define HANDLE_DW_AT(ID, NAME, VERSION, VENDOR) \
79 return "DW_AT_" #NAME;
80 #include "llvm/BinaryFormat/Dwarf.def"
84 unsigned llvm::dwarf::AttributeVersion(dwarf::Attribute Attribute) {
88 #define HANDLE_DW_AT(ID, NAME, VERSION, VENDOR) \
91 #include "llvm/BinaryFormat/Dwarf.def"
95 unsigned llvm::dwarf::AttributeVendor(dwarf::Attribute Attribute) {
99 #define HANDLE_DW_AT(ID, NAME, VERSION, VENDOR) \
101 return DWARF_VENDOR_##VENDOR;
102 #include "llvm/BinaryFormat/Dwarf.def"
106 StringRef llvm::dwarf::FormEncodingString(unsigned Encoding) {
110 #define HANDLE_DW_FORM(ID, NAME, VERSION, VENDOR) \
111 case DW_FORM_##NAME: \
112 return "DW_FORM_" #NAME;
113 #include "llvm/BinaryFormat/Dwarf.def"
117 unsigned llvm::dwarf::FormVersion(dwarf::Form Form) {
121 #define HANDLE_DW_FORM(ID, NAME, VERSION, VENDOR) \
122 case DW_FORM_##NAME: \
124 #include "llvm/BinaryFormat/Dwarf.def"
128 unsigned llvm::dwarf::FormVendor(dwarf::Form Form) {
132 #define HANDLE_DW_FORM(ID, NAME, VERSION, VENDOR) \
133 case DW_FORM_##NAME: \
134 return DWARF_VENDOR_##VENDOR;
135 #include "llvm/BinaryFormat/Dwarf.def"
139 StringRef llvm::dwarf::OperationEncodingString(unsigned Encoding) {
143 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
145 return "DW_OP_" #NAME;
146 #include "llvm/BinaryFormat/Dwarf.def"
147 case DW_OP_LLVM_fragment:
148 return "DW_OP_LLVM_fragment";
152 unsigned llvm::dwarf::getOperationEncoding(StringRef OperationEncodingString) {
153 return StringSwitch<unsigned>(OperationEncodingString)
154 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
155 .Case("DW_OP_" #NAME, DW_OP_##NAME)
156 #include "llvm/BinaryFormat/Dwarf.def"
157 .Case("DW_OP_LLVM_fragment", DW_OP_LLVM_fragment)
161 unsigned llvm::dwarf::OperationVersion(dwarf::LocationAtom Op) {
165 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
168 #include "llvm/BinaryFormat/Dwarf.def"
172 unsigned llvm::dwarf::OperationVendor(dwarf::LocationAtom Op) {
176 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) \
178 return DWARF_VENDOR_##VENDOR;
179 #include "llvm/BinaryFormat/Dwarf.def"
183 StringRef llvm::dwarf::AttributeEncodingString(unsigned Encoding) {
187 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
188 case DW_ATE_##NAME: \
189 return "DW_ATE_" #NAME;
190 #include "llvm/BinaryFormat/Dwarf.def"
194 unsigned llvm::dwarf::getAttributeEncoding(StringRef EncodingString) {
195 return StringSwitch<unsigned>(EncodingString)
196 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
197 .Case("DW_ATE_" #NAME, DW_ATE_##NAME)
198 #include "llvm/BinaryFormat/Dwarf.def"
202 unsigned llvm::dwarf::AttributeEncodingVersion(dwarf::TypeKind ATE) {
206 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
207 case DW_ATE_##NAME: \
209 #include "llvm/BinaryFormat/Dwarf.def"
213 unsigned llvm::dwarf::AttributeEncodingVendor(dwarf::TypeKind ATE) {
217 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) \
218 case DW_ATE_##NAME: \
219 return DWARF_VENDOR_##VENDOR;
220 #include "llvm/BinaryFormat/Dwarf.def"
224 StringRef llvm::dwarf::DecimalSignString(unsigned Sign) {
227 return "DW_DS_unsigned";
228 case DW_DS_leading_overpunch:
229 return "DW_DS_leading_overpunch";
230 case DW_DS_trailing_overpunch:
231 return "DW_DS_trailing_overpunch";
232 case DW_DS_leading_separate:
233 return "DW_DS_leading_separate";
234 case DW_DS_trailing_separate:
235 return "DW_DS_trailing_separate";
240 StringRef llvm::dwarf::EndianityString(unsigned Endian) {
243 return "DW_END_default";
247 return "DW_END_little";
249 return "DW_END_lo_user";
251 return "DW_END_hi_user";
256 StringRef llvm::dwarf::AccessibilityString(unsigned Access) {
258 // Accessibility codes
259 case DW_ACCESS_public:
260 return "DW_ACCESS_public";
261 case DW_ACCESS_protected:
262 return "DW_ACCESS_protected";
263 case DW_ACCESS_private:
264 return "DW_ACCESS_private";
269 StringRef llvm::dwarf::VisibilityString(unsigned Visibility) {
270 switch (Visibility) {
272 return "DW_VIS_local";
273 case DW_VIS_exported:
274 return "DW_VIS_exported";
275 case DW_VIS_qualified:
276 return "DW_VIS_qualified";
281 StringRef llvm::dwarf::VirtualityString(unsigned Virtuality) {
282 switch (Virtuality) {
285 #define HANDLE_DW_VIRTUALITY(ID, NAME) \
286 case DW_VIRTUALITY_##NAME: \
287 return "DW_VIRTUALITY_" #NAME;
288 #include "llvm/BinaryFormat/Dwarf.def"
292 unsigned llvm::dwarf::getVirtuality(StringRef VirtualityString) {
293 return StringSwitch<unsigned>(VirtualityString)
294 #define HANDLE_DW_VIRTUALITY(ID, NAME) \
295 .Case("DW_VIRTUALITY_" #NAME, DW_VIRTUALITY_##NAME)
296 #include "llvm/BinaryFormat/Dwarf.def"
297 .Default(DW_VIRTUALITY_invalid);
300 StringRef llvm::dwarf::LanguageString(unsigned Language) {
304 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
305 case DW_LANG_##NAME: \
306 return "DW_LANG_" #NAME;
307 #include "llvm/BinaryFormat/Dwarf.def"
311 unsigned llvm::dwarf::getLanguage(StringRef LanguageString) {
312 return StringSwitch<unsigned>(LanguageString)
313 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
314 .Case("DW_LANG_" #NAME, DW_LANG_##NAME)
315 #include "llvm/BinaryFormat/Dwarf.def"
319 unsigned llvm::dwarf::LanguageVersion(dwarf::SourceLanguage Lang) {
323 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
324 case DW_LANG_##NAME: \
326 #include "llvm/BinaryFormat/Dwarf.def"
330 unsigned llvm::dwarf::LanguageVendor(dwarf::SourceLanguage Lang) {
334 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
335 case DW_LANG_##NAME: \
336 return DWARF_VENDOR_##VENDOR;
337 #include "llvm/BinaryFormat/Dwarf.def"
341 Optional<unsigned> llvm::dwarf::LanguageLowerBound(dwarf::SourceLanguage Lang) {
345 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
346 case DW_LANG_##NAME: \
348 #include "llvm/BinaryFormat/Dwarf.def"
352 StringRef llvm::dwarf::CaseString(unsigned Case) {
354 case DW_ID_case_sensitive:
355 return "DW_ID_case_sensitive";
357 return "DW_ID_up_case";
358 case DW_ID_down_case:
359 return "DW_ID_down_case";
360 case DW_ID_case_insensitive:
361 return "DW_ID_case_insensitive";
366 StringRef llvm::dwarf::ConventionString(unsigned CC) {
370 #define HANDLE_DW_CC(ID, NAME) \
372 return "DW_CC_" #NAME;
373 #include "llvm/BinaryFormat/Dwarf.def"
377 unsigned llvm::dwarf::getCallingConvention(StringRef CCString) {
378 return StringSwitch<unsigned>(CCString)
379 #define HANDLE_DW_CC(ID, NAME) .Case("DW_CC_" #NAME, DW_CC_##NAME)
380 #include "llvm/BinaryFormat/Dwarf.def"
384 StringRef llvm::dwarf::InlineCodeString(unsigned Code) {
386 case DW_INL_not_inlined:
387 return "DW_INL_not_inlined";
389 return "DW_INL_inlined";
390 case DW_INL_declared_not_inlined:
391 return "DW_INL_declared_not_inlined";
392 case DW_INL_declared_inlined:
393 return "DW_INL_declared_inlined";
398 StringRef llvm::dwarf::ArrayOrderString(unsigned Order) {
400 case DW_ORD_row_major:
401 return "DW_ORD_row_major";
402 case DW_ORD_col_major:
403 return "DW_ORD_col_major";
408 StringRef llvm::dwarf::LNStandardString(unsigned Standard) {
412 #define HANDLE_DW_LNS(ID, NAME) \
413 case DW_LNS_##NAME: \
414 return "DW_LNS_" #NAME;
415 #include "llvm/BinaryFormat/Dwarf.def"
419 StringRef llvm::dwarf::LNExtendedString(unsigned Encoding) {
423 #define HANDLE_DW_LNE(ID, NAME) \
424 case DW_LNE_##NAME: \
425 return "DW_LNE_" #NAME;
426 #include "llvm/BinaryFormat/Dwarf.def"
430 StringRef llvm::dwarf::MacinfoString(unsigned Encoding) {
432 // Macinfo Type Encodings
433 case DW_MACINFO_define:
434 return "DW_MACINFO_define";
435 case DW_MACINFO_undef:
436 return "DW_MACINFO_undef";
437 case DW_MACINFO_start_file:
438 return "DW_MACINFO_start_file";
439 case DW_MACINFO_end_file:
440 return "DW_MACINFO_end_file";
441 case DW_MACINFO_vendor_ext:
442 return "DW_MACINFO_vendor_ext";
443 case DW_MACINFO_invalid:
444 return "DW_MACINFO_invalid";
449 unsigned llvm::dwarf::getMacinfo(StringRef MacinfoString) {
450 return StringSwitch<unsigned>(MacinfoString)
451 .Case("DW_MACINFO_define", DW_MACINFO_define)
452 .Case("DW_MACINFO_undef", DW_MACINFO_undef)
453 .Case("DW_MACINFO_start_file", DW_MACINFO_start_file)
454 .Case("DW_MACINFO_end_file", DW_MACINFO_end_file)
455 .Case("DW_MACINFO_vendor_ext", DW_MACINFO_vendor_ext)
456 .Default(DW_MACINFO_invalid);
459 StringRef llvm::dwarf::RangeListEncodingString(unsigned Encoding) {
463 #define HANDLE_DW_RLE(ID, NAME) \
464 case DW_RLE_##NAME: \
465 return "DW_RLE_" #NAME;
466 #include "llvm/BinaryFormat/Dwarf.def"
470 StringRef llvm::dwarf::CallFrameString(unsigned Encoding,
471 Triple::ArchType Arch) {
472 assert(Arch != llvm::Triple::ArchType::UnknownArch);
473 #define SELECT_AARCH64 (Arch == llvm::Triple::aarch64_be || Arch == llvm::Triple::aarch64)
474 #define SELECT_MIPS64 Arch == llvm::Triple::mips64
475 #define SELECT_SPARC (Arch == llvm::Triple::sparc || Arch == llvm::Triple::sparcv9)
476 #define SELECT_X86 (Arch == llvm::Triple::x86 || Arch == llvm::Triple::x86_64)
477 #define HANDLE_DW_CFA(ID, NAME)
478 #define HANDLE_DW_CFA_PRED(ID, NAME, PRED) \
479 if (ID == Encoding && PRED) \
480 return "DW_CFA_" #NAME;
481 #include "llvm/BinaryFormat/Dwarf.def"
486 #define HANDLE_DW_CFA_PRED(ID, NAME, PRED)
487 #define HANDLE_DW_CFA(ID, NAME) \
488 case DW_CFA_##NAME: \
489 return "DW_CFA_" #NAME;
490 #include "llvm/BinaryFormat/Dwarf.def"
495 #undef SELECT_AARCH64
499 StringRef llvm::dwarf::ApplePropertyString(unsigned Prop) {
503 #define HANDLE_DW_APPLE_PROPERTY(ID, NAME) \
504 case DW_APPLE_PROPERTY_##NAME: \
505 return "DW_APPLE_PROPERTY_" #NAME;
506 #include "llvm/BinaryFormat/Dwarf.def"
510 StringRef llvm::dwarf::UnitTypeString(unsigned UT) {
514 #define HANDLE_DW_UT(ID, NAME) \
516 return "DW_UT_" #NAME;
517 #include "llvm/BinaryFormat/Dwarf.def"
521 StringRef llvm::dwarf::AtomTypeString(unsigned AT) {
523 case dwarf::DW_ATOM_null:
524 return "DW_ATOM_null";
525 case dwarf::DW_ATOM_die_offset:
526 return "DW_ATOM_die_offset";
527 case DW_ATOM_cu_offset:
528 return "DW_ATOM_cu_offset";
529 case DW_ATOM_die_tag:
530 return "DW_ATOM_die_tag";
531 case DW_ATOM_type_flags:
532 case DW_ATOM_type_type_flags:
533 return "DW_ATOM_type_flags";
534 case DW_ATOM_qual_name_hash:
535 return "DW_ATOM_qual_name_hash";
540 StringRef llvm::dwarf::GDBIndexEntryKindString(GDBIndexEntryKind Kind) {
559 llvm_unreachable("Unknown GDBIndexEntryKind value");
563 llvm::dwarf::GDBIndexEntryLinkageString(GDBIndexEntryLinkage Linkage) {
570 llvm_unreachable("Unknown GDBIndexEntryLinkage value");
573 StringRef llvm::dwarf::AttributeValueString(uint16_t Attr, unsigned Val) {
575 case DW_AT_accessibility:
576 return AccessibilityString(Val);
577 case DW_AT_virtuality:
578 return VirtualityString(Val);
580 return LanguageString(Val);
582 return AttributeEncodingString(Val);
583 case DW_AT_decimal_sign:
584 return DecimalSignString(Val);
585 case DW_AT_endianity:
586 return EndianityString(Val);
587 case DW_AT_visibility:
588 return VisibilityString(Val);
589 case DW_AT_identifier_case:
590 return CaseString(Val);
591 case DW_AT_calling_convention:
592 return ConventionString(Val);
594 return InlineCodeString(Val);
596 return ArrayOrderString(Val);
597 case DW_AT_APPLE_runtime_class:
598 return LanguageString(Val);
604 StringRef llvm::dwarf::AtomValueString(uint16_t Atom, unsigned Val) {
608 case DW_ATOM_die_tag:
609 return TagString(Val);
615 StringRef llvm::dwarf::IndexString(unsigned Idx) {
619 #define HANDLE_DW_IDX(ID, NAME) \
620 case DW_IDX_##NAME: \
621 return "DW_IDX_" #NAME;
622 #include "llvm/BinaryFormat/Dwarf.def"
626 Optional<uint8_t> llvm::dwarf::getFixedFormByteSize(dwarf::Form Form,
631 return Params.AddrSize;
634 case DW_FORM_block: // ULEB128 length L followed by L bytes.
635 case DW_FORM_block1: // 1 byte length L followed by L bytes.
636 case DW_FORM_block2: // 2 byte length L followed by L bytes.
637 case DW_FORM_block4: // 4 byte length L followed by L bytes.
638 case DW_FORM_string: // C-string with null terminator.
639 case DW_FORM_sdata: // SLEB128.
640 case DW_FORM_udata: // ULEB128.
641 case DW_FORM_ref_udata: // ULEB128.
642 case DW_FORM_indirect: // ULEB128.
643 case DW_FORM_exprloc: // ULEB128 length L followed by L bytes.
644 case DW_FORM_strx: // ULEB128.
645 case DW_FORM_addrx: // ULEB128.
646 case DW_FORM_loclistx: // ULEB128.
647 case DW_FORM_rnglistx: // ULEB128.
648 case DW_FORM_GNU_addr_index: // ULEB128.
649 case DW_FORM_GNU_str_index: // ULEB128.
652 case DW_FORM_ref_addr:
654 return Params.getRefAddrByteSize();
675 case DW_FORM_ref_sup4:
681 case DW_FORM_GNU_ref_alt:
682 case DW_FORM_GNU_strp_alt:
683 case DW_FORM_line_strp:
684 case DW_FORM_sec_offset:
685 case DW_FORM_strp_sup:
687 return Params.getDwarfOffsetByteSize();
692 case DW_FORM_ref_sig8:
693 case DW_FORM_ref_sup8:
696 case DW_FORM_flag_present:
702 case DW_FORM_implicit_const:
703 // The implicit value is stored in the abbreviation as a SLEB128, and
704 // there no data in debug info.
713 bool llvm::dwarf::isValidFormForVersion(Form F, unsigned Version,
715 if (FormVendor(F) == DWARF_VENDOR_DWARF) {
716 unsigned FV = FormVersion(F);
717 return FV > 0 && FV <= Version;
722 constexpr char llvm::dwarf::EnumTraits<Attribute>::Type[];
723 constexpr char llvm::dwarf::EnumTraits<Form>::Type[];
724 constexpr char llvm::dwarf::EnumTraits<Index>::Type[];
725 constexpr char llvm::dwarf::EnumTraits<Tag>::Type[];