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