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-2013 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#include "pub_core_basics.h"         // UnwindStartRegs
41
42// Variant that gives a little more control over the stack-walking
43// (this is the "worker" function that actually does the walking).
44// If you know what the thread ID for this stack is, send that
45// as the first parameter, else send zero.  This helps generate
46// better stack traces on ppc64-linux and has no effect on other
47// platforms.
48//
49// The acquired IP values are placed in
50// ips[0 .. min(n_ips,return_value)].  If sps and fps are non-NULL,
51// the corresponding frame-pointer and stack-pointer values for each
52// frame are stored there.
53
54UInt VG_(get_StackTrace_wrk) ( ThreadId tid_if_known,
55                               /*OUT*/Addr* ips, UInt n_ips,
56                               /*OUT*/Addr* sps, /*OUT*/Addr* fps,
57                               UnwindStartRegs* startRegs,
58                               Addr fp_max_orig );
59
60#endif   // __PUB_CORE_STACKTRACE_H
61
62/*--------------------------------------------------------------------*/
63/*--- end                                                          ---*/
64/*--------------------------------------------------------------------*/
65