[InstCombine] Signed saturation patterns
[llvm-core.git] / include / llvm / BinaryFormat / Dwarf.h
blob1c6aee48661c899d7dc0681710080f423164fa77
1 //===-- llvm/BinaryFormat/Dwarf.h ---Dwarf Constants-------------*- C++ -*-===//
2 //
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
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 /// \file
10 /// This file contains constants used for implementing Dwarf
11 /// debug support.
12 ///
13 /// For details on the Dwarf specfication see the latest DWARF Debugging
14 /// Information Format standard document on http://www.dwarfstd.org. This
15 /// file often includes support for non-released standard features.
17 //===----------------------------------------------------------------------===//
19 #ifndef LLVM_BINARYFORMAT_DWARF_H
20 #define LLVM_BINARYFORMAT_DWARF_H
22 #include "llvm/ADT/Optional.h"
23 #include "llvm/Support/Compiler.h"
24 #include "llvm/Support/DataTypes.h"
25 #include "llvm/Support/ErrorHandling.h"
26 #include "llvm/Support/Format.h"
27 #include "llvm/Support/FormatVariadicDetails.h"
28 #include "llvm/ADT/Triple.h"
30 namespace llvm {
31 class StringRef;
33 namespace dwarf {
35 //===----------------------------------------------------------------------===//
36 // DWARF constants as gleaned from the DWARF Debugging Information Format V.5
37 // reference manual http://www.dwarfstd.org/.
40 // Do not mix the following two enumerations sets. DW_TAG_invalid changes the
41 // enumeration base type.
43 enum LLVMConstants : uint32_t {
44 // LLVM mock tags (see also llvm/BinaryFormat/Dwarf.def).
45 DW_TAG_invalid = ~0U, // Tag for invalid results.
46 DW_VIRTUALITY_invalid = ~0U, // Virtuality for invalid results.
47 DW_MACINFO_invalid = ~0U, // Macinfo type for invalid results.
49 // Special values for an initial length field.
50 DW_LENGTH_lo_reserved = 0xfffffff0, // Lower bound of the reserved range.
51 DW_LENGTH_DWARF64 = 0xffffffff, // Indicator of 64-bit DWARF format.
52 DW_LENGTH_hi_reserved = 0xffffffff, // Upper bound of the reserved range.
54 // Other constants.
55 DWARF_VERSION = 4, // Default dwarf version we output.
56 DW_PUBTYPES_VERSION = 2, // Section version number for .debug_pubtypes.
57 DW_PUBNAMES_VERSION = 2, // Section version number for .debug_pubnames.
58 DW_ARANGES_VERSION = 2, // Section version number for .debug_aranges.
59 // Identifiers we use to distinguish vendor extensions.
60 DWARF_VENDOR_DWARF = 0, // Defined in v2 or later of the DWARF standard.
61 DWARF_VENDOR_APPLE = 1,
62 DWARF_VENDOR_BORLAND = 2,
63 DWARF_VENDOR_GNU = 3,
64 DWARF_VENDOR_GOOGLE = 4,
65 DWARF_VENDOR_LLVM = 5,
66 DWARF_VENDOR_MIPS = 6
69 /// Constants that define the DWARF format as 32 or 64 bit.
70 enum DwarfFormat : uint8_t { DWARF32, DWARF64 };
72 /// Special ID values that distinguish a CIE from a FDE in DWARF CFI.
73 /// Not inside an enum because a 64-bit value is needed.
74 /// @{
75 const uint32_t DW_CIE_ID = UINT32_MAX;
76 const uint64_t DW64_CIE_ID = UINT64_MAX;
77 /// @}
79 /// Identifier of an invalid DIE offset in the .debug_info section.
80 const uint32_t DW_INVALID_OFFSET = UINT32_MAX;
82 enum Tag : uint16_t {
83 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR, KIND) DW_TAG_##NAME = ID,
84 #include "llvm/BinaryFormat/Dwarf.def"
85 DW_TAG_lo_user = 0x4080,
86 DW_TAG_hi_user = 0xffff,
87 DW_TAG_user_base = 0x1000 ///< Recommended base for user tags.
90 inline bool isType(Tag T) {
91 switch (T) {
92 default:
93 return false;
94 #define HANDLE_DW_TAG(ID, NAME, VERSION, VENDOR, KIND) \
95 case DW_TAG_##NAME: \
96 return (KIND == DW_KIND_TYPE);
97 #include "llvm/BinaryFormat/Dwarf.def"
101 /// Attributes.
102 enum Attribute : uint16_t {
103 #define HANDLE_DW_AT(ID, NAME, VERSION, VENDOR) DW_AT_##NAME = ID,
104 #include "llvm/BinaryFormat/Dwarf.def"
105 DW_AT_lo_user = 0x2000,
106 DW_AT_hi_user = 0x3fff,
109 enum Form : uint16_t {
110 #define HANDLE_DW_FORM(ID, NAME, VERSION, VENDOR) DW_FORM_##NAME = ID,
111 #include "llvm/BinaryFormat/Dwarf.def"
112 DW_FORM_lo_user = 0x1f00, ///< Not specified by DWARF.
115 enum LocationAtom {
116 #define HANDLE_DW_OP(ID, NAME, VERSION, VENDOR) DW_OP_##NAME = ID,
117 #include "llvm/BinaryFormat/Dwarf.def"
118 DW_OP_lo_user = 0xe0,
119 DW_OP_hi_user = 0xff,
120 DW_OP_LLVM_fragment = 0x1000, ///< Only used in LLVM metadata.
121 DW_OP_LLVM_convert = 0x1001, ///< Only used in LLVM metadata.
122 DW_OP_LLVM_tag_offset = 0x1002, ///< Only used in LLVM metadata.
123 DW_OP_LLVM_entry_value = 0x1003, ///< Only used in LLVM metadata.
126 enum TypeKind : uint8_t {
127 #define HANDLE_DW_ATE(ID, NAME, VERSION, VENDOR) DW_ATE_##NAME = ID,
128 #include "llvm/BinaryFormat/Dwarf.def"
129 DW_ATE_lo_user = 0x80,
130 DW_ATE_hi_user = 0xff
133 enum DecimalSignEncoding {
134 // Decimal sign attribute values
135 DW_DS_unsigned = 0x01,
136 DW_DS_leading_overpunch = 0x02,
137 DW_DS_trailing_overpunch = 0x03,
138 DW_DS_leading_separate = 0x04,
139 DW_DS_trailing_separate = 0x05
142 enum EndianityEncoding {
143 // Endianity attribute values
144 #define HANDLE_DW_END(ID, NAME) DW_END_##NAME = ID,
145 #include "llvm/BinaryFormat/Dwarf.def"
146 DW_END_lo_user = 0x40,
147 DW_END_hi_user = 0xff
150 enum AccessAttribute {
151 // Accessibility codes
152 DW_ACCESS_public = 0x01,
153 DW_ACCESS_protected = 0x02,
154 DW_ACCESS_private = 0x03
157 enum VisibilityAttribute {
158 // Visibility codes
159 DW_VIS_local = 0x01,
160 DW_VIS_exported = 0x02,
161 DW_VIS_qualified = 0x03
164 enum VirtualityAttribute {
165 #define HANDLE_DW_VIRTUALITY(ID, NAME) DW_VIRTUALITY_##NAME = ID,
166 #include "llvm/BinaryFormat/Dwarf.def"
167 DW_VIRTUALITY_max = 0x02
170 enum DefaultedMemberAttribute {
171 #define HANDLE_DW_DEFAULTED(ID, NAME) DW_DEFAULTED_##NAME = ID,
172 #include "llvm/BinaryFormat/Dwarf.def"
173 DW_DEFAULTED_max = 0x02
176 enum SourceLanguage {
177 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR) \
178 DW_LANG_##NAME = ID,
179 #include "llvm/BinaryFormat/Dwarf.def"
180 DW_LANG_lo_user = 0x8000,
181 DW_LANG_hi_user = 0xffff
184 inline bool isCPlusPlus(SourceLanguage S) {
185 // Deliberately enumerate all the language options so we get a warning when
186 // new language options are added (-Wswitch) that'll hopefully help keep this
187 // switch up-to-date when new C++ versions are added.
188 switch (S) {
189 case DW_LANG_C_plus_plus:
190 case DW_LANG_C_plus_plus_03:
191 case DW_LANG_C_plus_plus_11:
192 case DW_LANG_C_plus_plus_14:
193 return true;
194 case DW_LANG_C89:
195 case DW_LANG_C:
196 case DW_LANG_Ada83:
197 case DW_LANG_Cobol74:
198 case DW_LANG_Cobol85:
199 case DW_LANG_Fortran77:
200 case DW_LANG_Fortran90:
201 case DW_LANG_Pascal83:
202 case DW_LANG_Modula2:
203 case DW_LANG_Java:
204 case DW_LANG_C99:
205 case DW_LANG_Ada95:
206 case DW_LANG_Fortran95:
207 case DW_LANG_PLI:
208 case DW_LANG_ObjC:
209 case DW_LANG_ObjC_plus_plus:
210 case DW_LANG_UPC:
211 case DW_LANG_D:
212 case DW_LANG_Python:
213 case DW_LANG_OpenCL:
214 case DW_LANG_Go:
215 case DW_LANG_Modula3:
216 case DW_LANG_Haskell:
217 case DW_LANG_OCaml:
218 case DW_LANG_Rust:
219 case DW_LANG_C11:
220 case DW_LANG_Swift:
221 case DW_LANG_Julia:
222 case DW_LANG_Dylan:
223 case DW_LANG_Fortran03:
224 case DW_LANG_Fortran08:
225 case DW_LANG_RenderScript:
226 case DW_LANG_BLISS:
227 case DW_LANG_Mips_Assembler:
228 case DW_LANG_GOOGLE_RenderScript:
229 case DW_LANG_BORLAND_Delphi:
230 case DW_LANG_lo_user:
231 case DW_LANG_hi_user:
232 return false;
234 llvm_unreachable("Invalid source language");
237 enum CaseSensitivity {
238 // Identifier case codes
239 DW_ID_case_sensitive = 0x00,
240 DW_ID_up_case = 0x01,
241 DW_ID_down_case = 0x02,
242 DW_ID_case_insensitive = 0x03
245 enum CallingConvention {
246 // Calling convention codes
247 #define HANDLE_DW_CC(ID, NAME) DW_CC_##NAME = ID,
248 #include "llvm/BinaryFormat/Dwarf.def"
249 DW_CC_lo_user = 0x40,
250 DW_CC_hi_user = 0xff
253 enum InlineAttribute {
254 // Inline codes
255 DW_INL_not_inlined = 0x00,
256 DW_INL_inlined = 0x01,
257 DW_INL_declared_not_inlined = 0x02,
258 DW_INL_declared_inlined = 0x03
261 enum ArrayDimensionOrdering {
262 // Array ordering
263 DW_ORD_row_major = 0x00,
264 DW_ORD_col_major = 0x01
267 enum DiscriminantList {
268 // Discriminant descriptor values
269 DW_DSC_label = 0x00,
270 DW_DSC_range = 0x01
273 /// Line Number Standard Opcode Encodings.
274 enum LineNumberOps : uint8_t {
275 #define HANDLE_DW_LNS(ID, NAME) DW_LNS_##NAME = ID,
276 #include "llvm/BinaryFormat/Dwarf.def"
279 /// Line Number Extended Opcode Encodings.
280 enum LineNumberExtendedOps {
281 #define HANDLE_DW_LNE(ID, NAME) DW_LNE_##NAME = ID,
282 #include "llvm/BinaryFormat/Dwarf.def"
283 DW_LNE_lo_user = 0x80,
284 DW_LNE_hi_user = 0xff
287 enum LineNumberEntryFormat {
288 #define HANDLE_DW_LNCT(ID, NAME) DW_LNCT_##NAME = ID,
289 #include "llvm/BinaryFormat/Dwarf.def"
290 DW_LNCT_lo_user = 0x2000,
291 DW_LNCT_hi_user = 0x3fff,
294 enum MacinfoRecordType {
295 // Macinfo Type Encodings
296 DW_MACINFO_define = 0x01,
297 DW_MACINFO_undef = 0x02,
298 DW_MACINFO_start_file = 0x03,
299 DW_MACINFO_end_file = 0x04,
300 DW_MACINFO_vendor_ext = 0xff
303 /// DWARF v5 macro information entry type encodings.
304 enum MacroEntryType {
305 #define HANDLE_DW_MACRO(ID, NAME) DW_MACRO_##NAME = ID,
306 #include "llvm/BinaryFormat/Dwarf.def"
307 DW_MACRO_lo_user = 0xe0,
308 DW_MACRO_hi_user = 0xff
311 /// DWARF v5 range list entry encoding values.
312 enum RnglistEntries {
313 #define HANDLE_DW_RLE(ID, NAME) DW_RLE_##NAME = ID,
314 #include "llvm/BinaryFormat/Dwarf.def"
317 /// DWARF v5 loc list entry encoding values.
318 enum LoclistEntries {
319 #define HANDLE_DW_LLE(ID, NAME) DW_LLE_##NAME = ID,
320 #include "llvm/BinaryFormat/Dwarf.def"
323 /// Call frame instruction encodings.
324 enum CallFrameInfo {
325 #define HANDLE_DW_CFA(ID, NAME) DW_CFA_##NAME = ID,
326 #define HANDLE_DW_CFA_PRED(ID, NAME, ARCH) DW_CFA_##NAME = ID,
327 #include "llvm/BinaryFormat/Dwarf.def"
328 DW_CFA_extended = 0x00,
330 DW_CFA_lo_user = 0x1c,
331 DW_CFA_hi_user = 0x3f
334 enum Constants {
335 // Children flag
336 DW_CHILDREN_no = 0x00,
337 DW_CHILDREN_yes = 0x01,
339 DW_EH_PE_absptr = 0x00,
340 DW_EH_PE_omit = 0xff,
341 DW_EH_PE_uleb128 = 0x01,
342 DW_EH_PE_udata2 = 0x02,
343 DW_EH_PE_udata4 = 0x03,
344 DW_EH_PE_udata8 = 0x04,
345 DW_EH_PE_sleb128 = 0x09,
346 DW_EH_PE_sdata2 = 0x0A,
347 DW_EH_PE_sdata4 = 0x0B,
348 DW_EH_PE_sdata8 = 0x0C,
349 DW_EH_PE_signed = 0x08,
350 DW_EH_PE_pcrel = 0x10,
351 DW_EH_PE_textrel = 0x20,
352 DW_EH_PE_datarel = 0x30,
353 DW_EH_PE_funcrel = 0x40,
354 DW_EH_PE_aligned = 0x50,
355 DW_EH_PE_indirect = 0x80
358 /// Constants for the DW_APPLE_PROPERTY_attributes attribute.
359 /// Keep this list in sync with clang's DeclSpec.h ObjCPropertyAttributeKind!
360 enum ApplePropertyAttributes {
361 #define HANDLE_DW_APPLE_PROPERTY(ID, NAME) DW_APPLE_PROPERTY_##NAME = ID,
362 #include "llvm/BinaryFormat/Dwarf.def"
365 /// Constants for unit types in DWARF v5.
366 enum UnitType : unsigned char {
367 #define HANDLE_DW_UT(ID, NAME) DW_UT_##NAME = ID,
368 #include "llvm/BinaryFormat/Dwarf.def"
369 DW_UT_lo_user = 0x80,
370 DW_UT_hi_user = 0xff
373 enum Index {
374 #define HANDLE_DW_IDX(ID, NAME) DW_IDX_##NAME = ID,
375 #include "llvm/BinaryFormat/Dwarf.def"
376 DW_IDX_lo_user = 0x2000,
377 DW_IDX_hi_user = 0x3fff
380 inline bool isUnitType(uint8_t UnitType) {
381 switch (UnitType) {
382 case DW_UT_compile:
383 case DW_UT_type:
384 case DW_UT_partial:
385 case DW_UT_skeleton:
386 case DW_UT_split_compile:
387 case DW_UT_split_type:
388 return true;
389 default:
390 return false;
394 inline bool isUnitType(dwarf::Tag T) {
395 switch (T) {
396 case DW_TAG_compile_unit:
397 case DW_TAG_type_unit:
398 case DW_TAG_partial_unit:
399 case DW_TAG_skeleton_unit:
400 return true;
401 default:
402 return false;
406 // Constants for the DWARF v5 Accelerator Table Proposal
407 enum AcceleratorTable {
408 // Data layout descriptors.
409 DW_ATOM_null = 0u, /// Marker as the end of a list of atoms.
410 DW_ATOM_die_offset = 1u, // DIE offset in the debug_info section.
411 DW_ATOM_cu_offset = 2u, // Offset of the compile unit header that contains the
412 // item in question.
413 DW_ATOM_die_tag = 3u, // A tag entry.
414 DW_ATOM_type_flags = 4u, // Set of flags for a type.
416 DW_ATOM_type_type_flags = 5u, // Dsymutil type extension.
417 DW_ATOM_qual_name_hash = 6u, // Dsymutil qualified hash extension.
419 // DW_ATOM_type_flags values.
421 // Always set for C++, only set for ObjC if this is the @implementation for a
422 // class.
423 DW_FLAG_type_implementation = 2u,
425 // Hash functions.
427 // Daniel J. Bernstein hash.
428 DW_hash_function_djb = 0u
431 // Constants for the GNU pubnames/pubtypes extensions supporting gdb index.
432 enum GDBIndexEntryKind {
433 GIEK_NONE,
434 GIEK_TYPE,
435 GIEK_VARIABLE,
436 GIEK_FUNCTION,
437 GIEK_OTHER,
438 GIEK_UNUSED5,
439 GIEK_UNUSED6,
440 GIEK_UNUSED7
443 enum GDBIndexEntryLinkage { GIEL_EXTERNAL, GIEL_STATIC };
445 /// \defgroup DwarfConstantsDumping Dwarf constants dumping functions
447 /// All these functions map their argument's value back to the
448 /// corresponding enumerator name or return an empty StringRef if the value
449 /// isn't known.
451 /// @{
452 StringRef TagString(unsigned Tag);
453 StringRef ChildrenString(unsigned Children);
454 StringRef AttributeString(unsigned Attribute);
455 StringRef FormEncodingString(unsigned Encoding);
456 StringRef OperationEncodingString(unsigned Encoding);
457 StringRef AttributeEncodingString(unsigned Encoding);
458 StringRef DecimalSignString(unsigned Sign);
459 StringRef EndianityString(unsigned Endian);
460 StringRef AccessibilityString(unsigned Access);
461 StringRef VisibilityString(unsigned Visibility);
462 StringRef VirtualityString(unsigned Virtuality);
463 StringRef LanguageString(unsigned Language);
464 StringRef CaseString(unsigned Case);
465 StringRef ConventionString(unsigned Convention);
466 StringRef InlineCodeString(unsigned Code);
467 StringRef ArrayOrderString(unsigned Order);
468 StringRef LNStandardString(unsigned Standard);
469 StringRef LNExtendedString(unsigned Encoding);
470 StringRef MacinfoString(unsigned Encoding);
471 StringRef RangeListEncodingString(unsigned Encoding);
472 StringRef LocListEncodingString(unsigned Encoding);
473 StringRef CallFrameString(unsigned Encoding, Triple::ArchType Arch);
474 StringRef ApplePropertyString(unsigned);
475 StringRef UnitTypeString(unsigned);
476 StringRef AtomTypeString(unsigned Atom);
477 StringRef GDBIndexEntryKindString(GDBIndexEntryKind Kind);
478 StringRef GDBIndexEntryLinkageString(GDBIndexEntryLinkage Linkage);
479 StringRef IndexString(unsigned Idx);
480 /// @}
482 /// \defgroup DwarfConstantsParsing Dwarf constants parsing functions
484 /// These functions map their strings back to the corresponding enumeration
485 /// value or return 0 if there is none, except for these exceptions:
487 /// \li \a getTag() returns \a DW_TAG_invalid on invalid input.
488 /// \li \a getVirtuality() returns \a DW_VIRTUALITY_invalid on invalid input.
489 /// \li \a getMacinfo() returns \a DW_MACINFO_invalid on invalid input.
491 /// @{
492 unsigned getTag(StringRef TagString);
493 unsigned getOperationEncoding(StringRef OperationEncodingString);
494 unsigned getVirtuality(StringRef VirtualityString);
495 unsigned getLanguage(StringRef LanguageString);
496 unsigned getCallingConvention(StringRef LanguageString);
497 unsigned getAttributeEncoding(StringRef EncodingString);
498 unsigned getMacinfo(StringRef MacinfoString);
499 /// @}
501 /// \defgroup DwarfConstantsVersioning Dwarf version for constants
503 /// For constants defined by DWARF, returns the DWARF version when the constant
504 /// was first defined. For vendor extensions, if there is a version-related
505 /// policy for when to emit it, returns a version number for that policy.
506 /// Otherwise returns 0.
508 /// @{
509 unsigned TagVersion(Tag T);
510 unsigned AttributeVersion(Attribute A);
511 unsigned FormVersion(Form F);
512 unsigned OperationVersion(LocationAtom O);
513 unsigned AttributeEncodingVersion(TypeKind E);
514 unsigned LanguageVersion(SourceLanguage L);
515 /// @}
517 /// \defgroup DwarfConstantsVendor Dwarf "vendor" for constants
519 /// These functions return an identifier describing "who" defined the constant,
520 /// either the DWARF standard itself or the vendor who defined the extension.
522 /// @{
523 unsigned TagVendor(Tag T);
524 unsigned AttributeVendor(Attribute A);
525 unsigned FormVendor(Form F);
526 unsigned OperationVendor(LocationAtom O);
527 unsigned AttributeEncodingVendor(TypeKind E);
528 unsigned LanguageVendor(SourceLanguage L);
529 /// @}
531 Optional<unsigned> LanguageLowerBound(SourceLanguage L);
533 /// A helper struct providing information about the byte size of DW_FORM
534 /// values that vary in size depending on the DWARF version, address byte
535 /// size, or DWARF32/DWARF64.
536 struct FormParams {
537 uint16_t Version;
538 uint8_t AddrSize;
539 DwarfFormat Format;
541 /// The definition of the size of form DW_FORM_ref_addr depends on the
542 /// version. In DWARF v2 it's the size of an address; after that, it's the
543 /// size of a reference.
544 uint8_t getRefAddrByteSize() const {
545 if (Version == 2)
546 return AddrSize;
547 return getDwarfOffsetByteSize();
550 /// The size of a reference is determined by the DWARF 32/64-bit format.
551 uint8_t getDwarfOffsetByteSize() const {
552 switch (Format) {
553 case DwarfFormat::DWARF32:
554 return 4;
555 case DwarfFormat::DWARF64:
556 return 8;
558 llvm_unreachable("Invalid Format value");
561 explicit operator bool() const { return Version && AddrSize; }
564 /// Get the byte size of the unit length field depending on the DWARF format.
565 inline uint8_t getUnitLengthFieldByteSize(DwarfFormat Format) {
566 switch (Format) {
567 case DwarfFormat::DWARF32:
568 return 4;
569 case DwarfFormat::DWARF64:
570 return 12;
572 llvm_unreachable("Invalid Format value");
575 /// Get the fixed byte size for a given form.
577 /// If the form has a fixed byte size, then an Optional with a value will be
578 /// returned. If the form is always encoded using a variable length storage
579 /// format (ULEB or SLEB numbers or blocks) then None will be returned.
581 /// \param Form DWARF form to get the fixed byte size for.
582 /// \param Params DWARF parameters to help interpret forms.
583 /// \returns Optional<uint8_t> value with the fixed byte size or None if
584 /// \p Form doesn't have a fixed byte size.
585 Optional<uint8_t> getFixedFormByteSize(dwarf::Form Form, FormParams Params);
587 /// Tells whether the specified form is defined in the specified version,
588 /// or is an extension if extensions are allowed.
589 bool isValidFormForVersion(Form F, unsigned Version, bool ExtensionsOk = true);
591 /// Returns the symbolic string representing Val when used as a value
592 /// for attribute Attr.
593 StringRef AttributeValueString(uint16_t Attr, unsigned Val);
595 /// Returns the symbolic string representing Val when used as a value
596 /// for atom Atom.
597 StringRef AtomValueString(uint16_t Atom, unsigned Val);
599 /// Describes an entry of the various gnu_pub* debug sections.
601 /// The gnu_pub* kind looks like:
603 /// 0-3 reserved
604 /// 4-6 symbol kind
605 /// 7 0 == global, 1 == static
607 /// A gdb_index descriptor includes the above kind, shifted 24 bits up with the
608 /// offset of the cu within the debug_info section stored in those 24 bits.
609 struct PubIndexEntryDescriptor {
610 GDBIndexEntryKind Kind;
611 GDBIndexEntryLinkage Linkage;
612 PubIndexEntryDescriptor(GDBIndexEntryKind Kind, GDBIndexEntryLinkage Linkage)
613 : Kind(Kind), Linkage(Linkage) {}
614 /* implicit */ PubIndexEntryDescriptor(GDBIndexEntryKind Kind)
615 : Kind(Kind), Linkage(GIEL_EXTERNAL) {}
616 explicit PubIndexEntryDescriptor(uint8_t Value)
617 : Kind(
618 static_cast<GDBIndexEntryKind>((Value & KIND_MASK) >> KIND_OFFSET)),
619 Linkage(static_cast<GDBIndexEntryLinkage>((Value & LINKAGE_MASK) >>
620 LINKAGE_OFFSET)) {}
621 uint8_t toBits() const {
622 return Kind << KIND_OFFSET | Linkage << LINKAGE_OFFSET;
625 private:
626 enum {
627 KIND_OFFSET = 4,
628 KIND_MASK = 7 << KIND_OFFSET,
629 LINKAGE_OFFSET = 7,
630 LINKAGE_MASK = 1 << LINKAGE_OFFSET
634 template <typename Enum> struct EnumTraits : public std::false_type {};
636 template <> struct EnumTraits<Attribute> : public std::true_type {
637 static constexpr char Type[3] = "AT";
638 static constexpr StringRef (*StringFn)(unsigned) = &AttributeString;
641 template <> struct EnumTraits<Form> : public std::true_type {
642 static constexpr char Type[5] = "FORM";
643 static constexpr StringRef (*StringFn)(unsigned) = &FormEncodingString;
646 template <> struct EnumTraits<Index> : public std::true_type {
647 static constexpr char Type[4] = "IDX";
648 static constexpr StringRef (*StringFn)(unsigned) = &IndexString;
651 template <> struct EnumTraits<Tag> : public std::true_type {
652 static constexpr char Type[4] = "TAG";
653 static constexpr StringRef (*StringFn)(unsigned) = &TagString;
655 } // End of namespace dwarf
657 /// Dwarf constants format_provider
659 /// Specialization of the format_provider template for dwarf enums. Unlike the
660 /// dumping functions above, these format unknown enumerator values as
661 /// DW_TYPE_unknown_1234 (e.g. DW_TAG_unknown_ffff).
662 template <typename Enum>
663 struct format_provider<
664 Enum, typename std::enable_if<dwarf::EnumTraits<Enum>::value>::type> {
665 static void format(const Enum &E, raw_ostream &OS, StringRef Style) {
666 StringRef Str = dwarf::EnumTraits<Enum>::StringFn(E);
667 if (Str.empty()) {
668 OS << "DW_" << dwarf::EnumTraits<Enum>::Type << "_unknown_"
669 << llvm::format("%x", E);
670 } else
671 OS << Str;
674 } // End of namespace llvm
676 #endif