[thirdparty/gcc.git] / include / dwarf2.h

/* Declarations and definitions of codes relating to the DWARF2 and
   DWARF3 symbolic debugging information formats.
   Copyright (C) 1992-2023 Free Software Foundation, Inc.

   Written by Gary Funck (gary@intrepid.com) The Ada Joint Program
   Office (AJPO), Florida State University and Silicon Graphics Inc.
   provided support for this effort -- June 21, 1995.

   Derived from the DWARF 1 implementation written by Ron Guilmette
   (rfg@netcom.com), November 1990.

   This file is part of GCC.

   GCC is free software; you can redistribute it and/or modify it under
   the terms of the GNU General Public License as published by the Free
   Software Foundation; either version 3, or (at your option) any later
   version.

   GCC is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
   or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
   License for more details.

   Under Section 7 of GPL version 3, you are granted additional
   permissions described in the GCC Runtime Library Exception, version
   3.1, as published by the Free Software Foundation.

   You should have received a copy of the GNU General Public License and
   a copy of the GCC Runtime Library Exception along with this program;
   see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
   <http://www.gnu.org/licenses/>.  */

/* This file is derived from the DWARF specification (a public document)
   Revision 2.0.0 (July 27, 1993) developed by the UNIX International
   Programming Languages Special Interest Group (UI/PLSIG) and distributed
   by UNIX International.  Copies of this specification are available from
   UNIX International, 20 Waterview Boulevard, Parsippany, NJ, 07054.

   This file also now contains definitions from the DWARF 3 specification
   published Dec 20, 2005, available from: http://dwarf.freestandards.org.  */

#ifndef _DWARF2_H
#define _DWARF2_H

#define DW_TAG(name, value) , name = value
#define DW_TAG_DUP(name, value) , name = value
#define DW_FORM(name, value) , name = value
#define DW_AT(name, value) , name = value
#define DW_AT_DUP(name, value) , name = value
#define DW_OP(name, value) , name = value
#define DW_OP_DUP(name, value) , name = value
#define DW_ATE(name, value) , name = value
#define DW_ATE_DUP(name, value) , name = value
#define DW_CFA(name, value) , name = value
#define DW_CFA_DUP(name, value) , name = value
#define DW_IDX(name, value) , name = value
#define DW_IDX_DUP(name, value) , name = value
#define DW_UT(name, value) , name = value

#define DW_FIRST_TAG(name, value) enum dwarf_tag { \
  name = value
#define DW_END_TAG };
#define DW_FIRST_FORM(name, value) enum dwarf_form { \
  name = value
#define DW_END_FORM };
#define DW_FIRST_AT(name, value) enum dwarf_attribute { \
  name = value
#define DW_END_AT };
#define DW_FIRST_OP(name, value) enum dwarf_location_atom { \
  name = value
#define DW_END_OP };
#define DW_FIRST_ATE(name, value) enum dwarf_type { \
  name = value
#define DW_END_ATE };
#define DW_FIRST_CFA(name, value) enum dwarf_call_frame_info { \
  name = value
#define DW_END_CFA };
#define DW_FIRST_IDX(name, value) enum dwarf_name_index_attribute { \
  name = value
#define DW_END_IDX };
#define DW_FIRST_UT(name, value) enum dwarf_unit_type { \
  name = value
#define DW_END_UT };

#include "dwarf2.def"

#undef DW_FIRST_TAG
#undef DW_END_TAG
#undef DW_FIRST_FORM
#undef DW_END_FORM
#undef DW_FIRST_AT
#undef DW_END_AT
#undef DW_FIRST_OP
#undef DW_END_OP
#undef DW_FIRST_ATE
#undef DW_END_ATE
#undef DW_FIRST_CFA
#undef DW_END_CFA
#undef DW_FIRST_IDX
#undef DW_END_IDX
#undef DW_FIRST_UT
#undef DW_END_UT

#undef DW_TAG
#undef DW_TAG_DUP
#undef DW_FORM
#undef DW_AT
#undef DW_AT_DUP
#undef DW_OP
#undef DW_OP_DUP
#undef DW_ATE
#undef DW_ATE_DUP
#undef DW_CFA
#undef DW_CFA_DUP
#undef DW_IDX
#undef DW_IDX_DUP
#undef DW_UT

/* Flag that tells whether entry has a child or not.  */
#define DW_children_no   0
#define	DW_children_yes  1

