1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Debug info. pub_core_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 10b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov Copyright (C) 2000-2011 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_CORE_DEBUGINFO_H 32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_CORE_DEBUGINFO_H 33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//-------------------------------------------------------------------- 35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// PURPOSE: This module deals with reading debug info and symbol tables 36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// to get file and function names, line numbers, variable types, and 37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// to help stack unwinding. 38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//-------------------------------------------------------------------- 39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_tool_debuginfo.h" 41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Initialise the entire module. Must be called first of all. */ 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(di_initialise) ( void ); 44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* LINUX: Notify the debuginfo system about a new mapping, or the 46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown disappearance of such, or a permissions change on an existing 47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown mapping. This is the way new debug information gets loaded. If 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown allow_SkFileV is True, it will try load debug info if the mapping 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown at 'a' belongs to Valgrind; whereas normally (False) it will not do 50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown that. This allows us to carefully control when the thing will read 51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown symbols from the Valgrind executable itself. 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown If a call to VG_(di_notify_mmap) causes debug info to be read, then 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown the returned ULong is an abstract handle which can later be used to 55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown refer to the debuginfo read as a result of this specific mapping, 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown in later queries to m_debuginfo. In this case the handle value 57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown will be one or above. If the returned value is zero, no debug info 58b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov was read. 59b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov 60b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov For VG_(di_notify_mmap), if use_fd is not -1, that is used instead 61b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov of the filename; this avoids perturbing fcntl locks, which are 62b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov released by simply re-opening and closing the same file (even via 63b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov different fd!). 64b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov*/ 65b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov#if defined(VGO_linux) || defined(VGO_darwin) 66b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern ULong VG_(di_notify_mmap)( Addr a, Bool allow_SkFileV, Int use_fd ); 67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(di_notify_munmap)( Addr a, SizeT len ); 69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(di_notify_mprotect)( Addr a, SizeT len, UInt prot ); 71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* this should really return ULong, as per VG_(di_notify_mmap). */ 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(di_notify_pdb_debuginfo)( Int fd, Addr avma, 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SizeT total_size, 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown PtrdiffT unknown_purpose__reloc ); 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 77b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov/* this should also really return ULong */ 78b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern void VG_(di_notify_vm_protect)( Addr a, SizeT len, UInt prot ); 79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(di_discard_ALL_debuginfo)( void ); 82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Like VG_(get_fnname), but it does not do C++ demangling nor Z-demangling 84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown * nor below-main renaming. 85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown * It should not be used for any names that will be shown to users. 86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown * It should only be used in cases where the names of interest will have 87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown * particular (ie. non-mangled) forms, or the mangled form is acceptable. */ 88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern 89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool VG_(get_fnname_raw) ( Addr a, Char* buf, Int nbuf ); 90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Like VG_(get_fnname), but without C++ demangling. (But it does 92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown * Z-demangling and below-main renaming.) */ 93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern 94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool VG_(get_fnname_no_cxx_demangle) ( Addr a, Char* buf, Int nbuf ); 95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Use DWARF2/3 CFA information to do one step of stack unwinding. 98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown D3UnwindRegs holds the current register values, and is 99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown arch-specific. Note that the x86 and amd64 definitions are shared 100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown and so the regs are named 'xip' etc rather than 'eip' and 'rip'. */ 101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#if defined(VGA_amd64) || defined(VGA_x86) 102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { Addr xip; Addr xsp; Addr xbp; } 104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown D3UnwindRegs; 105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGA_arm) 106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { Addr r15; Addr r14; Addr r13; Addr r12; Addr r11; Addr r7; } 108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown D3UnwindRegs; 109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGA_ppc32) || defined(VGA_ppc64) 110ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 111ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UChar /* should be void, but gcc complains at use points */ 112ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown D3UnwindRegs; 113b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov#elif defined(VGA_s390x) 114b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovtypedef 115b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov struct { Addr ia; Addr sp; Addr fp; Addr lr;} 116b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov D3UnwindRegs; 117ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#else 118ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# error "Unsupported arch" 119ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 120ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 121ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(use_CF_info) ( /*MOD*/D3UnwindRegs* uregs, 122ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr min_accessible, 123ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr max_accessible ); 124ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 125ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 126ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Use MSVC FPO data to do one step of stack unwinding. */ 127ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(use_FPO_info) ( /*MOD*/Addr* ipP, 128ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*MOD*/Addr* spP, 129ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*MOD*/Addr* fpP, 130ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr min_accessible, 131ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr max_accessible ); 132ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 133ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ppc64-linux only: find the TOC pointer (R2 value) that should be in 134ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown force at the entry point address of the function containing 135ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown guest_code_addr. Returns 0 if not known. */ 136ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Addr VG_(get_tocptr) ( Addr guest_code_addr ); 137ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 138ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Map a function name to its entry point and toc pointer. Is done by 139ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown sequential search of all symbol tables, so is very slow. To 140ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown mitigate the worst performance effects, you may specify a soname 141ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown pattern, and only objects matching that pattern are searched. 142ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Therefore specify "*" to search all the objects. On TOC-afflicted 143ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown platforms, a symbol is deemed to be found only if it has a nonzero 144ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown TOC pointer. */ 145ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern 146ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool VG_(lookup_symbol_SLOW)(UChar* sopatt, UChar* name, Addr* pEnt, Addr* pToc); 147ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 148ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif // __PUB_CORE_DEBUGINFO_H 149ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 150ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 151ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end ---*/ 152ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 153