[thirdparty/binutils-gdb.git] / binutils / dwarf.h

/* dwarf.h - DWARF support header file
   Copyright (C) 2005-2023 Free Software Foundation, Inc.

   This file is part of GNU Binutils.

   This program 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 of the License, or
   (at your option) any later version.

   This program 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.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
   MA 02110-1301, USA.  */

#include "dwarf2.h" /* for enum dwarf_unit_type */

/* Structure found in the .debug_line section.  */
typedef struct
{
  uint64_t	 li_length;
  unsigned short li_version;
  unsigned char  li_address_size;
  unsigned char  li_segment_size;
  uint64_t	 li_prologue_length;
  unsigned char  li_min_insn_length;
  unsigned char  li_max_ops_per_insn;
  unsigned char  li_default_is_stmt;
  int            li_line_base;
  unsigned char  li_line_range;
  unsigned char  li_opcode_base;
  unsigned int   li_offset_size;
}
DWARF2_Internal_LineInfo;

/* Structure found in .debug_pubnames section.  */
typedef struct
{
  uint64_t	 pn_length;
  unsigned short pn_version;
  uint64_t	 pn_offset;
  uint64_t	 pn_size;
}
DWARF2_Internal_PubNames;

/* Structure found in .debug_info section.  */
typedef struct
{
  uint64_t	 cu_length;
  unsigned short cu_version;
  uint64_t	 cu_abbrev_offset;
  unsigned char  cu_pointer_size;
  enum dwarf_unit_type cu_unit_type;
}
DWARF2_Internal_CompUnit;

/* Structure found in .debug_aranges section.  */
typedef struct
{
  uint64_t	 ar_length;
  unsigned short ar_version;
  uint64_t	 ar_info_offset;
  unsigned char  ar_pointer_size;
  unsigned char  ar_segment_size;
}
DWARF2_Internal_ARange;

/* N.B. The order here must match the order in debug_displays.  */

enum dwarf_section_display_enum
{
  abbrev = 0,
  aranges,
  frame,
  info,
  line,
  pubnames,
  gnu_pubnames,
  eh_frame,
  macinfo,
  macro,
  str,
  line_str,
  loc,
  loclists,
  loclists_dwo,
  pubtypes,
  gnu_pubtypes,
  ranges,
  rnglists,
  rnglists_dwo,
  static_func,
  static_vars,
  types,
  weaknames,
  gdb_index,
  debug_names,
  trace_info,
  trace_abbrev,
  trace_aranges,
  info_dwo,
  abbrev_dwo,
  types_dwo,
  line_dwo,
  loc_dwo,
  macro_dwo,
  macinfo_dwo,
  str_dwo,
  str_index,
  str_index_dwo,
  debug_addr,
  dwp_cu_index,
  dwp_tu_index,
  gnu_debuglink,
  gnu_debugaltlink,
  debug_sup,
  separate_debug_str,
  note_gnu_build_id,
  max
};

struct dwarf_section
{
  /* A debug section has a different name when it's stored compressed
     or not.  XCOFF DWARF section also have a special name.
     COMPRESSED_NAME, UNCOMPRESSED_NAME and XCOFF_NAME are the three
     possibilities.  NAME is set to whichever one is used for this
     input file, as determined by load_debug_section().  */
  const char *                     uncompressed_name;
  const char *                     compressed_name;
  const char *                     xcoff_name;
  const char *                     name;
  /* If non-NULL then FILENAME is the name of the separate debug info
     file containing the section.  */
  const char *                     filename;
  unsigned char *                  start;
  uint64_t                         address;
  uint64_t                         size;
  enum dwarf_section_display_enum  abbrev_sec;
  /* Used by clients to help them implement the reloc_at callback.  */
  void *                           reloc_info;
  uint64_t                         num_relocs;
};

/* A structure containing the name of a debug section
   and a pointer to a function that can decode it.  */
struct dwarf_section_display
{
  struct dwarf_section section;
  int (*display) (struct dwarf_section *, void *);
  int *enabled;
  bool relocate;
};

