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