#define DW_AT_stride_size   DW_AT_bit_stride  /* Note: The use of DW_AT_stride_size is deprecated.  */
#define DW_AT_stride   DW_AT_byte_stride  /* Note: The use of DW_AT_stride is deprecated.  */

/* Decimal sign encodings.  */
enum dwarf_decimal_sign_encoding
  {
    /* DWARF 3.  */
    DW_DS_unsigned = 0x01,
    DW_DS_leading_overpunch = 0x02,
    DW_DS_trailing_overpunch = 0x03,
    DW_DS_leading_separate = 0x04,
    DW_DS_trailing_separate = 0x05
  };

/* Endianity encodings.  */
enum dwarf_endianity_encoding
  {
    /* DWARF 3.  */
    DW_END_default = 0x00,
    DW_END_big = 0x01,
    DW_END_little = 0x02,

    DW_END_lo_user = 0x40,
    DW_END_hi_user = 0xff
  };

/* Array ordering names and codes.  */
enum dwarf_array_dim_ordering
  {
    DW_ORD_row_major = 0,
    DW_ORD_col_major = 1
  };

/* Access attribute.  */
enum dwarf_access_attribute
  {
    DW_ACCESS_public = 1,
    DW_ACCESS_protected = 2,
    DW_ACCESS_private = 3
  };

/* Visibility.  */
enum dwarf_visibility_attribute
  {
    DW_VIS_local = 1,
    DW_VIS_exported = 2,
    DW_VIS_qualified = 3
  };

/* Virtuality.  */
enum dwarf_virtuality_attribute
  {
    DW_VIRTUALITY_none = 0,
    DW_VIRTUALITY_virtual = 1,
    DW_VIRTUALITY_pure_virtual = 2
  };

/* Case sensitivity.  */
enum dwarf_id_case
  {
    DW_ID_case_sensitive = 0,
    DW_ID_up_case = 1,
    DW_ID_down_case = 2,
    DW_ID_case_insensitive = 3
  };

/* Calling convention.  */
enum dwarf_calling_convention
  {
    DW_CC_normal = 0x1,
    DW_CC_program = 0x2,
    DW_CC_nocall = 0x3,

    /* DWARF 5.  */
    DW_CC_pass_by_reference = 0x4,
    DW_CC_pass_by_value = 0x5,

    DW_CC_lo_user = 0x40,
    DW_CC_hi_user = 0xff,

    DW_CC_GNU_renesas_sh = 0x40,
    DW_CC_GNU_borland_fastcall_i386 = 0x41,

    /* This DW_CC_ value is not currently generated by any toolchain.  It is
       used internally to GDB to indicate OpenCL C functions that have been
       compiled with the IBM XL C for OpenCL compiler and use a non-platform
       calling convention for passing OpenCL C vector types.  This value may
       be changed freely as long as it does not conflict with any other DW_CC_
       value defined here.  */
    DW_CC_GDB_IBM_OpenCL = 0xff
  };

/* Inline attribute.  */
enum dwarf_inline_attribute
  {
    DW_INL_not_inlined = 0,
    DW_INL_inlined = 1,
    DW_INL_declared_not_inlined = 2,
    DW_INL_declared_inlined = 3
  };

/* Discriminant lists.  */
enum dwarf_discrim_list
  {
    DW_DSC_label = 0,
    DW_DSC_range = 1
  };

/* Line number opcodes.  */
enum dwarf_line_number_ops
  {
    DW_LNS_extended_op = 0,
    DW_LNS_copy = 1,
    DW_LNS_advance_pc = 2,
    DW_LNS_advance_line = 3,
    DW_LNS_set_file = 4,
    DW_LNS_set_column = 5,
    DW_LNS_negate_stmt = 6,
    DW_LNS_set_basic_block = 7,
    DW_LNS_const_add_pc = 8,
    DW_LNS_fixed_advance_pc = 9,
    /* DWARF 3.  */
    DW_LNS_set_prologue_end = 10,
    DW_LNS_set_epilogue_begin = 11,
    DW_LNS_set_isa = 12
  };

