gdb/frame.h

   1 /* Definitions for dealing with stack frames, for GDB, the GNU debugger.
   2    Copyright 1986, 1989, 1991, 1992, 1999 Free Software Foundation, Inc.
   3
   4 This file is part of GDB.
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  19
  20 #if !defined (FRAME_H)
  21 #define FRAME_H 1
  22
  23 /* Describe the saved registers of a frame.  */
  24
  25 #if defined (EXTRA_FRAME_INFO) || defined (FRAME_FIND_SAVED_REGS)
  26 /* XXXX - deprecated */
  27 struct frame_saved_regs
  28   {
  29
  30     /* For each register, address of where it was saved on entry to
  31        the frame, or zero if it was not saved on entry to this frame.
  32        This includes special registers such as pc and fp saved in
  33        special ways in the stack frame.  The SP_REGNUM is even more
  34        special, the address here is the sp for the next frame, not the
  35        address where the sp was saved.  */
  36
  37     CORE_ADDR regs[NUM_REGS];
  38   };
  39 #endif
  40
  41 /* We keep a cache of stack frames, each of which is a "struct
  42    frame_info".  The innermost one gets allocated (in
  43    wait_for_inferior) each time the inferior stops; current_frame
  44    points to it.  Additional frames get allocated (in
  45    get_prev_frame) as needed, and are chained through the next
  46    and prev fields.  Any time that the frame cache becomes invalid
  47    (most notably when we execute something, but also if we change how
  48    we interpret the frames (e.g. "set heuristic-fence-post" in
  49    mips-tdep.c, or anything which reads new symbols)), we should call
  50    reinit_frame_cache.  */
  51
  52 struct frame_info
  53   {
  54     /* Nominal address of the frame described.  See comments at FRAME_FP
  55        about what this means outside the *FRAME* macros; in the *FRAME*
  56        macros, it can mean whatever makes most sense for this machine.  */
  57     CORE_ADDR frame;
  58
  59     /* Address at which execution is occurring in this frame.
  60        For the innermost frame, it's the current pc.
  61        For other frames, it is a pc saved in the next frame.  */
  62     CORE_ADDR pc;
  63
  64     /* Nonzero if this is a frame associated with calling a signal handler.
  65
  66        Set by machine-dependent code.  On some machines, if
  67        the machine-dependent code fails to check for this, the backtrace
  68        will look relatively normal.  For example, on the i386
  69          #3  0x158728 in sighold ()
  70        On other machines (e.g. rs6000), the machine-dependent code better
  71        set this to prevent us from trying to print it like a normal frame.  */
  72     int signal_handler_caller;
  73
  74     /* For each register, address of where it was saved on entry to
  75        the frame, or zero if it was not saved on entry to this frame.
  76        This includes special registers such as pc and fp saved in
  77        special ways in the stack frame.  The SP_REGNUM is even more
  78        special, the address here is the sp for the next frame, not the
  79        address where the sp was saved.  */
  80     /* Allocated by frame_saved_regs_zalloc () which is called /
  81        initialized by FRAME_INIT_SAVED_REGS(). */
  82     CORE_ADDR *saved_regs; /*NUM_REGS*/
  83
  84 #ifdef EXTRA_FRAME_INFO
  85     /* XXXX - deprecated */
  86     /* Anything extra for this structure that may have been defined
  87        in the machine dependent files. */
  88     EXTRA_FRAME_INFO
  89 #endif
  90
  91     /* Anything extra for this structure that may have been defined
  92        in the machine dependent files. */
  93     /* Allocated by frame_obstack_alloc () which is called /
  94        initialized by INIT_EXTRA_FRAME_INFO */
  95     struct frame_extra_info *extra_info;
  96
  97     /* Pointers to the next and previous frame_info's in the frame cache.  */
  98    struct frame_info *next, *prev;
  99   };
 100
 101 /* Allocate additional space for appendices to a struct frame_info. */
 102
 103 #ifndef SIZEOF_FRAME_SAVED_REGS
 104 #define SIZEOF_FRAME_SAVED_REGS (sizeof (CORE_ADDR) * (NUM_REGS))
 105 #endif
 106 extern void *frame_obstack_alloc PARAMS ((unsigned long size));
 107 extern void frame_saved_regs_zalloc PARAMS ((struct frame_info *));
 108
 109 /* Return the frame address from FR.  Except in the machine-dependent
 110    *FRAME* macros, a frame address has no defined meaning other than
 111    as a magic cookie which identifies a frame over calls to the
 112    inferior.  The only known exception is inferior.h
 113    (PC_IN_CALL_DUMMY) [ON_STACK]; see comments there.  You cannot
 114    assume that a frame address contains enough information to
 115    reconstruct the frame; if you want more than just to identify the
 116    frame (e.g. be able to fetch variables relative to that frame),
 117    then save the whole struct frame_info (and the next struct
 118    frame_info, since the latter is used for fetching variables on some
 119    machines).  */
 120
 121 #define FRAME_FP(fi) ((fi)->frame)
 122
 123 /* Define a default FRAME_CHAIN_VALID, in the form that is suitable for most
 124    targets.  If FRAME_CHAIN_VALID returns zero it means that the given frame
 125    is the outermost one and has no caller.
 126
 127    If a particular target needs a different definition, then it can override
 128    the definition here by providing one in the tm file.
 129
 130    XXXX - both default and alternate frame_chain_valid functions are
 131    deprecated.  New code should use generic dummy frames. */
 132
 133 extern int default_frame_chain_valid PARAMS ((CORE_ADDR, struct frame_info *));
 134 extern int alternate_frame_chain_valid PARAMS ((CORE_ADDR, struct frame_info *));
 135 extern int nonnull_frame_chain_valid PARAMS ((CORE_ADDR, struct frame_info *));
 136 extern int generic_frame_chain_valid PARAMS ((CORE_ADDR, struct frame_info *));
 137 extern void generic_save_dummy_frame_tos PARAMS ((CORE_ADDR sp));
 138
 139 #if !defined (FRAME_CHAIN_VALID)
 140 #if !defined (FRAME_CHAIN_VALID_ALTERNATE)
 141 #define FRAME_CHAIN_VALID(chain, thisframe) default_frame_chain_valid (chain, thisframe)
 142 #else
 143 /* Use the alternate method of avoiding running up off the end of the frame
 144    chain or following frames back into the startup code.  See the comments
 145    in objfiles.h. */
 146 #define FRAME_CHAIN_VALID(chain, thisframe) alternate_frame_chain_valid (chain,thisframe)
 147 #endif  /* FRAME_CHAIN_VALID_ALTERNATE */
 148 #endif  /* FRAME_CHAIN_VALID */
 149
 150 /* The stack frame that the user has specified for commands to act on.
 151    Note that one cannot assume this is the address of valid data.  */
 152
 153 extern struct frame_info *selected_frame;
 154
 155 /* Level of the selected frame:
 156    0 for innermost, 1 for its caller, ...
 157    or -1 for frame specified by address with no defined level.  */
 158
 159 extern int selected_frame_level;
 160
 161 extern struct frame_info *create_new_frame PARAMS ((CORE_ADDR, CORE_ADDR));
 162
 163 extern void flush_cached_frames PARAMS ((void));
 164
 165 extern void reinit_frame_cache PARAMS ((void));
 166
 167
 168 #ifdef FRAME_FIND_SAVED_REGS
 169 /* XXX - deprecated */
 170 #define FRAME_INIT_SAVED_REGS(FI) get_frame_saved_regs (FI, NULL)
 171 extern void get_frame_saved_regs PARAMS ((struct frame_info *,
 172                                           struct frame_saved_regs *));
 173 #endif
 174
 175 extern void set_current_frame PARAMS ((struct frame_info *));
 176
 177 extern struct frame_info *get_prev_frame PARAMS ((struct frame_info *));
 178
 179 extern struct frame_info *get_current_frame PARAMS ((void));
 180
 181 extern struct frame_info *get_next_frame PARAMS ((struct frame_info *));
 182
 183 extern struct block *get_frame_block PARAMS ((struct frame_info *));
 184
 185 extern struct block *get_current_block PARAMS ((void));
 186
 187 extern struct block *get_selected_block PARAMS ((void));
 188
 189 extern struct symbol *get_frame_function PARAMS ((struct frame_info *));
 190
 191 extern CORE_ADDR get_frame_pc PARAMS ((struct frame_info *));
 192
 193 extern CORE_ADDR get_pc_function_start PARAMS ((CORE_ADDR));
 194
 195 extern struct block * block_for_pc PARAMS ((CORE_ADDR));
 196
 197 extern struct block * block_for_pc_sect PARAMS ((CORE_ADDR, asection *));
 198
 199 extern int frameless_look_for_prologue PARAMS ((struct frame_info *));
 200
 201 extern void print_frame_args PARAMS ((struct symbol *, struct frame_info *,
 202                                       int, GDB_FILE *));
 203
 204 extern struct frame_info *find_relative_frame PARAMS ((struct frame_info *, int*));
 205
 206 extern void show_and_print_stack_frame PARAMS ((struct frame_info *fi, int level, int source));
 207
 208 extern void print_stack_frame PARAMS ((struct frame_info *, int, int));
 209
 210 extern void print_only_stack_frame PARAMS ((struct frame_info *, int, int));
 211
 212 extern void show_stack_frame PARAMS ((struct frame_info *));
 213
 214 extern void select_frame PARAMS ((struct frame_info *, int));
 215
 216 extern void record_selected_frame PARAMS ((CORE_ADDR *, int *));
 217
 218 extern void select_and_print_frame PARAMS ((struct frame_info *, int));
 219
 220 extern void print_frame_info PARAMS ((struct frame_info *, int, int, int));
 221
 222 extern void show_frame_info PARAMS ((struct frame_info *, int, int, int));
 223
 224 extern CORE_ADDR find_saved_register PARAMS ((struct frame_info *, int));
 225
 226 extern struct frame_info *block_innermost_frame PARAMS ((struct block *));
 227
 228 extern struct frame_info *find_frame_addr_in_frame_chain PARAMS ((CORE_ADDR));
 229
 230 extern CORE_ADDR sigtramp_saved_pc PARAMS ((struct frame_info *));
 231
 232 extern CORE_ADDR generic_read_register_dummy PARAMS ((CORE_ADDR pc,
 233                                                       CORE_ADDR fp,
 234                                                       int));
 235 extern void      generic_push_dummy_frame    PARAMS ((void));
 236 extern void      generic_pop_current_frame   PARAMS ((void (*) (struct frame_info *)));
 237 extern void      generic_pop_dummy_frame     PARAMS ((void));
 238
 239 extern int       generic_pc_in_call_dummy    PARAMS ((CORE_ADDR pc,
 240                                                       CORE_ADDR sp,
 241                                                       CORE_ADDR fp));
 242 extern char *    generic_find_dummy_frame    PARAMS ((CORE_ADDR pc,
 243                                                       CORE_ADDR fp));
 244
 245 extern void generic_fix_call_dummy PARAMS ((char *dummy, CORE_ADDR pc, CORE_ADDR fun,
 246                                             int nargs, struct value **args,
 247                                             struct type *type, int gcc_p));
 248
 249 #ifdef __STDC__
 250 /* Some native compilers, even ones that are supposed to be ANSI and for which __STDC__
 251    is true, complain about forward decls of enums. */
 252 enum lval_type;
 253 extern void      generic_get_saved_register  PARAMS ((char *, int *, CORE_ADDR *, struct frame_info *, int, enum lval_type *));
 254 #endif
 255
 256 #endif /* !defined (FRAME_H)  */