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