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
 138 #if !defined (FRAME_CHAIN_VALID)
 139 #if !defined (FRAME_CHAIN_VALID_ALTERNATE)
 140 #define FRAME_CHAIN_VALID(chain, thisframe) default_frame_chain_valid (chain, thisframe)
 141 #else
 142 /* Use the alternate method of avoiding running up off the end of the frame
 143    chain or following frames back into the startup code.  See the comments
 144    in objfiles.h. */
 145 #define FRAME_CHAIN_VALID(chain, thisframe) alternate_frame_chain_valid (chain,thisframe)
 146 #endif  /* FRAME_CHAIN_VALID_ALTERNATE */
 147 #endif  /* FRAME_CHAIN_VALID */
 148
 149 /* The stack frame that the user has specified for commands to act on.
 150    Note that one cannot assume this is the address of valid data.  */
 151
 152 extern struct frame_info *selected_frame;
 153
 154 /* Level of the selected frame:
 155    0 for innermost, 1 for its caller, ...
 156    or -1 for frame specified by address with no defined level.  */
 157
 158 extern int selected_frame_level;
 159
 160 extern struct frame_info *create_new_frame PARAMS ((CORE_ADDR, CORE_ADDR));
 161
 162 extern void flush_cached_frames PARAMS ((void));
 163
 164 extern void reinit_frame_cache PARAMS ((void));
 165
 166
 167 #ifdef FRAME_FIND_SAVED_REGS
 168 /* XXX - deprecated */
 169 #define FRAME_INIT_SAVED_REGS(FI) get_frame_saved_regs (FI, NULL)
 170 extern void get_frame_saved_regs PARAMS ((struct frame_info *,
 171                                           struct frame_saved_regs *));
 172 #endif
 173
 174 extern void set_current_frame PARAMS ((struct frame_info *));
 175
 176 extern struct frame_info *get_prev_frame PARAMS ((struct frame_info *));
 177
 178 extern struct frame_info *get_current_frame PARAMS ((void));
 179
 180 extern struct frame_info *get_next_frame PARAMS ((struct frame_info *));
 181
 182 extern struct block *get_frame_block PARAMS ((struct frame_info *));
 183
 184 extern struct block *get_current_block PARAMS ((void));
 185
 186 extern struct block *get_selected_block PARAMS ((void));
 187
 188 extern struct symbol *get_frame_function PARAMS ((struct frame_info *));
 189
 190 extern CORE_ADDR get_frame_pc PARAMS ((struct frame_info *));
 191
 192 extern CORE_ADDR get_pc_function_start PARAMS ((CORE_ADDR));
 193
 194 extern struct block * block_for_pc PARAMS ((CORE_ADDR));
 195
 196 extern struct block * block_for_pc_sect PARAMS ((CORE_ADDR, asection *));
 197
 198 extern int frameless_look_for_prologue PARAMS ((struct frame_info *));
 199
 200 extern void print_frame_args PARAMS ((struct symbol *, struct frame_info *,
 201                                       int, GDB_FILE *));
 202
 203 extern struct frame_info *find_relative_frame PARAMS ((struct frame_info *, int*));
 204
 205 extern void show_and_print_stack_frame PARAMS ((struct frame_info *fi, int level, int source));
 206
 207 extern void print_stack_frame PARAMS ((struct frame_info *, int, int));
 208
 209 extern void print_only_stack_frame PARAMS ((struct frame_info *, int, int));
 210
 211 extern void show_stack_frame PARAMS ((struct frame_info *));
 212
 213 extern void select_frame PARAMS ((struct frame_info *, int));
 214
 215 extern void record_selected_frame PARAMS ((CORE_ADDR *, int *));
 216
 217 extern void select_and_print_frame PARAMS ((struct frame_info *, int));
 218
 219 extern void print_frame_info PARAMS ((struct frame_info *, int, int, int));
 220
 221 extern void show_frame_info PARAMS ((struct frame_info *, int, int, int));
 222
 223 extern CORE_ADDR find_saved_register PARAMS ((struct frame_info *, int));
 224
 225 extern struct frame_info *block_innermost_frame PARAMS ((struct block *));
 226
 227 extern struct frame_info *find_frame_addr_in_frame_chain PARAMS ((CORE_ADDR));
 228
 229 extern CORE_ADDR sigtramp_saved_pc PARAMS ((struct frame_info *));
 230
 231 extern CORE_ADDR generic_read_register_dummy PARAMS ((CORE_ADDR pc,
 232                                                       CORE_ADDR fp,
 233                                                       int));
 234 extern void      generic_push_dummy_frame    PARAMS ((void));
 235 extern void      generic_pop_current_frame   PARAMS ((void (*) (struct frame_info *)));
 236 extern void      generic_pop_dummy_frame     PARAMS ((void));
 237
 238 extern int       generic_pc_in_call_dummy    PARAMS ((CORE_ADDR pc,
 239                                                       CORE_ADDR sp,
 240                                                       CORE_ADDR fp));
 241 extern char *    generic_find_dummy_frame    PARAMS ((CORE_ADDR pc,
 242                                                       CORE_ADDR fp));
 243
 244 extern void generic_fix_call_dummy PARAMS ((char *dummy, CORE_ADDR pc, CORE_ADDR fun,
 245                                             int nargs, struct value **args,
 246                                             struct type *type, int gcc_p));
 247
 248 #ifdef __STDC__
 249 /* Some native compilers, even ones that are supposed to be ANSI and for which __STDC__
 250    is true, complain about forward decls of enums. */
 251 enum lval_type;
 252 extern void      generic_get_saved_register  PARAMS ((char *, int *, CORE_ADDR *, struct frame_info *, int, enum lval_type *));
 253 #endif
 254
 255 #endif /* !defined (FRAME_H)  */