gdb/frame.h

   1 /* Definitions for dealing with stack frames, for GDB, the GNU debugger.
   2    Copyright 1986, 1989, 1991, 1992, 1999, 2000 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 /* Values for the source flag to be used in print_frame_info_base(). */
 103 enum print_what
 104   {
 105     /* Print only the source line, like in stepi. */
 106     SRC_LINE = -1,
 107     /* Print only the location, i.e. level, address (sometimes)
 108        function, args, file, line, line num. */
 109     LOCATION,
 110     /* Print both of the above. */
 111     SRC_AND_LOC,
 112     /* Print location only, but always include the address. */
 113     LOC_AND_ADDRESS
 114   };
 115
 116 /* Allocate additional space for appendices to a struct frame_info. */
 117
 118 #ifndef SIZEOF_FRAME_SAVED_REGS
 119 #define SIZEOF_FRAME_SAVED_REGS (sizeof (CORE_ADDR) * (NUM_REGS))
 120 #endif
 121 extern void *frame_obstack_alloc (unsigned long size);
 122 extern void frame_saved_regs_zalloc (struct frame_info *);
 123
 124 /* Return the frame address from FR.  Except in the machine-dependent
 125    *FRAME* macros, a frame address has no defined meaning other than
 126    as a magic cookie which identifies a frame over calls to the
 127    inferior.  The only known exception is inferior.h
 128    (PC_IN_CALL_DUMMY) [ON_STACK]; see comments there.  You cannot
 129    assume that a frame address contains enough information to
 130    reconstruct the frame; if you want more than just to identify the
 131    frame (e.g. be able to fetch variables relative to that frame),
 132    then save the whole struct frame_info (and the next struct
 133    frame_info, since the latter is used for fetching variables on some
 134    machines).  */
 135
 136 #define FRAME_FP(fi) ((fi)->frame)
 137
 138 /* Define a default FRAME_CHAIN_VALID, in the form that is suitable for most
 139    targets.  If FRAME_CHAIN_VALID returns zero it means that the given frame
 140    is the outermost one and has no caller.
 141
 142    If a particular target needs a different definition, then it can override
 143    the definition here by providing one in the tm file.
 144
 145    XXXX - both default and alternate frame_chain_valid functions are
 146    deprecated.  New code should use dummy frames and one of the
 147    generic functions. */
 148
 149 extern int file_frame_chain_valid (CORE_ADDR, struct frame_info *);
 150 extern int func_frame_chain_valid (CORE_ADDR, struct frame_info *);
 151 extern int nonnull_frame_chain_valid (CORE_ADDR, struct frame_info *);
 152 extern int generic_file_frame_chain_valid (CORE_ADDR, struct frame_info *);
 153 extern int generic_func_frame_chain_valid (CORE_ADDR, struct frame_info *);
 154 extern void generic_save_dummy_frame_tos (CORE_ADDR sp);
 155
 156 #if !defined (FRAME_CHAIN_VALID)
 157 #if !defined (FRAME_CHAIN_VALID_ALTERNATE)
 158 #define FRAME_CHAIN_VALID(chain, thisframe) file_frame_chain_valid (chain, thisframe)
 159 #else
 160 /* Use the alternate method of avoiding running up off the end of the frame
 161    chain or following frames back into the startup code.  See the comments
 162    in objfiles.h. */
 163 #define FRAME_CHAIN_VALID(chain, thisframe) func_frame_chain_valid (chain,thisframe)
 164 #endif /* FRAME_CHAIN_VALID_ALTERNATE */
 165 #endif /* FRAME_CHAIN_VALID */
 166
 167 /* The stack frame that the user has specified for commands to act on.
 168    Note that one cannot assume this is the address of valid data.  */
 169
 170 extern struct frame_info *selected_frame;
 171
 172 /* Level of the selected frame:
 173    0 for innermost, 1 for its caller, ...
 174    or -1 for frame specified by address with no defined level.  */
 175
 176 extern int selected_frame_level;
 177
 178 extern struct frame_info *create_new_frame (CORE_ADDR, CORE_ADDR);
 179
 180 extern void flush_cached_frames (void);
 181
 182 extern void reinit_frame_cache (void);
 183
 184
 185 #ifdef FRAME_FIND_SAVED_REGS
 186 /* XXX - deprecated */
 187 #define FRAME_INIT_SAVED_REGS(FI) get_frame_saved_regs (FI, NULL)
 188 extern void get_frame_saved_regs (struct frame_info *,
 189                                   struct frame_saved_regs *);
 190 #endif
 191
 192 extern void set_current_frame (struct frame_info *);
 193
 194 extern struct frame_info *get_prev_frame (struct frame_info *);
 195
 196 extern struct frame_info *get_current_frame (void);
 197
 198 extern struct frame_info *get_next_frame (struct frame_info *);
 199
 200 extern struct block *get_frame_block (struct frame_info *);
 201
 202 extern struct block *get_current_block (void);
 203
 204 extern struct block *get_selected_block (void);
 205
 206 extern struct symbol *get_frame_function (struct frame_info *);
 207
 208 extern CORE_ADDR get_frame_pc (struct frame_info *);
 209
 210 extern CORE_ADDR get_pc_function_start (CORE_ADDR);
 211
 212 extern struct block *block_for_pc (CORE_ADDR);
 213
 214 extern struct block *block_for_pc_sect (CORE_ADDR, asection *);
 215
 216 extern int frameless_look_for_prologue (struct frame_info *);
 217
 218 extern void print_frame_args (struct symbol *, struct frame_info *,
 219                               int, struct ui_file *);
 220
 221 extern struct frame_info *find_relative_frame (struct frame_info *, int *);
 222
 223 extern void show_and_print_stack_frame (struct frame_info *fi, int level,
 224                                         int source);
 225
 226 extern void print_stack_frame (struct frame_info *, int, int);
 227
 228 extern void print_only_stack_frame (struct frame_info *, int, int);
 229
 230 extern void show_stack_frame (struct frame_info *);
 231
 232 extern void select_frame (struct frame_info *, int);
 233
 234 extern void record_selected_frame (CORE_ADDR *, int *);
 235
 236 extern void select_and_print_frame (struct frame_info *, int);
 237
 238 extern void print_frame_info (struct frame_info *, int, int, int);
 239
 240 extern void show_frame_info (struct frame_info *, int, int, int);
 241
 242 extern CORE_ADDR find_saved_register (struct frame_info *, int);
 243
 244 extern struct frame_info *block_innermost_frame (struct block *);
 245
 246 extern struct frame_info *find_frame_addr_in_frame_chain (CORE_ADDR);
 247
 248 extern CORE_ADDR sigtramp_saved_pc (struct frame_info *);
 249
 250 extern CORE_ADDR generic_read_register_dummy (CORE_ADDR pc,
 251                                               CORE_ADDR fp, int);
 252 extern void generic_push_dummy_frame (void);
 253 extern void generic_pop_current_frame (void (*)(struct frame_info *));
 254 extern void generic_pop_dummy_frame (void);
 255
 256 extern int generic_pc_in_call_dummy (CORE_ADDR pc,
 257                                      CORE_ADDR sp, CORE_ADDR fp);
 258 extern char *generic_find_dummy_frame (CORE_ADDR pc, CORE_ADDR fp);
 259
 260 extern void generic_fix_call_dummy (char *dummy, CORE_ADDR pc, CORE_ADDR fun,
 261                                     int nargs, struct value **args,
 262                                     struct type *type, int gcc_p);
 263
 264 extern void generic_get_saved_register (char *, int *, CORE_ADDR *,
 265                                         struct frame_info *, int,
 266                                         enum lval_type *);
 267
 268 #endif /* !defined (FRAME_H)  */