extern struct dwarf_section_display debug_displays [];

/* This structure records the information that
   we extract from the.debug_info section.  */
typedef struct
{
  unsigned int   pointer_size;
  unsigned int   offset_size;
  int            dwarf_version;
  uint64_t	 cu_offset;
  uint64_t	 base_address;
  /* This field is filled in when reading the attribute DW_AT_GNU_addr_base and
     is used with the form DW_FORM_GNU_addr_index.  */
  uint64_t	 addr_base;
  /* This field is filled in when reading the attribute DW_AT_GNU_ranges_base and
     is used when calculating ranges.  */
  uint64_t	 ranges_base;
  /* This is an array of offsets to the location list table.  */
  uint64_t *	 loc_offsets;
  /* This is an array of offsets to the location view table.  */
  uint64_t *	 loc_views;
  int *          have_frame_base;

  /* Information for associating location lists with CUs.  */
  unsigned int   num_loc_offsets;
  unsigned int   max_loc_offsets;
  unsigned int   num_loc_views;
  uint64_t	 loclists_base;

  /* List of .debug_ranges offsets seen in this .debug_info.  */
  uint64_t *	 range_lists;
  unsigned int   num_range_lists;
  unsigned int   max_range_lists;
  uint64_t	 rnglists_base;
  uint64_t	 str_offsets_base;
}
debug_info;

typedef struct separate_info
{
  void *                  handle;    /* The pointer returned by open_debug_file().  */
  const char *            filename;
  struct separate_info *  next;
} separate_info;

extern separate_info * first_separate_info;

extern unsigned int eh_addr_size;

extern int do_debug_info;
extern int do_debug_abbrevs;
extern int do_debug_lines;
extern int do_debug_pubnames;
extern int do_debug_pubtypes;
extern int do_debug_aranges;
extern int do_debug_ranges;
extern int do_debug_frames;
extern int do_debug_frames_interp;
extern int do_debug_macinfo;
extern int do_debug_str;
extern int do_debug_str_offsets;
extern int do_debug_loc;
extern int do_gdb_index;
extern int do_trace_info;
extern int do_trace_abbrevs;
extern int do_trace_aranges;
extern int do_debug_addr;
extern int do_debug_cu_index;
extern int do_wide;
extern int do_debug_links;
extern int do_follow_links;
#ifdef HAVE_LIBDEBUGINFOD
extern int use_debuginfod;
#endif
extern bool do_checks;

extern int dwarf_cutoff_level;
extern unsigned long dwarf_start_die;

extern int dwarf_check;

extern void init_dwarf_regnames_by_elf_machine_code (unsigned int);
extern void init_dwarf_regnames_by_bfd_arch_and_mach (enum bfd_architecture arch,
						      unsigned long mach);

extern bool load_debug_section (enum dwarf_section_display_enum, void *);
extern void free_debug_section (enum dwarf_section_display_enum);
extern bool load_separate_debug_files (void *, const char *);
extern void close_debug_file (void *);
extern void *open_debug_file (const char *);

extern void free_debug_memory (void);

extern int dwarf_select_sections_by_names (const char *);
extern int dwarf_select_sections_by_letters (const char *);
extern void dwarf_select_sections_all (void);

extern unsigned int * find_cu_tu_set (void *, unsigned int);

extern void * cmalloc (uint64_t, size_t);
extern void * xcalloc2 (uint64_t, size_t);
extern void * xcmalloc (uint64_t, size_t);
extern void * xcrealloc (void *, uint64_t, size_t);

/* A callback into the client.  Returns TRUE if there is a
   relocation against the given debug section at the given
   offset.  */
extern bool reloc_at (struct dwarf_section *, uint64_t);

extern uint64_t read_leb128 (unsigned char *, const unsigned char *const,
			     bool, unsigned int *, int *);

#if HAVE_LIBDEBUGINFOD
extern unsigned char * get_build_id (void *);
#endif

