blob: 8ac53bf1ec4e4baef19c89f1d8c0968363a6ed74 [file] [log] [blame]
Masami Hiramatsue0d153c2011-06-27 16:27:27 +09001#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 */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030028const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090029
30/* Get DW_AT_comp_dir (should be NULL with older gcc) */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030031const char *cu_get_comp_dir(Dwarf_Die *cu_die);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090032
33/* Get a line number and file name for given address */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030034int cu_find_lineinfo(Dwarf_Die *cudie, unsigned long addr,
35 const char **fname, int *lineno);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090036
Masami Hiramatsu221d0612011-08-11 20:02:59 +090037/* Walk on funcitons at given address */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030038int cu_walk_functions_at(Dwarf_Die *cu_die, Dwarf_Addr addr,
39 int (*callback)(Dwarf_Die *, void *), void *data);
Masami Hiramatsu221d0612011-08-11 20:02:59 +090040
Masami Hiramatsud5a00292016-09-24 00:35:31 +090041/* Get DW_AT_linkage_name (should be NULL for C binary) */
42const char *die_get_linkage_name(Dwarf_Die *dw_die);
43
Masami Hiramatsu0dbb1ca2012-04-23 12:24:36 +090044/* Ensure that this DIE is a subprogram and definition (not declaration) */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030045bool die_is_func_def(Dwarf_Die *dw_die);
Masami Hiramatsu0dbb1ca2012-04-23 12:24:36 +090046
Masami Hiramatsue1ecbbc2015-01-30 18:37:44 +090047/* Ensure that this DIE is an instance of a subprogram */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030048bool die_is_func_instance(Dwarf_Die *dw_die);
Masami Hiramatsue1ecbbc2015-01-30 18:37:44 +090049
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090050/* Compare diename and tname */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030051bool die_compare_name(Dwarf_Die *dw_die, const char *tname);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090052
Masami Hiramatsu4c859352015-05-08 10:03:35 +090053/* Matching diename with glob pattern */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030054bool die_match_name(Dwarf_Die *dw_die, const char *glob);
Masami Hiramatsu4c859352015-05-08 10:03:35 +090055
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090056/* Get callsite line number of inline-function instance */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030057int die_get_call_lineno(Dwarf_Die *in_die);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090058
Masami Hiramatsub0e9cb22011-08-11 20:02:41 +090059/* Get callsite file name of inlined function instance */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030060const char *die_get_call_file(Dwarf_Die *in_die);
Masami Hiramatsub0e9cb22011-08-11 20:02:41 +090061
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090062/* Get type die */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030063Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090064
65/* Get a type die, but skip qualifiers and typedef */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030066Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090067
68/* Check whether the DIE is signed or not */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030069bool die_is_signed_type(Dwarf_Die *tp_die);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090070
71/* Get data_member_location offset */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030072int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090073
74/* Return values for die_find_child() callbacks */
75enum {
76 DIE_FIND_CB_END = 0, /* End of Search */
77 DIE_FIND_CB_CHILD = 1, /* Search only children */
78 DIE_FIND_CB_SIBLING = 2, /* Search only siblings */
79 DIE_FIND_CB_CONTINUE = 3, /* Search children and siblings */
80};
81
82/* Search child DIEs */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030083Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
84 int (*callback)(Dwarf_Die *, void *),
85 void *data, Dwarf_Die *die_mem);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090086
87/* Search a non-inlined function including given address */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030088Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
89 Dwarf_Die *die_mem);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +090090
Naveen N. Raod4c537e2015-04-30 17:12:31 +053091/* Search a non-inlined function with tail call at given address */
92Dwarf_Die *die_find_tailfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
93 Dwarf_Die *die_mem);
94
Masami Hiramatsue08cfd42013-09-30 18:21:44 +090095/* Search the top inlined function including given address */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -030096Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
97 Dwarf_Die *die_mem);
Masami Hiramatsue08cfd42013-09-30 18:21:44 +090098
99/* Search the deepest inlined function including given address */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -0300100Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
101 Dwarf_Die *die_mem);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +0900102
Masami Hiramatsudb0d2c62011-08-11 20:03:11 +0900103/* Walk on the instances of given DIE */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -0300104int die_walk_instances(Dwarf_Die *in_die,
105 int (*callback)(Dwarf_Die *, void *), void *data);
Masami Hiramatsudb0d2c62011-08-11 20:03:11 +0900106
Masami Hiramatsue0d153c2011-06-27 16:27:27 +0900107/* Walker on lines (Note: line number will not be sorted) */
108typedef int (* line_walk_callback_t) (const char *fname, int lineno,
109 Dwarf_Addr addr, void *data);
110
111/*
112 * Walk on lines inside given DIE. If the DIE is a subprogram, walk only on
113 * the lines inside the subprogram, otherwise the DIE must be a CU DIE.
114 */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -0300115int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback, void *data);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +0900116
117/* Find a variable called 'name' at given address */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -0300118Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
119 Dwarf_Addr addr, Dwarf_Die *die_mem);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +0900120
121/* Find a member called 'name' */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -0300122Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
123 Dwarf_Die *die_mem);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +0900124
125/* Get the name of given variable DIE */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -0300126int die_get_typename(Dwarf_Die *vr_die, struct strbuf *buf);
Masami Hiramatsue0d153c2011-06-27 16:27:27 +0900127
128/* Get the name and type of given variable DIE, stored as "type\tname" */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -0300129int die_get_varname(Dwarf_Die *vr_die, struct strbuf *buf);
130int die_get_var_range(Dwarf_Die *sp_die, Dwarf_Die *vr_die, struct strbuf *buf);
Ravi Bangoria6243b9d2016-08-30 14:09:37 +0530131
132/* Check if target program is compiled with optimization */
133bool die_is_optimized_target(Dwarf_Die *cu_die);
134
135/* Use next address after prologue as probe location */
136void die_skip_prologue(Dwarf_Die *sp_die, Dwarf_Die *cu_die,
137 Dwarf_Addr *entrypc);
138
Masami Hiramatsue0d153c2011-06-27 16:27:27 +0900139#endif