coregrind/pub_core_stacktrace.h

   1 /*--------------------------------------------------------------------*/
   2 /*--- Stack traces: getting, traversing, printing.                 ---*/
   3 /*---                                        pub_core_stacktrace.h ---*/
   4 /*--------------------------------------------------------------------*/
   5
   6 /*
   7    This file is part of Valgrind, a dynamic binary instrumentation
   8    framework.
   9
  10    Copyright (C) 2000-2012 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_CORE_STACKTRACE_H
  32 #define __PUB_CORE_STACKTRACE_H
  33
  34 //--------------------------------------------------------------------
  35 // PURPOSE: This module deals with stack traces:  getting them,
  36 // traversing them, and printing them.
  37 //--------------------------------------------------------------------
  38
  39 #include "pub_tool_stacktrace.h"
  40
  41 // Variant that gives a little more control over the stack-walking
  42 // (this is the "worker" function that actually does the walking).
  43 // If you know what the thread ID for this stack is, send that
  44 // as the first parameter, else send zero.  This helps generate
  45 // better stack traces on ppc64-linux and has no effect on other
  46 // platforms.
  47 //
  48 // The acquired IP values are placed in
  49 // ips[0 .. min(n_ips,return_value)].  If sps and fps are non-NULL,
  50 // the corresponding frame-pointer and stack-pointer values for each
  51 // frame are stored there.
  52
  53 UInt VG_(get_StackTrace_wrk) ( ThreadId tid_if_known,
  54                                /*OUT*/Addr* ips, UInt n_ips,
  55                                /*OUT*/Addr* sps, /*OUT*/Addr* fps,
  56                                UnwindStartRegs* startRegs,
  57                                Addr fp_max_orig );
  58
  59 #endif   // __PUB_CORE_STACKTRACE_H
  60
  61 /*--------------------------------------------------------------------*/
  62 /*--- end                                                          ---*/
  63 /*--------------------------------------------------------------------*/