1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- DebugInfo. pub_tool_debuginfo.h ---*/ 4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* 7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This file is part of Valgrind, a dynamic binary instrumentation 8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown framework. 9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 10436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov Copyright (C) 2000-2013 Julian Seward 11ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown jseward@acm.org 12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is free software; you can redistribute it and/or 14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown modify it under the terms of the GNU General Public License as 15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown published by the Free Software Foundation; either version 2 of the 16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown License, or (at your option) any later version. 17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is distributed in the hope that it will be useful, but 19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown WITHOUT ANY WARRANTY; without even the implied warranty of 20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown General Public License for more details. 22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown You should have received a copy of the GNU General Public License 24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown along with this program; if not, write to the Free Software 25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 02111-1307, USA. 27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown The GNU General Public License is contained in the file COPYING. 29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PUB_TOOL_DEBUGINFO_H 32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_TOOL_DEBUGINFO_H 33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 34436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov#include "pub_tool_basics.h" // VG_ macro 35436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov 36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*====================================================================*/ 37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*=== Obtaining debug information ===*/ 38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*====================================================================*/ 39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Get the file/function/line number of the instruction at address 41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 'a'. For these four, if debug info for the address is found, it 42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown copies the info into the buffer/UInt and returns True. If not, it 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown returns False and nothing is copied. VG_(get_fnname) always 44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown demangles C++ function names. VG_(get_fnname_w_offset) is the 45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown same, except it appends "+N" to symbol names to indicate offsets. */ 46436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern Bool VG_(get_filename) ( Addr a, HChar* filename, Int n_filename ); 47436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern Bool VG_(get_fnname) ( Addr a, HChar* fnname, Int n_fnname ); 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(get_linenum) ( Addr a, UInt* linenum ); 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(get_fnname_w_offset) 50436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov ( Addr a, HChar* fnname, Int n_fnname ); 51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* This one is the most general. It gives filename, line number and 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown optionally directory name. filename and linenum may not be NULL. 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown dirname may be NULL, meaning that the caller does not want 55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown directory name info, in which case dirname_available must also be 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown NULL. If dirname is non-null, directory info is written to it, if 57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown it is available; if not available, '\0' is written to the first 58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown byte. In either case *dirname_available is set to indicate whether 59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown or not directory information was available. 60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Returned value indicates whether any filename/line info could be 62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown found. */ 63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(get_filename_linenum) 64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ( Addr a, 65436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov /*OUT*/HChar* filename, Int n_filename, 66436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov /*OUT*/HChar* dirname, Int n_dirname, 67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*OUT*/Bool* dirname_available, 68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*OUT*/UInt* linenum ); 69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Succeeds only if we find from debug info that 'a' is the address of the 71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown first instruction in a function -- as opposed to VG_(get_fnname) which 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown succeeds if we find from debug info that 'a' is the address of any 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown instruction in a function. Use this to instrument the start of 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown a particular function. Nb: if an executable/shared object is stripped 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown of its symbols, this function will not be able to recognise function 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown entry points within it. */ 77436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern Bool VG_(get_fnname_if_entry) ( Addr a, HChar* fnname, Int n_fnname ); 78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown enum { 81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Vg_FnNameNormal, // A normal function. 82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Vg_FnNameMain, // "main" 83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Vg_FnNameBelowMain // Something below "main", eg. __libc_start_main. 84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } Vg_FnNameKind; // Such names are often filtered. 85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Indicates what kind of fnname it is. */ 87436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern Vg_FnNameKind VG_(get_fnname_kind) ( HChar* name ); 88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Like VG_(get_fnname_kind), but takes a code address. */ 90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Vg_FnNameKind VG_(get_fnname_kind_from_IP) ( Addr ip ); 91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Looks up data_addr in the collection of data symbols, and if found 93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown puts its name (or as much as will fit) into dname[0 .. n_dname-1], 94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown which is guaranteed to be zero terminated. Also data_addr's offset 95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown from the symbol start is put into *offset. */ 96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(get_datasym_and_offset)( Addr data_addr, 97436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov /*OUT*/HChar* dname, Int n_dname, 98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*OUT*/PtrdiffT* offset ); 99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Try to form some description of DATA_ADDR by looking at the DWARF3 101436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov debug info we have. This considers all global variables, and 8 102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown frames in the stacks of all threads. Result is written at the ends 103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown of DNAME{1,2}V, which are XArray*s of HChar, that have been 104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown initialised by the caller, and True is returned. If no description 105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown is created, False is returned. Regardless of the return value, 106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown DNAME{1,2}V are guaranteed to be zero terminated after the call. 107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Note that after the call, DNAME{1,2} may have more than one 109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown trailing zero, so callers should establish the useful text length 110ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown using VG_(strlen) on the contents, rather than VG_(sizeXA) on the 111ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown XArray itself. 112ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 113ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool VG_(get_data_description)( 114ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*MOD*/ void* /* really, XArray* of HChar */ dname1v, 115ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*MOD*/ void* /* really, XArray* of HChar */ dname2v, 116ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr data_addr 117ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ); 118ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 119ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Succeeds if the address is within a shared object or the main executable. 120ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown It doesn't matter if debug info is present or not. */ 121436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern Bool VG_(get_objname) ( Addr a, HChar* objname, Int n_objname ); 122ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 123ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Puts into 'buf' info about the code address %eip: the address, function 124ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown name (if known) and filename/line number (if known), like this: 125ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 126ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 0x4001BF05: realloc (vg_replace_malloc.c:339) 127ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 128ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 'n_buf' gives length of 'buf'. Returns 'buf'. 129ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 130436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern HChar* VG_(describe_IP)(Addr eip, HChar* buf, Int n_buf); 131ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 132ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 133ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Get an XArray of StackBlock which describe the stack (auto) blocks 134ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown for this ip. The caller is expected to free the XArray at some 135ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown point. If 'arrays_only' is True, only array-typed blocks are 136ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown returned; otherwise blocks of all types are returned. */ 137ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 138ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 139ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 140ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown PtrdiffT base; /* offset from sp or fp */ 141ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SizeT szB; /* size in bytes */ 142ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Bool spRel; /* True => sp-rel, False => fp-rel */ 143ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Bool isVec; /* does block have an array type, or not? */ 144ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar name[16]; /* first 15 chars of name (asciiz) */ 145ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 146ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown StackBlock; 147ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 148ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void* /* really, XArray* of StackBlock */ 149ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_(di_get_stack_blocks_at_ip)( Addr ip, Bool arrays_only ); 150ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 151ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 152ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Get an array of GlobalBlock which describe the global blocks owned 153ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown by the shared object characterised by the given di_handle. Asserts 154ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown if the handle is invalid. The caller is responsible for freeing 155ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown the array at some point. If 'arrays_only' is True, only 156ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown array-typed blocks are returned; otherwise blocks of all types are 157ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown returned. */ 158ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 159ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 160ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 161ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr addr; 162ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SizeT szB; 163ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Bool isVec; /* does block have an array type, or not? */ 164ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar name[16]; /* first 15 chars of name (asciiz) */ 165ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar soname[16]; /* first 15 chars of name (asciiz) */ 166ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 167ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown GlobalBlock; 168ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 169ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void* /* really, XArray* of GlobalBlock */ 170ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownVG_(di_get_global_blocks_from_dihandle) ( ULong di_handle, 171ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Bool arrays_only ); 172ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 173ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 174ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*====================================================================*/ 175ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*=== Obtaining debug information ===*/ 176ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*====================================================================*/ 177ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 178ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* A way to make limited debuginfo queries on a per-mapped-object 179ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown basis. */ 180ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef struct _DebugInfo DebugInfo; 181ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 182ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Returns NULL if the DebugInfo isn't found. It doesn't matter if 183ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown debug info is present or not. */ 184ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownDebugInfo* VG_(find_DebugInfo) ( Addr a ); 185ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 186ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Fish bits out of DebugInfos. */ 187ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownAddr VG_(DebugInfo_get_text_avma) ( const DebugInfo *di ); 188ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownSizeT VG_(DebugInfo_get_text_size) ( const DebugInfo *di ); 189436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy IvanovAddr VG_(DebugInfo_get_bss_avma) ( const DebugInfo *di ); 190436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy IvanovSizeT VG_(DebugInfo_get_bss_size) ( const DebugInfo *di ); 191ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownAddr VG_(DebugInfo_get_plt_avma) ( const DebugInfo *di ); 192ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownSizeT VG_(DebugInfo_get_plt_size) ( const DebugInfo *di ); 193ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownAddr VG_(DebugInfo_get_gotplt_avma) ( const DebugInfo *di ); 194ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownSizeT VG_(DebugInfo_get_gotplt_size) ( const DebugInfo *di ); 195436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy IvanovAddr VG_(DebugInfo_get_got_avma) ( const DebugInfo *di ); 196436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy IvanovSizeT VG_(DebugInfo_get_got_size) ( const DebugInfo *di ); 197436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovconst HChar* VG_(DebugInfo_get_soname) ( const DebugInfo *di ); 198436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovconst HChar* VG_(DebugInfo_get_filename) ( const DebugInfo *di ); 199ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownPtrdiffT VG_(DebugInfo_get_text_bias) ( const DebugInfo *di ); 200ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 201ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Function for traversing the DebugInfo list. When called with NULL 202ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown it returns the first element; otherwise it returns the given 203ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown element's successor. Note that the order of elements in the list 204ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown changes in response to most of the queries listed in this header, 205ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown that explicitly or implicitly have to search the list for a 206ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown particular code address. So it isn't safe to assume that the order 207ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown of the list stays constant. */ 208ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownconst DebugInfo* VG_(next_DebugInfo) ( const DebugInfo *di ); 209ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 210ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Functions for traversing all the symbols in a DebugInfo. _howmany 211b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov tells how many symbol table entries there are. _getidx retrieves 212b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov the n'th entry, for n in 0 .. _howmany-1. You may not modify the 213b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov function names thereby acquired; if you want to do so, first strdup 214b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov them. The primary name is returned in *pri_name, and *sec_names is 215b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov set either to NULL or to a NULL terminated vector containing 216b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov pointers to the secondary names. */ 217ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownInt VG_(DebugInfo_syms_howmany) ( const DebugInfo *di ); 218ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid VG_(DebugInfo_syms_getidx) ( const DebugInfo *di, 219ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Int idx, 220b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov /*OUT*/Addr* avma, 221b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov /*OUT*/Addr* tocptr, 222b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov /*OUT*/UInt* size, 223436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov /*OUT*/HChar** pri_name, 224436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov /*OUT*/HChar*** sec_names, 225b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov /*OUT*/Bool* isText, 226b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov /*OUT*/Bool* isIFunc ); 227ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 228ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* A simple enumeration to describe the 'kind' of various kinds of 229ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown segments that arise from the mapping of object files. */ 230ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 231ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown enum { 232ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Vg_SectUnknown, 233ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Vg_SectText, 234ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Vg_SectData, 235ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Vg_SectBSS, 236ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Vg_SectGOT, 237ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Vg_SectPLT, 238ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Vg_SectGOTPLT, 239ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Vg_SectOPD 240ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 241ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgSectKind; 242ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 243ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Convert a VgSectKind to a string, which must be copied if you want 244ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown to change it. */ 245ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownconst HChar* VG_(pp_SectKind)( VgSectKind kind ); 246ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 247ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Given an address 'a', make a guess of which section of which object 248ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown it comes from. If name is non-NULL, then the last n_name-1 249ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown characters of the object's name is put in name[0 .. n_name-2], and 250ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown name[n_name-1] is set to zero (guaranteed zero terminated). */ 251436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy IvanovVgSectKind VG_(DebugInfo_sect_kind)( /*OUT*/HChar* name, SizeT n_name, 252ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr a); 253ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 254ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 255ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif // __PUB_TOOL_DEBUGINFO_H 256ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 257ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 258ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end ---*/ 259ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 260