1 /* Definitions for dealing with stack frames, for GDB, the GNU debugger.
2 Copyright 1986, 1989, 1991, 1992, 1999 Free Software Foundation, Inc.
4 This file is part of GDB.
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.
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.
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. */
21 #if !defined (FRAME_H)
24 /* Describe the saved registers of a frame. */
26 #if defined (EXTRA_FRAME_INFO) || defined (FRAME_FIND_SAVED_REGS)
27 /* XXXX - deprecated */
28 struct frame_saved_regs
31 /* For each register, address of where it was saved on entry to
32 the frame, or zero if it was not saved on entry to this frame.
33 This includes special registers such as pc and fp saved in
34 special ways in the stack frame. The SP_REGNUM is even more
35 special, the address here is the sp for the next frame, not the
36 address where the sp was saved. */
38 CORE_ADDR regs
[NUM_REGS
];
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. */
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. */
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. */
65 /* Nonzero if this is a frame associated with calling a signal handler.
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
;
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 */
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. */
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
;
98 /* Pointers to the next and previous frame_info's in the frame cache. */
99 struct frame_info
*next
, *prev
;
102 /* Allocate additional space for appendices to a struct frame_info. */
104 #ifndef SIZEOF_FRAME_SAVED_REGS
105 #define SIZEOF_FRAME_SAVED_REGS (sizeof (CORE_ADDR) * (NUM_REGS))
107 extern void *frame_obstack_alloc
PARAMS ((unsigned long size
));
108 extern void frame_saved_regs_zalloc
PARAMS ((struct frame_info
*));
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
122 #define FRAME_FP(fi) ((fi)->frame)
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.
128 If a particular target needs a different definition, then it can override
129 the definition here by providing one in the tm file.
131 XXXX - both default and alternate frame_chain_valid functions are
132 deprecated. New code should use generic dummy frames. */
134 extern int default_frame_chain_valid
PARAMS ((CORE_ADDR
, struct frame_info
*));
135 extern int alternate_frame_chain_valid
PARAMS ((CORE_ADDR
, struct frame_info
*));
136 extern int nonnull_frame_chain_valid
PARAMS ((CORE_ADDR
, struct frame_info
*));
137 extern int generic_frame_chain_valid
PARAMS ((CORE_ADDR
, struct frame_info
*));
138 extern void generic_save_dummy_frame_tos
PARAMS ((CORE_ADDR sp
));
140 #if !defined (FRAME_CHAIN_VALID)
141 #if !defined (FRAME_CHAIN_VALID_ALTERNATE)
142 #define FRAME_CHAIN_VALID(chain, thisframe) default_frame_chain_valid (chain, thisframe)
144 /* Use the alternate method of avoiding running up off the end of the frame
145 chain or following frames back into the startup code. See the comments
147 #define FRAME_CHAIN_VALID(chain, thisframe) alternate_frame_chain_valid (chain,thisframe)
148 #endif /* FRAME_CHAIN_VALID_ALTERNATE */
149 #endif /* FRAME_CHAIN_VALID */
151 /* The stack frame that the user has specified for commands to act on.
152 Note that one cannot assume this is the address of valid data. */
154 extern struct frame_info
*selected_frame
;
156 /* Level of the selected frame:
157 0 for innermost, 1 for its caller, ...
158 or -1 for frame specified by address with no defined level. */
160 extern int selected_frame_level
;
162 extern struct frame_info
*create_new_frame
PARAMS ((CORE_ADDR
, CORE_ADDR
));
164 extern void flush_cached_frames
PARAMS ((void));
166 extern void reinit_frame_cache
PARAMS ((void));
169 #ifdef FRAME_FIND_SAVED_REGS
170 /* XXX - deprecated */
171 #define FRAME_INIT_SAVED_REGS(FI) get_frame_saved_regs (FI, NULL)
172 extern void get_frame_saved_regs
PARAMS ((struct frame_info
*,
173 struct frame_saved_regs
*));
176 extern void set_current_frame
PARAMS ((struct frame_info
*));
178 extern struct frame_info
*get_prev_frame
PARAMS ((struct frame_info
*));
180 extern struct frame_info
*get_current_frame
PARAMS ((void));
182 extern struct frame_info
*get_next_frame
PARAMS ((struct frame_info
*));
184 extern struct block
*get_frame_block
PARAMS ((struct frame_info
*));
186 extern struct block
*get_current_block
PARAMS ((void));
188 extern struct block
*get_selected_block
PARAMS ((void));
190 extern struct symbol
*get_frame_function
PARAMS ((struct frame_info
*));
192 extern CORE_ADDR get_frame_pc
PARAMS ((struct frame_info
*));
194 extern CORE_ADDR get_pc_function_start
PARAMS ((CORE_ADDR
));
196 extern struct block
*block_for_pc
PARAMS ((CORE_ADDR
));
198 extern struct block
*block_for_pc_sect
PARAMS ((CORE_ADDR
, asection
*));
200 extern int frameless_look_for_prologue
PARAMS ((struct frame_info
*));
202 extern void print_frame_args
PARAMS ((struct symbol
*, struct frame_info
*,
205 extern struct frame_info
*find_relative_frame
PARAMS ((struct frame_info
*, int *));
207 extern void show_and_print_stack_frame
PARAMS ((struct frame_info
* fi
, int level
, int source
));
209 extern void print_stack_frame
PARAMS ((struct frame_info
*, int, int));
211 extern void print_only_stack_frame
PARAMS ((struct frame_info
*, int, int));
213 extern void show_stack_frame
PARAMS ((struct frame_info
*));
215 extern void select_frame
PARAMS ((struct frame_info
*, int));
217 extern void record_selected_frame
PARAMS ((CORE_ADDR
*, int *));
219 extern void select_and_print_frame
PARAMS ((struct frame_info
*, int));
221 extern void print_frame_info
PARAMS ((struct frame_info
*, int, int, int));
223 extern void show_frame_info
PARAMS ((struct frame_info
*, int, int, int));
225 extern CORE_ADDR find_saved_register
PARAMS ((struct frame_info
*, int));
227 extern struct frame_info
*block_innermost_frame
PARAMS ((struct block
*));
229 extern struct frame_info
*find_frame_addr_in_frame_chain
PARAMS ((CORE_ADDR
));
231 extern CORE_ADDR sigtramp_saved_pc
PARAMS ((struct frame_info
*));
233 extern CORE_ADDR generic_read_register_dummy
PARAMS ((CORE_ADDR pc
,
236 extern void generic_push_dummy_frame
PARAMS ((void));
237 extern void generic_pop_current_frame
PARAMS ((void (*)(struct frame_info
*)));
238 extern void generic_pop_dummy_frame
PARAMS ((void));
240 extern int generic_pc_in_call_dummy
PARAMS ((CORE_ADDR pc
,
243 extern char *generic_find_dummy_frame
PARAMS ((CORE_ADDR pc
,
246 extern void generic_fix_call_dummy
PARAMS ((char *dummy
, CORE_ADDR pc
, CORE_ADDR fun
,
247 int nargs
, struct value
** args
,
248 struct type
* type
, int gcc_p
));
251 /* Some native compilers, even ones that are supposed to be ANSI and for which __STDC__
252 is true, complain about forward decls of enums. */
254 extern void generic_get_saved_register
PARAMS ((char *, int *, CORE_ADDR
*, struct frame_info
*, int, enum lval_type
*));
257 #endif /* !defined (FRAME_H) */