xref: /linux/tools/perf/util/dwarf-aux.h (revision c0e297dc61f8d4453e07afbea1fa8d0e67cd4a34)
1 #ifndef _DWARF_AUX_H
2 #define _DWARF_AUX_H
3 /*
4  * dwarf-aux.h : libdw auxiliary interfaces
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19  *
20  */
21 
22 #include <dwarf.h>
23 #include <elfutils/libdw.h>
24 #include <elfutils/libdwfl.h>
25 #include <elfutils/version.h>
26 
27 /* Find the realpath of the target file */
28 extern const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname);
29 
30 /* Get DW_AT_comp_dir (should be NULL with older gcc) */
31 extern const char *cu_get_comp_dir(Dwarf_Die *cu_die);
32 
33 /* Get a line number and file name for given address */
34 extern int cu_find_lineinfo(Dwarf_Die *cudie, unsigned long addr,
35 			    const char **fname, int *lineno);
36 
37 /* Walk on funcitons at given address */
38 extern int cu_walk_functions_at(Dwarf_Die *cu_die, Dwarf_Addr addr,
39 			int (*callback)(Dwarf_Die *, void *), void *data);
40 
41 /* Ensure that this DIE is a subprogram and definition (not declaration) */
42 extern bool die_is_func_def(Dwarf_Die *dw_die);
43 
44 /* Ensure that this DIE is an instance of a subprogram */
45 extern bool die_is_func_instance(Dwarf_Die *dw_die);
46 
47 /* Compare diename and tname */
48 extern bool die_compare_name(Dwarf_Die *dw_die, const char *tname);
49 
50 /* Matching diename with glob pattern */
51 extern bool die_match_name(Dwarf_Die *dw_die, const char *glob);
52 
53 /* Get callsite line number of inline-function instance */
54 extern int die_get_call_lineno(Dwarf_Die *in_die);
55 
56 /* Get callsite file name of inlined function instance */
57 extern const char *die_get_call_file(Dwarf_Die *in_die);
58 
59 /* Get type die */
60 extern Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
61 
62 /* Get a type die, but skip qualifiers and typedef */
63 extern Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
64 
65 /* Check whether the DIE is signed or not */
66 extern bool die_is_signed_type(Dwarf_Die *tp_die);
67 
68 /* Get data_member_location offset */
69 extern int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs);
70 
71 /* Return values for die_find_child() callbacks */
72 enum {
73 	DIE_FIND_CB_END = 0,		/* End of Search */
74 	DIE_FIND_CB_CHILD = 1,		/* Search only children */
75 	DIE_FIND_CB_SIBLING = 2,	/* Search only siblings */
76 	DIE_FIND_CB_CONTINUE = 3,	/* Search children and siblings */
77 };
78 
79 /* Search child DIEs */
80 extern Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
81 				 int (*callback)(Dwarf_Die *, void *),
82 				 void *data, Dwarf_Die *die_mem);
83 
84 /* Search a non-inlined function including given address */
85 extern Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
86 				    Dwarf_Die *die_mem);
87 
88 /* Search a non-inlined function with tail call at given address */
89 Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
90 				    Dwarf_Die *die_mem);
91 
92 /* Search the top inlined function including given address */
93 extern Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
94 					  Dwarf_Die *die_mem);
95 
96 /* Search the deepest inlined function including given address */
97 extern Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
98 				      Dwarf_Die *die_mem);
99 
100 /* Walk on the instances of given DIE */
101 extern int die_walk_instances(Dwarf_Die *in_die,
102 			      int (*callback)(Dwarf_Die *, void *), void *data);
103 
104 /* Walker on lines (Note: line number will not be sorted) */
105 typedef int (* line_walk_callback_t) (const char *fname, int lineno,
106 				      Dwarf_Addr addr, void *data);
107 
108 /*
109  * Walk on lines inside given DIE. If the DIE is a subprogram, walk only on
110  * the lines inside the subprogram, otherwise the DIE must be a CU DIE.
111  */
112 extern int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback,
113 			  void *data);
114 
115 /* Find a variable called 'name' at given address */
116 extern Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
117 				       Dwarf_Addr addr, Dwarf_Die *die_mem);
118 
119 /* Find a member called 'name' */
120 extern Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
121 				  Dwarf_Die *die_mem);
122 
123 /* Get the name of given variable DIE */
124 extern int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf);
125 
126 /* Get the name and type of given variable DIE, stored as "type\tname" */
127 extern int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf);
128 extern int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die,
129 			struct strbuf *buf);
130 #endif
131