blob: 39f4a56733787c7edb482942d09d0986e52ae83d [file] [log] [blame]
/*--- ExeContexts: long-lived stack traces. pub_tool_execontext.h ---*/
This file is part of Valgrind, a dynamic binary instrumentation
Copyright (C) 2000-2013 Julian Seward
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307, USA.
The GNU General Public License is contained in the file COPYING.
#include "pub_tool_basics.h" // ThreadID
// It's an abstract type.
struct _ExeContext
// Resolution type used to decide how closely to compare two errors for
// equality.
enum { Vg_LowRes, Vg_MedRes, Vg_HighRes }
// Take a snapshot of the client's stack. Search our collection of
// ExeContexts to see if we already have it, and if not, allocate a
// new one. Either way, return a pointer to the context. Context size
// controlled by --num-callers option.
// This should only be used for long-lived stack traces. If you want a
// short-lived stack trace, use VG_(get_StackTrace)().
// If called from generated code, use VG_(get_running_tid)() to get the
// current ThreadId. If called from non-generated code, the current
// ThreadId should be passed in by the core. The initial IP value to
// use is adjusted by first_ip_delta before the stack is unwound.
// A safe value to pass is zero.
// See comments in pub_tool_stacktrace.h for precise definition of
// the meaning of the code addresses in the returned ExeContext.
ExeContext* VG_(record_ExeContext) ( ThreadId tid, Word first_ip_delta );
// Trivial version of VG_(record_ExeContext), which just records the
// thread's current program counter but does not do any stack
// unwinding. This is useful in some rare cases when we suspect the
// stack might be outside mapped storage, and so unwinding
// might cause a segfault. In this case we can at least safely
// produce a one-element stack trace, which is better than nothing.
ExeContext* VG_(record_depth_1_ExeContext)(ThreadId tid, Word first_ip_delta);
// Apply a function to every element in the ExeContext. The parameter 'n'
// gives the index of the passed ip. Doesn't go below main() unless
// --show-below-main=yes is set.
extern void VG_(apply_ExeContext)( void(*action)(UInt n, Addr ip),
ExeContext* ec, UInt n_ips );
// Compare two ExeContexts. Number of callers considered depends on `res':
// Vg_LowRes: 2
// Vg_MedRes: 4
// Vg_HighRes: all
extern Bool VG_(eq_ExeContext) ( VgRes res, const ExeContext* e1,
const ExeContext* e2 );
// Print an ExeContext.
extern void VG_(pp_ExeContext) ( ExeContext* ec );
// Get the 32-bit unique reference number for this ExeContext
// (the "ExeContext Unique"). Guaranteed to be nonzero and to be a
// multiple of four (iow, the lowest two bits are guaranteed to
// be zero, so that callers can store other information there.
extern UInt VG_(get_ECU_from_ExeContext)( const ExeContext* e );
// How many entries (frames) in this ExeContext?
extern Int VG_(get_ExeContext_n_ips)( const ExeContext* e );
// Find the ExeContext that has the given ECU, if any.
// NOTE: very slow. Do not call often.
extern ExeContext* VG_(get_ExeContext_from_ECU)( UInt uniq );
// Make an ExeContext containing just 'a', and nothing else
ExeContext* VG_(make_depth_1_ExeContext_from_Addr)( Addr a );
// Is this a plausible-looking ECU ? Catches some obvious stupid
// cases, but does not guarantee that the ECU is really valid, that
// is, has an associated ExeContext.
static inline Bool VG_(is_plausible_ECU)( UInt ecu ) {
return (ecu > 0) && ((ecu & 3) == 0);
// Make an ExeContext containing exactly the specified stack frames.
ExeContext* VG_(make_ExeContext_from_StackTrace)( const Addr* ips, UInt n_ips );
// Returns the "null" exe context. The null execontext is an artificial
// exe context, with a stack trace made of one Addr (the NULL address).
ExeContext* VG_(null_ExeContext) (void);
/*--- end ---*/