1 //===-- llvm/BinaryFormat/Dwarf.h ---Dwarf Constants-------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 /// \file
11 /// This file contains constants used for implementing Dwarf
12 /// debug support.
13 ///
14 /// For details on the Dwarf specfication see the latest DWARF Debugging
15 /// Information Format standard document on http://www.dwarfstd.org. This
16 /// file often includes support for non-released standard features.
17 //
18 //===----------------------------------------------------------------------===//
19
20 #ifndef LLVM_BINARYFORMAT_DWARF_H
21 #define LLVM_BINARYFORMAT_DWARF_H
22
23 #include "llvm/ADT/Optional.h"
24 #include "llvm/Support/Compiler.h"
25 #include "llvm/Support/DataTypes.h"
26 #include "llvm/Support/ErrorHandling.h"
27 #include "llvm/Support/Format.h"
28 #include "llvm/Support/FormatVariadicDetails.h"
29 #include "llvm/ADT/Triple.h"
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
44 enum LLVMConstants : uint32_t {
45 // LLVM mock tags (see also llvm/BinaryFormat/Dwarf.def).
46 DW_TAG_invalid = ~0U, // Tag for invalid results.
47 DW_VIRTUALITY_invalid = ~0U, // Virtuality for invalid results.
48 DW_MACINFO_invalid = ~0U, // Macinfo type for invalid results.
49
50 // Other constants.
51 DWARF_VERSION = 4, // Default dwarf version we output.
52 DW_PUBTYPES_VERSION = 2, // Section version number for .debug_pubtypes.
53 DW_PUBNAMES_VERSION = 2, // Section version number for .debug_pubnames.
54 DW_ARANGES_VERSION = 2, // Section version number for .debug_aranges.
55 // Identifiers we use to distinguish vendor extensions.
56 DWARF_VENDOR_DWARF = 0, // Defined in v2 or later of the DWARF standard.
57 DWARF_VENDOR_APPLE = 1,
58 DWARF_VENDOR_BORLAND = 2,
59 DWARF_VENDOR_GNU = 3,
60 DWARF_VENDOR_GOOGLE = 4,
61 DWARF_VENDOR_LLVM = 5,
62 DWARF_VENDOR_MIPS = 6
63 };
64
65 /// Constants that define the DWARF format as 32 or 64 bit.
66 enum DwarfFormat : uint8_t { DWARF32, DWARF64 };
67
68 /// Special ID values that distinguish a CIE from a FDE in DWARF CFI.
69 /// Not inside an enum because a 64-bit value is needed.
70 /// @{
71 const uint32_t DW_CIE_ID = UINT32_MAX;
72 const uint64_t DW64_CIE_ID = UINT64_MAX;
73 /// @}
74
75 /// Identifier of an invalid DIE offset in the .debug_info section.
76 const uint32_t DW_INVALID_OFFSET = UINT32_MAX;
77
78 enum Tag : uint16_t {
79 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR) DW_TAG_##NAME = ID,
80 #include "llvm/BinaryFormat/Dwarf.def"
81 DW_TAG_lo_user = 0x4080,
82 DW_TAG_hi_user = 0xffff,
83 DW_TAG_user_base = 0x1000 ///< Recommended base for user tags.
84 };
85
isType(Tag T)86 inline bool isType(Tag T) {
87 switch (T) {
88 case DW_TAG_array_type:
89 case DW_TAG_class_type:
90 case DW_TAG_interface_type:
91 case DW_TAG_enumeration_type:
92 case DW_TAG_pointer_type:
93 case DW_TAG_reference_type:
94 case DW_TAG_rvalue_reference_type:
95 case DW_TAG_string_type:
96 case DW_TAG_structure_type:
97 case DW_TAG_subroutine_type:
98 case DW_TAG_union_type:
99 case DW_TAG_ptr_to_member_type:
100 case DW_TAG_set_type:
101 case DW_TAG_subrange_type:
102 case DW_TAG_base_type:
103 case DW_TAG_const_type:
104 case DW_TAG_file_type:
105 case DW_TAG_packed_type:
106 case DW_TAG_volatile_type:
107 case DW_TAG_typedef:
108 return true;
109 default:
110 return false;
111 }
112 }
113
114 /// Attributes.
115 enum Attribute : uint16_t {
116 #define HANDLE_DW_AT(ID, NAME, VERSION, VENDOR) DW_AT_##NAME = ID,
117 #include "llvm/BinaryFormat/Dwarf.def"
118 DW_AT_lo_user = 0x2000,
119 DW_AT_hi_user = 0x3fff,
120 };
121
122 enum Form : uint16_t {
123 #define HANDLE_DW_FORM(ID, NAME, VERSION, VENDOR) DW_FORM_##NAME = ID,
124 #include "llvm/BinaryFormat/Dwarf.def"
125 DW_FORM_lo_user = 0x1f00, ///< Not specified by DWARF.
126 };
127
128 enum LocationAtom {
129 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) DW_OP_##NAME = ID,
130 #include "llvm/BinaryFormat/Dwarf.def"
131 DW_OP_lo_user = 0xe0,
132 DW_OP_hi_user = 0xff,
133 DW_OP_LLVM_fragment = 0x1000 ///< Only used in LLVM metadata.
134 };
135
136 enum TypeKind : uint8_t {
137 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) DW_ATE_##NAME = ID,
138 #include "llvm/BinaryFormat/Dwarf.def"
139 DW_ATE_lo_user = 0x80,
140 DW_ATE_hi_user = 0xff
141 };
142
143 enum DecimalSignEncoding {
144 // Decimal sign attribute values
145 DW_DS_unsigned = 0x01,
146 DW_DS_leading_overpunch = 0x02,
147 DW_DS_trailing_overpunch = 0x03,
148 DW_DS_leading_separate = 0x04,
149 DW_DS_trailing_separate = 0x05
150 };
151
152 enum EndianityEncoding {
153 // Endianity attribute values
154 #define HANDLE_DW_END(ID, NAME) DW_END_##NAME = ID,
155 #include "llvm/BinaryFormat/Dwarf.def"
156 DW_END_lo_user = 0x40,
157 DW_END_hi_user = 0xff
158 };
159
160 enum AccessAttribute {
161 // Accessibility codes
162 DW_ACCESS_public = 0x01,
163 DW_ACCESS_protected = 0x02,
164 DW_ACCESS_private = 0x03
165 };
166
167 enum VisibilityAttribute {
168 // Visibility codes
169 DW_VIS_local = 0x01,
170 DW_VIS_exported = 0x02,
171 DW_VIS_qualified = 0x03
172 };
173
174 enum VirtualityAttribute {
175 #define HANDLE_DW_VIRTUALITY(ID, NAME) DW_VIRTUALITY_##NAME = ID,
176 #include "llvm/BinaryFormat/Dwarf.def"
177 DW_VIRTUALITY_max = 0x02
178 };
179
180 enum DefaultedMemberAttribute {
181 #define HANDLE_DW_DEFAULTED(ID, NAME) DW_DEFAULTED_##NAME = ID,
182 #include "llvm/BinaryFormat/Dwarf.def"
183 DW_DEFAULTED_max = 0x02
184 };
185
186 enum SourceLanguage {
187 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
188 DW_LANG_##NAME = ID,
189 #include "llvm/BinaryFormat/Dwarf.def"
190 DW_LANG_lo_user = 0x8000,
191 DW_LANG_hi_user = 0xffff
192 };
193
194 enum CaseSensitivity {
195 // Identifier case codes
196 DW_ID_case_sensitive = 0x00,
197 DW_ID_up_case = 0x01,
198 DW_ID_down_case = 0x02,
199 DW_ID_case_insensitive = 0x03
200 };
201
202 enum CallingConvention {
203 // Calling convention codes
204 #define HANDLE_DW_CC(ID, NAME) DW_CC_##NAME = ID,
205 #include "llvm/BinaryFormat/Dwarf.def"
206 DW_CC_lo_user = 0x40,
207 DW_CC_hi_user = 0xff
208 };
209
210 enum InlineAttribute {
211 // Inline codes
212 DW_INL_not_inlined = 0x00,
213 DW_INL_inlined = 0x01,
214 DW_INL_declared_not_inlined = 0x02,
215 DW_INL_declared_inlined = 0x03
216 };
217
218 enum ArrayDimensionOrdering {
219 // Array ordering
220 DW_ORD_row_major = 0x00,
221 DW_ORD_col_major = 0x01
222 };
223
224 enum DiscriminantList {
225 // Discriminant descriptor values
226 DW_DSC_label = 0x00,
227 DW_DSC_range = 0x01
228 };
229
230 /// Line Number Standard Opcode Encodings.
231 enum LineNumberOps : uint8_t {
232 #define HANDLE_DW_LNS(ID, NAME) DW_LNS_##NAME = ID,
233 #include "llvm/BinaryFormat/Dwarf.def"
234 };
235
236 /// Line Number Extended Opcode Encodings.
237 enum LineNumberExtendedOps {
238 #define HANDLE_DW_LNE(ID, NAME) DW_LNE_##NAME = ID,
239 #include "llvm/BinaryFormat/Dwarf.def"
240 DW_LNE_lo_user = 0x80,
241 DW_LNE_hi_user = 0xff
242 };
243
244 enum LineNumberEntryFormat {
245 #define HANDLE_DW_LNCT(ID, NAME) DW_LNCT_##NAME = ID,
246 #include "llvm/BinaryFormat/Dwarf.def"
247 DW_LNCT_lo_user = 0x2000,
248 DW_LNCT_hi_user = 0x3fff,
249 };
250
251 enum MacinfoRecordType {
252 // Macinfo Type Encodings
253 DW_MACINFO_define = 0x01,
254 DW_MACINFO_undef = 0x02,
255 DW_MACINFO_start_file = 0x03,
256 DW_MACINFO_end_file = 0x04,
257 DW_MACINFO_vendor_ext = 0xff
258 };
259
260 /// DWARF v5 macro information entry type encodings.
261 enum MacroEntryType {
262 #define HANDLE_DW_MACRO(ID, NAME) DW_MACRO_##NAME = ID,
263 #include "llvm/BinaryFormat/Dwarf.def"
264 DW_MACRO_lo_user = 0xe0,
265 DW_MACRO_hi_user = 0xff
266 };
267
268 /// DWARF v5 range list entry encoding values.
269 enum RangeListEntries {
270 #define HANDLE_DW_RLE(ID, NAME) DW_RLE_##NAME = ID,
271 #include "llvm/BinaryFormat/Dwarf.def"
272 };
273
274 /// Call frame instruction encodings.
275 enum CallFrameInfo {
276 #define HANDLE_DW_CFA(ID, NAME) DW_CFA_##NAME = ID,
277 #define HANDLE_DW_CFA_PRED(ID, NAME, ARCH) DW_CFA_##NAME = ID,
278 #include "llvm/BinaryFormat/Dwarf.def"
279 DW_CFA_extended = 0x00,
280
281 DW_CFA_lo_user = 0x1c,
282 DW_CFA_hi_user = 0x3f
283 };
284
285 enum Constants {
286 // Children flag
287 DW_CHILDREN_no = 0x00,
288 DW_CHILDREN_yes = 0x01,
289
290 DW_EH_PE_absptr = 0x00,
291 DW_EH_PE_omit = 0xff,
292 DW_EH_PE_uleb128 = 0x01,
293 DW_EH_PE_udata2 = 0x02,
294 DW_EH_PE_udata4 = 0x03,
295 DW_EH_PE_udata8 = 0x04,
296 DW_EH_PE_sleb128 = 0x09,
297 DW_EH_PE_sdata2 = 0x0A,
298 DW_EH_PE_sdata4 = 0x0B,
299 DW_EH_PE_sdata8 = 0x0C,
300 DW_EH_PE_signed = 0x08,
301 DW_EH_PE_pcrel = 0x10,
302 DW_EH_PE_textrel = 0x20,
303 DW_EH_PE_datarel = 0x30,
304 DW_EH_PE_funcrel = 0x40,
305 DW_EH_PE_aligned = 0x50,
306 DW_EH_PE_indirect = 0x80
307 };
308
309 /// Constants for location lists in DWARF v5.
310 enum LocationListEntry : unsigned char {
311 DW_LLE_end_of_list = 0x00,
312 DW_LLE_base_addressx = 0x01,
313 DW_LLE_startx_endx = 0x02,
314 DW_LLE_startx_length = 0x03,
315 DW_LLE_offset_pair = 0x04,
316 DW_LLE_default_location = 0x05,
317 DW_LLE_base_address = 0x06,
318 DW_LLE_start_end = 0x07,
319 DW_LLE_start_length = 0x08
320 };
321
322 /// Constants for the DW_APPLE_PROPERTY_attributes attribute.
323 /// Keep this list in sync with clang's DeclSpec.h ObjCPropertyAttributeKind!
324 enum ApplePropertyAttributes {
325 #define HANDLE_DW_APPLE_PROPERTY(ID, NAME) DW_APPLE_PROPERTY_##NAME = ID,
326 #include "llvm/BinaryFormat/Dwarf.def"
327 };
328
329 /// Constants for unit types in DWARF v5.
330 enum UnitType : unsigned char {
331 #define HANDLE_DW_UT(ID, NAME) DW_UT_##NAME = ID,
332 #include "llvm/BinaryFormat/Dwarf.def"
333 DW_UT_lo_user = 0x80,
334 DW_UT_hi_user = 0xff
335 };
336
337 enum Index {
338 #define HANDLE_DW_IDX(ID, NAME) DW_IDX_##NAME = ID,
339 #include "llvm/BinaryFormat/Dwarf.def"
340 DW_IDX_lo_user = 0x2000,
341 DW_IDX_hi_user = 0x3fff
342 };
343
isUnitType(uint8_t UnitType)344 inline bool isUnitType(uint8_t UnitType) {
345 switch (UnitType) {
346 case DW_UT_compile:
347 case DW_UT_type:
348 case DW_UT_partial:
349 case DW_UT_skeleton:
350 case DW_UT_split_compile:
351 case DW_UT_split_type:
352 return true;
353 default:
354 return false;
355 }
356 }
357
isUnitType(dwarf::Tag T)358 inline bool isUnitType(dwarf::Tag T) {
359 switch (T) {
360 case DW_TAG_compile_unit:
361 case DW_TAG_type_unit:
362 case DW_TAG_partial_unit:
363 case DW_TAG_skeleton_unit:
364 return true;
365 default:
366 return false;
367 }
368 }
369
370 // Constants for the DWARF v5 Accelerator Table Proposal
371 enum AcceleratorTable {
372 // Data layout descriptors.
373 DW_ATOM_null = 0u, /// Marker as the end of a list of atoms.
374 DW_ATOM_die_offset = 1u, // DIE offset in the debug_info section.
375 DW_ATOM_cu_offset = 2u, // Offset of the compile unit header that contains the
376 // item in question.
377 DW_ATOM_die_tag = 3u, // A tag entry.
378 DW_ATOM_type_flags = 4u, // Set of flags for a type.
379
380 DW_ATOM_type_type_flags = 5u, // Dsymutil type extension.
381 DW_ATOM_qual_name_hash = 6u, // Dsymutil qualified hash extension.
382
383 // DW_ATOM_type_flags values.
384
385 // Always set for C++, only set for ObjC if this is the @implementation for a
386 // class.
387 DW_FLAG_type_implementation = 2u,
388
389 // Hash functions.
390
391 // Daniel J. Bernstein hash.
392 DW_hash_function_djb = 0u
393 };
394
395 // Constants for the GNU pubnames/pubtypes extensions supporting gdb index.
396 enum GDBIndexEntryKind {
397 GIEK_NONE,
398 GIEK_TYPE,
399 GIEK_VARIABLE,
400 GIEK_FUNCTION,
401 GIEK_OTHER,
402 GIEK_UNUSED5,
403 GIEK_UNUSED6,
404 GIEK_UNUSED7
405 };
406
407 enum GDBIndexEntryLinkage { GIEL_EXTERNAL, GIEL_STATIC };
408
409 /// \defgroup DwarfConstantsDumping Dwarf constants dumping functions
410 ///
411 /// All these functions map their argument's value back to the
412 /// corresponding enumerator name or return an empty StringRef if the value
413 /// isn't known.
414 ///
415 /// @{
416 StringRef TagString(unsigned Tag);
417 StringRef ChildrenString(unsigned Children);
418 StringRef AttributeString(unsigned Attribute);
419 StringRef FormEncodingString(unsigned Encoding);
420 StringRef OperationEncodingString(unsigned Encoding);
421 StringRef AttributeEncodingString(unsigned Encoding);
422 StringRef DecimalSignString(unsigned Sign);
423 StringRef EndianityString(unsigned Endian);
424 StringRef AccessibilityString(unsigned Access);
425 StringRef VisibilityString(unsigned Visibility);
426 StringRef VirtualityString(unsigned Virtuality);
427 StringRef LanguageString(unsigned Language);
428 StringRef CaseString(unsigned Case);
429 StringRef ConventionString(unsigned Convention);
430 StringRef InlineCodeString(unsigned Code);
431 StringRef ArrayOrderString(unsigned Order);
432 StringRef LNStandardString(unsigned Standard);
433 StringRef LNExtendedString(unsigned Encoding);
434 StringRef MacinfoString(unsigned Encoding);
435 StringRef RangeListEncodingString(unsigned Encoding);
436 StringRef CallFrameString(unsigned Encoding, Triple::ArchType Arch);
437 StringRef ApplePropertyString(unsigned);
438 StringRef UnitTypeString(unsigned);
439 StringRef AtomTypeString(unsigned Atom);
440 StringRef GDBIndexEntryKindString(GDBIndexEntryKind Kind);
441 StringRef GDBIndexEntryLinkageString(GDBIndexEntryLinkage Linkage);
442 StringRef IndexString(unsigned Idx);
443 /// @}
444
445 /// \defgroup DwarfConstantsParsing Dwarf constants parsing functions
446 ///
447 /// These functions map their strings back to the corresponding enumeration
448 /// value or return 0 if there is none, except for these exceptions:
449 ///
450 /// \li \a getTag() returns \a DW_TAG_invalid on invalid input.
451 /// \li \a getVirtuality() returns \a DW_VIRTUALITY_invalid on invalid input.
452 /// \li \a getMacinfo() returns \a DW_MACINFO_invalid on invalid input.
453 ///
454 /// @{
455 unsigned getTag(StringRef TagString);
456 unsigned getOperationEncoding(StringRef OperationEncodingString);
457 unsigned getVirtuality(StringRef VirtualityString);
458 unsigned getLanguage(StringRef LanguageString);
459 unsigned getCallingConvention(StringRef LanguageString);
460 unsigned getAttributeEncoding(StringRef EncodingString);
461 unsigned getMacinfo(StringRef MacinfoString);
462 /// @}
463
464 /// \defgroup DwarfConstantsVersioning Dwarf version for constants
465 ///
466 /// For constants defined by DWARF, returns the DWARF version when the constant
467 /// was first defined. For vendor extensions, if there is a version-related
468 /// policy for when to emit it, returns a version number for that policy.
469 /// Otherwise returns 0.
470 ///
471 /// @{
472 unsigned TagVersion(Tag T);
473 unsigned AttributeVersion(Attribute A);
474 unsigned FormVersion(Form F);
475 unsigned OperationVersion(LocationAtom O);
476 unsigned AttributeEncodingVersion(TypeKind E);
477 unsigned LanguageVersion(SourceLanguage L);
478 /// @}
479
480 /// \defgroup DwarfConstantsVendor Dwarf "vendor" for constants
481 ///
482 /// These functions return an identifier describing "who" defined the constant,
483 /// either the DWARF standard itself or the vendor who defined the extension.
484 ///
485 /// @{
486 unsigned TagVendor(Tag T);
487 unsigned AttributeVendor(Attribute A);
488 unsigned FormVendor(Form F);
489 unsigned OperationVendor(LocationAtom O);
490 unsigned AttributeEncodingVendor(TypeKind E);
491 unsigned LanguageVendor(SourceLanguage L);
492 /// @}
493
494 Optional<unsigned> LanguageLowerBound(SourceLanguage L);
495
496 /// A helper struct providing information about the byte size of DW_FORM
497 /// values that vary in size depending on the DWARF version, address byte
498 /// size, or DWARF32/DWARF64.
499 struct FormParams {
500 uint16_t Version;
501 uint8_t AddrSize;
502 DwarfFormat Format;
503
504 /// The definition of the size of form DW_FORM_ref_addr depends on the
505 /// version. In DWARF v2 it's the size of an address; after that, it's the
506 /// size of a reference.
getRefAddrByteSizeFormParams507 uint8_t getRefAddrByteSize() const {
508 if (Version == 2)
509 return AddrSize;
510 return getDwarfOffsetByteSize();
511 }
512
513 /// The size of a reference is determined by the DWARF 32/64-bit format.
getDwarfOffsetByteSizeFormParams514 uint8_t getDwarfOffsetByteSize() const {
515 switch (Format) {
516 case DwarfFormat::DWARF32:
517 return 4;
518 case DwarfFormat::DWARF64:
519 return 8;
520 }
521 llvm_unreachable("Invalid Format value");
522 }
523
524 explicit operator bool() const { return Version && AddrSize; }
525 };
526
527 /// Get the fixed byte size for a given form.
528 ///
529 /// If the form has a fixed byte size, then an Optional with a value will be
530 /// returned. If the form is always encoded using a variable length storage
531 /// format (ULEB or SLEB numbers or blocks) then None will be returned.
532 ///
533 /// \param Form DWARF form to get the fixed byte size for.
534 /// \param Params DWARF parameters to help interpret forms.
535 /// \returns Optional<uint8_t> value with the fixed byte size or None if
536 /// \p Form doesn't have a fixed byte size.
537 Optional<uint8_t> getFixedFormByteSize(dwarf::Form Form, FormParams Params);
538
539 /// Tells whether the specified form is defined in the specified version,
540 /// or is an extension if extensions are allowed.
541 bool isValidFormForVersion(Form F, unsigned Version, bool ExtensionsOk = true);
542
543 /// Returns the symbolic string representing Val when used as a value
544 /// for attribute Attr.
545 StringRef AttributeValueString(uint16_t Attr, unsigned Val);
546
547 /// Returns the symbolic string representing Val when used as a value
548 /// for atom Atom.
549 StringRef AtomValueString(uint16_t Atom, unsigned Val);
550
551 /// Describes an entry of the various gnu_pub* debug sections.
552 ///
553 /// The gnu_pub* kind looks like:
554 ///
555 /// 0-3 reserved
556 /// 4-6 symbol kind
557 /// 7 0 == global, 1 == static
558 ///
559 /// A gdb_index descriptor includes the above kind, shifted 24 bits up with the
560 /// offset of the cu within the debug_info section stored in those 24 bits.
561 struct PubIndexEntryDescriptor {
562 GDBIndexEntryKind Kind;
563 GDBIndexEntryLinkage Linkage;
PubIndexEntryDescriptorPubIndexEntryDescriptor564 PubIndexEntryDescriptor(GDBIndexEntryKind Kind, GDBIndexEntryLinkage Linkage)
565 : Kind(Kind), Linkage(Linkage) {}
PubIndexEntryDescriptorPubIndexEntryDescriptor566 /* implicit */ PubIndexEntryDescriptor(GDBIndexEntryKind Kind)
567 : Kind(Kind), Linkage(GIEL_EXTERNAL) {}
PubIndexEntryDescriptorPubIndexEntryDescriptor568 explicit PubIndexEntryDescriptor(uint8_t Value)
569 : Kind(
570 static_cast<GDBIndexEntryKind>((Value & KIND_MASK) >> KIND_OFFSET)),
571 Linkage(static_cast<GDBIndexEntryLinkage>((Value & LINKAGE_MASK) >>
572 LINKAGE_OFFSET)) {}
toBitsPubIndexEntryDescriptor573 uint8_t toBits() const {
574 return Kind << KIND_OFFSET | Linkage << LINKAGE_OFFSET;
575 }
576
577 private:
578 enum {
579 KIND_OFFSET = 4,
580 KIND_MASK = 7 << KIND_OFFSET,
581 LINKAGE_OFFSET = 7,
582 LINKAGE_MASK = 1 << LINKAGE_OFFSET
583 };
584 };
585
586 template <typename Enum> struct EnumTraits : public std::false_type {};
587
588 template <> struct EnumTraits<Attribute> : public std::true_type {
589 static constexpr char Type[3] = "AT";
590 static constexpr StringRef (*StringFn)(unsigned) = &AttributeString;
591 };
592
593 template <> struct EnumTraits<Form> : public std::true_type {
594 static constexpr char Type[5] = "FORM";
595 static constexpr StringRef (*StringFn)(unsigned) = &FormEncodingString;
596 };
597
598 template <> struct EnumTraits<Index> : public std::true_type {
599 static constexpr char Type[4] = "IDX";
600 static constexpr StringRef (*StringFn)(unsigned) = &IndexString;
601 };
602
603 template <> struct EnumTraits<Tag> : public std::true_type {
604 static constexpr char Type[4] = "TAG";
605 static constexpr StringRef (*StringFn)(unsigned) = &TagString;
606 };
607 } // End of namespace dwarf
608
609 /// Dwarf constants format_provider
610 ///
611 /// Specialization of the format_provider template for dwarf enums. Unlike the
612 /// dumping functions above, these format unknown enumerator values as
613 /// DW_TYPE_unknown_1234 (e.g. DW_TAG_unknown_ffff).
614 template <typename Enum>
615 struct format_provider<
616 Enum, typename std::enable_if<dwarf::EnumTraits<Enum>::value>::type> {
617 static void format(const Enum &E, raw_ostream &OS, StringRef Style) {
618 StringRef Str = dwarf::EnumTraits<Enum>::StringFn(E);
619 if (Str.empty()) {
620 OS << "DW_" << dwarf::EnumTraits<Enum>::Type << "_unknown_"
621 << llvm::format("%x", E);
622 } else
623 OS << Str;
624 }
625 };
626 } // End of namespace llvm
627
628 #endif
629