LCOV - code coverage report
Current view: top level - include/llvm/BinaryFormat - Dwarf.h (source / functions) Hit Total Coverage
Test: llvm-toolchain.info Lines: 52 56 92.9 %
Date: 2018-10-17 09:37:48 Functions: 5 8 62.5 %
Legend: Lines: hit not hit

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

Generated by: LCOV version 1.13