1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Stack traces: getting, traversing, printing. ---*/ 3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- tool_stacktrace.h ---*/ 4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* 7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This file is part of Valgrind, a dynamic binary instrumentation 8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown framework. 9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 10663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng Copyright (C) 2000-2012 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_STACKTRACE_H 32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_TOOL_STACKTRACE_H 33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// The basic stack trace type: just an array of code addresses. 35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef Addr* StackTrace; 36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Walks the stack to get instruction pointers from the top stack frames 38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// for thread 'tid'. Maximum of 'n_ips' addresses put into 'ips'; 39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 0 is the top of the stack, 1 is its caller, etc. Everything from 40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// ips[return_value] onwards is undefined and should not be read. 41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// The initial IP value to use is adjusted by first_ip_delta before 42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// the stack is unwound. A safe value to pass is zero. 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// The specific meaning of the returned addresses is: 45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// [0] is the IP of thread 'tid' 47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// [1] points to the last byte of the call instruction that called [0]. 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// [2] points to the last byte of the call instruction that called [1]. 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// etc etc 50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Hence ips[0 .. return_value-1] should all point to currently 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 'active' (in the sense of a stack of unfinished function calls) 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// instructions. [0] points to the start of an arbitrary instruction.# 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// [1 ..] point to the last byte of a chain of call instructions. 55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// If sps and fps are non-NULL, the corresponding frame-pointer and 57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// stack-pointer values for each frame are stored there. 58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern UInt VG_(get_StackTrace) ( ThreadId tid, 60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*OUT*/StackTrace ips, UInt n_ips, 61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*OUT*/StackTrace sps, 62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*OUT*/StackTrace fps, 63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Word first_ip_delta ); 64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Apply a function to every element in the StackTrace. The parameter 66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 'n' gives the index of the passed ip. 'opaque' is an arbitrary 67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// pointer provided to each invokation of 'action' (a poor man's 68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// closure). Doesn't go below main() unless --show-below-main=yes is 69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// set. 70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(apply_StackTrace)( 71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown void(*action)(UInt n, Addr ip, void* opaque), 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown void* opaque, 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown StackTrace ips, UInt n_ips 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ); 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Print a StackTrace. 77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(pp_StackTrace) ( StackTrace ips, UInt n_ips ); 78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Gets and immediately prints a StackTrace. Just a bit simpler than 80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// calling VG_(get_StackTrace)() then VG_(pp_StackTrace)(). 81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(get_and_pp_StackTrace) ( ThreadId tid, UInt n_ips ); 82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif // __PUB_TOOL_STACKTRACE_H 84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end ---*/ 87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 88