Home | History | Annotate | Download | only in util
      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 /* Compare diename and tname */
     45 extern bool die_compare_name(Dwarf_Die *dw_die, const char *tname);
     46 
     47 /* Get callsite line number of inline-function instance */
     48 extern int die_get_call_lineno(Dwarf_Die *in_die);
     49 
     50 /* Get callsite file name of inlined function instance */
     51 extern const char *die_get_call_file(Dwarf_Die *in_die);
     52 
     53 /* Get type die */
     54 extern 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 extern 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 extern bool die_is_signed_type(Dwarf_Die *tp_die);
     61 
     62 /* Get data_member_location offset */
     63 extern 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 extern 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 extern Dwarf_Die *die_find_realfunc(Dwarf_Die *cu_die, Dwarf_Addr addr,
     80 				    Dwarf_Die *die_mem);
     81 
     82 /* Search the top inlined function including given address */
     83 extern Dwarf_Die *die_find_top_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
     84 					  Dwarf_Die *die_mem);
     85 
     86 /* Search the deepest inlined function including given address */
     87 extern Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
     88 				      Dwarf_Die *die_mem);
     89 
     90 /* Walk on the instances of given DIE */
     91 extern int die_walk_instances(Dwarf_Die *in_die,
     92 			      int (*callback)(Dwarf_Die *, void *), void *data);
     93 
     94 /* Walker on lines (Note: line number will not be sorted) */
     95 typedef int (* line_walk_callback_t) (const char *fname, int lineno,
     96 				      Dwarf_Addr addr, void *data);
     97 
     98 /*
     99  * Walk on lines inside given DIE. If the DIE is a subprogram, walk only on
    100  * the lines inside the subprogram, otherwise the DIE must be a CU DIE.
    101  */
    102 extern int die_walk_lines(Dwarf_Die *rt_die, line_walk_callback_t callback,
    103 			  void *data);
    104 
    105 /* Find a variable called 'name' at given address */
    106 extern 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 extern 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 extern int die_get_typename(Dwarf_Die *vr_die, char *buf, int len);
    115 
    116 /* Get the name and type of given variable DIE, stored as "type\tname" */
    117 extern int die_get_varname(Dwarf_Die *vr_die, char *buf, int len);
    118 #endif
    119