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-2017 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, see <http://www.gnu.org/licenses/>.
  25
  26    The GNU General Public License is contained in the file COPYING.
  27 */
  28
  29 #ifndef __PUB_CORE_STACKTRACE_H
  30 #define __PUB_CORE_STACKTRACE_H
  31
  32 //--------------------------------------------------------------------
  33 // PURPOSE: This module deals with stack traces:  getting them,
  34 // traversing them, and printing them.
  35 //--------------------------------------------------------------------
  36
  37 #include "pub_tool_stacktrace.h"
  38 #include "pub_core_basics.h"         // UnwindStartRegs
  39
  40 // Variant that gives a little more control over the stack-walking
  41 // (this is the "worker" function that actually does the walking).
  42 // If you know what the thread ID for this stack is, send that
  43 // as the first parameter, else send zero.  This helps generate
  44 // better stack traces on ppc64-linux and has no effect on other
  45 // platforms.
  46 //
  47 // The acquired IP values are placed in
  48 // ips[0 .. min(n_ips,return_value)].  If sps and fps are non-NULL,
  49 // the corresponding frame-pointer and stack-pointer values for each
  50 // frame are stored there.
  51
  52 UInt VG_(get_StackTrace_wrk) ( ThreadId tid_if_known,
  53                                /*OUT*/Addr* ips, UInt n_ips,
  54                                /*OUT*/Addr* sps, /*OUT*/Addr* fps,
  55                                const UnwindStartRegs* startRegs,
  56                                Addr fp_max_orig );
  57
  58 #endif   // __PUB_CORE_STACKTRACE_H
  59
  60 /*--------------------------------------------------------------------*/
  61 /*--- end                                                          ---*/
  62 /*--------------------------------------------------------------------*/