tools/perf/util/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
  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 and typedef */
  60 Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
  61
  62 /* Check whether the DIE is signed or not */
  63 bool die_is_signed_type(Dwarf_Die *tp_die);
  64
  65 /* Get data_member_location offset */
  66 int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs);
  67
  68 /* Return values for die_find_child() callbacks */
  69 enum {
  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 */
  77 Dwarf_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 */
  82 Dwarf_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 */
  86 Dwarf_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 */
  90 Dwarf_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 */
  94 Dwarf_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 */
  98 int 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) */
 102 typedef 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  */
 109 int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data);
 110
 111 /* Find a variable called 'name' at given address */
 112 Dwarf_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' */
 116 Dwarf_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 */
 120 int die_get_typename_from_type(Dwarf_Die *type_die, struct strbuf *buf);
 121
 122 /* Get the name of given variable DIE */
 123 int 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" */
 126 int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf);
 127
 128 /* Check if target program is compiled with optimization */
 129 bool die_is_optimized_target(Dwarf_Die *cu_die);
 130
 131 /* Use next address after prologue as probe location */
 132 void die_skip_prologue(Dwarf_Die *sp_die, Dwarf_Die *cu_die,
 133                        Dwarf_Addr *entrypc);
 134
 135 /* Get the list of including scopes */
 136 int die_get_scopes(Dwarf_Die *cu_die, Dwarf_Addr pc, Dwarf_Die **scopes);
 137
 138 #ifdef HAVE_DWARF_GETLOCATIONS_SUPPORT
 139
 140 /* Get byte offset range of given variable DIE */
 141 int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf);
 142
 143 /* Find a variable saved in the 'reg' at given address */
 144 Dwarf_Die *die_find_variable_by_reg(Dwarf_Die *sc_die, Dwarf_Addr pc, int reg,
 145                                     Dwarf_Die *die_mem);
 146
 147 /* Find a (global) variable located in the 'addr' */
 148 Dwarf_Die *die_find_variable_by_addr(Dwarf_Die *sc_die, Dwarf_Addr pc,
 149                                      Dwarf_Addr addr, Dwarf_Die *die_mem,
 150                                      int *offset);
 151
 152 #else /*  HAVE_DWARF_GETLOCATIONS_SUPPORT */
 153
 154 static inline int die_get_var_range(Dwarf_Die *sp_die __maybe_unused,
 155                                     Dwarf_Die *vr_die __maybe_unused,
 156                                     struct strbuf *buf __maybe_unused)
 157 {
 158         return -ENOTSUP;
 159 }
 160
 161 static inline Dwarf_Die *die_find_variable_by_reg(Dwarf_Die *sc_die __maybe_unused,
 162                                                   Dwarf_Addr pc __maybe_unused,
 163                                                   int reg __maybe_unused,
 164                                                   Dwarf_Die *die_mem __maybe_unused)
 165 {
 166         return NULL;
 167 }
 168
 169 static inline Dwarf_Die *die_find_variable_by_addr(Dwarf_Die *sc_die __maybe_unused,
 170                                                    Dwarf_Addr pc __maybe_unused,
 171                                                    Dwarf_Addr addr __maybe_unused,
 172                                                    Dwarf_Die *die_mem __maybe_unused,
 173                                                    int *offset __maybe_unused)
 174 {
 175         return NULL;
 176 }
 177
 178 #endif /* HAVE_DWARF_GETLOCATIONS_SUPPORT */
 179
 180 #endif /* _DWARF_AUX_H */