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