static inline void
report_leb_status (int status)
{
  if ((status & 1) != 0)
    error (_("end of data encountered whilst reading LEB\n"));
  else if ((status & 2) != 0)
    error (_("read LEB value is too large to store in destination variable\n"));
}

#define SKIP_ULEB(start, end)					\
  do								\
    {								\
      unsigned int _len;					\
      read_leb128 (start, end, false, &_len, NULL);		\
      start += _len;						\
    }								\
  while (0)

#define SKIP_SLEB(start, end)					\
  do								\
    {								\
      unsigned int _len;					\
      read_leb128 (start, end, true, &_len, NULL);		\
      start += _len;						\
    }								\
  while (0)

#define READ_ULEB(var, start, end)				\
  do								\
    {								\
      uint64_t _val;						\
      unsigned int _len;					\
      int _status;						\
								\
      _val = read_leb128 (start, end, false, &_len, &_status);	\
      start += _len;						\
      (var) = _val;						\
      if ((var) != _val)					\
	_status |= 2;						\
      report_leb_status (_status);				\
    }								\
  while (0)

#define READ_SLEB(var, start, end)				\
  do								\
    {								\
      int64_t _val;						\
      unsigned int _len;					\
      int _status;						\
								\
      _val = read_leb128 (start, end, true, &_len, &_status);	\
      start += _len;						\
      (var) = _val;						\
      if ((var) != _val)					\
	_status |= 2;						\
      report_leb_status (_status);				\
    }								\
  while (0)
Commit	Line	Data
1b315056	1	/* dwarf.h - DWARF support header file
d87bef3a	2	Copyright (C) 2005-2023 Free Software Foundation, Inc.
19e6b90e	3
32866df7	4	This file is part of GNU Binutils.
19e6b90e	5
32866df7 NC	6	This program is free software; you can redistribute it and/or modify
	7	it under the terms of the GNU General Public License as published by
	8	the Free Software Foundation; either version 3 of the License, or
	9	(at your option) any later version.
19e6b90e	10
32866df7 NC	11	This program is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	GNU General Public License for more details.
19e6b90e	15
32866df7 NC	16	You should have received a copy of the GNU General Public License
	17	along with this program; if not, write to the Free Software
	18	Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
	19	MA 02110-1301, USA. */
19e6b90e	20
77145576 JK	21	#include "dwarf2.h" /* for enum dwarf_unit_type */
77145576 JK	22
47704ddf	23	/* Structure found in the .debug_line section. */
47704ddf KT	24	typedef struct
47704ddf KT	25	{
31e5a3a3	26	uint64_t li_length;
47704ddf	27	unsigned short li_version;
5496f3c6 NC	28	unsigned char li_address_size;
5496f3c6 NC	29	unsigned char li_segment_size;
31e5a3a3	30	uint64_t li_prologue_length;
47704ddf KT	31	unsigned char li_min_insn_length;
	32	unsigned char li_max_ops_per_insn;
	33	unsigned char li_default_is_stmt;
	34	int li_line_base;
	35	unsigned char li_line_range;
	36	unsigned char li_opcode_base;
77145576	37	unsigned int li_offset_size;
47704ddf KT	38	}
	39	DWARF2_Internal_LineInfo;
	40
	41	/* Structure found in .debug_pubnames section. */
47704ddf KT	42	typedef struct
47704ddf KT	43	{
31e5a3a3	44	uint64_t pn_length;
47704ddf	45	unsigned short pn_version;
31e5a3a3 AM	46	uint64_t pn_offset;
31e5a3a3 AM	47	uint64_t pn_size;
47704ddf KT	48	}
	49	DWARF2_Internal_PubNames;
	50
	51	/* Structure found in .debug_info section. */
47704ddf KT	52	typedef struct
47704ddf KT	53	{
31e5a3a3	54	uint64_t cu_length;
47704ddf	55	unsigned short cu_version;
31e5a3a3	56	uint64_t cu_abbrev_offset;
47704ddf	57	unsigned char cu_pointer_size;
77145576	58	enum dwarf_unit_type cu_unit_type;
47704ddf KT	59	}
	60	DWARF2_Internal_CompUnit;
	61
