• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 type die */
54  Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
55  
56  /* Get a type die, but skip qualifiers and typedef */
57  Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
58  
59  /* Check whether the DIE is signed or not */
60  bool die_is_signed_type(Dwarf_Die *tp_die);
61  
62  /* Get data_member_location offset */
63  int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs);
64  
65  /* Return values for die_find_child() callbacks */
66  enum {
67  	DIE_FIND_CB_END = 0,		/* End of Search */
68  	DIE_FIND_CB_CHILD = 1,		/* Search only children */
69  	DIE_FIND_CB_SIBLING = 2,	/* Search only siblings */
70  	DIE_FIND_CB_CONTINUE = 3,	/* Search children and siblings */
71  };
72  
73  /* Search child DIEs */
74  Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
75  			 int (*callback)(Dwarf_Die *, void *),
76  			 void *data, Dwarf_Die *die_mem);
77  
78  /* Search a non-inlined function including given address */
79  Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
80  			     Dwarf_Die *die_mem);
81  
82  /* Search a non-inlined function with tail call at given address */
83  Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
84  				    Dwarf_Die *die_mem);
85  
86  /* Search the top inlined function including given address */
87  Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
88  				   Dwarf_Die *die_mem);
89  
90  /* Search the deepest inlined function including given address */
91  Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
92  			       Dwarf_Die *die_mem);
93  
94  /* Walk on the instances of given DIE */
95  int die_walk_instances(Dwarf_Die *in_die,
96  		       int (*callback)(Dwarf_Die *, void *), void *data);
97  
98  /* Walker on lines (Note: line number will not be sorted) */
99  typedef int (* line_walk_callback_t) (const char *fname, int lineno,
100  				      Dwarf_Addr addr, void *data);
101  
102  /*
103   * Walk on lines inside given DIE. If the DIE is a subprogram, walk only on
104   * the lines inside the subprogram, otherwise the DIE must be a CU DIE.
105   */
106  int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data);
107  
108  /* Find a variable called 'name' at given address */
109  Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
110  				Dwarf_Addr addr, Dwarf_Die *die_mem);
111  
112  /* Find a member called 'name' */
113  Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
114  			   Dwarf_Die *die_mem);
115  
116  /* Get the name of given variable DIE */
117  int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf);
118  
119  /* Get the name and type of given variable DIE, stored as "type\tname" */
120  int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf);
121  int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf);
122  
123  /* Check if target program is compiled with optimization */
124  bool die_is_optimized_target(Dwarf_Die *cu_die);
125  
126  /* Use next address after prologue as probe location */
127  void die_skip_prologue(Dwarf_Die *sp_die, Dwarf_Die *cu_die,
128  		       Dwarf_Addr *entrypc);
129  
130  #endif
131