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

/* dwarf.h - DWARF support header file
   Copyright (C) 2005-2020 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 */

typedef unsigned HOST_WIDEST_INT  dwarf_vma;
typedef HOST_WIDEST_INT           dwarf_signed_vma;
typedef unsigned HOST_WIDEST_INT  dwarf_size_type;

/* Structure found in the .debug_line section.  */
typedef struct
{
  dwarf_vma	 li_length;
  unsigned short li_version;
  dwarf_vma      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
{
  dwarf_vma	 pn_length;
  unsigned short pn_version;
  dwarf_vma	 pn_offset;
  dwarf_vma	 pn_size;
}
DWARF2_Internal_PubNames;

/* Structure found in .debug_info section.  */
typedef struct
{
  dwarf_vma	 cu_length;
  unsigned short cu_version;
  dwarf_vma	 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
{
  dwarf_vma	 ar_length;
  unsigned short ar_version;
  dwarf_vma	 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,
  pubtypes,
  gnu_pubtypes,
  ranges,
  rnglists,
  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,
  separate_debug_str,
  max
};

struct dwarf_section
{
  /* A debug section has a different name when it's stored compressed
     or not.  COMPRESSED_NAME and UNCOMPRESSED_NAME are the two
     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 *                     name;
  /* If non-NULL then FILENAME is the name of the separate debug info
     file containing the section.  */
  const char *                     filename;
  unsigned char *                  start;
  dwarf_vma                        address;
  dwarf_size_type                  size;
  enum dwarf_section_display_enum  abbrev_sec;
  /* Used by clients to help them implement the reloc_at callback.  */
  void *                           reloc_info;
  unsigned long                    num_relocs;
  /* A spare field for random use.  */
  void *                           user_data;
};

/* 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;
  bfd_boolean           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;
  dwarf_vma	 cu_offset;
  dwarf_vma	 base_address;
  /* This field is filled in when reading the attribute DW_AT_GNU_addr_base and
     is used with the form DW_AT_GNU_FORM_addr_index.  */
  dwarf_vma	 addr_base;
  /* This field is filled in when reading the attribute DW_AT_GNU_ranges_base and
     is used when calculating ranges.  */
  dwarf_vma	 ranges_base;
  /* This is an array of offsets to the location list table.  */
  dwarf_vma *    loc_offsets;
  /* This is an array of offsets to the location view table.  */
  dwarf_vma *    loc_views;
  int *          have_frame_base;
  unsigned int   num_loc_offsets;
  unsigned int   max_loc_offsets;
  unsigned int   num_loc_views;
  /* List of .debug_ranges offsets seen in this .debug_info.  */
  dwarf_vma *    range_lists;
  unsigned int   num_range_lists;
  unsigned int   max_range_lists;
}
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_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;

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 bfd_boolean  load_debug_section (enum dwarf_section_display_enum, void *);
extern void         free_debug_section (enum dwarf_section_display_enum);
extern bfd_boolean  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 void dwarf_select_sections_by_names (const char *);
extern void 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 (size_t, size_t);
extern void * xcalloc2 (size_t, size_t);
extern void * xcmalloc (size_t, size_t);
extern void * xcrealloc (void *, size_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 bfd_boolean reloc_at (struct dwarf_section *, dwarf_vma);

extern dwarf_vma read_leb128 (unsigned char *, const unsigned char *const,
			      bfd_boolean, 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 (_("LEB end of data\n"));
  else if ((status & 2) != 0)
    error (_("LEB value too large\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								\
    {								\
      dwarf_vma _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								\
    {								\
      dwarf_signed_vma _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
b3adc24a	2	Copyright (C) 2005-2020 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
467c65bc NC	23	typedef unsigned HOST_WIDEST_INT dwarf_vma;
	24	typedef HOST_WIDEST_INT dwarf_signed_vma;
	25	typedef unsigned HOST_WIDEST_INT dwarf_size_type;
19e6b90e	26
47704ddf	27	/* Structure found in the .debug_line section. */
47704ddf KT	28	typedef struct
47704ddf KT	29	{
467c65bc	30	dwarf_vma li_length;
47704ddf	31	unsigned short li_version;
77ef8654	32	dwarf_vma li_prologue_length;
47704ddf KT	33	unsigned char li_min_insn_length;
	34	unsigned char li_max_ops_per_insn;
	35	unsigned char li_default_is_stmt;
	36	int li_line_base;
	37	unsigned char li_line_range;
	38	unsigned char li_opcode_base;
77145576	39	unsigned int li_offset_size;
47704ddf KT	40	}
	41	DWARF2_Internal_LineInfo;
	42
	43	/* Structure found in .debug_pubnames section. */
47704ddf KT	44	typedef struct
47704ddf KT	45	{
467c65bc	46	dwarf_vma pn_length;
47704ddf	47	unsigned short pn_version;
467c65bc NC	48	dwarf_vma pn_offset;
467c65bc NC	49	dwarf_vma pn_size;
47704ddf KT	50	}
	51	DWARF2_Internal_PubNames;
	52
	53	/* Structure found in .debug_info section. */
47704ddf KT	54	typedef struct
47704ddf KT	55	{
467c65bc	56	dwarf_vma cu_length;
47704ddf	57	unsigned short cu_version;
467c65bc	58	dwarf_vma cu_abbrev_offset;
47704ddf	59	unsigned char cu_pointer_size;
77145576	60	enum dwarf_unit_type cu_unit_type;
47704ddf KT	61	}
	62	DWARF2_Internal_CompUnit;
	63
77ef8654	64	/* Structure found in .debug_aranges section. */
47704ddf KT	65	typedef struct
47704ddf KT	66	{
467c65bc	67	dwarf_vma ar_length;
47704ddf	68	unsigned short ar_version;
467c65bc	69	dwarf_vma ar_info_offset;
47704ddf KT	70	unsigned char ar_pointer_size;
	71	unsigned char ar_segment_size;
	72	}
	73	DWARF2_Internal_ARange;
	74
459d52c8 DE	75	/* N.B. The order here must match the order in debug_displays. */
459d52c8 DE	76
c34f4fc6 NC	77	enum dwarf_section_display_enum
c34f4fc6 NC	78	{
19e6b90e L	79	abbrev = 0,
	80	aranges,
	81	frame,
	82	info,
	83	line,
	84	pubnames,
459d52c8	85	gnu_pubnames,
19e6b90e L	86	eh_frame,
19e6b90e L	87	macinfo,
4ccf1e31	88	macro,
19e6b90e	89	str,
77145576	90	line_str,
19e6b90e	91	loc,
d4620bee	92	loclists,
19e6b90e	93	pubtypes,
459d52c8	94	gnu_pubtypes,
19e6b90e	95	ranges,
d4620bee	96	rnglists,
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,
	120	gnu_debugaltlink,
	121	separate_debug_str,
19e6b90e L	122	max
	123	};
	124
4723351a CC	125	struct dwarf_section
	126	{
	127	/* A debug section has a different name when it's stored compressed
	128	or not. COMPRESSED_NAME and UNCOMPRESSED_NAME are the two
	129	possibilities. NAME is set to whichever one is used for this
	130	input file, as determined by load_debug_section(). */
dda8d76d NC	131	const char * uncompressed_name;
	132	const char * compressed_name;
	133	const char * name;
	134	/* If non-NULL then FILENAME is the name of the separate debug info
	135	file containing the section. */
	136	const char * filename;
	137	unsigned char * start;
	138	dwarf_vma address;
	139	dwarf_size_type size;
	140	enum dwarf_section_display_enum abbrev_sec;
d1c4b12b	141	/* Used by clients to help them implement the reloc_at callback. */
dda8d76d NC	142	void * reloc_info;
dda8d76d NC	143	unsigned long num_relocs;
06614111	144	/* A spare field for random use. */
dda8d76d	145	void * user_data;
4723351a CC	146	};
	147
	148	/* A structure containing the name of a debug section
	149	and a pointer to a function that can decode it. */
	150	struct dwarf_section_display
	151	{
dda8d76d NC	152	struct dwarf_section section;
	153	int (* display) (struct dwarf_section , void );
	154	int * enabled;
	155	bfd_boolean relocate;
4723351a CC	156	};
4723351a CC	157
19e6b90e L	158	extern struct dwarf_section_display debug_displays [];
	159
	160	/* This structure records the information that
	161	we extract from the.debug_info section. */
	162	typedef struct
	163	{
	164	unsigned int pointer_size;
b7807392 JJ	165	unsigned int offset_size;
b7807392 JJ	166	int dwarf_version;
467c65bc NC	167	dwarf_vma cu_offset;
467c65bc NC	168	dwarf_vma base_address;
4723351a CC	169	/* This field is filled in when reading the attribute DW_AT_GNU_addr_base and
	170	is used with the form DW_AT_GNU_FORM_addr_index. */
	171	dwarf_vma addr_base;
	172	/* This field is filled in when reading the attribute DW_AT_GNU_ranges_base and
	173	is used when calculating ranges. */
	174	dwarf_vma ranges_base;
19e6b90e	175	/* This is an array of offsets to the location list table. */
467c65bc	176	dwarf_vma * loc_offsets;
9f272209 AO	177	/* This is an array of offsets to the location view table. */
9f272209 AO	178	dwarf_vma * loc_views;
467c65bc	179	int * have_frame_base;
19e6b90e L	180	unsigned int num_loc_offsets;
19e6b90e L	181	unsigned int max_loc_offsets;
9f272209	182	unsigned int num_loc_views;
01a8f077	183	/* List of .debug_ranges offsets seen in this .debug_info. */
467c65bc	184	dwarf_vma * range_lists;
19e6b90e L	185	unsigned int num_range_lists;
	186	unsigned int max_range_lists;
	187	}
	188	debug_info;
	189
24841daa NC	190	typedef struct separate_info
	191	{
	192	void * handle; /* The pointer returned by open_debug_file(). */
	193	const char * filename;
	194	struct separate_info * next;
	195	} separate_info;
	196
	197	extern separate_info * first_separate_info;
	198
77ef8654	199	extern unsigned int eh_addr_size;
19e6b90e L	200
	201	extern int do_debug_info;
	202	extern int do_debug_abbrevs;
	203	extern int do_debug_lines;
	204	extern int do_debug_pubnames;
f9f0e732	205	extern int do_debug_pubtypes;
19e6b90e L	206	extern int do_debug_aranges;
	207	extern int do_debug_ranges;
	208	extern int do_debug_frames;
	209	extern int do_debug_frames_interp;
	210	extern int do_debug_macinfo;
	211	extern int do_debug_str;
	212	extern int do_debug_loc;
5bbdf3d5	213	extern int do_gdb_index;
6f875884 TG	214	extern int do_trace_info;
	215	extern int do_trace_abbrevs;
	216	extern int do_trace_aranges;
657d0d47 CC	217	extern int do_debug_addr;
657d0d47 CC	218	extern int do_debug_cu_index;
c34f4fc6	219	extern int do_wide;
dda8d76d	220	extern int do_debug_links;
39f0547e	221	extern int do_follow_links;
19e6b90e	222
fd2f0033 TT	223	extern int dwarf_cutoff_level;
	224	extern unsigned long dwarf_start_die;
	225
4723351a CC	226	extern int dwarf_check;
4723351a CC	227
955ff7fc	228	extern void init_dwarf_regnames_by_elf_machine_code (unsigned int);
229a22cf AB	229	extern void init_dwarf_regnames_by_bfd_arch_and_mach (enum bfd_architecture arch,
229a22cf AB	230	unsigned long mach);
2dc4cec1	231
dda8d76d NC	232	extern bfd_boolean load_debug_section (enum dwarf_section_display_enum, void *);
dda8d76d NC	233	extern void free_debug_section (enum dwarf_section_display_enum);
24841daa	234	extern bfd_boolean load_separate_debug_files (void , const char );
dda8d76d NC	235	extern void close_debug_file (void *);
dda8d76d NC	236	extern void * open_debug_file (const char *);
19e6b90e L	237
	238	extern void free_debug_memory (void);
	239
c34f4fc6 NC	240	extern void dwarf_select_sections_by_names (const char *);
c34f4fc6 NC	241	extern void dwarf_select_sections_by_letters (const char *);
4cb93e3b TG	242	extern void dwarf_select_sections_all (void);
4cb93e3b TG	243
82b1b41b	244	extern unsigned int * find_cu_tu_set (void *, unsigned int);
657d0d47	245
82b1b41b	246	extern void * cmalloc (size_t, size_t);
72c61a0d	247	extern void * xcalloc2 (size_t, size_t);
82b1b41b NC	248	extern void * xcmalloc (size_t, size_t);
82b1b41b NC	249	extern void * xcrealloc (void *, size_t, size_t);
19e6b90e	250
222c2bf0	251	/* A callback into the client. Returns TRUE if there is a
d1c4b12b NC	252	relocation against the given debug section at the given
	253	offset. */
	254	extern bfd_boolean reloc_at (struct dwarf_section *, dwarf_vma);
cd30bcef AM	255
	256	extern dwarf_vma read_leb128 (unsigned char , const unsigned char const,
	257	bfd_boolean, unsigned int , int );
	258
301a9420 AM	259	#if HAVE_LIBDEBUGINFOD
	260	extern unsigned char * get_build_id (void *);
	261	#endif
	262
cd30bcef AM	263	static inline void
	264	report_leb_status (int status)
	265	{
	266	if ((status & 1) != 0)
	267	error (_("LEB end of data\n"));
	268	else if ((status & 2) != 0)
	269	error (_("LEB value too large\n"));
	270	}
	271
	272	#define SKIP_ULEB(start, end) \
	273	do \
	274	{ \
	275	unsigned int _len; \
	276	read_leb128 (start, end, FALSE, &_len, NULL); \
	277	start += _len; \
	278	} while (0)
	279
	280	#define SKIP_SLEB(start, end) \
	281	do \
	282	{ \
	283	unsigned int _len; \
	284	read_leb128 (start, end, TRUE, &_len, NULL); \
	285	start += _len; \
	286	} while (0)
	287
	288	#define READ_ULEB(var, start, end) \
	289	do \
	290	{ \
	291	dwarf_vma _val; \
	292	unsigned int _len; \
	293	int _status; \
	294	\
	295	_val = read_leb128 (start, end, FALSE, &_len, &_status); \
	296	start += _len; \
	297	(var) = _val; \
	298	if ((var) != _val) \
	299	_status \|= 2; \
	300	report_leb_status (_status); \
	301	} while (0)
	302
	303	#define READ_SLEB(var, start, end) \
	304	do \
	305	{ \
	306	dwarf_signed_vma _val; \
	307	unsigned int _len; \
	308	int _status; \
	309	\
	310	_val = read_leb128 (start, end, TRUE, &_len, &_status); \
	311	start += _len; \
	312	(var) = _val; \
	313	if ((var) != _val) \
	314	_status \|= 2; \
	315	report_leb_status (_status); \
	316	} while (0)