/* Code dealing with dummy stack frames, for GDB, the GNU debugger.
- Copyright 2002 Free Software Foundation, Inc.
+ Copyright (C) 2002-2020 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;
-
-/* 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 FRAME_CHAIN_VALID as
- generic_{file,func}_frame_chain_valid and FIX_CALL_DUMMY as
- generic_fix_call_dummy. */
-
-/* Assuming that FRAME is a dummy, return a register value for the
- previous frame. */
-
-extern void dummy_frame_register_unwind (struct frame_info *frame,
- void **unwind_cache,
- int regnum,
- int *optimized,
- enum lval_type *lvalp,
- CORE_ADDR *addrp,
- int *realnump,
- void *valuep);
-
-/* Assuming that FRAME is a dummy, return the resume address for the
- previous frame. */
-
-extern CORE_ADDR dummy_frame_pc_unwind (struct frame_info *frame,
- void **unwind_cache);
-
-/* Assuming that FRAME is a dummy, return the ID of the calling frame
- (the frame that the dummy has the saved state of). */
-
-extern struct frame_id dummy_frame_id_unwind (struct frame_info *frame,
- void **unwind_cache);
-
-/* Does the PC fall in a dummy frame?
-
- This function is used by "frame.c" when creating a new `struct
- frame_info'.
-
- 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?
-
- Architecture dependant code, that has access to a frame, should not
- use this function. Instead (get_frame_type() == DUMMY_FRAME)
- should be used.
-
- 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. */
-
-extern int pc_in_dummy_frame (CORE_ADDR pc);
-
-/* 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. */
-
-extern struct regcache *generic_find_dummy_frame (CORE_ADDR pc,
- CORE_ADDR fp);
+#include "frame.h"
+
+struct infcall_suspend_state;
+struct frame_unwind;
+class thread_info;
+
+/* 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 void dummy_frame_push (infcall_suspend_state *caller_state,
+ const frame_id *dummy_id,
+ thread_info *thread);
+
+/* 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.
+
+ 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. */
+
+extern void dummy_frame_pop (frame_id dummy_id, thread_info *thread);
+
+extern void dummy_frame_discard (frame_id dummy_id, thread_info *thread);
+
+/* If the PC falls in a dummy frame, return a dummy frame
+ unwinder. */
+
+extern const struct frame_unwind dummy_frame_unwind;
+
+/* 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);
+
+/* Call DTOR with DTOR_DATA when DUMMY_ID frame of thread THREAD gets
+ discarded. Dummy frame with DUMMY_ID must exist. Multiple
+ destructors may be registered, they will be called in the reverse
+ order of registrations (LIFO). */
+extern void register_dummy_frame_dtor (frame_id dummy_id,
+ thread_info *thread,
+ dummy_frame_dtor_ftype *dtor,
+ void *dtor_data);
+
+/* Return 1 if there exists any dummy frame with any of its registered
+ destructors equal to both DTOR and DTOR_DATA. Return 0 otherwise. */
+extern int find_dummy_frame_dtor (dummy_frame_dtor_ftype *dtor,
+ void *dtor_data);
+
+/* Default implementation of gdbarch_dummy_id. Generate a dummy frame_id
+ for THIS_FRAME assuming that the frame is a dummy frame. */
+
+extern struct frame_id default_dummy_id (struct gdbarch *gdbarch,
+ struct frame_info *this_frame);
+
#endif /* !defined (DUMMY_FRAME_H) */
projects / deliverable / binutils-gdb.git / blobdiff