/* Line number extended opcodes.  */
enum dwarf_line_number_x_ops
  {
    DW_LNE_end_sequence = 1,
    DW_LNE_set_address = 2,
    DW_LNE_define_file = 3,
    DW_LNE_set_discriminator = 4,
    /* HP extensions.  */
    DW_LNE_HP_negate_is_UV_update      = 0x11,
    DW_LNE_HP_push_context             = 0x12,
    DW_LNE_HP_pop_context              = 0x13,
    DW_LNE_HP_set_file_line_column     = 0x14,
    DW_LNE_HP_set_routine_name         = 0x15,
    DW_LNE_HP_set_sequence             = 0x16,
    DW_LNE_HP_negate_post_semantics    = 0x17,
    DW_LNE_HP_negate_function_exit     = 0x18,
    DW_LNE_HP_negate_front_end_logical = 0x19,
    DW_LNE_HP_define_proc              = 0x20,
    DW_LNE_HP_source_file_correlation  = 0x80,

    DW_LNE_lo_user = 0x80,
    DW_LNE_hi_user = 0xff
  };

/* Sub-opcodes for DW_LNE_HP_source_file_correlation.  */
enum dwarf_line_number_hp_sfc_ops
  {
    DW_LNE_HP_SFC_formfeed = 1,
    DW_LNE_HP_SFC_set_listing_line = 2,
    DW_LNE_HP_SFC_associate = 3
  };

/* Content type codes in line table directory_entry_format
   and file_name_entry_format sequences.  */
enum dwarf_line_number_content_type
  {
    DW_LNCT_path = 0x1,
    DW_LNCT_directory_index = 0x2,
    DW_LNCT_timestamp = 0x3,
    DW_LNCT_size = 0x4,
    DW_LNCT_MD5 = 0x5,
    DW_LNCT_lo_user = 0x2000,
    DW_LNCT_hi_user = 0x3fff
  };

/* Type codes for location list entries.  */
enum dwarf_location_list_entry_type
  {
    DW_LLE_end_of_list = 0x00,
    DW_LLE_base_addressx = 0x01,
    DW_LLE_startx_endx = 0x02,
    DW_LLE_startx_length = 0x03,
    DW_LLE_offset_pair = 0x04,
    DW_LLE_default_location = 0x05,
    DW_LLE_base_address = 0x06,
    DW_LLE_start_end = 0x07,
    DW_LLE_start_length = 0x08,

    /* <http://lists.dwarfstd.org/private.cgi/dwarf-discuss-dwarfstd.org/2017-April/004347.html>
       has the proposal for now; only available to list members.

       A (possibly updated) copy of the proposal is available at
       <http://people.redhat.com/aoliva/papers/sfn/dwarf6-sfn-lvu.txt>.  */
    DW_LLE_GNU_view_pair = 0x09,
#define DW_LLE_view_pair DW_LLE_GNU_view_pair

    /* Former extension for Fission.
       See http://gcc.gnu.org/wiki/DebugFission.  */
    DW_LLE_GNU_end_of_list_entry = 0x00,
    DW_LLE_GNU_base_address_selection_entry = 0x01,
    DW_LLE_GNU_start_end_entry = 0x02,
    DW_LLE_GNU_start_length_entry = 0x03
  };

#define DW_CIE_ID	  0xffffffff
#define DW64_CIE_ID	  0xffffffffffffffffULL

#define DW_CFA_extended   0

#define DW_CHILDREN_no		     0x00
#define DW_CHILDREN_yes		     0x01

#define DW_ADDR_none		0

