| njn | d01fef7 | 2005-03-25 23:35:48 +0000 | [diff] [blame] | 1 | /*--------------------------------------------------------------------*/ |
| 2 | /*--- ExeContexts: long-lived stack traces. pub_tool_execontext.h ---*/ |
| 3 | /*--------------------------------------------------------------------*/ |
| 4 | |
| 5 | /* |
| 6 | This file is part of Valgrind, a dynamic binary instrumentation |
| 7 | framework. |
| 8 | |
| 9 | Copyright (C) 2000-2005 Julian Seward |
| 10 | jseward@acm.org |
| 11 | |
| 12 | This program is free software; you can redistribute it and/or |
| 13 | modify it under the terms of the GNU General Public License as |
| 14 | published by the Free Software Foundation; either version 2 of the |
| 15 | License, or (at your option) any later version. |
| 16 | |
| 17 | This program is distributed in the hope that it will be useful, but |
| 18 | WITHOUT ANY WARRANTY; without even the implied warranty of |
| 19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 20 | General Public License for more details. |
| 21 | |
| 22 | You should have received a copy of the GNU General Public License |
| 23 | along with this program; if not, write to the Free Software |
| 24 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 25 | 02111-1307, USA. |
| 26 | |
| 27 | The GNU General Public License is contained in the file COPYING. |
| 28 | */ |
| 29 | |
| 30 | #ifndef __PUB_TOOL_EXECONTEXT_H |
| 31 | #define __PUB_TOOL_EXECONTEXT_H |
| 32 | |
| 33 | // It's an abstract type. |
| 34 | typedef |
| 35 | struct _ExeContext |
| 36 | ExeContext; |
| 37 | |
| 38 | // Resolution type used to decide how closely to compare two errors for |
| 39 | // equality. |
| 40 | typedef |
| 41 | enum { Vg_LowRes, Vg_MedRes, Vg_HighRes } |
| 42 | VgRes; |
| 43 | |
| 44 | // Take a snapshot of the client's stack. Search our collection of |
| 45 | // ExeContexts to see if we already have it, and if not, allocate a |
| 46 | // new one. Either way, return a pointer to the context. Context size |
| 47 | // controlled by --num-callers option. |
| 48 | // |
| 49 | // This should only be used for long-lived stack traces. If you want a |
| 50 | // short-lived stack trace, use VG_(get_StackTrace)(). |
| 51 | // |
| 52 | // If called from generated code, use VG_(get_running_tid)() to get the |
| 53 | // current ThreadId. If called from non-generated code, the current |
| 54 | // ThreadId should be passed in by the core. |
| 55 | extern ExeContext* VG_(record_ExeContext) ( ThreadId tid ); |
| 56 | |
| 57 | // Apply a function to every element in the ExeContext. The parameter 'n' |
| 58 | // gives the index of the passed ip. Doesn't go below main() unless |
| 59 | // --show-below-main=yes is set. |
| 60 | extern void VG_(apply_ExeContext)( void(*action)(UInt n, Addr ip), |
| 61 | ExeContext* ec, UInt n_ips ); |
| 62 | |
| 63 | // Compare two ExeContexts. Number of callers considered depends on `res': |
| 64 | // Vg_LowRes: 2 |
| 65 | // Vg_MedRes: 4 |
| 66 | // Vg_HighRes: all |
| 67 | extern Bool VG_(eq_ExeContext) ( VgRes res, ExeContext* e1, ExeContext* e2 ); |
| 68 | |
| 69 | // Print an ExeContext. |
| 70 | extern void VG_(pp_ExeContext) ( ExeContext* ec ); |
| 71 | |
| 72 | #endif // __PUB_TOOL_EXECONTEXT_H |
| 73 | |
| 74 | /*--------------------------------------------------------------------*/ |
| 75 | /*--- end ---*/ |
| 76 | /*--------------------------------------------------------------------*/ |