perf/util/dwarf-aux.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 #ifndef _DWARF_AUX_H
0003 #define _DWARF_AUX_H
0004 /*
0005  * dwarf-aux.h : libdw auxiliary interfaces
0006  */
0007
0008 #include <dwarf.h>
0009 #include <elfutils/libdw.h>
0010 #include <elfutils/libdwfl.h>
0011 #include <elfutils/version.h>
0012
0013 struct strbuf;
0014
0015 /* Find the realpath of the target file */
0016 const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname);
0017
0018 /* Get DW_AT_comp_dir (should be NULL with older gcc) */
0019 const char *cu_get_comp_dir(Dwarf_Die *cu_die);
0020
0021 /* Get a line number and file name for given address */
0022 int cu_find_lineinfo(Dwarf_Die *cudie, Dwarf_Addr addr,
0023              const char **fname, int *lineno);
0024
0025 /* Walk on functions at given address */
0026 int cu_walk_functions_at(Dwarf_Die *cu_die, Dwarf_Addr addr,
0027              int (*callback)(Dwarf_Die *, void *), void *data);
0028
0029 /* Get DW_AT_linkage_name (should be NULL for C binary) */
0030 const char *die_get_linkage_name(Dwarf_Die *dw_die);
0031
0032 /* Get the lowest PC in DIE (including range list) */
0033 int die_entrypc(Dwarf_Die *dw_die, Dwarf_Addr *addr);
0034
0035 /* Ensure that this DIE is a subprogram and definition (not declaration) */
0036 bool die_is_func_def(Dwarf_Die *dw_die);
0037
0038 /* Ensure that this DIE is an instance of a subprogram */
0039 bool die_is_func_instance(Dwarf_Die *dw_die);
0040
0041 /* Compare diename and tname */
0042 bool die_compare_name(Dwarf_Die *dw_die, const char *tname);
0043
0044 /* Matching diename with glob pattern */
0045 bool die_match_name(Dwarf_Die *dw_die, const char *glob);
0046
0047 /* Get callsite line number of inline-function instance */
0048 int die_get_call_lineno(Dwarf_Die *in_die);
0049
0050 /* Get callsite file name of inlined function instance */
0051 const char *die_get_call_file(Dwarf_Die *in_die);
0052
0053 /* Get type die */
0054 Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
0055
0056 /* Get a type die, but skip qualifiers and typedef */
0057 Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
0058
0059 /* Check whether the DIE is signed or not */
0060 bool die_is_signed_type(Dwarf_Die *tp_die);
0061
0062 /* Get data_member_location offset */
0063 int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs);
0064
0065 /* Return values for die_find_child() callbacks */
0066 enum {
0067     DIE_FIND_CB_END = 0,        /* End of Search */
0068     DIE_FIND_CB_CHILD = 1,      /* Search only children */
0069     DIE_FIND_CB_SIBLING = 2,    /* Search only siblings */
0070     DIE_FIND_CB_CONTINUE = 3,   /* Search children and siblings */
0071 };
0072
0073 /* Search child DIEs */
0074 Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
0075              int (*callback)(Dwarf_Die *, void *),
0076              void *data, Dwarf_Die *die_mem);
0077
0078 /* Search a non-inlined function including given address */
0079 Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
0080                  Dwarf_Die *die_mem);
0081
0082 /* Search a non-inlined function with tail call at given address */
0083 Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
0084                     Dwarf_Die *die_mem);
0085
0086 /* Search the top inlined function including given address */
0087 Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
0088                    Dwarf_Die *die_mem);
0089
0090 /* Search the deepest inlined function including given address */
0091 Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
0092                    Dwarf_Die *die_mem);
0093
0094 /* Walk on the instances of given DIE */
0095 int die_walk_instances(Dwarf_Die *in_die,
0096                int (*callback)(Dwarf_Die *, void *), void *data);
0097
0098 /* Walker on lines (Note: line number will not be sorted) */
0099 typedef int (* line_walk_callback_t) (const char *fname, int lineno,
0100                       Dwarf_Addr addr, void *data);
0101
0102 /*
0103  * Walk on lines inside given DIE. If the DIE is a subprogram, walk only on
0104  * the lines inside the subprogram, otherwise the DIE must be a CU DIE.
0105  */
0106 int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data);
0107
0108 /* Find a variable called 'name' at given address */
0109 Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
0110                 Dwarf_Addr addr, Dwarf_Die *die_mem);
0111
0112 /* Find a member called 'name' */
0113 Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
0114                Dwarf_Die *die_mem);
0115
0116 /* Get the name of given variable DIE */
0117 int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf);
0118
0119 /* Get the name and type of given variable DIE, stored as "type\tname" */
0120 int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf);
0121 int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf);
0122
0123 /* Check if target program is compiled with optimization */
0124 bool die_is_optimized_target(Dwarf_Die *cu_die);
0125
0126 /* Use next address after prologue as probe location */
0127 void die_skip_prologue(Dwarf_Die *sp_die, Dwarf_Die *cu_die,
0128                Dwarf_Addr *entrypc);
0129
0130 #endif