77ef8654	62	/* Structure found in .debug_aranges section. */
47704ddf KT	63	typedef struct
47704ddf KT	64	{
31e5a3a3	65	uint64_t ar_length;
47704ddf	66	unsigned short ar_version;
31e5a3a3	67	uint64_t ar_info_offset;
47704ddf KT	68	unsigned char ar_pointer_size;
	69	unsigned char ar_segment_size;
	70	}
	71	DWARF2_Internal_ARange;
	72
459d52c8 DE	73	/* N.B. The order here must match the order in debug_displays. */
459d52c8 DE	74
c34f4fc6 NC	75	enum dwarf_section_display_enum
c34f4fc6 NC	76	{
19e6b90e L	77	abbrev = 0,
	78	aranges,
	79	frame,
	80	info,
	81	line,
	82	pubnames,
459d52c8	83	gnu_pubnames,
19e6b90e L	84	eh_frame,
19e6b90e L	85	macinfo,
4ccf1e31	86	macro,
19e6b90e	87	str,
77145576	88	line_str,
19e6b90e	89	loc,
d4620bee	90	loclists,
4694a0e5	91	loclists_dwo,
19e6b90e	92	pubtypes,
459d52c8	93	gnu_pubtypes,
19e6b90e	94	ranges,
d4620bee	95	rnglists,
4694a0e5	96	rnglists_dwo,
19e6b90e L	97	static_func,
	98	static_vars,
	99	types,
	100	weaknames,
48049d1e	101	gdb_index,
61364358	102	debug_names,
6f875884 TG	103	trace_info,
	104	trace_abbrev,
	105	trace_aranges,
4723351a CC	106	info_dwo,
	107	abbrev_dwo,
	108	types_dwo,
	109	line_dwo,
	110	loc_dwo,
	111	macro_dwo,
	112	macinfo_dwo,
	113	str_dwo,
	114	str_index,
	115	str_index_dwo,
	116	debug_addr,
657d0d47 CC	117	dwp_cu_index,
657d0d47 CC	118	dwp_tu_index,
dda8d76d NC	119	gnu_debuglink,
dda8d76d NC	120	gnu_debugaltlink,
e38332c2	121	debug_sup,
dda8d76d	122	separate_debug_str,
61ab1364	123	note_gnu_build_id,
19e6b90e L	124	max
	125	};
	126
