njn | ea27e46 | 2005-05-31 02:38:09 +0000 | [diff] [blame] | 1 | |
| 2 | /*--------------------------------------------------------------------*/ |
| 3 | /*--- DebugInfo. pub_tool_debuginfo.h ---*/ |
| 4 | /*--------------------------------------------------------------------*/ |
| 5 | |
| 6 | /* |
| 7 | This file is part of Valgrind, a dynamic binary instrumentation |
| 8 | framework. |
| 9 | |
| 10 | Copyright (C) 2000-2005 Julian Seward |
| 11 | jseward@acm.org |
| 12 | |
| 13 | This program is free software; you can redistribute it and/or |
| 14 | modify it under the terms of the GNU General Public License as |
| 15 | published by the Free Software Foundation; either version 2 of the |
| 16 | License, or (at your option) any later version. |
| 17 | |
| 18 | This program is distributed in the hope that it will be useful, but |
| 19 | WITHOUT ANY WARRANTY; without even the implied warranty of |
| 20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 21 | General Public License for more details. |
| 22 | |
| 23 | You should have received a copy of the GNU General Public License |
| 24 | along with this program; if not, write to the Free Software |
| 25 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 26 | 02111-1307, USA. |
| 27 | |
| 28 | The GNU General Public License is contained in the file COPYING. |
| 29 | */ |
| 30 | |
| 31 | #ifndef __PUB_TOOL_DEBUGINFO_H |
| 32 | #define __PUB_TOOL_DEBUGINFO_H |
| 33 | |
| 34 | /*====================================================================*/ |
| 35 | /*=== Obtaining debug information ===*/ |
| 36 | /*====================================================================*/ |
| 37 | |
| 38 | /* Get the file/function/line number of the instruction at address |
| 39 | 'a'. For these four, if debug info for the address is found, it |
| 40 | copies the info into the buffer/UInt and returns True. If not, it |
| 41 | returns False and nothing is copied. VG_(get_fnname) always |
| 42 | demangles C++ function names. VG_(get_fnname_w_offset) is the |
| 43 | same, except it appends "+N" to symbol names to indicate offsets. */ |
| 44 | extern Bool VG_(get_filename) ( Addr a, Char* filename, Int n_filename ); |
| 45 | extern Bool VG_(get_fnname) ( Addr a, Char* fnname, Int n_fnname ); |
| 46 | extern Bool VG_(get_linenum) ( Addr a, UInt* linenum ); |
| 47 | extern Bool VG_(get_fnname_w_offset) |
| 48 | ( Addr a, Char* fnname, Int n_fnname ); |
| 49 | |
sewardj | 7cee6f9 | 2005-06-13 17:39:06 +0000 | [diff] [blame] | 50 | /* This one is the most general. It gives filename, line number and |
| 51 | optionally directory name. filename and linenum may not be NULL. |
| 52 | dirname may be NULL, meaning that the caller does not want |
| 53 | directory name info, in which case dirname_available must also be |
| 54 | NULL. If dirname is non-null, directory info is written to it, if |
| 55 | it is available; if not available, '\0' is written to the first |
| 56 | byte. In either case *dirname_available is set to indicate whether |
| 57 | or not directory information was available. |
| 58 | |
| 59 | Returned value indicates whether any filename/line info could be |
| 60 | found. */ |
njn | ea27e46 | 2005-05-31 02:38:09 +0000 | [diff] [blame] | 61 | extern Bool VG_(get_filename_linenum) |
sewardj | 7cee6f9 | 2005-06-13 17:39:06 +0000 | [diff] [blame] | 62 | ( Addr a, |
| 63 | /*OUT*/Char* filename, Int n_filename, |
| 64 | /*OUT*/Char* dirname, Int n_dirname, |
| 65 | /*OUT*/Bool* dirname_available, |
| 66 | /*OUT*/UInt* linenum ); |
njn | ea27e46 | 2005-05-31 02:38:09 +0000 | [diff] [blame] | 67 | |
| 68 | /* Succeeds only if we find from debug info that 'a' is the address of the |
| 69 | first instruction in a function -- as opposed to VG_(get_fnname) which |
| 70 | succeeds if we find from debug info that 'a' is the address of any |
| 71 | instruction in a function. Use this to instrument the start of |
| 72 | a particular function. Nb: if an executable/shared object is stripped |
| 73 | of its symbols, this function will not be able to recognise function |
| 74 | entry points within it. */ |
| 75 | extern Bool VG_(get_fnname_if_entry) ( Addr a, Char* fnname, Int n_fnname ); |
| 76 | |
| 77 | /* Succeeds if the address is within a shared object or the main executable. |
| 78 | It doesn't matter if debug info is present or not. */ |
| 79 | extern Bool VG_(get_objname) ( Addr a, Char* objname, Int n_objname ); |
| 80 | |
| 81 | /* Puts into 'buf' info about the code address %eip: the address, function |
| 82 | name (if known) and filename/line number (if known), like this: |
| 83 | |
| 84 | 0x4001BF05: realloc (vg_replace_malloc.c:339) |
| 85 | |
| 86 | 'n_buf' gives length of 'buf'. Returns 'buf'. |
| 87 | */ |
| 88 | extern Char* VG_(describe_IP)(Addr eip, Char* buf, Int n_buf); |
| 89 | |
| 90 | /* Returns a string containing an expression for the given |
| 91 | address. String is malloced with VG_(malloc)() */ |
| 92 | Char *VG_(describe_addr)(ThreadId, Addr); |
| 93 | |
| 94 | /*====================================================================*/ |
| 95 | /*=== Obtaining segment information ===*/ |
| 96 | /*====================================================================*/ |
| 97 | |
| 98 | /* A way to get information about what segments are mapped */ |
| 99 | typedef struct _SegInfo SegInfo; |
| 100 | |
| 101 | /* Returns NULL if the SegInfo isn't found. It doesn't matter if debug info |
| 102 | is present or not. */ |
| 103 | extern SegInfo* VG_(get_obj) ( Addr a ); |
| 104 | |
njn | d9e5fd7 | 2005-06-25 19:51:33 +0000 | [diff] [blame^] | 105 | extern const SegInfo* VG_(next_seginfo) ( const SegInfo *si ); |
| 106 | extern Addr VG_(seginfo_start) ( const SegInfo *si ); |
| 107 | extern SizeT VG_(seginfo_size) ( const SegInfo *si ); |
| 108 | extern const UChar* VG_(seginfo_filename) ( const SegInfo *si ); |
| 109 | extern ULong VG_(seginfo_sym_offset)( const SegInfo *si ); |
njn | ea27e46 | 2005-05-31 02:38:09 +0000 | [diff] [blame] | 110 | |
| 111 | typedef |
| 112 | enum { |
| 113 | Vg_SectUnknown, |
| 114 | Vg_SectText, |
| 115 | Vg_SectData, |
| 116 | Vg_SectBSS, |
| 117 | Vg_SectGOT, |
| 118 | Vg_SectPLT |
| 119 | } |
| 120 | VgSectKind; |
| 121 | |
njn | d9e5fd7 | 2005-06-25 19:51:33 +0000 | [diff] [blame^] | 122 | extern VgSectKind VG_(seginfo_sect_kind)(Addr); |
njn | ea27e46 | 2005-05-31 02:38:09 +0000 | [diff] [blame] | 123 | |
| 124 | #endif // __PUB_TOOL_DEBUGINFO_H |
| 125 | |
| 126 | /*--------------------------------------------------------------------*/ |
| 127 | /*--- end ---*/ |
| 128 | /*--------------------------------------------------------------------*/ |