2002-11-15 Andrew Cagney <ac131313@redhat.com>
[external/binutils.git] / gdb / dummy-frame.h
1 /* Code dealing with dummy stack frames, for GDB, the GNU debugger.
2
3    Copyright 2002 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 2 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, write to the Free Software
19    Foundation, Inc., 59 Temple Place - Suite 330,
20    Boston, MA 02111-1307, USA.  */
21
22 #if !defined (DUMMY_FRAME_H)
23 #define DUMMY_FRAME_H 1
24
25 struct frame_info;
26 struct regcache;
27
28 /* GENERIC DUMMY FRAMES
29   
30    The following code serves to maintain the dummy stack frames for
31    inferior function calls (ie. when gdb calls into the inferior via
32    call_function_by_hand).  This code saves the machine state before
33    the call in host memory, so we must maintain an independent stack
34    and keep it consistant etc.  I am attempting to make this code
35    generic enough to be used by many targets.
36  
37    The cheapest and most generic way to do CALL_DUMMY on a new target
38    is probably to define CALL_DUMMY to be empty, CALL_DUMMY_LENGTH to
39    zero, and CALL_DUMMY_LOCATION to AT_ENTRY.  Then you must remember
40    to define PUSH_RETURN_ADDRESS, because no call instruction will be
41    being executed by the target.  Also FRAME_CHAIN_VALID as
42    generic_{file,func}_frame_chain_valid and FIX_CALL_DUMMY as
43    generic_fix_call_dummy.  */
44
45 /* Assuming that FRAME is a dummy, return a register value for the
46    previous frame.  */
47
48 extern void dummy_frame_register_unwind (struct frame_info *frame,
49                                          void **unwind_cache,
50                                          int regnum,
51                                          int *optimized,
52                                          enum lval_type *lvalp,
53                                          CORE_ADDR *addrp,
54                                          int *realnump,
55                                          void *valuep);
56
57 /* Assuming that FRAME is a dummy, return the resume address for the
58    previous frame.  */
59
60 extern CORE_ADDR dummy_frame_pc_unwind (struct frame_info *frame,
61                                         void **unwind_cache);
62
63 /* Return the regcache that belongs to the dummy-frame identifed by PC
64    and FP, or NULL if no such frame exists.  */
65 /* FIXME: cagney/2002-11-08: The function only exists because of
66    deprecated_generic_get_saved_register.  Eliminate that function and
67    this, to, can go.  */
68
69 extern struct regcache *generic_find_dummy_frame (CORE_ADDR pc,
70                                                   CORE_ADDR fp);
71 #endif /* !defined (DUMMY_FRAME_H)  */