[gcc.git] / include / dwarf2.h

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