1 /* SPDX-License-Identifier: GPL-2.0-or-later * <<
2 #ifndef _DWARF_AUX_H 1 #ifndef _DWARF_AUX_H
3 #define _DWARF_AUX_H 2 #define _DWARF_AUX_H
4 /* 3 /*
5 * dwarf-aux.h : libdw auxiliary interfaces 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 *
6 */ 20 */
7 21
8 #include <dwarf.h> 22 #include <dwarf.h>
9 #include <elfutils/libdw.h> 23 #include <elfutils/libdw.h>
10 #include <elfutils/libdwfl.h> 24 #include <elfutils/libdwfl.h>
11 #include <elfutils/version.h> 25 #include <elfutils/version.h>
12 26
13 struct strbuf; <<
14 <<
15 /* Find the realpath of the target file */ 27 /* Find the realpath of the target file */
16 const char *cu_find_realpath(Dwarf_Die *cu_die 28 const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname);
17 29
18 /* Get DW_AT_comp_dir (should be NULL with old 30 /* Get DW_AT_comp_dir (should be NULL with older gcc) */
19 const char *cu_get_comp_dir(Dwarf_Die *cu_die) 31 const char *cu_get_comp_dir(Dwarf_Die *cu_die);
20 32
21 /* Get a line number and file name for given a 33 /* Get a line number and file name for given address */
22 int cu_find_lineinfo(Dwarf_Die *cudie, Dwarf_A !! 34 int cu_find_lineinfo(Dwarf_Die *cudie, unsigned long addr,
23 const char **fname, int * 35 const char **fname, int *lineno);
24 36
25 /* Walk on functions at given address */ !! 37 /* Walk on funcitons at given address */
26 int cu_walk_functions_at(Dwarf_Die *cu_die, Dw 38 int cu_walk_functions_at(Dwarf_Die *cu_die, Dwarf_Addr addr,
27 int (*callback)(Dwarf 39 int (*callback)(Dwarf_Die *, void *), void *data);
28 40
29 /* Get DW_AT_linkage_name (should be NULL for 41 /* Get DW_AT_linkage_name (should be NULL for C binary) */
30 const char *die_get_linkage_name(Dwarf_Die *dw 42 const char *die_get_linkage_name(Dwarf_Die *dw_die);
31 43
32 /* Get the lowest PC in DIE (including range l <<
33 int die_entrypc(Dwarf_Die *dw_die, Dwarf_Addr <<
34 <<
35 /* Ensure that this DIE is a subprogram and de 44 /* Ensure that this DIE is a subprogram and definition (not declaration) */
36 bool die_is_func_def(Dwarf_Die *dw_die); 45 bool die_is_func_def(Dwarf_Die *dw_die);
37 46
38 /* Ensure that this DIE is an instance of a su 47 /* Ensure that this DIE is an instance of a subprogram */
39 bool die_is_func_instance(Dwarf_Die *dw_die); 48 bool die_is_func_instance(Dwarf_Die *dw_die);
40 49
41 /* Compare diename and tname */ 50 /* Compare diename and tname */
42 bool die_compare_name(Dwarf_Die *dw_die, const 51 bool die_compare_name(Dwarf_Die *dw_die, const char *tname);
43 52
44 /* Matching diename with glob pattern */ 53 /* Matching diename with glob pattern */
45 bool die_match_name(Dwarf_Die *dw_die, const c 54 bool die_match_name(Dwarf_Die *dw_die, const char *glob);
46 55
47 /* Get callsite line number of inline-function 56 /* Get callsite line number of inline-function instance */
48 int die_get_call_lineno(Dwarf_Die *in_die); 57 int die_get_call_lineno(Dwarf_Die *in_die);
49 58
50 /* Get callsite file name of inlined function 59 /* Get callsite file name of inlined function instance */
51 const char *die_get_call_file(Dwarf_Die *in_di 60 const char *die_get_call_file(Dwarf_Die *in_die);
52 61
53 /* Get declared file name of a DIE */ <<
54 const char *die_get_decl_file(Dwarf_Die *dw_di <<
55 <<
56 /* Get type die */ 62 /* Get type die */
57 Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwa 63 Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
58 64
59 /* Get a type die, but skip qualifiers and typ 65 /* Get a type die, but skip qualifiers and typedef */
60 Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die 66 Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
61 67
62 /* Check whether the DIE is signed or not */ 68 /* Check whether the DIE is signed or not */
63 bool die_is_signed_type(Dwarf_Die *tp_die); 69 bool die_is_signed_type(Dwarf_Die *tp_die);
64 70
65 /* Get data_member_location offset */ 71 /* Get data_member_location offset */
66 int die_get_data_member_location(Dwarf_Die *mb 72 int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs);
67 73
68 /* Return values for die_find_child() callback 74 /* Return values for die_find_child() callbacks */
69 enum { 75 enum {
70 DIE_FIND_CB_END = 0, /* End 76 DIE_FIND_CB_END = 0, /* End of Search */
71 DIE_FIND_CB_CHILD = 1, /* Sea 77 DIE_FIND_CB_CHILD = 1, /* Search only children */
72 DIE_FIND_CB_SIBLING = 2, /* Sea 78 DIE_FIND_CB_SIBLING = 2, /* Search only siblings */
73 DIE_FIND_CB_CONTINUE = 3, /* Sea 79 DIE_FIND_CB_CONTINUE = 3, /* Search children and siblings */
74 }; 80 };
75 81
76 /* Search child DIEs */ 82 /* Search child DIEs */
77 Dwarf_Die *die_find_child(Dwarf_Die *rt_die, 83 Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
78 int (*callback)(Dwarf 84 int (*callback)(Dwarf_Die *, void *),
79 void *data, Dwarf_Die 85 void *data, Dwarf_Die *die_mem);
80 86
81 /* Search a non-inlined function including giv 87 /* Search a non-inlined function including given address */
82 Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die 88 Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
83 Dwarf_Die *die_me 89 Dwarf_Die *die_mem);
84 90
85 /* Search a non-inlined function with tail cal 91 /* Search a non-inlined function with tail call at given address */
86 Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die 92 Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
87 Dwarf_Die 93 Dwarf_Die *die_mem);
88 94
89 /* Search the top inlined function including g 95 /* Search the top inlined function including given address */
90 Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die * 96 Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
91 Dwarf_Die * 97 Dwarf_Die *die_mem);
92 98
93 /* Search the deepest inlined function includi 99 /* Search the deepest inlined function including given address */
94 Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_d 100 Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
95 Dwarf_Die *die_ 101 Dwarf_Die *die_mem);
96 102
97 /* Search a non-inlined function by name and r <<
98 Dwarf_Die *die_find_func_rettype(Dwarf_Die *sp <<
99 Dwarf_Die *di <<
100 <<
101 /* Walk on the instances of given DIE */ 103 /* Walk on the instances of given DIE */
102 int die_walk_instances(Dwarf_Die *in_die, 104 int die_walk_instances(Dwarf_Die *in_die,
103 int (*callback)(Dwarf_D 105 int (*callback)(Dwarf_Die *, void *), void *data);
104 106
105 /* Walker on lines (Note: line number will not 107 /* Walker on lines (Note: line number will not be sorted) */
106 typedef int (* line_walk_callback_t) (const ch 108 typedef int (* line_walk_callback_t) (const char *fname, int lineno,
107 Dwarf_Ad 109 Dwarf_Addr addr, void *data);
108 110
109 /* 111 /*
110 * Walk on lines inside given DIE. If the DIE 112 * Walk on lines inside given DIE. If the DIE is a subprogram, walk only on
111 * the lines inside the subprogram, otherwise 113 * the lines inside the subprogram, otherwise the DIE must be a CU DIE.
112 */ 114 */
113 int die_walk_lines(Dwarf_Die *rt_die, line_wal 115 int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data);
114 116
115 /* Find a variable called 'name' at given addr 117 /* Find a variable called 'name' at given address */
116 Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_ 118 Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
117 Dwarf_Addr add 119 Dwarf_Addr addr, Dwarf_Die *die_mem);
118 120
119 /* Find a member called 'name' */ 121 /* Find a member called 'name' */
120 Dwarf_Die *die_find_member(Dwarf_Die *st_die, 122 Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
121 Dwarf_Die *die_mem) 123 Dwarf_Die *die_mem);
122 124
123 /* Get the name of given type DIE */ <<
124 int die_get_typename_from_type(Dwarf_Die *type <<
125 <<
126 /* Get the name of given variable DIE */ 125 /* Get the name of given variable DIE */
127 int die_get_typename(Dwarf_Die *vr_die, struct 126 int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf);
128 127
129 /* Get the name and type of given variable DIE 128 /* Get the name and type of given variable DIE, stored as "type\tname" */
130 int die_get_varname(Dwarf_Die *vr_die, struct 129 int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf);
>> 130 int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf);
131 131
132 /* Check if target program is compiled with op 132 /* Check if target program is compiled with optimization */
133 bool die_is_optimized_target(Dwarf_Die *cu_die 133 bool die_is_optimized_target(Dwarf_Die *cu_die);
134 134
135 /* Use next address after prologue as probe lo 135 /* Use next address after prologue as probe location */
136 void die_skip_prologue(Dwarf_Die *sp_die, Dwar 136 void die_skip_prologue(Dwarf_Die *sp_die, Dwarf_Die *cu_die,
137 Dwarf_Addr *entrypc); 137 Dwarf_Addr *entrypc);
138 138
139 /* Get the list of including scopes */ !! 139 #endif
140 int die_get_scopes(Dwarf_Die *cu_die, Dwarf_Ad <<
141 <<
142 /* Variable type information */ <<
143 struct die_var_type { <<
144 struct die_var_type *next; <<
145 u64 die_off; <<
146 u64 addr; <<
147 int reg; <<
148 int offset; <<
149 }; <<
150 <<
151 /* Return type info of a member at offset */ <<
152 Dwarf_Die *die_get_member_type(Dwarf_Die *type <<
153 <<
154 /* Return type info where the pointer and offs <<
155 Dwarf_Die *die_deref_ptr_type(Dwarf_Die *ptr_d <<
156 <<
157 #ifdef HAVE_DWARF_GETLOCATIONS_SUPPORT <<
158 <<
159 /* Get byte offset range of given variable DIE <<
160 int die_get_var_range(Dwarf_Die *sp_die, Dwarf <<
161 <<
162 /* Find a variable saved in the 'reg' at given <<
163 Dwarf_Die *die_find_variable_by_reg(Dwarf_Die <<
164 int *poffs <<
165 Dwarf_Die <<
166 <<
167 /* Find a (global) variable located in the 'ad <<
168 Dwarf_Die *die_find_variable_by_addr(Dwarf_Die <<
169 Dwarf_Die <<
170 <<
171 /* Save all variables and parameters in this s <<
172 void die_collect_vars(Dwarf_Die *sc_die, struc <<
173 <<
174 /* Save all global variables in this CU */ <<
175 void die_collect_global_vars(Dwarf_Die *cu_die <<
176 <<
177 #else /* HAVE_DWARF_GETLOCATIONS_SUPPORT */ <<
178 <<
179 static inline int die_get_var_range(Dwarf_Die <<
180 Dwarf_Die <<
181 struct str <<
182 { <<
183 return -ENOTSUP; <<
184 } <<
185 <<
186 static inline Dwarf_Die *die_find_variable_by_ <<
187 <<
188 <<
189 <<
190 <<
191 <<
192 { <<
193 return NULL; <<
194 } <<
195 <<
196 static inline Dwarf_Die *die_find_variable_by_ <<
197 <<
198 <<
199 <<
200 { <<
201 return NULL; <<
202 } <<
203 <<
204 static inline void die_collect_vars(Dwarf_Die <<
205 struct die <<
206 { <<
207 } <<
208 <<
209 static inline void die_collect_global_vars(Dwa <<
210 str <<
211 { <<
212 } <<
213 <<
214 #endif /* HAVE_DWARF_GETLOCATIONS_SUPPORT */ <<
215 <<
216 #ifdef HAVE_DWARF_CFI_SUPPORT <<
217 <<
218 /* Get the frame base information from CFA */ <<
219 int die_get_cfa(Dwarf *dwarf, u64 pc, int *pre <<
220 <<
221 #else /* HAVE_DWARF_CFI_SUPPORT */ <<
222 <<
223 static inline int die_get_cfa(Dwarf *dwarf __m <<
224 int *preg __mayb <<
225 { <<
226 return -1; <<
227 } <<
228 <<
229 #endif /* HAVE_DWARF_CFI_SUPPORT */ <<
230 <<
231 #endif /* _DWARF_AUX_H */ <<
232 140
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.