Convert generic probe interface to C++ (and perform some cleanups)
[external/binutils.git] / gdb / sentinel-frame.h
1 /* Code dealing with register stack frames, for GDB, the GNU debugger.
2
3    Copyright (C) 2003-2017 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 #if !defined (SENTINEL_FRAME_H)
21 #define SENTINEL_FRAME_H 1
22
23 struct frame_unwind;
24 struct regcache;
25
26 /* Implement the sentinel frame.  The sentinel frame terminates the
27    inner most end of the frame chain.  If unwound, it returns the
28    information need to construct an inner-most frame.  */
29
30 /* Pump prime the sentinel frame's cache.  Since this needs the
31    REGCACHE provide that here.  */
32
33 extern void *sentinel_frame_cache (struct regcache *regcache);
34
35 /* At present there is only one type of sentinel frame.  */
36
37 extern const struct frame_unwind sentinel_frame_unwind;
38
39 #endif /* !defined (SENTINEL_FRAME_H)  */