Loading...
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, Dwarf_Addr addr,
23 const char **fname, int *lineno);
24
25/* Walk on functions 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/* Get the lowest PC in DIE (including range list) */
33int die_entrypc(Dwarf_Die *dw_die, Dwarf_Addr *addr);
34
35/* Ensure that this DIE is a subprogram and definition (not declaration) */
36bool die_is_func_def(Dwarf_Die *dw_die);
37
38/* Ensure that this DIE is an instance of a subprogram */
39bool die_is_func_instance(Dwarf_Die *dw_die);
40
41/* Compare diename and tname */
42bool die_compare_name(Dwarf_Die *dw_die, const char *tname);
43
44/* Matching diename with glob pattern */
45bool die_match_name(Dwarf_Die *dw_die, const char *glob);
46
47/* Get callsite line number of inline-function instance */
48int die_get_call_lineno(Dwarf_Die *in_die);
49
50/* Get callsite file name of inlined function instance */
51const char *die_get_call_file(Dwarf_Die *in_die);
52
53/* Get declared file name of a DIE */
54const char *die_get_decl_file(Dwarf_Die *dw_die);
55
56/* Get type die */
57Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
58
59/* Get a type die, but skip qualifiers and typedef */
60Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
61
62/* Check whether the DIE is signed or not */
63bool die_is_signed_type(Dwarf_Die *tp_die);
64
65/* Get data_member_location offset */
66int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs);
67
68/* Return values for die_find_child() callbacks */
69enum {
70 DIE_FIND_CB_END = 0, /* End of Search */
71 DIE_FIND_CB_CHILD = 1, /* Search only children */
72 DIE_FIND_CB_SIBLING = 2, /* Search only siblings */
73 DIE_FIND_CB_CONTINUE = 3, /* Search children and siblings */
74};
75
76/* Search child DIEs */
77Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
78 int (*callback)(Dwarf_Die *, void *),
79 void *data, Dwarf_Die *die_mem);
80
81/* Search a non-inlined function including given address */
82Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
83 Dwarf_Die *die_mem);
84
85/* Search a non-inlined function with tail call at given address */
86Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
87 Dwarf_Die *die_mem);
88
89/* Search the top inlined function including given address */
90Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
91 Dwarf_Die *die_mem);
92
93/* Search the deepest inlined function including given address */
94Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
95 Dwarf_Die *die_mem);
96
97/* Walk on the instances of given DIE */
98int die_walk_instances(Dwarf_Die *in_die,
99 int (*callback)(Dwarf_Die *, void *), void *data);
100
101/* Walker on lines (Note: line number will not be sorted) */
102typedef int (* line_walk_callback_t) (const char *fname, int lineno,
103 Dwarf_Addr addr, void *data);
104
105/*
106 * Walk on lines inside given DIE. If the DIE is a subprogram, walk only on
107 * the lines inside the subprogram, otherwise the DIE must be a CU DIE.
108 */
109int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data);
110
111/* Find a variable called 'name' at given address */
112Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
113 Dwarf_Addr addr, Dwarf_Die *die_mem);
114
115/* Find a member called 'name' */
116Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
117 Dwarf_Die *die_mem);
118
119/* Get the name of given type DIE */
120int die_get_typename_from_type(Dwarf_Die *type_die, struct strbuf *buf);
121
122/* Get the name of given variable DIE */
123int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf);
124
125/* Get the name and type of given variable DIE, stored as "type\tname" */
126int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf);
127
128/* Check if target program is compiled with optimization */
129bool die_is_optimized_target(Dwarf_Die *cu_die);
130
131/* Use next address after prologue as probe location */
132void die_skip_prologue(Dwarf_Die *sp_die, Dwarf_Die *cu_die,
133 Dwarf_Addr *entrypc);
134
135/* Get the list of including scopes */
136int die_get_scopes(Dwarf_Die *cu_die, Dwarf_Addr pc, Dwarf_Die **scopes);
137
138/* Variable type information */
139struct die_var_type {
140 struct die_var_type *next;
141 u64 die_off;
142 u64 addr;
143 int reg;
144 int offset;
145};
146
147#ifdef HAVE_DWARF_GETLOCATIONS_SUPPORT
148
149/* Get byte offset range of given variable DIE */
150int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf);
151
152/* Find a variable saved in the 'reg' at given address */
153Dwarf_Die *die_find_variable_by_reg(Dwarf_Die *sc_die, Dwarf_Addr pc, int reg,
154 int *poffset, bool is_fbreg,
155 Dwarf_Die *die_mem);
156
157/* Find a (global) variable located in the 'addr' */
158Dwarf_Die *die_find_variable_by_addr(Dwarf_Die *sc_die, Dwarf_Addr pc,
159 Dwarf_Addr addr, Dwarf_Die *die_mem,
160 int *offset);
161
162/* Save all variables and parameters in this scope */
163void die_collect_vars(Dwarf_Die *sc_die, struct die_var_type **var_types);
164
165#else /* HAVE_DWARF_GETLOCATIONS_SUPPORT */
166
167static inline int die_get_var_range(Dwarf_Die *sp_die __maybe_unused,
168 Dwarf_Die *vr_die __maybe_unused,
169 struct strbuf *buf __maybe_unused)
170{
171 return -ENOTSUP;
172}
173
174static inline Dwarf_Die *die_find_variable_by_reg(Dwarf_Die *sc_die __maybe_unused,
175 Dwarf_Addr pc __maybe_unused,
176 int reg __maybe_unused,
177 int *poffset __maybe_unused,
178 bool is_fbreg __maybe_unused,
179 Dwarf_Die *die_mem __maybe_unused)
180{
181 return NULL;
182}
183
184static inline Dwarf_Die *die_find_variable_by_addr(Dwarf_Die *sc_die __maybe_unused,
185 Dwarf_Addr pc __maybe_unused,
186 Dwarf_Addr addr __maybe_unused,
187 Dwarf_Die *die_mem __maybe_unused,
188 int *offset __maybe_unused)
189{
190 return NULL;
191}
192
193static inline void die_collect_vars(Dwarf_Die *sc_die __maybe_unused,
194 struct die_var_type **var_types __maybe_unused)
195{
196}
197
198#endif /* HAVE_DWARF_GETLOCATIONS_SUPPORT */
199
200#ifdef HAVE_DWARF_CFI_SUPPORT
201
202/* Get the frame base information from CFA */
203int die_get_cfa(Dwarf *dwarf, u64 pc, int *preg, int *poffset);
204
205#else /* HAVE_DWARF_CFI_SUPPORT */
206
207static inline int die_get_cfa(Dwarf *dwarf __maybe_unused, u64 pc __maybe_unused,
208 int *preg __maybe_unused, int *poffset __maybe_unused)
209{
210 return -1;
211}
212
213#endif /* HAVE_DWARF_CFI_SUPPORT */
214
215#endif /* _DWARF_AUX_H */
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, Dwarf_Addr addr,
23 const char **fname, int *lineno);
24
25/* Walk on functions 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/* Get the lowest PC in DIE (including range list) */
33int die_entrypc(Dwarf_Die *dw_die, Dwarf_Addr *addr);
34
35/* Ensure that this DIE is a subprogram and definition (not declaration) */
36bool die_is_func_def(Dwarf_Die *dw_die);
37
38/* Ensure that this DIE is an instance of a subprogram */
39bool die_is_func_instance(Dwarf_Die *dw_die);
40
41/* Compare diename and tname */
42bool die_compare_name(Dwarf_Die *dw_die, const char *tname);
43
44/* Matching diename with glob pattern */
45bool die_match_name(Dwarf_Die *dw_die, const char *glob);
46
47/* Get callsite line number of inline-function instance */
48int die_get_call_lineno(Dwarf_Die *in_die);
49
50/* Get callsite file name of inlined function instance */
51const char *die_get_call_file(Dwarf_Die *in_die);
52
53/* Get type die */
54Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
55
56/* Get a type die, but skip qualifiers and typedef */
57Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
58
59/* Check whether the DIE is signed or not */
60bool die_is_signed_type(Dwarf_Die *tp_die);
61
62/* Get data_member_location offset */
63int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs);
64
65/* Return values for die_find_child() callbacks */
66enum {
67 DIE_FIND_CB_END = 0, /* End of Search */
68 DIE_FIND_CB_CHILD = 1, /* Search only children */
69 DIE_FIND_CB_SIBLING = 2, /* Search only siblings */
70 DIE_FIND_CB_CONTINUE = 3, /* Search children and siblings */
71};
72
73/* Search child DIEs */
74Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
75 int (*callback)(Dwarf_Die *, void *),
76 void *data, Dwarf_Die *die_mem);
77
78/* Search a non-inlined function including given address */
79Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
80 Dwarf_Die *die_mem);
81
82/* Search a non-inlined function with tail call at given address */
83Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
84 Dwarf_Die *die_mem);
85
86/* Search the top inlined function including given address */
87Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
88 Dwarf_Die *die_mem);
89
90/* Search the deepest inlined function including given address */
91Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
92 Dwarf_Die *die_mem);
93
94/* Walk on the instances of given DIE */
95int die_walk_instances(Dwarf_Die *in_die,
96 int (*callback)(Dwarf_Die *, void *), void *data);
97
98/* Walker on lines (Note: line number will not be sorted) */
99typedef int (* line_walk_callback_t) (const char *fname, int lineno,
100 Dwarf_Addr addr, void *data);
101
102/*
103 * Walk on lines inside given DIE. If the DIE is a subprogram, walk only on
104 * the lines inside the subprogram, otherwise the DIE must be a CU DIE.
105 */
106int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data);
107
108/* Find a variable called 'name' at given address */
109Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
110 Dwarf_Addr addr, Dwarf_Die *die_mem);
111
112/* Find a member called 'name' */
113Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
114 Dwarf_Die *die_mem);
115
116/* Get the name of given variable DIE */
117int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf);
118
119/* Get the name and type of given variable DIE, stored as "type\tname" */
120int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf);
121int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf);
122
123/* Check if target program is compiled with optimization */
124bool die_is_optimized_target(Dwarf_Die *cu_die);
125
126/* Use next address after prologue as probe location */
127void die_skip_prologue(Dwarf_Die *sp_die, Dwarf_Die *cu_die,
128 Dwarf_Addr *entrypc);
129
130#endif