| njn | d01fef7 | 2005-03-25 23:35:48 +0000 | [diff] [blame] | 1 | /*--------------------------------------------------------------------*/ |
| 2 | /*--- Stack traces: getting, traversing, printing. ---*/ |
| 3 | /*--- tool_stacktrace.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_STACKTRACE_H |
| 32 | #define __PUB_TOOL_STACKTRACE_H |
| 33 | |
| 34 | #include "basic_types.h" |
| 35 | |
| 36 | // The basic stack trace type: just an array of code addresses. |
| 37 | typedef Addr* StackTrace; |
| 38 | |
| 39 | // Walks the stack to get instruction pointers from the top stack frames for |
| 40 | // thread 'tid'. Maximum of 'n_ips' addresses put into 'ips'; 0 is the top |
| 41 | // of the stack, 1 is its caller, etc. |
| 42 | extern UInt VG_(get_StackTrace) ( ThreadId tid, StackTrace ips, UInt n_ips ); |
| 43 | |
| 44 | // Apply a function to every element in the StackTrace. The parameter 'n' |
| 45 | // gives the index of the passed ip. Doesn't go below main() unless |
| 46 | // --show-below-main=yes is set. |
| 47 | extern void VG_(apply_StackTrace)( void(*action)(UInt n, Addr ip), |
| 48 | StackTrace ips, UInt n_ips ); |
| 49 | |
| 50 | // Print a StackTrace. |
| 51 | extern void VG_(pp_StackTrace) ( StackTrace ips, UInt n_ips ); |
| 52 | |
| 53 | // Gets and immediately prints a StackTrace. Just a bit simpler than |
| 54 | // calling VG_(get_StackTrace)() then VG_(pp_StackTrace)(). |
| 55 | extern void VG_(get_and_pp_StackTrace) ( ThreadId tid, UInt n_ips ); |
| 56 | |
| 57 | #endif // __PUB_TOOL_STACKTRACE_H |
| 58 | |
| 59 | /*--------------------------------------------------------------------*/ |
| 60 | /*--- end ---*/ |
| 61 | /*--------------------------------------------------------------------*/ |