c8e491bc133f9c169cab8fbd468f496c87201520
[linux-2.6.git] / tools / perf / util / dwarf-aux.h
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 /* Compare diename and tname */
38 extern bool die_compare_name(Dwarf_Die *dw_die, const char *tname);
39
40 /* Get callsite line number of inline-function instance */
41 extern int die_get_call_lineno(Dwarf_Die *in_die);
42
43 /* Get callsite file name of inlined function instance */
44 extern const char *die_get_call_file(Dwarf_Die *in_die);
45
46 /* Get type die */
47 extern Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
48
49 /* Get a type die, but skip qualifiers and typedef */
50 extern Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
51
52 /* Check whether the DIE is signed or not */
53 extern bool die_is_signed_type(Dwarf_Die *tp_die);
54
55 /* Get data_member_location offset */
56 extern int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs);
57
58 /* Return values for die_find_child() callbacks */
59 enum {
60         DIE_FIND_CB_END = 0,            /* End of Search */
61         DIE_FIND_CB_CHILD = 1,          /* Search only children */
62         DIE_FIND_CB_SIBLING = 2,        /* Search only siblings */
63         DIE_FIND_CB_CONTINUE = 3,       /* Search children and siblings */
64 };
65
66 /* Search child DIEs */
67 extern Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
68                                  int (*callback)(Dwarf_Die *, void *),
69                                  void *data, Dwarf_Die *die_mem);
70
71 /* Search a non-inlined function including given address */
72 extern Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
73                                     Dwarf_Die *die_mem);
74
75 /* Search an inlined function including given address */
76 extern Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
77                                       Dwarf_Die *die_mem);
78
79 /* Walker on lines (Note: line number will not be sorted) */
80 typedef int (* line_walk_callback_t) (const char *fname, int lineno,
81                                       Dwarf_Addr addr, void *data);
82
83 /*
84  * Walk on lines inside given DIE. If the DIE is a subprogram, walk only on
85  * the lines inside the subprogram, otherwise the DIE must be a CU DIE.
86  */
87 extern int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback,
88                           void *data);
89
90 /* Find a variable called 'name' at given address */
91 extern Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
92                                        Dwarf_Addr addr, Dwarf_Die *die_mem);
93
94 /* Find a member called 'name' */
95 extern Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
96                                   Dwarf_Die *die_mem);
97
98 /* Get the name of given variable DIE */
99 extern int die_get_typename(Dwarf_Die *vr_die, char *buf, int len);
100
101 /* Get the name and type of given variable DIE, stored as "type\tname" */
102 extern int die_get_varname(Dwarf_Die *vr_die, char *buf, int len);
103 #endif