Home | History | Annotate | Download | only in include
      1 /* Declarations and definitions of codes relating to the DWARF2 and
      2    DWARF3 symbolic debugging information formats.
      3    Copyright (C) 1992-2016 Free Software Foundation, Inc.
      4 
      5    Written by Gary Funck (gary (at) intrepid.com) The Ada Joint Program
      6    Office (AJPO), Florida State University and Silicon Graphics Inc.
      7    provided support for this effort -- June 21, 1995.
      8 
      9    Derived from the DWARF 1 implementation written by Ron Guilmette
     10    (rfg (at) netcom.com), November 1990.
     11 
     12    This file is part of GCC.
     13 
     14    GCC is free software; you can redistribute it and/or modify it under
     15    the terms of the GNU General Public License as published by the Free
     16    Software Foundation; either version 3, or (at your option) any later
     17    version.
     18 
     19    GCC is distributed in the hope that it will be useful, but WITHOUT
     20    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
     21    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
     22    License for more details.
     23 
     24    Under Section 7 of GPL version 3, you are granted additional
     25    permissions described in the GCC Runtime Library Exception, version
     26    3.1, as published by the Free Software Foundation.
     27 
     28    You should have received a copy of the GNU General Public License and
     29    a copy of the GCC Runtime Library Exception along with this program;
     30    see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
     31    <http://www.gnu.org/licenses/>.  */
     32 
     33 /* This file is derived from the DWARF specification (a public document)
     34    Revision 2.0.0 (July 27, 1993) developed by the UNIX International
     35    Programming Languages Special Interest Group (UI/PLSIG) and distributed
     36    by UNIX International.  Copies of this specification are available from
     37    UNIX International, 20 Waterview Boulevard, Parsippany, NJ, 07054.
     38 
     39    This file also now contains definitions from the DWARF 3 specification
     40    published Dec 20, 2005, available from: http://dwarf.freestandards.org.  */
     41 
     42 #ifndef _DWARF2_H
     43 #define _DWARF2_H
     44 
     45 #define DW_TAG(name, value) , name = value
     46 #define DW_TAG_DUP(name, value) , name = value
     47 #define DW_FORM(name, value) , name = value
     48 #define DW_AT(name, value) , name = value
     49 #define DW_AT_DUP(name, value) , name = value
     50 #define DW_OP(name, value) , name = value
     51 #define DW_OP_DUP(name, value) , name = value
     52 #define DW_ATE(name, value) , name = value
     53 #define DW_ATE_DUP(name, value) , name = value
     54 #define DW_CFA(name, value) , name = value
     55 
     56 #define DW_FIRST_TAG(name, value) enum dwarf_tag { \
     57   name = value
     58 #define DW_END_TAG };
     59 #define DW_FIRST_FORM(name, value) enum dwarf_form { \
     60   name = value
     61 #define DW_END_FORM };
     62 #define DW_FIRST_AT(name, value) enum dwarf_attribute { \
     63   name = value
     64 #define DW_END_AT };
     65 #define DW_FIRST_OP(name, value) enum dwarf_location_atom { \
     66   name = value
     67 #define DW_END_OP };
     68 #define DW_FIRST_ATE(name, value) enum dwarf_type { \
     69   name = value
     70 #define DW_END_ATE };
     71 #define DW_FIRST_CFA(name, value) enum dwarf_call_frame_info { \
     72   name = value
     73 #define DW_END_CFA };
     74 
     75 #include "dwarf2.def"
     76 
     77 #undef DW_FIRST_TAG
     78 #undef DW_END_TAG
     79 #undef DW_FIRST_FORM
     80 #undef DW_END_FORM
     81 #undef DW_FIRST_AT
     82 #undef DW_END_AT
     83 #undef DW_FIRST_OP
     84 #undef DW_END_OP
     85 #undef DW_FIRST_ATE
     86 #undef DW_END_ATE
     87 #undef DW_FIRST_CFA
     88 #undef DW_END_CFA
     89 
     90 #undef DW_TAG
     91 #undef DW_TAG_DUP
     92 #undef DW_FORM
     93 #undef DW_AT
     94 #undef DW_AT_DUP
     95 #undef DW_OP
     96 #undef DW_OP_DUP
     97 #undef DW_ATE
     98 #undef DW_ATE_DUP
     99 #undef DW_CFA
    100 
    101 /* Flag that tells whether entry has a child or not.  */
    102 #define DW_children_no   0
    103 #define	DW_children_yes  1
    104 
    105 #define DW_AT_stride_size   DW_AT_bit_stride  /* Note: The use of DW_AT_stride_size is deprecated.  */
    106 #define DW_AT_stride   DW_AT_byte_stride  /* Note: The use of DW_AT_stride is deprecated.  */
    107 
    108 /* Decimal sign encodings.  */
    109 enum dwarf_decimal_sign_encoding
    110   {
    111     /* DWARF 3.  */
    112     DW_DS_unsigned = 0x01,
    113     DW_DS_leading_overpunch = 0x02,
    114     DW_DS_trailing_overpunch = 0x03,
    115     DW_DS_leading_separate = 0x04,
    116     DW_DS_trailing_separate = 0x05
    117   };
    118 
    119 /* Endianity encodings.  */
    120 enum dwarf_endianity_encoding
    121   {
    122     /* DWARF 3.  */
    123     DW_END_default = 0x00,
    124     DW_END_big = 0x01,
    125     DW_END_little = 0x02,
    126 
    127     DW_END_lo_user = 0x40,
    128     DW_END_hi_user = 0xff
    129   };
    130 
    131 /* Array ordering names and codes.  */
    132 enum dwarf_array_dim_ordering
    133   {
    134     DW_ORD_row_major = 0,
    135     DW_ORD_col_major = 1
    136   };
    137 
    138 /* Access attribute.  */
    139 enum dwarf_access_attribute
    140   {
    141     DW_ACCESS_public = 1,
    142     DW_ACCESS_protected = 2,
    143     DW_ACCESS_private = 3
    144   };
    145 
    146 /* Visibility.  */
    147 enum dwarf_visibility_attribute
    148   {
    149     DW_VIS_local = 1,
    150     DW_VIS_exported = 2,
    151     DW_VIS_qualified = 3
    152   };
    153 
    154 /* Virtuality.  */
    155 enum dwarf_virtuality_attribute
    156   {
    157     DW_VIRTUALITY_none = 0,
    158     DW_VIRTUALITY_virtual = 1,
    159     DW_VIRTUALITY_pure_virtual = 2
    160   };
    161 
    162 /* Case sensitivity.  */
    163 enum dwarf_id_case
    164   {
    165     DW_ID_case_sensitive = 0,
    166     DW_ID_up_case = 1,
    167     DW_ID_down_case = 2,
    168     DW_ID_case_insensitive = 3
    169   };
    170 
    171 /* Calling convention.  */
    172 enum dwarf_calling_convention
    173   {
    174     DW_CC_normal = 0x1,
    175     DW_CC_program = 0x2,
    176     DW_CC_nocall = 0x3,
    177 
    178     DW_CC_lo_user = 0x40,
    179     DW_CC_hi_user = 0xff,
    180 
    181     DW_CC_GNU_renesas_sh = 0x40,
    182     DW_CC_GNU_borland_fastcall_i386 = 0x41,
    183 
    184     /* This DW_CC_ value is not currently generated by any toolchain.  It is
    185        used internally to GDB to indicate OpenCL C functions that have been
    186        compiled with the IBM XL C for OpenCL compiler and use a non-platform
    187        calling convention for passing OpenCL C vector types.  This value may
    188        be changed freely as long as it does not conflict with any other DW_CC_
    189        value defined here.  */
    190     DW_CC_GDB_IBM_OpenCL = 0xff
    191   };
    192 
    193 /* Inline attribute.  */
    194 enum dwarf_inline_attribute
    195   {
    196     DW_INL_not_inlined = 0,
    197     DW_INL_inlined = 1,
    198     DW_INL_declared_not_inlined = 2,
    199     DW_INL_declared_inlined = 3
    200   };
    201 
    202 /* Discriminant lists.  */
    203 enum dwarf_discrim_list
    204   {
    205     DW_DSC_label = 0,
    206     DW_DSC_range = 1
    207   };
    208 
    209 /* Line number opcodes.  */
    210 enum dwarf_line_number_ops
    211   {
    212     DW_LNS_extended_op = 0,
    213     DW_LNS_copy = 1,
    214     DW_LNS_advance_pc = 2,
    215     DW_LNS_advance_line = 3,
    216     DW_LNS_set_file = 4,
    217     DW_LNS_set_column = 5,
    218     DW_LNS_negate_stmt = 6,
    219     DW_LNS_set_basic_block = 7,
    220     DW_LNS_const_add_pc = 8,
    221     DW_LNS_fixed_advance_pc = 9,
    222     /* DWARF 3.  */
    223     DW_LNS_set_prologue_end = 10,
    224     DW_LNS_set_epilogue_begin = 11,
    225     DW_LNS_set_isa = 12,
    226     /* Experimental DWARF 5 extensions.
    227        See http://wiki.dwarfstd.org/index.php?title=TwoLevelLineTables.  */
    228     DW_LNS_set_address_from_logical = 13, /* Actuals table only.  */
    229     DW_LNS_set_subprogram = 13,           /* Logicals table only.  */
    230     DW_LNS_inlined_call = 14,             /* Logicals table only.  */
    231     DW_LNS_pop_context = 15               /* Logicals table only.  */
    232   };
    233 
    234 /* Line number extended opcodes.  */
    235 enum dwarf_line_number_x_ops
    236   {
    237     DW_LNE_end_sequence = 1,
    238     DW_LNE_set_address = 2,
    239     DW_LNE_define_file = 3,
    240     DW_LNE_set_discriminator = 4,
    241     /* HP extensions.  */
    242     DW_LNE_HP_negate_is_UV_update      = 0x11,
    243     DW_LNE_HP_push_context             = 0x12,
    244     DW_LNE_HP_pop_context              = 0x13,
    245     DW_LNE_HP_set_file_line_column     = 0x14,
    246     DW_LNE_HP_set_routine_name         = 0x15,
    247     DW_LNE_HP_set_sequence             = 0x16,
    248     DW_LNE_HP_negate_post_semantics    = 0x17,
    249     DW_LNE_HP_negate_function_exit     = 0x18,
    250     DW_LNE_HP_negate_front_end_logical = 0x19,
    251     DW_LNE_HP_define_proc              = 0x20,
    252     DW_LNE_HP_source_file_correlation  = 0x80,
    253 
    254     DW_LNE_lo_user = 0x80,
    255     DW_LNE_hi_user = 0xff
    256   };
    257 
    258 /* Sub-opcodes for DW_LNE_HP_source_file_correlation.  */
    259 enum dwarf_line_number_hp_sfc_ops
    260   {
    261     DW_LNE_HP_SFC_formfeed = 1,
    262     DW_LNE_HP_SFC_set_listing_line = 2,
    263     DW_LNE_HP_SFC_associate = 3
    264   };
    265 
    266 /* Type codes for location list entries.
    267    Extension for Fission.  See http://gcc.gnu.org/wiki/DebugFission.  */
    268 
    269 enum dwarf_location_list_entry_type
    270   {
    271     DW_LLE_GNU_end_of_list_entry = 0,
    272     DW_LLE_GNU_base_address_selection_entry = 1,
    273     DW_LLE_GNU_start_end_entry = 2,
    274     DW_LLE_GNU_start_length_entry = 3
    275   };
    276 
    277 /* Type codes for line number program content descriptors (DWARF 5).  */
    278 
    279 enum dwarf_line_number_content_type
    280   {
    281     DW_LNCT_path = 1,
    282     DW_LNCT_directory_index = 2,
    283     DW_LNCT_timestamp = 3,
    284     DW_LNCT_size = 4,
    285     DW_LNCT_MD5 = 5,
    286     /* Experimental DWARF 5 extensions.
    287        See http://wiki.dwarfstd.org/index.php?title=TwoLevelLineTables.  */
    288     DW_LNCT_subprogram_name = 6,
    289     DW_LNCT_decl_file = 7,
    290     DW_LNCT_decl_line = 8
    291   };
    292 
    293 #define DW_CIE_ID	  0xffffffff
    294 #define DW64_CIE_ID	  0xffffffffffffffffULL
    295 #define DW_CIE_VERSION	  1
    296 
    297 #define DW_CFA_extended   0
    298 
    299 #define DW_CHILDREN_no		     0x00
    300 #define DW_CHILDREN_yes		     0x01
    301 
    302 #define DW_ADDR_none		0
    303 
    304 /* Source language names and codes.  */
    305 enum dwarf_source_language
    306   {
    307     DW_LANG_C89 = 0x0001,
    308     DW_LANG_C = 0x0002,
    309     DW_LANG_Ada83 = 0x0003,
    310     DW_LANG_C_plus_plus = 0x0004,
    311     DW_LANG_Cobol74 = 0x0005,
    312     DW_LANG_Cobol85 = 0x0006,
    313     DW_LANG_Fortran77 = 0x0007,
    314     DW_LANG_Fortran90 = 0x0008,
    315     DW_LANG_Pascal83 = 0x0009,
    316     DW_LANG_Modula2 = 0x000a,
    317     /* DWARF 3.  */
    318     DW_LANG_Java = 0x000b,
    319     DW_LANG_C99 = 0x000c,
    320     DW_LANG_Ada95 = 0x000d,
    321     DW_LANG_Fortran95 = 0x000e,
    322     DW_LANG_PLI = 0x000f,
    323     DW_LANG_ObjC = 0x0010,
    324     DW_LANG_ObjC_plus_plus = 0x0011,
    325     DW_LANG_UPC = 0x0012,
    326     DW_LANG_D = 0x0013,
    327     /* DWARF 4.  */
    328     DW_LANG_Python = 0x0014,
    329     /* DWARF 5.  */
    330     DW_LANG_Go = 0x0016,
    331 
    332     DW_LANG_C_plus_plus_11 = 0x001a, /* dwarf5.20141029.pdf DRAFT */
    333     DW_LANG_Rust = 0x001c,
    334     DW_LANG_C11 = 0x001d,
    335     DW_LANG_C_plus_plus_14 = 0x0021,
    336     DW_LANG_Fortran03 = 0x0022,
    337     DW_LANG_Fortran08 = 0x0023,
    338 
    339     DW_LANG_lo_user = 0x8000,	/* Implementation-defined range start.  */
    340     DW_LANG_hi_user = 0xffff,	/* Implementation-defined range start.  */
    341 
    342     /* MIPS.  */
    343     DW_LANG_Mips_Assembler = 0x8001,
    344     /* UPC.  */
    345     DW_LANG_Upc = 0x8765,
    346     /* HP extensions.  */
    347     DW_LANG_HP_Bliss     = 0x8003,
    348     DW_LANG_HP_Basic91   = 0x8004,
    349     DW_LANG_HP_Pascal91  = 0x8005,
    350     DW_LANG_HP_IMacro    = 0x8006,
    351     DW_LANG_HP_Assembler = 0x8007,
    352 
    353     /* Rust extension, but replaced in DWARF 5.  */
    354     DW_LANG_Rust_old = 0x9000
    355   };
    356 
    357 /* Names and codes for macro information.  */
    358 enum dwarf_macinfo_record_type
    359   {
    360     DW_MACINFO_define = 1,
    361     DW_MACINFO_undef = 2,
    362     DW_MACINFO_start_file = 3,
    363     DW_MACINFO_end_file = 4,
    364     DW_MACINFO_vendor_ext = 255
    365   };
    366 
    367 /* Names and codes for new style macro information.  */
    368 enum dwarf_macro_record_type
    369   {
    370     DW_MACRO_GNU_define = 1,
    371     DW_MACRO_GNU_undef = 2,
    372     DW_MACRO_GNU_start_file = 3,
    373     DW_MACRO_GNU_end_file = 4,
    374     DW_MACRO_GNU_define_indirect = 5,
    375     DW_MACRO_GNU_undef_indirect = 6,
    376     DW_MACRO_GNU_transparent_include = 7,
    377     /* Extensions for DWZ multifile.
    378        See http://www.dwarfstd.org/ShowIssue.php?issue=120604.1&type=open .  */
    379     DW_MACRO_GNU_define_indirect_alt = 8,
    380     DW_MACRO_GNU_undef_indirect_alt = 9,
    381     DW_MACRO_GNU_transparent_include_alt = 10,
    382     DW_MACRO_GNU_lo_user = 0xe0,
    383     DW_MACRO_GNU_hi_user = 0xff
    384   };
    385 
    386 /* @@@ For use with GNU frame unwind information.  */
    388 
    389 #define DW_EH_PE_absptr		0x00
    390 #define DW_EH_PE_omit		0xff
    391 
    392 #define DW_EH_PE_uleb128	0x01
    393 #define DW_EH_PE_udata2		0x02
    394 #define DW_EH_PE_udata4		0x03
    395 #define DW_EH_PE_udata8		0x04
    396 #define DW_EH_PE_sleb128	0x09
    397 #define DW_EH_PE_sdata2		0x0A
    398 #define DW_EH_PE_sdata4		0x0B
    399 #define DW_EH_PE_sdata8		0x0C
    400 #define DW_EH_PE_signed		0x08
    401 
    402 #define DW_EH_PE_pcrel		0x10
    403 #define DW_EH_PE_textrel	0x20
    404 #define DW_EH_PE_datarel	0x30
    405 #define DW_EH_PE_funcrel	0x40
    406 #define DW_EH_PE_aligned	0x50
    407 
    408 #define DW_EH_PE_indirect	0x80
    409 
    410 /* Codes for the debug sections in a dwarf package (.dwp) file.
    411    Extensions for Fission.  See http://gcc.gnu.org/wiki/DebugFissionDWP.  */
    412 enum dwarf_sect
    413   {
    414     DW_SECT_INFO = 1,
    415     DW_SECT_TYPES = 2,
    416     DW_SECT_ABBREV = 3,
    417     DW_SECT_LINE = 4,
    418     DW_SECT_LOC = 5,
    419     DW_SECT_STR_OFFSETS = 6,
    420     DW_SECT_MACINFO = 7,
    421     DW_SECT_MACRO = 8,
    422     DW_SECT_MAX = 8
    423   };
    424 
    425 #ifdef __cplusplus
    426 extern "C" {
    427 #endif /* __cplusplus */
    428 
    429 /* Return the name of a DW_TAG_ constant, or NULL if the value is not
    430    recognized.  */
    431 extern const char *get_DW_TAG_name (unsigned int tag);
    432 
    433 /* Return the name of a DW_AT_ constant, or NULL if the value is not
    434    recognized.  */
    435 extern const char *get_DW_AT_name (unsigned int attr);
    436 
    437 /* Return the name of a DW_FORM_ constant, or NULL if the value is not
    438    recognized.  */
    439 extern const char *get_DW_FORM_name (unsigned int form);
    440 
    441 /* Return the name of a DW_OP_ constant, or NULL if the value is not
    442    recognized.  */
    443 extern const char *get_DW_OP_name (unsigned int op);
    444 
    445 /* Return the name of a DW_ATE_ constant, or NULL if the value is not
    446    recognized.  */
    447 extern const char *get_DW_ATE_name (unsigned int enc);
    448 
    449 /* Return the name of a DW_CFA_ constant, or NULL if the value is not
    450    recognized.  */
    451 extern const char *get_DW_CFA_name (unsigned int opc);
    452 
    453 #ifdef __cplusplus
    454 }
    455 #endif /* __cplusplus */
    456 
    457 #endif /* _DWARF2_H */
    458