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 struct frame_id;
  28
  29 /* GENERIC DUMMY FRAMES
  30
  31    The following code serves to maintain the dummy stack frames for
  32    inferior function calls (ie. when gdb calls into the inferior via
  33    call_function_by_hand).  This code saves the machine state before
  34    the call in host memory, so we must maintain an independent stack
  35    and keep it consistant etc.  I am attempting to make this code
  36    generic enough to be used by many targets.
  37
  38    The cheapest and most generic way to do CALL_DUMMY on a new target
  39    is probably to define CALL_DUMMY to be empty, CALL_DUMMY_LENGTH to
  40    zero, and CALL_DUMMY_LOCATION to AT_ENTRY.  Then you must remember
  41    to define PUSH_RETURN_ADDRESS, because no call instruction will be
  42    being executed by the target.  Also FRAME_CHAIN_VALID as
  43    generic_{file,func}_frame_chain_valid and FIX_CALL_DUMMY as
  44    generic_fix_call_dummy.  */
  45
  46 /* Assuming that FRAME is a dummy, return a register value for the
  47    previous frame.  */
  48
  49 extern void dummy_frame_register_unwind (struct frame_info *frame,
  50                                          void **unwind_cache,
  51                                          int regnum,
  52                                          int *optimized,
  53                                          enum lval_type *lvalp,
  54                                          CORE_ADDR *addrp,
  55                                          int *realnump,
  56                                          void *valuep);
  57
  58 /* Assuming that FRAME is a dummy, return the resume address for the
  59    previous frame.  */
  60
  61 extern CORE_ADDR dummy_frame_pc_unwind (struct frame_info *frame,
  62                                         void **unwind_cache);
  63
  64 /* Assuming that FRAME is a dummy, return the ID of the calling frame
  65    (the frame that the dummy has the saved state of).  */
  66
  67 extern void dummy_frame_id_unwind (struct frame_info *frame,
  68                                    void **unwind_cache,
  69                                    struct frame_id *id);
  70
  71 /* Does the PC fall in a dummy frame?
  72
  73    This function is used by "frame.c" when creating a new `struct
  74    frame_info'.
  75
  76    Note that there is also very similar code in breakpoint.c (where
  77    the bpstat stop reason is computed).  It is looking for a PC
  78    falling on a dummy_frame breakpoint.  Perhaphs this, and that code
  79    should be combined?
  80
  81    Architecture dependant code, that has access to a frame, should not
  82    use this function.  Instead (get_frame_type() == DUMMY_FRAME)
  83    should be used.
  84
  85    Hmm, but what about threads?  When the dummy-frame code tries to
  86    relocate a dummy frame's saved registers it definitly needs to
  87    differentiate between threads (otherwize it will do things like
  88    clean-up the wrong threads frames).  However, when just trying to
  89    identify a dummy-frame that shouldn't matter.  The wost that can
  90    happen is that a thread is marked as sitting in a dummy frame when,
  91    in reality, its corrupted its stack, to the point that a PC is
  92    pointing into a dummy frame.  */
  93
  94 extern int pc_in_dummy_frame (CORE_ADDR pc);
  95
  96 /* Return the regcache that belongs to the dummy-frame identifed by PC
  97    and FP, or NULL if no such frame exists.  */
  98 /* FIXME: cagney/2002-11-08: The function only exists because of
  99    deprecated_generic_get_saved_register.  Eliminate that function and
 100    this, to, can go.  */
 101
 102 extern struct regcache *generic_find_dummy_frame (CORE_ADDR pc,
 103                                                   CORE_ADDR fp);
 104 #endif /* !defined (DUMMY_FRAME_H)  */