/* Source language names and codes.  */
enum dwarf_source_language
  {
    DW_LANG_C89 = 0x0001,
    DW_LANG_C = 0x0002,
    DW_LANG_Ada83 = 0x0003,
    DW_LANG_C_plus_plus = 0x0004,
    DW_LANG_Cobol74 = 0x0005,
    DW_LANG_Cobol85 = 0x0006,
    DW_LANG_Fortran77 = 0x0007,
    DW_LANG_Fortran90 = 0x0008,
    DW_LANG_Pascal83 = 0x0009,
    DW_LANG_Modula2 = 0x000a,
    /* DWARF 3.  */
    DW_LANG_Java = 0x000b,
    DW_LANG_C99 = 0x000c,
    DW_LANG_Ada95 = 0x000d,
    DW_LANG_Fortran95 = 0x000e,
    DW_LANG_PLI = 0x000f,
    DW_LANG_ObjC = 0x0010,
    DW_LANG_ObjC_plus_plus = 0x0011,
    DW_LANG_UPC = 0x0012,
    DW_LANG_D = 0x0013,
    /* DWARF 4.  */
    DW_LANG_Python = 0x0014,
    /* DWARF 5.  */
    DW_LANG_OpenCL = 0x0015,
    DW_LANG_Go = 0x0016,
    DW_LANG_Modula3 = 0x0017,
    DW_LANG_Haskell = 0x0018,
    DW_LANG_C_plus_plus_03 = 0x0019,
    DW_LANG_C_plus_plus_11 = 0x001a,
    DW_LANG_OCaml = 0x001b,
    DW_LANG_Rust = 0x001c,
    DW_LANG_C11 = 0x001d,
    DW_LANG_Swift = 0x001e,
    DW_LANG_Julia = 0x001f,
    DW_LANG_Dylan = 0x0020,
    DW_LANG_C_plus_plus_14 = 0x0021,
    DW_LANG_Fortran03 = 0x0022,
    DW_LANG_Fortran08 = 0x0023,
    DW_LANG_RenderScript = 0x0024,
    DW_LANG_BLISS = 0x0025,
    DW_LANG_Kotlin = 0x0026,
    DW_LANG_Zig = 0x0027,
    DW_LANG_Crystal = 0x0028,
    DW_LANG_C_plus_plus_17 = 0x002a,
    DW_LANG_C_plus_plus_20 = 0x002b,
    DW_LANG_C17 = 0x002c,
    DW_LANG_Fortran18 = 0x002d,
    DW_LANG_Ada2005 = 0x002e,
    DW_LANG_Ada2012 = 0x002f,

    DW_LANG_lo_user = 0x8000,	/* Implementation-defined range start.  */
    DW_LANG_hi_user = 0xffff,	/* Implementation-defined range start.  */

    /* MIPS.  */
    DW_LANG_Mips_Assembler = 0x8001,
    /* UPC.  */
    DW_LANG_Upc = 0x8765,
    /* HP extensions.  */
    DW_LANG_HP_Bliss     = 0x8003,
    DW_LANG_HP_Basic91   = 0x8004,
    DW_LANG_HP_Pascal91  = 0x8005,
    DW_LANG_HP_IMacro    = 0x8006,
    DW_LANG_HP_Assembler = 0x8007,

    /* Rust extension, but replaced in DWARF 5.  */
    DW_LANG_Rust_old = 0x9000
  };

/* Names and codes for macro information.  */
enum dwarf_macinfo_record_type
  {
    DW_MACINFO_define = 1,
    DW_MACINFO_undef = 2,
    DW_MACINFO_start_file = 3,
    DW_MACINFO_end_file = 4,
    DW_MACINFO_vendor_ext = 255
  };

/* DW_TAG_defaulted/DW_TAG_GNU_defaulted attributes.  */
enum dwarf_defaulted_attribute
  {
    DW_DEFAULTED_no = 0x00,
    DW_DEFAULTED_in_class = 0x01,
    DW_DEFAULTED_out_of_class = 0x02
  };

/* Names and codes for new style macro information.  */
enum dwarf_macro_record_type
  {
    DW_MACRO_define = 0x01,
    DW_MACRO_undef = 0x02,
    DW_MACRO_start_file = 0x03,
    DW_MACRO_end_file = 0x04,
    DW_MACRO_define_strp = 0x05,
    DW_MACRO_undef_strp = 0x06,
    DW_MACRO_import = 0x07,
    DW_MACRO_define_sup = 0x08,
    DW_MACRO_undef_sup = 0x09,
    DW_MACRO_import_sup = 0x0a,
    DW_MACRO_define_strx = 0x0b,
    DW_MACRO_undef_strx = 0x0c,
    DW_MACRO_lo_user = 0xe0,
    DW_MACRO_hi_user = 0xff,

    /* Compatibility macros for the GNU .debug_macro extension.  */
    DW_MACRO_GNU_define = 0x01,
    DW_MACRO_GNU_undef = 0x02,
    DW_MACRO_GNU_start_file = 0x03,
    DW_MACRO_GNU_end_file = 0x04,
    DW_MACRO_GNU_define_indirect = 0x05,
    DW_MACRO_GNU_undef_indirect = 0x06,
    DW_MACRO_GNU_transparent_include = 0x07,
    /* Extensions for DWZ multifile.
       See http://www.dwarfstd.org/ShowIssue.php?issue=120604.1&type=open .  */
    DW_MACRO_GNU_define_indirect_alt = 0x08,
    DW_MACRO_GNU_undef_indirect_alt = 0x09,
    DW_MACRO_GNU_transparent_include_alt = 0x0a,
    DW_MACRO_GNU_lo_user = 0xe0,
    DW_MACRO_GNU_hi_user = 0xff
  };

