/* Code dealing with dummy stack frames, for GDB, the GNU debugger.
- Copyright 2002 Free Software Foundation, Inc.
+ Copyright (C) 2002-2015 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA. */
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
#if !defined (DUMMY_FRAME_H)
#define DUMMY_FRAME_H 1
-struct frame_info;
-struct regcache;
+#include "frame.h"
+
+struct infcall_suspend_state;
struct frame_unwind;
-struct frame_id;
-
-/* GENERIC DUMMY FRAMES
-
- The following code serves to maintain the dummy stack frames for
- inferior function calls (ie. when gdb calls into the inferior via
- call_function_by_hand). This code saves the machine state before
- the call in host memory, so we must maintain an independent stack
- and keep it consistant etc. I am attempting to make this code
- generic enough to be used by many targets.
-
- The cheapest and most generic way to do CALL_DUMMY on a new target
- is probably to define CALL_DUMMY to be empty, CALL_DUMMY_LENGTH to
- zero, and CALL_DUMMY_LOCATION to AT_ENTRY. Then you must remember
- to define PUSH_RETURN_ADDRESS, because no call instruction will be
- being executed by the target. Also DEPRECATED_FRAME_CHAIN_VALID as
- generic_{file,func}_frame_chain_valid and do not set
- FIX_CALL_DUMMY. */
-/* If the PC falls in a dummy frame, return a dummy frame
- unwinder. */
+/* Push the information needed to identify, and unwind from, a dummy
+ frame onto the dummy frame stack. */
+
+/* NOTE: cagney/2004-08-02: In the case of ABIs using push_dummy_code
+ containing more than one instruction, this interface many need to
+ be expanded so that it knowns the lower/upper extent of the dummy
+ frame's code. */
-extern const struct frame_unwind *dummy_frame_p (CORE_ADDR pc);
+extern void dummy_frame_push (struct infcall_suspend_state *caller_state,
+ const struct frame_id *dummy_id, ptid_t ptid);
-/* Does the PC fall in a dummy frame?
+/* Pop the dummy frame DUMMY_ID, restoring program state to that before the
+ frame was created.
+ On return reinit_frame_cache has been called.
+ If the frame isn't found, flag an internal error.
- This function is used by "frame.c" when creating a new `struct
- frame_info'.
+ NOTE: This can only pop the one frame, even if it is in the middle of the
+ stack, because the other frames may be for different threads, and there's
+ currently no way to tell which stack frame is for which thread. */
- Note that there is also very similar code in breakpoint.c (where
- the bpstat stop reason is computed). It is looking for a PC
- falling on a dummy_frame breakpoint. Perhaphs this, and that code
- should be combined?
+extern void dummy_frame_pop (struct frame_id dummy_id, ptid_t ptid);
+
+extern void dummy_frame_discard (struct frame_id dummy_id, ptid_t ptid);
+
+/* If the PC falls in a dummy frame, return a dummy frame
+ unwinder. */
- Architecture dependant code, that has access to a frame, should not
- use this function. Instead (get_frame_type() == DUMMY_FRAME)
- should be used.
+extern const struct frame_unwind dummy_frame_unwind;
- Hmm, but what about threads? When the dummy-frame code tries to
- relocate a dummy frame's saved registers it definitly needs to
- differentiate between threads (otherwize it will do things like
- clean-up the wrong threads frames). However, when just trying to
- identify a dummy-frame that shouldn't matter. The wost that can
- happen is that a thread is marked as sitting in a dummy frame when,
- in reality, its corrupted its stack, to the point that a PC is
- pointing into a dummy frame. */
+/* Destructor for dummy_frame. DATA is supplied by registrant.
+ REGISTERS_VALID is 1 for dummy_frame_pop, 0 for dummy_frame_discard. */
+typedef void (dummy_frame_dtor_ftype) (void *data, int registers_valid);
-extern int pc_in_dummy_frame (CORE_ADDR pc);
+/* Call DTOR with DTOR_DATA when DUMMY_ID frame of thread PTID gets discarded.
+ Dummy frame with DUMMY_ID must exist. There must be no other call of
+ register_dummy_frame_dtor for that dummy frame. */
+extern void register_dummy_frame_dtor (struct frame_id dummy_id, ptid_t ptid,
+ dummy_frame_dtor_ftype *dtor,
+ void *dtor_data);
-/* Return the regcache that belongs to the dummy-frame identifed by PC
- and FP, or NULL if no such frame exists. */
-/* FIXME: cagney/2002-11-08: The function only exists because of
- deprecated_generic_get_saved_register. Eliminate that function and
- this, to, can go. */
+/* Return 1 if there exists dummy frame with registered DTOR and DTOR_DATA.
+ Return 0 otherwise. */
+extern int find_dummy_frame_dtor (dummy_frame_dtor_ftype *dtor,
+ void *dtor_data);
-extern struct regcache *generic_find_dummy_frame (CORE_ADDR pc,
- CORE_ADDR fp);
#endif /* !defined (DUMMY_FRAME_H) */
projects / deliverable / binutils-gdb.git / blobdiff