1#ifndef _DWARF_AUX_H
  2#define _DWARF_AUX_H
  3/*
  4 * dwarf-aux.h : libdw auxiliary interfaces
  5 *
  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 2 of the License, or
  9 * (at your option) any later version.
 10 *
 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.
 15 *
 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 19 *
 20 */
 21
 22#include <dwarf.h>
 23#include <elfutils/libdw.h>
 24#include <elfutils/libdwfl.h>
 25#include <elfutils/version.h>
 
 
 26
 27/* Find the realpath of the target file */
 28const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname);
 29
 30/* Get DW_AT_comp_dir (should be NULL with older gcc) */
 31const char *cu_get_comp_dir(Dwarf_Die *cu_die);
 32
 33/* Get a line number and file name for given address */
 34int cu_find_lineinfo(Dwarf_Die *cudie, unsigned long addr,
 35		     const char **fname, int *lineno);
 36
 37/* Walk on funcitons at given address */
 38int cu_walk_functions_at(Dwarf_Die *cu_die, Dwarf_Addr addr,
 39			 int (*callback)(Dwarf_Die *, void *), void *data);
 40
 41/* Get DW_AT_linkage_name (should be NULL for C binary) */
 42const char *die_get_linkage_name(Dwarf_Die *dw_die);
 43
 44/* Ensure that this DIE is a subprogram and definition (not declaration) */
 45bool die_is_func_def(Dwarf_Die *dw_die);
 46
 47/* Ensure that this DIE is an instance of a subprogram */
 48bool die_is_func_instance(Dwarf_Die *dw_die);
 49
 50/* Compare diename and tname */
 51bool die_compare_name(Dwarf_Die *dw_die, const char *tname);
 52
 53/* Matching diename with glob pattern */
 54bool die_match_name(Dwarf_Die *dw_die, const char *glob);
 55
 56/* Get callsite line number of inline-function instance */
 57int die_get_call_lineno(Dwarf_Die *in_die);
 58
 59/* Get callsite file name of inlined function instance */
 60const char *die_get_call_file(Dwarf_Die *in_die);
 61
 62/* Get type die */
 63Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
 64
 65/* Get a type die, but skip qualifiers and typedef */
 66Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
 67
 68/* Check whether the DIE is signed or not */
 69bool die_is_signed_type(Dwarf_Die *tp_die);
 70
 71/* Get data_member_location offset */
 72int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs);
 73
 74/* Return values for die_find_child() callbacks */
 75enum {
 76	DIE_FIND_CB_END = 0,		/* End of Search */
 77	DIE_FIND_CB_CHILD = 1,		/* Search only children */
 78	DIE_FIND_CB_SIBLING = 2,	/* Search only siblings */
 79	DIE_FIND_CB_CONTINUE = 3,	/* Search children and siblings */
 80};
 81
 82/* Search child DIEs */
 83Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
 84			 int (*callback)(Dwarf_Die *, void *),
 85			 void *data, Dwarf_Die *die_mem);
 86
 87/* Search a non-inlined function including given address */
 88Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
 89			     Dwarf_Die *die_mem);
 90
 91/* Search a non-inlined function with tail call at given address */
 92Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
 93				    Dwarf_Die *die_mem);
 94
 95/* Search the top inlined function including given address */
 96Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
 97				   Dwarf_Die *die_mem);
 98
 99/* Search the deepest inlined function including given address */
100Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
101			       Dwarf_Die *die_mem);
102
103/* Walk on the instances of given DIE */
104int die_walk_instances(Dwarf_Die *in_die,
105		       int (*callback)(Dwarf_Die *, void *), void *data);
106
107/* Walker on lines (Note: line number will not be sorted) */
108typedef int (* line_walk_callback_t) (const char *fname, int lineno,
109				      Dwarf_Addr addr, void *data);
110
111/*
112 * Walk on lines inside given DIE. If the DIE is a subprogram, walk only on
113 * the lines inside the subprogram, otherwise the DIE must be a CU DIE.
114 */
115int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data);
116
117/* Find a variable called 'name' at given address */
118Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
119				Dwarf_Addr addr, Dwarf_Die *die_mem);
120
121/* Find a member called 'name' */
122Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
123			   Dwarf_Die *die_mem);
124
125/* Get the name of given variable DIE */
126int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf);
127
128/* Get the name and type of given variable DIE, stored as "type\tname" */
129int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf);
130int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf);
131
132/* Check if target program is compiled with optimization */
133bool die_is_optimized_target(Dwarf_Die *cu_die);
134
135/* Use next address after prologue as probe location */
136void die_skip_prologue(Dwarf_Die *sp_die, Dwarf_Die *cu_die,
137		       Dwarf_Addr *entrypc);
138
139#endif

  1/* SPDX-License-Identifier: GPL-2.0-or-later */
  2#ifndef _DWARF_AUX_H
  3#define _DWARF_AUX_H
  4/*
  5 * dwarf-aux.h : libdw auxiliary interfaces
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  6 */
  7
  8#include <dwarf.h>
  9#include <elfutils/libdw.h>
 10#include <elfutils/libdwfl.h>
 11#include <elfutils/version.h>
 12
 13struct strbuf;
 14
 15/* Find the realpath of the target file */
 16const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname);
 17
 18/* Get DW_AT_comp_dir (should be NULL with older gcc) */
 19const char *cu_get_comp_dir(Dwarf_Die *cu_die);
 20
 21/* Get a line number and file name for given address */
 22int cu_find_lineinfo(Dwarf_Die *cudie, unsigned long addr,
 23		     const char **fname, int *lineno);
 24
 25/* Walk on funcitons at given address */
 26int cu_walk_functions_at(Dwarf_Die *cu_die, Dwarf_Addr addr,
 27			 int (*callback)(Dwarf_Die *, void *), void *data);
 28
 29/* Get DW_AT_linkage_name (should be NULL for C binary) */
 30const char *die_get_linkage_name(Dwarf_Die *dw_die);
 31
 32/* Ensure that this DIE is a subprogram and definition (not declaration) */
 33bool die_is_func_def(Dwarf_Die *dw_die);
 34
 35/* Ensure that this DIE is an instance of a subprogram */
 36bool die_is_func_instance(Dwarf_Die *dw_die);
 37
 38/* Compare diename and tname */
 39bool die_compare_name(Dwarf_Die *dw_die, const char *tname);
 40
 41/* Matching diename with glob pattern */
 42bool die_match_name(Dwarf_Die *dw_die, const char *glob);
 43
 44/* Get callsite line number of inline-function instance */
 45int die_get_call_lineno(Dwarf_Die *in_die);
 46
 47/* Get callsite file name of inlined function instance */
 48const char *die_get_call_file(Dwarf_Die *in_die);
 49
 50/* Get type die */
 51Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
 52
 53/* Get a type die, but skip qualifiers and typedef */
 54Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
 55
 56/* Check whether the DIE is signed or not */
 57bool die_is_signed_type(Dwarf_Die *tp_die);
 58
 59/* Get data_member_location offset */
 60int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs);
 61
 62/* Return values for die_find_child() callbacks */
 63enum {
 64	DIE_FIND_CB_END = 0,		/* End of Search */
 65	DIE_FIND_CB_CHILD = 1,		/* Search only children */
 66	DIE_FIND_CB_SIBLING = 2,	/* Search only siblings */
 67	DIE_FIND_CB_CONTINUE = 3,	/* Search children and siblings */
 68};
 69
 70/* Search child DIEs */
 71Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
 72			 int (*callback)(Dwarf_Die *, void *),
 73			 void *data, Dwarf_Die *die_mem);
 74
 75/* Search a non-inlined function including given address */
 76Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
 77			     Dwarf_Die *die_mem);
 78
 79/* Search a non-inlined function with tail call at given address */
 80Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
 81				    Dwarf_Die *die_mem);
 82
 83/* Search the top inlined function including given address */
 84Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
 85				   Dwarf_Die *die_mem);
 86
 87/* Search the deepest inlined function including given address */
 88Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
 89			       Dwarf_Die *die_mem);
 90
 91/* Walk on the instances of given DIE */
 92int die_walk_instances(Dwarf_Die *in_die,
 93		       int (*callback)(Dwarf_Die *, void *), void *data);
 94
 95/* Walker on lines (Note: line number will not be sorted) */
 96typedef int (* line_walk_callback_t) (const char *fname, int lineno,
 97				      Dwarf_Addr addr, void *data);
 98
 99/*
100 * Walk on lines inside given DIE. If the DIE is a subprogram, walk only on
101 * the lines inside the subprogram, otherwise the DIE must be a CU DIE.
102 */
103int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data);
104
105/* Find a variable called 'name' at given address */
106Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
107				Dwarf_Addr addr, Dwarf_Die *die_mem);
108
109/* Find a member called 'name' */
110Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
111			   Dwarf_Die *die_mem);
112
113/* Get the name of given variable DIE */
114int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf);
115
116/* Get the name and type of given variable DIE, stored as "type\tname" */
117int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf);
118int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf);
119
120/* Check if target program is compiled with optimization */
121bool die_is_optimized_target(Dwarf_Die *cu_die);
122
123/* Use next address after prologue as probe location */
124void die_skip_prologue(Dwarf_Die *sp_die, Dwarf_Die *cu_die,
125		       Dwarf_Addr *entrypc);
126
127#endif