1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- ExeContexts: long-lived stack traces. pub_tool_execontext.h ---*/ 3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* 6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This file is part of Valgrind, a dynamic binary instrumentation 7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown framework. 8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 9436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov Copyright (C) 2000-2013 Julian Seward 10ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown jseward@acm.org 11ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is free software; you can redistribute it and/or 13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown modify it under the terms of the GNU General Public License as 14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown published by the Free Software Foundation; either version 2 of the 15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown License, or (at your option) any later version. 16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is distributed in the hope that it will be useful, but 18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown WITHOUT ANY WARRANTY; without even the implied warranty of 19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown General Public License for more details. 21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown You should have received a copy of the GNU General Public License 23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown along with this program; if not, write to the Free Software 24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 02111-1307, USA. 26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown The GNU General Public License is contained in the file COPYING. 28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PUB_TOOL_EXECONTEXT_H 31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_TOOL_EXECONTEXT_H 32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 33436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov#include "pub_tool_basics.h" // ThreadID 34436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov 35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// It's an abstract type. 36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct _ExeContext 38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ExeContext; 39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Resolution type used to decide how closely to compare two errors for 41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// equality. 42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown enum { Vg_LowRes, Vg_MedRes, Vg_HighRes } 44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgRes; 45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Take a snapshot of the client's stack. Search our collection of 47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// ExeContexts to see if we already have it, and if not, allocate a 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// new one. Either way, return a pointer to the context. Context size 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// controlled by --num-callers option. 50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// This should only be used for long-lived stack traces. If you want a 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// short-lived stack trace, use VG_(get_StackTrace)(). 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// If called from generated code, use VG_(get_running_tid)() to get the 55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// current ThreadId. If called from non-generated code, the current 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// ThreadId should be passed in by the core. The initial IP value to 57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// use is adjusted by first_ip_delta before the stack is unwound. 58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// A safe value to pass is zero. 59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// See comments in pub_tool_stacktrace.h for precise definition of 61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// the meaning of the code addresses in the returned ExeContext. 62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern 63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownExeContext* VG_(record_ExeContext) ( ThreadId tid, Word first_ip_delta ); 64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Trivial version of VG_(record_ExeContext), which just records the 66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// thread's current program counter but does not do any stack 67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// unwinding. This is useful in some rare cases when we suspect the 68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// stack might be outside mapped storage, and so unwinding 69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// might cause a segfault. In this case we can at least safely 70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// produce a one-element stack trace, which is better than nothing. 71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern 72663860b1408516d02ebfcb3a9999a134e6cfb223Ben ChengExeContext* VG_(record_depth_1_ExeContext)(ThreadId tid, Word first_ip_delta); 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Apply a function to every element in the ExeContext. The parameter 'n' 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// gives the index of the passed ip. Doesn't go below main() unless 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// --show-below-main=yes is set. 77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(apply_ExeContext)( void(*action)(UInt n, Addr ip), 78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ExeContext* ec, UInt n_ips ); 79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Compare two ExeContexts. Number of callers considered depends on `res': 81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Vg_LowRes: 2 82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Vg_MedRes: 4 83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Vg_HighRes: all 84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(eq_ExeContext) ( VgRes res, ExeContext* e1, ExeContext* e2 ); 85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Print an ExeContext. 87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(pp_ExeContext) ( ExeContext* ec ); 88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Get the 32-bit unique reference number for this ExeContext 90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// (the "ExeContext Unique"). Guaranteed to be nonzero and to be a 91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// multiple of four (iow, the lowest two bits are guaranteed to 92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// be zero, so that callers can store other information there. 93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern UInt VG_(get_ECU_from_ExeContext)( ExeContext* e ); 94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// How many entries (frames) in this ExeContext? 96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(get_ExeContext_n_ips)( ExeContext* e ); 97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Find the ExeContext that has the given ECU, if any. 99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// NOTE: very slow. Do not call often. 100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern ExeContext* VG_(get_ExeContext_from_ECU)( UInt uniq ); 101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Make an ExeContext containing just 'a', and nothing else 103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownExeContext* VG_(make_depth_1_ExeContext_from_Addr)( Addr a ); 104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Is this a plausible-looking ECU ? Catches some obvious stupid 106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// cases, but does not guarantee that the ECU is really valid, that 107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// is, has an associated ExeContext. 108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic inline Bool VG_(is_plausible_ECU)( UInt ecu ) { 109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return (ecu > 0) && ((ecu & 3) == 0); 110ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 111ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 112ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Make an ExeContext containing exactly the specified stack frames. 113ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownExeContext* VG_(make_ExeContext_from_StackTrace)( Addr* ips, UInt n_ips ); 114ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 115436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// Returns the "null" exe context. The null execontext is an artificial 116436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// exe context, with a stack trace made of one Addr (the NULL address). 117436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern 118436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy IvanovExeContext* VG_(null_ExeContext) (void); 119436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov 120ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif // __PUB_TOOL_EXECONTEXT_H 121ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 122ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 123ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end ---*/ 124ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 125