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 /* Get a pointer/array type, following typedefs/qualifiers */ 64 Dwarf_Die *die_get_pointer_type(Dwarf_Die *type_die, Dwarf_Die *die_mem); 65 66 /* Check whether the DIE is signed or not */ 67 bool die_is_signed_type(Dwarf_Die *tp_die); 68 69 /* Get data_member_location offset */ 70 int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs); 71 72 /* Return values for die_find_child() callbacks */ 73 enum { 74 DIE_FIND_CB_END = 0, /* End of Search */ 75 DIE_FIND_CB_CHILD = 1, /* Search only children */ 76 DIE_FIND_CB_SIBLING = 2, /* Search only siblings */ 77 DIE_FIND_CB_CONTINUE = 3, /* Search children and siblings */ 78 }; 79 80 /* Search child DIEs */ 81 Dwarf_Die *die_find_child(Dwarf_Die *rt_die, 82 int (*callback)(Dwarf_Die *, void *), 83 void *data, Dwarf_Die *die_mem); 84 85 /* Search a non-inlined function including given address */ 86 Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr, 87 Dwarf_Die *die_mem); 88 89 /* Search a non-inlined function with tail call at given address */ 90 Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr, 91 Dwarf_Die *die_mem); 92 93 /* Search the top inlined function including given address */ 94 Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr, 95 Dwarf_Die *die_mem); 96 97 /* Search the deepest inlined function including given address */ 98 Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr, 99 Dwarf_Die *die_mem); 100 101 /* Search a non-inlined function by name and returns its return type */ 102 Dwarf_Die *die_find_func_rettype(Dwarf_Die *sp_die, const char *name, 103 Dwarf_Die *die_mem); 104 105 /* Walk on the instances of given DIE */ 106 int die_walk_instances(Dwarf_Die *in_die, 107 int (*callback)(Dwarf_Die *, void *), void *data); 108 109 /* Walker on lines (Note: line number will not be sorted) */ 110 typedef int (* line_walk_callback_t) (const char *fname, int lineno, 111 Dwarf_Addr addr, void *data); 112 113 /* 114 * Walk on lines inside given DIE. If the DIE is a subprogram, walk only on 115 * the lines inside the subprogram, otherwise the DIE must be a CU DIE. 116 */ 117 int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data); 118 119 /* Find a variable called 'name' at given address */ 120 Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name, 121 Dwarf_Addr addr, Dwarf_Die *die_mem); 122 123 /* Find a member called 'name' */ 124 Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name, 125 Dwarf_Die *die_mem); 126 127 /* Get the name of given type DIE */ 128 int die_get_typename_from_type(Dwarf_Die *type_die, struct strbuf *buf); 129 130 /* Get the name of given variable DIE */ 131 int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf); 132 133 /* Get the name and type of given variable DIE, stored as "type\tname" */ 134 int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf); 135 136 /* Check if target program is compiled with optimization */ 137 bool die_is_optimized_target(Dwarf_Die *cu_die); 138 139 /* Use next address after prologue as probe location */ 140 void die_skip_prologue(Dwarf_Die *sp_die, Dwarf_Die *cu_die, 141 Dwarf_Addr *entrypc); 142 143 /* Get the list of including scopes */ 144 int die_get_scopes(Dwarf_Die *cu_die, Dwarf_Addr pc, Dwarf_Die **scopes); 145 146 /* Variable type information */ 147 struct die_var_type { 148 struct die_var_type *next; 149 u64 die_off; 150 u64 addr; 151 u64 end; /* end address of location range */ 152 int reg; 153 int offset; 154 /* Whether the register holds a address to the type */ 155 bool is_reg_var_addr; 156 bool has_range; /* whether end is valid */ 157 }; 158 159 /* Return type info of a member at offset */ 160 Dwarf_Die *die_get_member_type(Dwarf_Die *type_die, int offset, Dwarf_Die *die_mem); 161 162 /* Return type info where the pointer and offset point to */ 163 Dwarf_Die *die_deref_ptr_type(Dwarf_Die *ptr_die, int offset, Dwarf_Die *die_mem); 164 165 /* Get byte offset range of given variable DIE */ 166 int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf); 167 168 /* Find a variable saved in the 'reg' at given address */ 169 Dwarf_Die *die_find_variable_by_reg(Dwarf_Die *sc_die, Dwarf_Addr pc, int reg, 170 Dwarf_Die *type_die, int *poffset, bool is_fbreg, 171 Dwarf_Die *die_mem); 172 173 /* Find a (global) variable located in the 'addr' */ 174 Dwarf_Die *die_find_variable_by_addr(Dwarf_Die *sc_die, Dwarf_Addr addr, 175 Dwarf_Die *die_mem, Dwarf_Die *type_die, 176 int *offset); 177 178 /* Save all variables and parameters in this scope */ 179 void die_collect_vars(Dwarf_Die *sc_die, struct die_var_type **var_types); 180 181 /* Save all global variables in this CU */ 182 void die_collect_global_vars(Dwarf_Die *cu_die, struct die_var_type **var_types); 183 184 /* Get the frame base information from CFA */ 185 int die_get_cfa(Dwarf *dwarf, u64 pc, int *preg, int *poffset); 186 187 #endif /* _DWARF_AUX_H */ 188