/* Range list entry kinds in .debug_rnglists* section.  */
enum dwarf_range_list_entry
  {
    DW_RLE_end_of_list = 0x00,
    DW_RLE_base_addressx = 0x01,
    DW_RLE_startx_endx = 0x02,
    DW_RLE_startx_length = 0x03,
    DW_RLE_offset_pair = 0x04,
    DW_RLE_base_address = 0x05,
    DW_RLE_start_end = 0x06,
    DW_RLE_start_length = 0x07
  };
\f
/* @@@ For use with GNU frame unwind information.  */

#define DW_EH_PE_absptr		0x00
#define DW_EH_PE_omit		0xff

#define DW_EH_PE_uleb128	0x01
#define DW_EH_PE_udata2		0x02
#define DW_EH_PE_udata4		0x03
#define DW_EH_PE_udata8		0x04
#define DW_EH_PE_sleb128	0x09
#define DW_EH_PE_sdata2		0x0A
#define DW_EH_PE_sdata4		0x0B
#define DW_EH_PE_sdata8		0x0C
#define DW_EH_PE_signed		0x08

#define DW_EH_PE_pcrel		0x10
#define DW_EH_PE_textrel	0x20
#define DW_EH_PE_datarel	0x30
#define DW_EH_PE_funcrel	0x40
#define DW_EH_PE_aligned	0x50

#define DW_EH_PE_indirect	0x80

/* Codes for the debug sections in a dwarf package (.dwp) file.
   (From the pre-standard formats Extensions for Fission.
   See http://gcc.gnu.org/wiki/DebugFissionDWP).  */
enum dwarf_sect
{
  DW_SECT_INFO = 1,
  DW_SECT_TYPES = 2,
  DW_SECT_ABBREV = 3,
  DW_SECT_LINE = 4,
  DW_SECT_LOC = 5,
  DW_SECT_STR_OFFSETS = 6,
  DW_SECT_MACINFO = 7,
  DW_SECT_MACRO = 8,
  DW_SECT_MAX = 8
};

/* Codes for the debug sections in a dwarf package (.dwp) file.
   (From the official DWARF v5 spec.
   See http://dwarfstd.org/doc/DWARF5.pdf, section 7.3.5).  */
enum dwarf_sect_v5
{
  DW_SECT_INFO_V5 = 1,
  DW_SECT_RESERVED_V5 = 2,
  DW_SECT_ABBREV_V5 = 3,
  DW_SECT_LINE_V5 = 4,
  DW_SECT_LOCLISTS_V5 = 5,
  DW_SECT_STR_OFFSETS_V5 = 6,
  DW_SECT_MACRO_V5 = 7,
  DW_SECT_RNGLISTS_V5 = 8,
  DW_SECT_MAX_V5 = 8
};

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/* Return the name of a DW_TAG_ constant, or NULL if the value is not
   recognized.  */
extern const char *get_DW_TAG_name (unsigned int tag);

/* Return the name of a DW_AT_ constant, or NULL if the value is not
   recognized.  */
extern const char *get_DW_AT_name (unsigned int attr);

/* Return the name of a DW_FORM_ constant, or NULL if the value is not
   recognized.  */
extern const char *get_DW_FORM_name (unsigned int form);

/* Return the name of a DW_OP_ constant, or NULL if the value is not
   recognized.  */
extern const char *get_DW_OP_name (unsigned int op);

/* Return the name of a DW_ATE_ constant, or NULL if the value is not
   recognized.  */
extern const char *get_DW_ATE_name (unsigned int enc);

/* Return the name of a DW_CFA_ constant, or NULL if the value is not
   recognized.  */
extern const char *get_DW_CFA_name (unsigned int opc);

/* Return the name of a DW_IDX_ constant, or NULL if the value is not
   recognized.  */
extern const char *get_DW_IDX_name (unsigned int idx);

/* Return the name of a DW_UT_ constant, or NULL if the value is not
   recognized.  */
extern const char *get_DW_UT_name (unsigned int ut);

#ifdef __cplusplus
}
#endif /* __cplusplus */

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