| 1 | /* Code dealing with dummy stack frames, for GDB, the GNU debugger. |
| 2 | |
| 3 | Copyright (C) 2002-2019 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 (DUMMY_FRAME_H) |
| 21 | #define DUMMY_FRAME_H 1 |
| 22 | |
| 23 | #include "frame.h" |
| 24 | |
| 25 | struct infcall_suspend_state; |
| 26 | struct frame_unwind; |
| 27 | class thread_info; |
| 28 | |
| 29 | /* Push the information needed to identify, and unwind from, a dummy |
| 30 | frame onto the dummy frame stack. */ |
| 31 | |
| 32 | /* NOTE: cagney/2004-08-02: In the case of ABIs using push_dummy_code |
| 33 | containing more than one instruction, this interface many need to |
| 34 | be expanded so that it knowns the lower/upper extent of the dummy |
| 35 | frame's code. */ |
| 36 | |
| 37 | extern void dummy_frame_push (infcall_suspend_state *caller_state, |
| 38 | const frame_id *dummy_id, |
| 39 | thread_info *thread); |
| 40 | |
| 41 | /* Pop the dummy frame DUMMY_ID, restoring program state to that before the |
| 42 | frame was created. |
| 43 | On return reinit_frame_cache has been called. |
| 44 | If the frame isn't found, flag an internal error. |
| 45 | |
| 46 | NOTE: This can only pop the one frame, even if it is in the middle of the |
| 47 | stack, because the other frames may be for different threads, and there's |
| 48 | currently no way to tell which stack frame is for which thread. */ |
| 49 | |
| 50 | extern void dummy_frame_pop (frame_id dummy_id, thread_info *thread); |
| 51 | |
| 52 | extern void dummy_frame_discard (frame_id dummy_id, thread_info *thread); |
| 53 | |
| 54 | /* If the PC falls in a dummy frame, return a dummy frame |
| 55 | unwinder. */ |
| 56 | |
| 57 | extern const struct frame_unwind dummy_frame_unwind; |
| 58 | |
| 59 | /* Destructor for dummy_frame. DATA is supplied by registrant. |
| 60 | REGISTERS_VALID is 1 for dummy_frame_pop, 0 for dummy_frame_discard. */ |
| 61 | typedef void (dummy_frame_dtor_ftype) (void *data, int registers_valid); |
| 62 | |
| 63 | /* Call DTOR with DTOR_DATA when DUMMY_ID frame of thread THREAD gets |
| 64 | discarded. Dummy frame with DUMMY_ID must exist. Multiple |
| 65 | destructors may be registered, they will be called in the reverse |
| 66 | order of registrations (LIFO). */ |
| 67 | extern void register_dummy_frame_dtor (frame_id dummy_id, |
| 68 | thread_info *thread, |
| 69 | dummy_frame_dtor_ftype *dtor, |
| 70 | void *dtor_data); |
| 71 | |
| 72 | /* Return 1 if there exists any dummy frame with any of its registered |
| 73 | destructors equal to both DTOR and DTOR_DATA. Return 0 otherwise. */ |
| 74 | extern int find_dummy_frame_dtor (dummy_frame_dtor_ftype *dtor, |
| 75 | void *dtor_data); |
| 76 | |
| 77 | /* Default implementation of gdbarch_dummy_id. Generate a dummy frame_id |
| 78 | for THIS_FRAME assuming that the frame is a dummy frame. */ |
| 79 | |
| 80 | extern struct frame_id default_dummy_id (struct gdbarch *gdbarch, |
| 81 | struct frame_info *this_frame); |
| 82 | |
| 83 | #endif /* !defined (DUMMY_FRAME_H) */ |