include/dwarf2.h

   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@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@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   };
 227
 228 /* Line number extended opcodes.  */
 229 enum dwarf_line_number_x_ops
 230   {
 231     DW_LNE_end_sequence = 1,
 232     DW_LNE_set_address = 2,
 233     DW_LNE_define_file = 3,
 234     DW_LNE_set_discriminator = 4,
 235     /* HP extensions.  */
 236     DW_LNE_HP_negate_is_UV_update      = 0x11,
 237     DW_LNE_HP_push_context             = 0x12,
 238     DW_LNE_HP_pop_context              = 0x13,
 239     DW_LNE_HP_set_file_line_column     = 0x14,
 240     DW_LNE_HP_set_routine_name         = 0x15,
 241     DW_LNE_HP_set_sequence             = 0x16,
 242     DW_LNE_HP_negate_post_semantics    = 0x17,
 243     DW_LNE_HP_negate_function_exit     = 0x18,
 244     DW_LNE_HP_negate_front_end_logical = 0x19,
 245     DW_LNE_HP_define_proc              = 0x20,
 246     DW_LNE_HP_source_file_correlation  = 0x80,
 247
 248     DW_LNE_lo_user = 0x80,
 249     DW_LNE_hi_user = 0xff
 250   };
 251
 252 /* Sub-opcodes for DW_LNE_HP_source_file_correlation.  */
 253 enum dwarf_line_number_hp_sfc_ops
 254   {
 255     DW_LNE_HP_SFC_formfeed = 1,
 256     DW_LNE_HP_SFC_set_listing_line = 2,
 257     DW_LNE_HP_SFC_associate = 3
 258   };
 259
 260 /* Type codes for location list entries.
 261    Extension for Fission.  See http://gcc.gnu.org/wiki/DebugFission.  */
 262
 263 enum dwarf_location_list_entry_type
 264   {
 265     DW_LLE_GNU_end_of_list_entry = 0,
 266     DW_LLE_GNU_base_address_selection_entry = 1,
 267     DW_LLE_GNU_start_end_entry = 2,
 268     DW_LLE_GNU_start_length_entry = 3
 269   };
 270
 271 #define DW_CIE_ID         0xffffffff
 272 #define DW64_CIE_ID       0xffffffffffffffffULL
 273 #define DW_CIE_VERSION    1
 274
 275 #define DW_CFA_extended   0
 276
 277 #define DW_CHILDREN_no               0x00
 278 #define DW_CHILDREN_yes              0x01
 279
 280 #define DW_ADDR_none            0
 281
 282 /* Source language names and codes.  */
 283 enum dwarf_source_language
 284   {
 285     DW_LANG_C89 = 0x0001,
 286     DW_LANG_C = 0x0002,
 287     DW_LANG_Ada83 = 0x0003,
 288     DW_LANG_C_plus_plus = 0x0004,
 289     DW_LANG_Cobol74 = 0x0005,
 290     DW_LANG_Cobol85 = 0x0006,
 291     DW_LANG_Fortran77 = 0x0007,
 292     DW_LANG_Fortran90 = 0x0008,
 293     DW_LANG_Pascal83 = 0x0009,
 294     DW_LANG_Modula2 = 0x000a,
 295     /* DWARF 3.  */
 296     DW_LANG_Java = 0x000b,
 297     DW_LANG_C99 = 0x000c,
 298     DW_LANG_Ada95 = 0x000d,
 299     DW_LANG_Fortran95 = 0x000e,
 300     DW_LANG_PLI = 0x000f,
 301     DW_LANG_ObjC = 0x0010,
 302     DW_LANG_ObjC_plus_plus = 0x0011,
 303     DW_LANG_UPC = 0x0012,
 304     DW_LANG_D = 0x0013,
 305     /* DWARF 4.  */
 306     DW_LANG_Python = 0x0014,
 307     /* DWARF 5.  */
 308     DW_LANG_Go = 0x0016,
 309
 310     DW_LANG_C_plus_plus_11 = 0x001a, /* dwarf5.20141029.pdf DRAFT */
 311     DW_LANG_Rust = 0x001c,
 312     DW_LANG_C11 = 0x001d,
 313     DW_LANG_C_plus_plus_14 = 0x0021,
 314     DW_LANG_Fortran03 = 0x0022,
 315     DW_LANG_Fortran08 = 0x0023,
 316
 317     DW_LANG_lo_user = 0x8000,   /* Implementation-defined range start.  */
 318     DW_LANG_hi_user = 0xffff,   /* Implementation-defined range start.  */
 319
 320     /* MIPS.  */
 321     DW_LANG_Mips_Assembler = 0x8001,
 322     /* UPC.  */
 323     DW_LANG_Upc = 0x8765,
 324     /* HP extensions.  */
 325     DW_LANG_HP_Bliss     = 0x8003,
 326     DW_LANG_HP_Basic91   = 0x8004,
 327     DW_LANG_HP_Pascal91  = 0x8005,
 328     DW_LANG_HP_IMacro    = 0x8006,
 329     DW_LANG_HP_Assembler = 0x8007,
 330
 331     /* Rust extension, but replaced in DWARF 5.  */
 332     DW_LANG_Rust_old = 0x9000
 333   };
 334
 335 /* Names and codes for macro information.  */
 336 enum dwarf_macinfo_record_type
 337   {
 338     DW_MACINFO_define = 1,
 339     DW_MACINFO_undef = 2,
 340     DW_MACINFO_start_file = 3,
 341     DW_MACINFO_end_file = 4,
 342     DW_MACINFO_vendor_ext = 255
 343   };
 344
 345 /* Names and codes for new style macro information.  */
 346 enum dwarf_macro_record_type
 347   {
 348     DW_MACRO_GNU_define = 1,
 349     DW_MACRO_GNU_undef = 2,
 350     DW_MACRO_GNU_start_file = 3,
 351     DW_MACRO_GNU_end_file = 4,
 352     DW_MACRO_GNU_define_indirect = 5,
 353     DW_MACRO_GNU_undef_indirect = 6,
 354     DW_MACRO_GNU_transparent_include = 7,
 355     /* Extensions for DWZ multifile.
 356        See http://www.dwarfstd.org/ShowIssue.php?issue=120604.1&type=open .  */
 357     DW_MACRO_GNU_define_indirect_alt = 8,
 358     DW_MACRO_GNU_undef_indirect_alt = 9,
 359     DW_MACRO_GNU_transparent_include_alt = 10,
 360     DW_MACRO_GNU_lo_user = 0xe0,
 361     DW_MACRO_GNU_hi_user = 0xff
 362   };
 363 \f
 364 /* @@@ For use with GNU frame unwind information.  */
 365
 366 #define DW_EH_PE_absptr         0x00
 367 #define DW_EH_PE_omit           0xff
 368
 369 #define DW_EH_PE_uleb128        0x01
 370 #define DW_EH_PE_udata2         0x02
 371 #define DW_EH_PE_udata4         0x03
 372 #define DW_EH_PE_udata8         0x04
 373 #define DW_EH_PE_sleb128        0x09
 374 #define DW_EH_PE_sdata2         0x0A
 375 #define DW_EH_PE_sdata4         0x0B
 376 #define DW_EH_PE_sdata8         0x0C
 377 #define DW_EH_PE_signed         0x08
 378
 379 #define DW_EH_PE_pcrel          0x10
 380 #define DW_EH_PE_textrel        0x20
 381 #define DW_EH_PE_datarel        0x30
 382 #define DW_EH_PE_funcrel        0x40
 383 #define DW_EH_PE_aligned        0x50
 384
 385 #define DW_EH_PE_indirect       0x80
 386
 387 /* Codes for the debug sections in a dwarf package (.dwp) file.
 388    Extensions for Fission.  See http://gcc.gnu.org/wiki/DebugFissionDWP.  */
 389 enum dwarf_sect
 390   {
 391     DW_SECT_INFO = 1,
 392     DW_SECT_TYPES = 2,
 393     DW_SECT_ABBREV = 3,
 394     DW_SECT_LINE = 4,
 395     DW_SECT_LOC = 5,
 396     DW_SECT_STR_OFFSETS = 6,
 397     DW_SECT_MACINFO = 7,
 398     DW_SECT_MACRO = 8,
 399     DW_SECT_MAX = 8
 400   };
 401
 402 #ifdef __cplusplus
 403 extern "C" {
 404 #endif /* __cplusplus */
 405
 406 /* Return the name of a DW_TAG_ constant, or NULL if the value is not
 407    recognized.  */
 408 extern const char *get_DW_TAG_name (unsigned int tag);
 409
 410 /* Return the name of a DW_AT_ constant, or NULL if the value is not
 411    recognized.  */
 412 extern const char *get_DW_AT_name (unsigned int attr);
 413
 414 /* Return the name of a DW_FORM_ constant, or NULL if the value is not
 415    recognized.  */
 416 extern const char *get_DW_FORM_name (unsigned int form);
 417
 418 /* Return the name of a DW_OP_ constant, or NULL if the value is not
 419    recognized.  */
 420 extern const char *get_DW_OP_name (unsigned int op);
 421
 422 /* Return the name of a DW_ATE_ constant, or NULL if the value is not
 423    recognized.  */
 424 extern const char *get_DW_ATE_name (unsigned int enc);
 425
 426 /* Return the name of a DW_CFA_ constant, or NULL if the value is not
 427    recognized.  */
 428 extern const char *get_DW_CFA_name (unsigned int opc);
 429
 430 #ifdef __cplusplus
 431 }
 432 #endif /* __cplusplus */
 433
 434 #endif /* _DWARF2_H */