4723351a CC	127	struct dwarf_section
	128	{
	129	/* A debug section has a different name when it's stored compressed
51d29b8c CC	130	or not. XCOFF DWARF section also have a special name.
51d29b8c CC	131	COMPRESSED_NAME, UNCOMPRESSED_NAME and XCOFF_NAME are the three
4723351a CC	132	possibilities. NAME is set to whichever one is used for this
4723351a CC	133	input file, as determined by load_debug_section(). */
dda8d76d NC	134	const char * uncompressed_name;
dda8d76d NC	135	const char * compressed_name;
51d29b8c	136	const char * xcoff_name;
dda8d76d NC	137	const char * name;
	138	/* If non-NULL then FILENAME is the name of the separate debug info
	139	file containing the section. */
	140	const char * filename;
	141	unsigned char * start;
31e5a3a3 AM	142	uint64_t address;
31e5a3a3 AM	143	uint64_t size;
dda8d76d	144	enum dwarf_section_display_enum abbrev_sec;
d1c4b12b	145	/* Used by clients to help them implement the reloc_at callback. */
dda8d76d	146	void * reloc_info;
26c527e6	147	uint64_t num_relocs;
4723351a CC	148	};
	149
	150	/* A structure containing the name of a debug section
	151	and a pointer to a function that can decode it. */
	152	struct dwarf_section_display
	153	{
015dc7e1 AM	154	struct dwarf_section section;
	155	int (display) (struct dwarf_section , void *);
	156	int *enabled;
	157	bool relocate;
4723351a CC	158	};
4723351a CC	159
19e6b90e L	160	extern struct dwarf_section_display debug_displays [];
	161
	162	/* This structure records the information that
	163	we extract from the.debug_info section. */
	164	typedef struct
	165	{
	166	unsigned int pointer_size;
b7807392 JJ	167	unsigned int offset_size;
b7807392 JJ	168	int dwarf_version;
31e5a3a3 AM	169	uint64_t cu_offset;
31e5a3a3 AM	170	uint64_t base_address;
4723351a	171	/* This field is filled in when reading the attribute DW_AT_GNU_addr_base and
528a4f87	172	is used with the form DW_FORM_GNU_addr_index. */
31e5a3a3	173	uint64_t addr_base;
4723351a CC	174	/* This field is filled in when reading the attribute DW_AT_GNU_ranges_base and
4723351a CC	175	is used when calculating ranges. */
31e5a3a3	176	uint64_t ranges_base;
19e6b90e	177	/* This is an array of offsets to the location list table. */
31e5a3a3	178	uint64_t * loc_offsets;
9f272209	179	/* This is an array of offsets to the location view table. */
31e5a3a3	180	uint64_t * loc_views;
467c65bc	181	int * have_frame_base;
19c26da6 NC	182
19c26da6 NC	183	/* Information for associating location lists with CUs. */
19e6b90e L	184	unsigned int num_loc_offsets;
19e6b90e L	185	unsigned int max_loc_offsets;
9f272209	186	unsigned int num_loc_views;
31e5a3a3	187	uint64_t loclists_base;
19c26da6	188
01a8f077	189	/* List of .debug_ranges offsets seen in this .debug_info. */
31e5a3a3	190	uint64_t * range_lists;
19e6b90e L	191	unsigned int num_range_lists;
19e6b90e L	192	unsigned int max_range_lists;
31e5a3a3 AM	193	uint64_t rnglists_base;
31e5a3a3 AM	194	uint64_t str_offsets_base;
19e6b90e L	195	}
	196	debug_info;
	197
24841daa NC	198	typedef struct separate_info
	199	{
	200	void * handle; /* The pointer returned by open_debug_file(). */
	201	const char * filename;
	202	struct separate_info * next;
	203	} separate_info;
	204
	205	extern separate_info * first_separate_info;
	206
77ef8654	207	extern unsigned int eh_addr_size;
19e6b90e L	208
	209	extern int do_debug_info;
	210	extern int do_debug_abbrevs;
	211	extern int do_debug_lines;
	212	extern int do_debug_pubnames;
f9f0e732	213	extern int do_debug_pubtypes;
19e6b90e L	214	extern int do_debug_aranges;
	215	extern int do_debug_ranges;
	216	extern int do_debug_frames;
	217	extern int do_debug_frames_interp;
	218	extern int do_debug_macinfo;
	219	extern int do_debug_str;
e4b7104b	220	extern int do_debug_str_offsets;
19e6b90e	221	extern int do_debug_loc;
5bbdf3d5	222	extern int do_gdb_index;
6f875884 TG	223	extern int do_trace_info;
	224	extern int do_trace_abbrevs;
	225	extern int do_trace_aranges;
657d0d47 CC	226	extern int do_debug_addr;
657d0d47 CC	227	extern int do_debug_cu_index;
c34f4fc6	228	extern int do_wide;
dda8d76d	229	extern int do_debug_links;
39f0547e	230	extern int do_follow_links;
bed566bb NC	231	#ifdef HAVE_LIBDEBUGINFOD
	232	extern int use_debuginfod;
	233	#endif
015dc7e1	234	extern bool do_checks;
19e6b90e	235
fd2f0033 TT	236	extern int dwarf_cutoff_level;
	237	extern unsigned long dwarf_start_die;
	238
4723351a CC	239	extern int dwarf_check;
4723351a CC	240
955ff7fc	241	extern void init_dwarf_regnames_by_elf_machine_code (unsigned int);
229a22cf AB	242	extern void init_dwarf_regnames_by_bfd_arch_and_mach (enum bfd_architecture arch,
229a22cf AB	243	unsigned long mach);
2dc4cec1	244
015dc7e1 AM	245	extern bool load_debug_section (enum dwarf_section_display_enum, void *);
	246	extern void free_debug_section (enum dwarf_section_display_enum);
	247	extern bool load_separate_debug_files (void , const char );
	248	extern void close_debug_file (void *);
	249	extern void open_debug_file (const char );
