include/dwarf2.h

   1 /* Declarations and definitions of codes relating to the DWARF2 and
   2    DWARF3 symbolic debugging information formats.
   3    Copyright (C) 1992-2020 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 #define DW_CFA_DUP(name, value) , name = value
  56 #define DW_IDX(name, value) , name = value
  57 #define DW_IDX_DUP(name, value) , name = value
  58
  59 #define DW_FIRST_TAG(name, value) enum dwarf_tag { \
  60   name = value
  61 #define DW_END_TAG };
  62 #define DW_FIRST_FORM(name, value) enum dwarf_form { \
  63   name = value
  64 #define DW_END_FORM };
  65 #define DW_FIRST_AT(name, value) enum dwarf_attribute { \
  66   name = value
  67 #define DW_END_AT };
  68 #define DW_FIRST_OP(name, value) enum dwarf_location_atom { \
  69   name = value
  70 #define DW_END_OP };
  71 #define DW_FIRST_ATE(name, value) enum dwarf_type { \
  72   name = value
  73 #define DW_END_ATE };
  74 #define DW_FIRST_CFA(name, value) enum dwarf_call_frame_info { \
  75   name = value
  76 #define DW_END_CFA };
  77 #define DW_FIRST_IDX(name, value) enum dwarf_name_index_attribute { \
  78   name = value
  79 #define DW_END_IDX };
  80
  81 #include "dwarf2.def"
  82
  83 #undef DW_FIRST_TAG
  84 #undef DW_END_TAG
  85 #undef DW_FIRST_FORM
  86 #undef DW_END_FORM
  87 #undef DW_FIRST_AT
  88 #undef DW_END_AT
  89 #undef DW_FIRST_OP
  90 #undef DW_END_OP
  91 #undef DW_FIRST_ATE
  92 #undef DW_END_ATE
  93 #undef DW_FIRST_CFA
  94 #undef DW_END_CFA
  95 #undef DW_FIRST_IDX
  96 #undef DW_END_IDX
  97
  98 #undef DW_TAG
  99 #undef DW_TAG_DUP
 100 #undef DW_FORM
 101 #undef DW_AT
 102 #undef DW_AT_DUP
 103 #undef DW_OP
 104 #undef DW_OP_DUP
 105 #undef DW_ATE
 106 #undef DW_ATE_DUP
 107 #undef DW_CFA
 108 #undef DW_CFA_DUP
 109 #undef DW_IDX
 110 #undef DW_IDX_DUP
 111
 112 /* Flag that tells whether entry has a child or not.  */
 113 #define DW_children_no   0
 114 #define DW_children_yes  1
 115
 116 #define DW_AT_stride_size   DW_AT_bit_stride  /* Note: The use of DW_AT_stride_size is deprecated.  */
 117 #define DW_AT_stride   DW_AT_byte_stride  /* Note: The use of DW_AT_stride is deprecated.  */
 118
 119 /* Decimal sign encodings.  */
 120 enum dwarf_decimal_sign_encoding
 121   {
 122     /* DWARF 3.  */
 123     DW_DS_unsigned = 0x01,
 124     DW_DS_leading_overpunch = 0x02,
 125     DW_DS_trailing_overpunch = 0x03,
 126     DW_DS_leading_separate = 0x04,
 127     DW_DS_trailing_separate = 0x05
 128   };
 129
 130 /* Endianity encodings.  */
 131 enum dwarf_endianity_encoding
 132   {
 133     /* DWARF 3.  */
 134     DW_END_default = 0x00,
 135     DW_END_big = 0x01,
 136     DW_END_little = 0x02,
 137
 138     DW_END_lo_user = 0x40,
 139     DW_END_hi_user = 0xff
 140   };
 141
 142 /* Array ordering names and codes.  */
 143 enum dwarf_array_dim_ordering
 144   {
 145     DW_ORD_row_major = 0,
 146     DW_ORD_col_major = 1
 147   };
 148
 149 /* Access attribute.  */
 150 enum dwarf_access_attribute
 151   {
 152     DW_ACCESS_public = 1,
 153     DW_ACCESS_protected = 2,
 154     DW_ACCESS_private = 3
 155   };
 156
 157 /* Visibility.  */
 158 enum dwarf_visibility_attribute
 159   {
 160     DW_VIS_local = 1,
 161     DW_VIS_exported = 2,
 162     DW_VIS_qualified = 3
 163   };
 164
 165 /* Virtuality.  */
 166 enum dwarf_virtuality_attribute
 167   {
 168     DW_VIRTUALITY_none = 0,
 169     DW_VIRTUALITY_virtual = 1,
 170     DW_VIRTUALITY_pure_virtual = 2
 171   };
 172
 173 /* Case sensitivity.  */
 174 enum dwarf_id_case
 175   {
 176     DW_ID_case_sensitive = 0,
 177     DW_ID_up_case = 1,
 178     DW_ID_down_case = 2,
 179     DW_ID_case_insensitive = 3
 180   };
 181
 182 /* Calling convention.  */
 183 enum dwarf_calling_convention
 184   {
 185     DW_CC_normal = 0x1,
 186     DW_CC_program = 0x2,
 187     DW_CC_nocall = 0x3,
 188
 189     /* DWARF 5.  */
 190     DW_CC_pass_by_reference = 0x4,
 191     DW_CC_pass_by_value = 0x5,
 192
 193     DW_CC_lo_user = 0x40,
 194     DW_CC_hi_user = 0xff,
 195
 196     DW_CC_GNU_renesas_sh = 0x40,
 197     DW_CC_GNU_borland_fastcall_i386 = 0x41,
 198
 199     /* This DW_CC_ value is not currently generated by any toolchain.  It is
 200        used internally to GDB to indicate OpenCL C functions that have been
 201        compiled with the IBM XL C for OpenCL compiler and use a non-platform
 202        calling convention for passing OpenCL C vector types.  This value may
 203        be changed freely as long as it does not conflict with any other DW_CC_
 204        value defined here.  */
 205     DW_CC_GDB_IBM_OpenCL = 0xff
 206   };
 207
 208 /* Inline attribute.  */
 209 enum dwarf_inline_attribute
 210   {
 211     DW_INL_not_inlined = 0,
 212     DW_INL_inlined = 1,
 213     DW_INL_declared_not_inlined = 2,
 214     DW_INL_declared_inlined = 3
 215   };
 216
 217 /* Discriminant lists.  */
 218 enum dwarf_discrim_list
 219   {
 220     DW_DSC_label = 0,
 221     DW_DSC_range = 1
 222   };
 223
 224 /* Line number opcodes.  */
 225 enum dwarf_line_number_ops
 226   {
 227     DW_LNS_extended_op = 0,
 228     DW_LNS_copy = 1,
 229     DW_LNS_advance_pc = 2,
 230     DW_LNS_advance_line = 3,
 231     DW_LNS_set_file = 4,
 232     DW_LNS_set_column = 5,
 233     DW_LNS_negate_stmt = 6,
 234     DW_LNS_set_basic_block = 7,
 235     DW_LNS_const_add_pc = 8,
 236     DW_LNS_fixed_advance_pc = 9,
 237     /* DWARF 3.  */
 238     DW_LNS_set_prologue_end = 10,
 239     DW_LNS_set_epilogue_begin = 11,
 240     DW_LNS_set_isa = 12
 241   };
 242
 243 /* Line number extended opcodes.  */
 244 enum dwarf_line_number_x_ops
 245   {
 246     DW_LNE_end_sequence = 1,
 247     DW_LNE_set_address = 2,
 248     DW_LNE_define_file = 3,
 249     DW_LNE_set_discriminator = 4,
 250     /* HP extensions.  */
 251     DW_LNE_HP_negate_is_UV_update      = 0x11,
 252     DW_LNE_HP_push_context             = 0x12,
 253     DW_LNE_HP_pop_context              = 0x13,
 254     DW_LNE_HP_set_file_line_column     = 0x14,
 255     DW_LNE_HP_set_routine_name         = 0x15,
 256     DW_LNE_HP_set_sequence             = 0x16,
 257     DW_LNE_HP_negate_post_semantics    = 0x17,
 258     DW_LNE_HP_negate_function_exit     = 0x18,
 259     DW_LNE_HP_negate_front_end_logical = 0x19,
 260     DW_LNE_HP_define_proc              = 0x20,
 261     DW_LNE_HP_source_file_correlation  = 0x80,
 262
 263     DW_LNE_lo_user = 0x80,
 264     DW_LNE_hi_user = 0xff
 265   };
 266
 267 /* Sub-opcodes for DW_LNE_HP_source_file_correlation.  */
 268 enum dwarf_line_number_hp_sfc_ops
 269   {
 270     DW_LNE_HP_SFC_formfeed = 1,
 271     DW_LNE_HP_SFC_set_listing_line = 2,
 272     DW_LNE_HP_SFC_associate = 3
 273   };
 274
 275 /* Content type codes in line table directory_entry_format
 276    and file_name_entry_format sequences.  */
 277 enum dwarf_line_number_content_type
 278   {
 279     DW_LNCT_path = 0x1,
 280     DW_LNCT_directory_index = 0x2,
 281     DW_LNCT_timestamp = 0x3,
 282     DW_LNCT_size = 0x4,
 283     DW_LNCT_MD5 = 0x5,
 284     DW_LNCT_lo_user = 0x2000,
 285     DW_LNCT_hi_user = 0x3fff
 286   };
 287
 288 /* Type codes for location list entries.  */
 289 enum dwarf_location_list_entry_type
 290   {
 291     DW_LLE_end_of_list = 0x00,
 292     DW_LLE_base_addressx = 0x01,
 293     DW_LLE_startx_endx = 0x02,
 294     DW_LLE_startx_length = 0x03,
 295     DW_LLE_offset_pair = 0x04,
 296     DW_LLE_default_location = 0x05,
 297     DW_LLE_base_address = 0x06,
 298     DW_LLE_start_end = 0x07,
 299     DW_LLE_start_length = 0x08,
 300
 301     /* <http://lists.dwarfstd.org/private.cgi/dwarf-discuss-dwarfstd.org/2017-April/004347.html>
 302        has the proposal for now; only available to list members.
 303
 304        A (possibly updated) copy of the proposal is available at
 305        <http://people.redhat.com/aoliva/papers/sfn/dwarf6-sfn-lvu.txt>.  */
 306     DW_LLE_GNU_view_pair = 0x09,
 307 #define DW_LLE_view_pair DW_LLE_GNU_view_pair
 308
 309     /* Former extension for Fission.
 310        See http://gcc.gnu.org/wiki/DebugFission.  */
 311     DW_LLE_GNU_end_of_list_entry = 0x00,
 312     DW_LLE_GNU_base_address_selection_entry = 0x01,
 313     DW_LLE_GNU_start_end_entry = 0x02,
 314     DW_LLE_GNU_start_length_entry = 0x03
 315   };
 316
 317 #define DW_CIE_ID         0xffffffff
 318 #define DW64_CIE_ID       0xffffffffffffffffULL
 319
 320 #define DW_CFA_extended   0
 321
 322 #define DW_CHILDREN_no               0x00
 323 #define DW_CHILDREN_yes              0x01
 324
 325 #define DW_ADDR_none            0
 326
 327 /* Source language names and codes.  */
 328 enum dwarf_source_language
 329   {
 330     DW_LANG_C89 = 0x0001,
 331     DW_LANG_C = 0x0002,
 332     DW_LANG_Ada83 = 0x0003,
 333     DW_LANG_C_plus_plus = 0x0004,
 334     DW_LANG_Cobol74 = 0x0005,
 335     DW_LANG_Cobol85 = 0x0006,
 336     DW_LANG_Fortran77 = 0x0007,
 337     DW_LANG_Fortran90 = 0x0008,
 338     DW_LANG_Pascal83 = 0x0009,
 339     DW_LANG_Modula2 = 0x000a,
 340     /* DWARF 3.  */
 341     DW_LANG_Java = 0x000b,
 342     DW_LANG_C99 = 0x000c,
 343     DW_LANG_Ada95 = 0x000d,
 344     DW_LANG_Fortran95 = 0x000e,
 345     DW_LANG_PLI = 0x000f,
 346     DW_LANG_ObjC = 0x0010,
 347     DW_LANG_ObjC_plus_plus = 0x0011,
 348     DW_LANG_UPC = 0x0012,
 349     DW_LANG_D = 0x0013,
 350     /* DWARF 4.  */
 351     DW_LANG_Python = 0x0014,
 352     /* DWARF 5.  */
 353     DW_LANG_OpenCL = 0x0015,
 354     DW_LANG_Go = 0x0016,
 355     DW_LANG_Modula3 = 0x0017,
 356     DW_LANG_Haskell = 0x0018,
 357     DW_LANG_C_plus_plus_03 = 0x0019,
 358     DW_LANG_C_plus_plus_11 = 0x001a,
 359     DW_LANG_OCaml = 0x001b,
 360     DW_LANG_Rust = 0x001c,
 361     DW_LANG_C11 = 0x001d,
 362     DW_LANG_Swift = 0x001e,
 363     DW_LANG_Julia = 0x001f,
 364     DW_LANG_Dylan = 0x0020,
 365     DW_LANG_C_plus_plus_14 = 0x0021,
 366     DW_LANG_Fortran03 = 0x0022,
 367     DW_LANG_Fortran08 = 0x0023,
 368     DW_LANG_RenderScript = 0x0024,
 369
 370     DW_LANG_lo_user = 0x8000,   /* Implementation-defined range start.  */
 371     DW_LANG_hi_user = 0xffff,   /* Implementation-defined range start.  */
 372
 373     /* MIPS.  */
 374     DW_LANG_Mips_Assembler = 0x8001,
 375     /* UPC.  */
 376     DW_LANG_Upc = 0x8765,
 377     /* HP extensions.  */
 378     DW_LANG_HP_Bliss     = 0x8003,
 379     DW_LANG_HP_Basic91   = 0x8004,
 380     DW_LANG_HP_Pascal91  = 0x8005,
 381     DW_LANG_HP_IMacro    = 0x8006,
 382     DW_LANG_HP_Assembler = 0x8007,
 383
 384     /* Rust extension, but replaced in DWARF 5.  */
 385     DW_LANG_Rust_old = 0x9000
 386   };
 387
 388 /* Names and codes for macro information.  */
 389 enum dwarf_macinfo_record_type
 390   {
 391     DW_MACINFO_define = 1,
 392     DW_MACINFO_undef = 2,
 393     DW_MACINFO_start_file = 3,
 394     DW_MACINFO_end_file = 4,
 395     DW_MACINFO_vendor_ext = 255
 396   };
 397
 398 /* DW_TAG_defaulted/DW_TAG_GNU_defaulted attributes.  */
 399 enum dwarf_defaulted_attribute
 400   {
 401     DW_DEFAULTED_no = 0x00,
 402     DW_DEFAULTED_in_class = 0x01,
 403     DW_DEFAULTED_out_of_class = 0x02
 404   };
 405
 406 /* Names and codes for new style macro information.  */
 407 enum dwarf_macro_record_type
 408   {
 409     DW_MACRO_define = 0x01,
 410     DW_MACRO_undef = 0x02,
 411     DW_MACRO_start_file = 0x03,
 412     DW_MACRO_end_file = 0x04,
 413     DW_MACRO_define_strp = 0x05,
 414     DW_MACRO_undef_strp = 0x06,
 415     DW_MACRO_import = 0x07,
 416     DW_MACRO_define_sup = 0x08,
 417     DW_MACRO_undef_sup = 0x09,
 418     DW_MACRO_import_sup = 0x0a,
 419     DW_MACRO_define_strx = 0x0b,
 420     DW_MACRO_undef_strx = 0x0c,
 421     DW_MACRO_lo_user = 0xe0,
 422     DW_MACRO_hi_user = 0xff,
 423
 424     /* Compatibility macros for the GNU .debug_macro extension.  */
 425     DW_MACRO_GNU_define = 0x01,
 426     DW_MACRO_GNU_undef = 0x02,
 427     DW_MACRO_GNU_start_file = 0x03,
 428     DW_MACRO_GNU_end_file = 0x04,
 429     DW_MACRO_GNU_define_indirect = 0x05,
 430     DW_MACRO_GNU_undef_indirect = 0x06,
 431     DW_MACRO_GNU_transparent_include = 0x07,
 432     /* Extensions for DWZ multifile.
 433        See http://www.dwarfstd.org/ShowIssue.php?issue=120604.1&type=open .  */
 434     DW_MACRO_GNU_define_indirect_alt = 0x08,
 435     DW_MACRO_GNU_undef_indirect_alt = 0x09,
 436     DW_MACRO_GNU_transparent_include_alt = 0x0a,
 437     DW_MACRO_GNU_lo_user = 0xe0,
 438     DW_MACRO_GNU_hi_user = 0xff
 439   };
 440
 441 /* Range list entry kinds in .debug_rnglists* section.  */
 442 enum dwarf_range_list_entry
 443   {
 444     DW_RLE_end_of_list = 0x00,
 445     DW_RLE_base_addressx = 0x01,
 446     DW_RLE_startx_endx = 0x02,
 447     DW_RLE_startx_length = 0x03,
 448     DW_RLE_offset_pair = 0x04,
 449     DW_RLE_base_address = 0x05,
 450     DW_RLE_start_end = 0x06,
 451     DW_RLE_start_length = 0x07
 452   };
 453
 454 /* Unit types in unit_type unit header field.  */
 455 enum dwarf_unit_type
 456   {
 457     DW_UT_compile = 0x01,
 458     DW_UT_type = 0x02,
 459     DW_UT_partial = 0x03,
 460     DW_UT_skeleton = 0x04,
 461     DW_UT_split_compile = 0x05,
 462     DW_UT_split_type = 0x06,
 463     DW_UT_lo_user = 0x80,
 464     DW_UT_hi_user = 0xff
 465   };
 466 \f
 467 /* @@@ For use with GNU frame unwind information.  */
 468
 469 #define DW_EH_PE_absptr         0x00
 470 #define DW_EH_PE_omit           0xff
 471
 472 #define DW_EH_PE_uleb128        0x01
 473 #define DW_EH_PE_udata2         0x02
 474 #define DW_EH_PE_udata4         0x03
 475 #define DW_EH_PE_udata8         0x04
 476 #define DW_EH_PE_sleb128        0x09
 477 #define DW_EH_PE_sdata2         0x0A
 478 #define DW_EH_PE_sdata4         0x0B
 479 #define DW_EH_PE_sdata8         0x0C
 480 #define DW_EH_PE_signed         0x08
 481
 482 #define DW_EH_PE_pcrel          0x10
 483 #define DW_EH_PE_textrel        0x20
 484 #define DW_EH_PE_datarel        0x30
 485 #define DW_EH_PE_funcrel        0x40
 486 #define DW_EH_PE_aligned        0x50
 487
 488 #define DW_EH_PE_indirect       0x80
 489
 490 /* Codes for the debug sections in a dwarf package (.dwp) file.
 491    Extensions for Fission.  See http://gcc.gnu.org/wiki/DebugFissionDWP.  */
 492 enum dwarf_sect
 493   {
 494     DW_SECT_INFO = 1,
 495     DW_SECT_TYPES = 2,
 496     DW_SECT_ABBREV = 3,
 497     DW_SECT_LINE = 4,
 498     DW_SECT_LOC = 5,
 499     DW_SECT_STR_OFFSETS = 6,
 500     DW_SECT_MACINFO = 7,
 501     DW_SECT_MACRO = 8,
 502     DW_SECT_MAX = 8
 503   };
 504
 505 #ifdef __cplusplus
 506 extern "C" {
 507 #endif /* __cplusplus */
 508
 509 /* Return the name of a DW_TAG_ constant, or NULL if the value is not
 510    recognized.  */
 511 extern const char *get_DW_TAG_name (unsigned int tag);
 512
 513 /* Return the name of a DW_AT_ constant, or NULL if the value is not
 514    recognized.  */
 515 extern const char *get_DW_AT_name (unsigned int attr);
 516
 517 /* Return the name of a DW_FORM_ constant, or NULL if the value is not
 518    recognized.  */
 519 extern const char *get_DW_FORM_name (unsigned int form);
 520
 521 /* Return the name of a DW_OP_ constant, or NULL if the value is not
 522    recognized.  */
 523 extern const char *get_DW_OP_name (unsigned int op);
 524
 525 /* Return the name of a DW_ATE_ constant, or NULL if the value is not
 526    recognized.  */
 527 extern const char *get_DW_ATE_name (unsigned int enc);
 528
 529 /* Return the name of a DW_CFA_ constant, or NULL if the value is not
 530    recognized.  */
 531 extern const char *get_DW_CFA_name (unsigned int opc);
 532
 533 /* Return the name of a DW_IDX_ constant, or NULL if the value is not
 534    recognized.  */
 535 extern const char *get_DW_IDX_name (unsigned int idx);
 536
 537 #ifdef __cplusplus
 538 }
 539 #endif /* __cplusplus */
 540
 541 #endif /* _DWARF2_H */