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 /* Find the realpath of the target file */
  14 const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname);
  15
  16 /* Get DW_AT_comp_dir (should be NULL with older gcc) */
  17 const char *cu_get_comp_dir(Dwarf_Die *cu_die);
  18
  19 /* Get a line number and file name for given address */
  20 int cu_find_lineinfo(Dwarf_Die *cudie, unsigned long addr,
  21                      const char **fname, int *lineno);
  22
  23 /* Walk on funcitons at given address */
  24 int cu_walk_functions_at(Dwarf_Die *cu_die, Dwarf_Addr addr,
  25                          int (*callback)(Dwarf_Die *, void *), void *data);
  26
  27 /* Get DW_AT_linkage_name (should be NULL for C binary) */
  28 const char *die_get_linkage_name(Dwarf_Die *dw_die);
  29
  30 /* Ensure that this DIE is a subprogram and definition (not declaration) */
  31 bool die_is_func_def(Dwarf_Die *dw_die);
  32
  33 /* Ensure that this DIE is an instance of a subprogram */
  34 bool die_is_func_instance(Dwarf_Die *dw_die);
  35
  36 /* Compare diename and tname */
  37 bool die_compare_name(Dwarf_Die *dw_die, const char *tname);
  38
  39 /* Matching diename with glob pattern */
  40 bool die_match_name(Dwarf_Die *dw_die, const char *glob);
  41
  42 /* Get callsite line number of inline-function instance */
  43 int die_get_call_lineno(Dwarf_Die *in_die);
  44
  45 /* Get callsite file name of inlined function instance */
  46 const char *die_get_call_file(Dwarf_Die *in_die);
  47
  48 /* Get type die */
  49 Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
  50
  51 /* Get a type die, but skip qualifiers and typedef */
  52 Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
  53
  54 /* Check whether the DIE is signed or not */
  55 bool die_is_signed_type(Dwarf_Die *tp_die);
  56
  57 /* Get data_member_location offset */
  58 int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs);
  59
  60 /* Return values for die_find_child() callbacks */
  61 enum {
  62         DIE_FIND_CB_END = 0,            /* End of Search */
  63         DIE_FIND_CB_CHILD = 1,          /* Search only children */
  64         DIE_FIND_CB_SIBLING = 2,        /* Search only siblings */
  65         DIE_FIND_CB_CONTINUE = 3,       /* Search children and siblings */
  66 };
  67
  68 /* Search child DIEs */
  69 Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
  70                          int (*callback)(Dwarf_Die *, void *),
  71                          void *data, Dwarf_Die *die_mem);
  72
  73 /* Search a non-inlined function including given address */
  74 Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
  75                              Dwarf_Die *die_mem);
  76
  77 /* Search a non-inlined function with tail call at given address */
  78 Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
  79                                     Dwarf_Die *die_mem);
  80
  81 /* Search the top inlined function including given address */
  82 Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
  83                                    Dwarf_Die *die_mem);
  84
  85 /* Search the deepest inlined function including given address */
  86 Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
  87                                Dwarf_Die *die_mem);
  88
  89 /* Walk on the instances of given DIE */
  90 int die_walk_instances(Dwarf_Die *in_die,
  91                        int (*callback)(Dwarf_Die *, void *), void *data);
  92
  93 /* Walker on lines (Note: line number will not be sorted) */
  94 typedef int (* line_walk_callback_t) (const char *fname, int lineno,
  95                                       Dwarf_Addr addr, void *data);
  96
  97 /*
  98  * Walk on lines inside given DIE. If the DIE is a subprogram, walk only on
  99  * the lines inside the subprogram, otherwise the DIE must be a CU DIE.
 100  */
 101 int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data);
 102
 103 /* Find a variable called 'name' at given address */
 104 Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
 105                                 Dwarf_Addr addr, Dwarf_Die *die_mem);
 106
 107 /* Find a member called 'name' */
 108 Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
 109                            Dwarf_Die *die_mem);
 110
 111 /* Get the name of given variable DIE */
 112 int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf);
 113
 114 /* Get the name and type of given variable DIE, stored as "type\tname" */
 115 int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf);
 116 int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf);
 117
 118 /* Check if target program is compiled with optimization */
 119 bool die_is_optimized_target(Dwarf_Die *cu_die);
 120
 121 /* Use next address after prologue as probe location */
 122 void die_skip_prologue(Dwarf_Die *sp_die, Dwarf_Die *cu_die,
 123                        Dwarf_Addr *entrypc);
 124
 125 #endif