19e6b90e L	250
	251	extern void free_debug_memory (void);
	252
94585d6d NC	253	extern int dwarf_select_sections_by_names (const char *);
94585d6d NC	254	extern int dwarf_select_sections_by_letters (const char *);
4cb93e3b TG	255	extern void dwarf_select_sections_all (void);
4cb93e3b TG	256
82b1b41b	257	extern unsigned int * find_cu_tu_set (void *, unsigned int);
657d0d47	258
26c527e6 AM	259	extern void * cmalloc (uint64_t, size_t);
	260	extern void * xcalloc2 (uint64_t, size_t);
	261	extern void * xcmalloc (uint64_t, size_t);
	262	extern void * xcrealloc (void *, uint64_t, size_t);
19e6b90e	263
222c2bf0	264	/* A callback into the client. Returns TRUE if there is a
d1c4b12b NC	265	relocation against the given debug section at the given
d1c4b12b NC	266	offset. */
31e5a3a3	267	extern bool reloc_at (struct dwarf_section *, uint64_t);
cd30bcef	268
31e5a3a3 AM	269	extern uint64_t read_leb128 (unsigned char , const unsigned char const,
31e5a3a3 AM	270	bool, unsigned int , int );
cd30bcef	271
301a9420 AM	272	#if HAVE_LIBDEBUGINFOD
	273	extern unsigned char * get_build_id (void *);
	274	#endif
	275
cd30bcef	276	static inline void
9039747f	277	report_leb_status (int status)
cd30bcef AM	278	{
cd30bcef AM	279	if ((status & 1) != 0)
9039747f	280	error (_("end of data encountered whilst reading LEB\n"));
cd30bcef	281	else if ((status & 2) != 0)
9039747f	282	error (_("read LEB value is too large to store in destination variable\n"));
cd30bcef AM	283	}
	284
	285	#define SKIP_ULEB(start, end) \
	286	do \
	287	{ \
	288	unsigned int _len; \
015dc7e1	289	read_leb128 (start, end, false, &_len, NULL); \
cd30bcef	290	start += _len; \
1b513401 NC	291	} \
1b513401 NC	292	while (0)
cd30bcef AM	293
	294	#define SKIP_SLEB(start, end) \
	295	do \
	296	{ \
	297	unsigned int _len; \
015dc7e1	298	read_leb128 (start, end, true, &_len, NULL); \
cd30bcef	299	start += _len; \
1b513401 NC	300	} \
1b513401 NC	301	while (0)
cd30bcef AM	302
	303	#define READ_ULEB(var, start, end) \
	304	do \
	305	{ \
31e5a3a3	306	uint64_t _val; \
cd30bcef AM	307	unsigned int _len; \
	308	int _status; \
	309	\
015dc7e1	310	_val = read_leb128 (start, end, false, &_len, &_status); \
cd30bcef AM	311	start += _len; \
	312	(var) = _val; \
	313	if ((var) != _val) \
	314	_status \|= 2; \
9039747f	315	report_leb_status (_status); \
1b513401 NC	316	} \
1b513401 NC	317	while (0)
cd30bcef AM	318
	319	#define READ_SLEB(var, start, end) \
	320	do \
	321	{ \
31e5a3a3	322	int64_t _val; \
cd30bcef AM	323	unsigned int _len; \
	324	int _status; \
	325	\
015dc7e1	326	_val = read_leb128 (start, end, true, &_len, &_status); \
cd30bcef AM	327	start += _len; \
	328	(var) = _val; \
	329	if ((var) != _val) \
	330	_status \|= 2; \
9039747f	331	report_leb_status (_status); \
1b513401 NC	332	} \
1b513401 NC	333	while (0)