Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Definitions for dealing with stack frames, for GDB, the GNU debugger. |
7cc19214 AC |
2 | |
3 | Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1996, | |
51603483 | 4 | 1997, 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc. |
c906108c | 5 | |
c5aa993b | 6 | This file is part of GDB. |
c906108c | 7 | |
c5aa993b JM |
8 | This program is free software; you can redistribute it and/or modify |
9 | it under the terms of the GNU General Public License as published by | |
10 | the Free Software Foundation; either version 2 of the License, or | |
11 | (at your option) any later version. | |
c906108c | 12 | |
c5aa993b JM |
13 | This program is distributed in the hope that it will be useful, |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
c906108c | 17 | |
c5aa993b JM |
18 | You should have received a copy of the GNU General Public License |
19 | along with this program; if not, write to the Free Software | |
20 | Foundation, Inc., 59 Temple Place - Suite 330, | |
21 | Boston, MA 02111-1307, USA. */ | |
c906108c SS |
22 | |
23 | #if !defined (FRAME_H) | |
24 | #define FRAME_H 1 | |
25 | ||
f0e7d0e8 AC |
26 | /* The following is the intended naming schema for frame functions. |
27 | It isn't 100% consistent, but it is aproaching that. Frame naming | |
28 | schema: | |
29 | ||
30 | Prefixes: | |
31 | ||
32 | get_frame_WHAT...(): Get WHAT from the THIS frame (functionaly | |
33 | equivalent to THIS->next->unwind->what) | |
34 | ||
35 | frame_unwind_WHAT...(): Unwind THIS frame's WHAT from the NEXT | |
36 | frame. | |
37 | ||
38 | put_frame_WHAT...(): Put a value into this frame (unsafe, need to | |
39 | invalidate the frame / regcache afterwards) (better name more | |
40 | strongly hinting at its unsafeness) | |
41 | ||
42 | safe_....(): Safer version of various functions, doesn't throw an | |
43 | error (leave this for later?). Returns non-zero if the fetch | |
44 | succeeds. Return a freshly allocated error message? | |
45 | ||
46 | Suffixes: | |
47 | ||
48 | void /frame/_WHAT(): Read WHAT's value into the buffer parameter. | |
49 | ||
50 | ULONGEST /frame/_WHAT_unsigned(): Return an unsigned value (the | |
51 | alternative is *frame_unsigned_WHAT). | |
52 | ||
53 | LONGEST /frame/_WHAT_signed(): Return WHAT signed value. | |
54 | ||
55 | What: | |
56 | ||
57 | /frame/_memory* (frame, coreaddr, len [, buf]): Extract/return | |
58 | *memory. | |
59 | ||
60 | /frame/_register* (frame, regnum [, buf]): extract/return register. | |
61 | ||
62 | CORE_ADDR /frame/_{pc,sp,...} (frame): Resume address, innner most | |
63 | stack *address, ... | |
64 | ||
65 | */ | |
66 | ||
1058bca7 | 67 | struct symtab_and_line; |
494cca16 | 68 | struct frame_unwind; |
da62e633 | 69 | struct frame_base; |
fe898f56 | 70 | struct block; |
cd983b5c | 71 | struct gdbarch; |
30e221b4 | 72 | struct ui_file; |
494cca16 | 73 | |
6dc42492 AC |
74 | /* A legacy unwinder to prop up architectures using the old style |
75 | saved regs array. */ | |
76 | extern const struct frame_unwind *legacy_saved_regs_unwind; | |
1058bca7 | 77 | |
c97eb5d9 AC |
78 | /* The frame object. */ |
79 | ||
80 | struct frame_info; | |
81 | ||
82 | /* The frame object's ID. This provides a per-frame unique identifier | |
83 | that can be used to relocate a `struct frame_info' after a target | |
7a424e99 AC |
84 | resume or a frame cache destruct. It of course assumes that the |
85 | inferior hasn't unwound the stack past that frame. */ | |
c97eb5d9 AC |
86 | |
87 | struct frame_id | |
88 | { | |
d0a55772 AC |
89 | /* The frame's stack address. This shall be constant through out |
90 | the lifetime of a frame. Note that this requirement applies to | |
91 | not just the function body, but also the prologue and (in theory | |
92 | at least) the epilogue. Since that value needs to fall either on | |
93 | the boundary, or within the frame's address range, the frame's | |
94 | outer-most address (the inner-most address of the previous frame) | |
95 | is used. Watch out for all the legacy targets that still use the | |
96 | function pointer register or stack pointer register. They are | |
97 | wrong. */ | |
c97eb5d9 AC |
98 | /* NOTE: cagney/2002-11-16: The ia64 has two stacks and hence two |
99 | frame bases. This will need to be expanded to accomodate that. */ | |
d0a55772 AC |
100 | CORE_ADDR stack_addr; |
101 | /* The frame's code address. This shall be constant through out the | |
102 | lifetime of the frame. While the PC (a.k.a. resume address) | |
103 | changes as the function is executed, this code address cannot. | |
104 | Typically, it is set to the address of the entry point of the | |
105 | frame's function (as returned by frame_func_unwind(). */ | |
106 | CORE_ADDR code_addr; | |
c97eb5d9 AC |
107 | }; |
108 | ||
7a424e99 AC |
109 | /* Methods for constructing and comparing Frame IDs. |
110 | ||
111 | NOTE: Given frameless functions A and B, where A calls B (and hence | |
112 | B is inner-to A). The relationships: !eq(A,B); !eq(B,A); | |
113 | !inner(A,B); !inner(B,A); all hold. This is because, while B is | |
114 | inner to A, B is not strictly inner to A (being frameless, they | |
115 | have the same .base value). */ | |
116 | ||
117 | /* For convenience. All fields are zero. */ | |
118 | extern const struct frame_id null_frame_id; | |
119 | ||
d0a55772 AC |
120 | /* Construct a frame ID. The first parameter is the frame's constant |
121 | stack address (typically the outer-bound), and the second the | |
122 | frame's constant code address (typically the entry point) (or zero, | |
123 | to indicate a wild card). */ | |
124 | extern struct frame_id frame_id_build (CORE_ADDR stack_addr, | |
125 | CORE_ADDR code_addr); | |
7a424e99 AC |
126 | |
127 | /* Returns non-zero when L is a valid frame (a valid frame has a | |
128 | non-zero .base). */ | |
129 | extern int frame_id_p (struct frame_id l); | |
130 | ||
131 | /* Returns non-zero when L and R identify the same frame, or, if | |
132 | either L or R have a zero .func, then the same frame base. */ | |
133 | extern int frame_id_eq (struct frame_id l, struct frame_id r); | |
134 | ||
135 | /* Returns non-zero when L is strictly inner-than R (they have | |
136 | different frame .bases). Neither L, nor R can be `null'. See note | |
137 | above about frameless functions. */ | |
138 | extern int frame_id_inner (struct frame_id l, struct frame_id r); | |
139 | ||
00905d52 AC |
140 | /* Write the internal representation of a frame ID on the specified |
141 | stream. */ | |
142 | extern void fprint_frame_id (struct ui_file *file, struct frame_id id); | |
143 | ||
7a424e99 | 144 | |
c97eb5d9 AC |
145 | /* For every stopped thread, GDB tracks two frames: current and |
146 | selected. Current frame is the inner most frame of the selected | |
abc0af47 AC |
147 | thread. Selected frame is the one being examined by the the GDB |
148 | CLI (selected using `up', `down', ...). The frames are created | |
149 | on-demand (via get_prev_frame()) and then held in a frame cache. */ | |
150 | /* FIXME: cagney/2002-11-28: Er, there is a lie here. If you do the | |
151 | sequence: `thread 1; up; thread 2; thread 1' you loose thread 1's | |
152 | selected frame. At present GDB only tracks the selected frame of | |
153 | the current thread. But be warned, that might change. */ | |
c97eb5d9 AC |
154 | /* FIXME: cagney/2002-11-14: At any time, only one thread's selected |
155 | and current frame can be active. Switching threads causes gdb to | |
156 | discard all that cached frame information. Ulgh! Instead, current | |
157 | and selected frame should be bound to a thread. */ | |
158 | ||
abc0af47 AC |
159 | /* On demand, create the inner most frame using information found in |
160 | the inferior. If the inner most frame can't be created, throw an | |
161 | error. */ | |
c97eb5d9 AC |
162 | extern struct frame_info *get_current_frame (void); |
163 | ||
abc0af47 AC |
164 | /* Invalidates the frame cache (this function should have been called |
165 | invalidate_cached_frames). | |
166 | ||
167 | FIXME: cagney/2002-11-28: The only difference between | |
168 | flush_cached_frames() and reinit_frame_cache() is that the latter | |
169 | explicitly sets the selected frame back to the current frame there | |
170 | isn't any real difference (except that one delays the selection of | |
6e7f8b9c AC |
171 | a new frame). Code can instead simply rely on get_selected_frame() |
172 | to reinit's the selected frame as needed. As for invalidating the | |
173 | cache, there should be two methods one that reverts the thread's | |
174 | selected frame back to current frame (for when the inferior | |
175 | resumes) and one that does not (for when the user modifies the | |
176 | target invalidating the frame cache). */ | |
c97eb5d9 | 177 | extern void flush_cached_frames (void); |
c97eb5d9 AC |
178 | extern void reinit_frame_cache (void); |
179 | ||
6e7f8b9c AC |
180 | /* On demand, create the selected frame and then return it. If the |
181 | selected frame can not be created, this function throws an error. */ | |
182 | /* FIXME: cagney/2002-11-28: At present, when there is no selected | |
183 | frame, this function always returns the current (inner most) frame. | |
184 | It should instead, when a thread has previously had its frame | |
185 | selected (but not resumed) and the frame cache invalidated, find | |
186 | and then return that thread's previously selected frame. */ | |
187 | extern struct frame_info *get_selected_frame (void); | |
188 | ||
abc0af47 AC |
189 | /* Select a specific frame. NULL, apparently implies re-select the |
190 | inner most frame. */ | |
191 | extern void select_frame (struct frame_info *); | |
192 | ||
c97eb5d9 AC |
193 | /* Given a FRAME, return the next (more inner, younger) or previous |
194 | (more outer, older) frame. */ | |
195 | extern struct frame_info *get_prev_frame (struct frame_info *); | |
196 | extern struct frame_info *get_next_frame (struct frame_info *); | |
197 | ||
870b3035 AC |
198 | /* Given a FRAME, return the true next (more inner, younger) frame. |
199 | This one exposes the sentinel frame and, hence, never returns NULL. | |
200 | It is here strictly to help old targets in their migration path to | |
201 | the new frame code - the new code requires the NEXT, and not THIS | |
202 | frame. */ | |
203 | extern struct frame_info *deprecated_get_next_frame_hack (struct frame_info *); | |
204 | ||
c97eb5d9 AC |
205 | /* Given a frame's ID, relocate the frame. Returns NULL if the frame |
206 | is not found. */ | |
207 | extern struct frame_info *frame_find_by_id (struct frame_id id); | |
208 | ||
209 | /* Base attributes of a frame: */ | |
210 | ||
211 | /* The frame's `resume' address. Where the program will resume in | |
ef6e7e13 AC |
212 | this frame. |
213 | ||
214 | This replaced: frame->pc; */ | |
c97eb5d9 AC |
215 | extern CORE_ADDR get_frame_pc (struct frame_info *); |
216 | ||
a9e5fdc2 AC |
217 | /* The frame's inner-most bound. AKA the stack-pointer. Confusingly |
218 | known as top-of-stack. */ | |
219 | ||
220 | extern CORE_ADDR get_frame_sp (struct frame_info *); | |
221 | extern CORE_ADDR frame_sp_unwind (struct frame_info *); | |
222 | ||
223 | ||
be41e9f4 AC |
224 | /* Following on from the `resume' address. Return the entry point |
225 | address of the function containing that resume address, or zero if | |
226 | that function isn't known. */ | |
227 | extern CORE_ADDR frame_func_unwind (struct frame_info *fi); | |
228 | extern CORE_ADDR get_frame_func (struct frame_info *fi); | |
229 | ||
1058bca7 AC |
230 | /* Closely related to the resume address, various symbol table |
231 | attributes that are determined by the PC. Note that for a normal | |
232 | frame, the PC refers to the resume address after the return, and | |
233 | not the call instruction. In such a case, the address is adjusted | |
234 | so that it (approximatly) identifies the call site (and not return | |
235 | site). | |
236 | ||
237 | NOTE: cagney/2002-11-28: The frame cache could be used to cache the | |
238 | computed value. Working on the assumption that the bottle-neck is | |
239 | in the single step code, and that code causes the frame cache to be | |
240 | constantly flushed, caching things in a frame is probably of little | |
241 | benefit. As they say `show us the numbers'. | |
242 | ||
243 | NOTE: cagney/2002-11-28: Plenty more where this one came from: | |
244 | find_frame_block(), find_frame_partial_function(), | |
245 | find_frame_symtab(), find_frame_function(). Each will need to be | |
246 | carefully considered to determine if the real intent was for it to | |
247 | apply to the PC or the adjusted PC. */ | |
248 | extern void find_frame_sal (struct frame_info *frame, | |
249 | struct symtab_and_line *sal); | |
250 | ||
da62e633 AC |
251 | /* Return the frame base (what ever that is) (DEPRECATED). |
252 | ||
253 | Old code was trying to use this single method for two conflicting | |
254 | purposes. Such code needs to be updated to use either of: | |
255 | ||
256 | get_frame_id: A low level frame unique identifier, that consists of | |
257 | both a stack and a function address, that can be used to uniquely | |
258 | identify a frame. This value is determined by the frame's | |
259 | low-level unwinder, the stack part [typically] being the | |
260 | top-of-stack of the previous frame, and the function part being the | |
261 | function's start address. Since the correct identification of a | |
262 | frameless function requires both the a stack and function address, | |
263 | the old get_frame_base method was not sufficient. | |
264 | ||
265 | get_frame_base_address: get_frame_locals_address: | |
266 | get_frame_args_address: A set of high-level debug-info dependant | |
267 | addresses that fall within the frame. These addresses almost | |
268 | certainly will not match the stack address part of a frame ID (as | |
ef6e7e13 AC |
269 | returned by get_frame_base). |
270 | ||
271 | This replaced: frame->frame; */ | |
c193f6ac AC |
272 | |
273 | extern CORE_ADDR get_frame_base (struct frame_info *); | |
274 | ||
c97eb5d9 | 275 | /* Return the per-frame unique identifer. Can be used to relocate a |
7a424e99 AC |
276 | frame after a frame cache flush (and other similar operations). If |
277 | FI is NULL, return the null_frame_id. */ | |
278 | extern struct frame_id get_frame_id (struct frame_info *fi); | |
c97eb5d9 | 279 | |
da62e633 AC |
280 | /* Assuming that a frame is `normal', return its base-address, or 0 if |
281 | the information isn't available. NOTE: This address is really only | |
282 | meaningful to the frame's high-level debug info. */ | |
283 | extern CORE_ADDR get_frame_base_address (struct frame_info *); | |
284 | ||
6bfb3e36 AC |
285 | /* Assuming that a frame is `normal', return the base-address of the |
286 | local variables, or 0 if the information isn't available. NOTE: | |
da62e633 AC |
287 | This address is really only meaningful to the frame's high-level |
288 | debug info. Typically, the argument and locals share a single | |
289 | base-address. */ | |
290 | extern CORE_ADDR get_frame_locals_address (struct frame_info *); | |
291 | ||
6bfb3e36 AC |
292 | /* Assuming that a frame is `normal', return the base-address of the |
293 | parameter list, or 0 if that information isn't available. NOTE: | |
294 | This address is really only meaningful to the frame's high-level | |
295 | debug info. Typically, the argument and locals share a single | |
da62e633 AC |
296 | base-address. */ |
297 | extern CORE_ADDR get_frame_args_address (struct frame_info *); | |
298 | ||
c97eb5d9 AC |
299 | /* The frame's level: 0 for innermost, 1 for its caller, ...; or -1 |
300 | for an invalid frame). */ | |
301 | extern int frame_relative_level (struct frame_info *fi); | |
302 | ||
5a203e44 AC |
303 | /* Return the frame's type. Some are real, some are signal |
304 | trampolines, and some are completly artificial (dummy). */ | |
305 | ||
306 | enum frame_type | |
307 | { | |
7df05f2b AC |
308 | /* The frame's type hasn't yet been defined. This is a catch-all |
309 | for legacy code that uses really strange technicques, such as | |
310 | deprecated_set_frame_type, to set the frame's type. New code | |
311 | should not use this value. */ | |
312 | UNKNOWN_FRAME, | |
5a203e44 AC |
313 | /* A true stack frame, created by the target program during normal |
314 | execution. */ | |
315 | NORMAL_FRAME, | |
316 | /* A fake frame, created by GDB when performing an inferior function | |
317 | call. */ | |
318 | DUMMY_FRAME, | |
319 | /* In a signal handler, various OSs handle this in various ways. | |
320 | The main thing is that the frame may be far from normal. */ | |
321 | SIGTRAMP_FRAME | |
322 | }; | |
323 | extern enum frame_type get_frame_type (struct frame_info *); | |
324 | ||
325 | /* FIXME: cagney/2002-11-10: Some targets want to directly mark a | |
326 | frame as being of a specific type. This shouldn't be necessary. | |
ae45cd16 AC |
327 | PC_IN_SIGTRAMP() indicates a SIGTRAMP_FRAME and |
328 | DEPRECATED_PC_IN_CALL_DUMMY() indicates a DUMMY_FRAME. I suspect | |
329 | the real problem here is that get_prev_frame() only sets | |
e9582e71 | 330 | initialized after DEPRECATED_INIT_EXTRA_FRAME_INFO as been called. |
ae45cd16 AC |
331 | Consequently, some targets found that the frame's type was wrong |
332 | and tried to fix it. The correct fix is to modify get_prev_frame() | |
333 | so that it initializes the frame's type before calling any other | |
334 | functions. */ | |
5a203e44 AC |
335 | extern void deprecated_set_frame_type (struct frame_info *, |
336 | enum frame_type type); | |
337 | ||
c97eb5d9 AC |
338 | /* Unwind the stack frame so that the value of REGNUM, in the previous |
339 | (up, older) frame is returned. If VALUEP is NULL, don't | |
340 | fetch/compute the value. Instead just return the location of the | |
341 | value. */ | |
342 | extern void frame_register_unwind (struct frame_info *frame, int regnum, | |
343 | int *optimizedp, enum lval_type *lvalp, | |
344 | CORE_ADDR *addrp, int *realnump, | |
345 | void *valuep); | |
346 | ||
f0e7d0e8 AC |
347 | /* Fetch a register from this, or unwind a register from the next |
348 | frame. Note that the get_frame methods are wrappers to | |
349 | frame->next->unwind. They all [potentially] throw an error if the | |
350 | fetch fails. */ | |
c97eb5d9 | 351 | |
5b181d62 AC |
352 | extern void frame_unwind_register (struct frame_info *frame, |
353 | int regnum, void *buf); | |
f0e7d0e8 AC |
354 | extern void get_frame_register (struct frame_info *frame, |
355 | int regnum, void *buf); | |
356 | ||
357 | extern LONGEST frame_unwind_register_signed (struct frame_info *frame, | |
358 | int regnum); | |
359 | extern LONGEST get_frame_register_signed (struct frame_info *frame, | |
360 | int regnum); | |
361 | extern ULONGEST frame_unwind_register_unsigned (struct frame_info *frame, | |
362 | int regnum); | |
363 | extern ULONGEST get_frame_register_unsigned (struct frame_info *frame, | |
364 | int regnum); | |
365 | ||
5b181d62 | 366 | |
f0e7d0e8 | 367 | /* Use frame_unwind_register_signed. */ |
c97eb5d9 AC |
368 | extern void frame_unwind_signed_register (struct frame_info *frame, |
369 | int regnum, LONGEST *val); | |
370 | ||
f0e7d0e8 | 371 | /* Use frame_unwind_register_signed. */ |
c97eb5d9 AC |
372 | extern void frame_unwind_unsigned_register (struct frame_info *frame, |
373 | int regnum, ULONGEST *val); | |
374 | ||
375 | /* Get the value of the register that belongs to this FRAME. This | |
376 | function is a wrapper to the call sequence ``frame_unwind_register | |
377 | (get_next_frame (FRAME))''. As per frame_register_unwind(), if | |
378 | VALUEP is NULL, the registers value is not fetched/computed. */ | |
379 | ||
380 | extern void frame_register (struct frame_info *frame, int regnum, | |
381 | int *optimizedp, enum lval_type *lvalp, | |
382 | CORE_ADDR *addrp, int *realnump, | |
383 | void *valuep); | |
384 | ||
385 | /* More convenient interface to frame_register(). */ | |
386 | /* NOTE: cagney/2002-09-13: Return void as one day these functions may | |
387 | be changed to return an indication that the read succeeded. */ | |
388 | ||
f0e7d0e8 | 389 | /* Use get_frame_register. */ |
5b181d62 AC |
390 | extern void frame_read_register (struct frame_info *frame, int regnum, |
391 | void *buf); | |
392 | ||
f0e7d0e8 | 393 | /* Use get_frame_register_signed. */ |
c97eb5d9 AC |
394 | extern void frame_read_signed_register (struct frame_info *frame, |
395 | int regnum, LONGEST *val); | |
396 | ||
f0e7d0e8 | 397 | /* Use get_frame_register_unsigned. */ |
c97eb5d9 AC |
398 | extern void frame_read_unsigned_register (struct frame_info *frame, |
399 | int regnum, ULONGEST *val); | |
400 | ||
ff2e87ac AC |
401 | /* The reverse. Store a register value relative to the specified |
402 | frame. Note: this call makes the frame's state undefined. The | |
403 | register and frame caches must be flushed. */ | |
404 | extern void put_frame_register (struct frame_info *frame, int regnum, | |
405 | const void *buf); | |
406 | ||
c97eb5d9 AC |
407 | /* Map between a frame register number and its name. A frame register |
408 | space is a superset of the cooked register space --- it also | |
5f601589 AC |
409 | includes builtin registers. If NAMELEN is negative, use the NAME's |
410 | length when doing the comparison. */ | |
c97eb5d9 | 411 | |
5f601589 | 412 | extern int frame_map_name_to_regnum (const char *name, int namelen); |
c97eb5d9 AC |
413 | extern const char *frame_map_regnum_to_name (int regnum); |
414 | ||
f18c5a73 AC |
415 | /* Unwind the PC. Strictly speaking return the resume address of the |
416 | calling frame. For GDB, `pc' is the resume address and not a | |
417 | specific register. */ | |
418 | ||
419 | extern CORE_ADDR frame_pc_unwind (struct frame_info *frame); | |
420 | ||
dbe9fe58 AC |
421 | /* Discard the specified frame. Restoring the registers to the state |
422 | of the caller. */ | |
423 | extern void frame_pop (struct frame_info *frame); | |
424 | ||
ae1e7417 AC |
425 | /* Return memory from the specified frame. A frame knows its thread / |
426 | LWP and hence can find its way down to a target. The assumption | |
427 | here is that the current and previous frame share a common address | |
428 | space. | |
429 | ||
430 | If the memory read fails, these methods throw an error. | |
431 | ||
432 | NOTE: cagney/2003-06-03: Should there be unwind versions of these | |
433 | methods? That isn't clear. Can code, for instance, assume that | |
434 | this and the previous frame's memory or architecture are identical? | |
435 | If architecture / memory changes are always separated by special | |
436 | adaptor frames this should be ok. */ | |
437 | ||
438 | extern void get_frame_memory (struct frame_info *this_frame, CORE_ADDR addr, | |
439 | void *buf, int len); | |
440 | extern LONGEST get_frame_memory_signed (struct frame_info *this_frame, | |
441 | CORE_ADDR memaddr, int len); | |
442 | extern ULONGEST get_frame_memory_unsigned (struct frame_info *this_frame, | |
443 | CORE_ADDR memaddr, int len); | |
444 | ||
445 | /* Return this frame's architecture. */ | |
446 | ||
447 | extern struct gdbarch *get_frame_arch (struct frame_info *this_frame); | |
448 | ||
449 | ||
c5394b80 JM |
450 | /* Values for the source flag to be used in print_frame_info_base(). */ |
451 | enum print_what | |
452 | { | |
453 | /* Print only the source line, like in stepi. */ | |
454 | SRC_LINE = -1, | |
455 | /* Print only the location, i.e. level, address (sometimes) | |
456 | function, args, file, line, line num. */ | |
457 | LOCATION, | |
458 | /* Print both of the above. */ | |
459 | SRC_AND_LOC, | |
460 | /* Print location only, but always include the address. */ | |
461 | LOC_AND_ADDRESS | |
462 | }; | |
463 | ||
64485362 AC |
464 | /* Allocate additional space for appendices to a struct frame_info. |
465 | NOTE: Much of GDB's code works on the assumption that the allocated | |
466 | saved_regs[] array is the size specified below. If you try to make | |
467 | that array smaller, GDB will happily walk off its end. */ | |
c906108c | 468 | |
64485362 AC |
469 | #ifdef SIZEOF_FRAME_SAVED_REGS |
470 | #error "SIZEOF_FRAME_SAVED_REGS can not be re-defined" | |
c906108c | 471 | #endif |
64485362 AC |
472 | #define SIZEOF_FRAME_SAVED_REGS \ |
473 | (sizeof (CORE_ADDR) * (NUM_REGS+NUM_PSEUDO_REGS)) | |
474 | ||
479ab5a0 AC |
475 | /* Allocate zero initialized memory from the frame cache obstack. |
476 | Appendices to the frame info (such as the unwind cache) should | |
477 | allocate memory using this method. */ | |
478 | ||
479 | extern void *frame_obstack_zalloc (unsigned long size); | |
eb4f72c5 | 480 | #define FRAME_OBSTACK_ZALLOC(TYPE) ((TYPE *) frame_obstack_zalloc (sizeof (TYPE))) |
f75493ed | 481 | #define FRAME_OBSTACK_CALLOC(NUMBER,TYPE) ((TYPE *) frame_obstack_zalloc ((NUMBER) * sizeof (TYPE))) |
c906108c | 482 | |
e6ba3bc9 AC |
483 | /* If legacy_frame_chain_valid() returns zero it means that the given |
484 | frame is the outermost one and has no caller. | |
485 | ||
486 | This method has been superseeded by the per-architecture | |
487 | frame_unwind_pc() (returns 0 to indicate an invalid return address) | |
488 | and per-frame this_id() (returns a NULL frame ID to indicate an | |
489 | invalid frame). */ | |
490 | extern int legacy_frame_chain_valid (CORE_ADDR, struct frame_info *); | |
c906108c | 491 | |
a14ed312 | 492 | extern void generic_save_dummy_frame_tos (CORE_ADDR sp); |
c906108c | 493 | |
ae767bfb JB |
494 | extern struct block *get_frame_block (struct frame_info *, |
495 | CORE_ADDR *addr_in_block); | |
c906108c | 496 | |
805e2818 AC |
497 | /* Return the `struct block' that belongs to the selected thread's |
498 | selected frame. If the inferior has no state, return NULL. | |
499 | ||
500 | NOTE: cagney/2002-11-29: | |
501 | ||
502 | No state? Does the inferior have any execution state (a core file | |
503 | does, an executable does not). At present the code tests | |
504 | `target_has_stack' but I'm left wondering if it should test | |
505 | `target_has_registers' or, even, a merged target_has_state. | |
506 | ||
507 | Should it look at the most recently specified SAL? If the target | |
508 | has no state, should this function try to extract a block from the | |
509 | most recently selected SAL? That way `list foo' would give it some | |
510 | sort of reference point. Then again, perhaphs that would confuse | |
511 | things. | |
512 | ||
513 | Calls to this function can be broken down into two categories: Code | |
514 | that uses the selected block as an additional, but optional, data | |
515 | point; Code that uses the selected block as a prop, when it should | |
516 | have the relevant frame/block/pc explicitly passed in. | |
517 | ||
518 | The latter can be eliminated by correctly parameterizing the code, | |
519 | the former though is more interesting. Per the "address" command, | |
520 | it occures in the CLI code and makes it possible for commands to | |
521 | work, even when the inferior has no state. */ | |
522 | ||
ae767bfb | 523 | extern struct block *get_selected_block (CORE_ADDR *addr_in_block); |
c906108c | 524 | |
a14ed312 | 525 | extern struct symbol *get_frame_function (struct frame_info *); |
c906108c | 526 | |
42f99ac2 JB |
527 | extern CORE_ADDR frame_address_in_block (struct frame_info *); |
528 | ||
a14ed312 | 529 | extern CORE_ADDR get_pc_function_start (CORE_ADDR); |
c906108c | 530 | |
a14ed312 | 531 | extern int frameless_look_for_prologue (struct frame_info *); |
c906108c | 532 | |
a14ed312 | 533 | extern struct frame_info *find_relative_frame (struct frame_info *, int *); |
c906108c | 534 | |
a14ed312 KB |
535 | extern void show_and_print_stack_frame (struct frame_info *fi, int level, |
536 | int source); | |
7a292a7a | 537 | |
a14ed312 | 538 | extern void print_stack_frame (struct frame_info *, int, int); |
c906108c | 539 | |
a14ed312 | 540 | extern void show_stack_frame (struct frame_info *); |
c906108c | 541 | |
a14ed312 | 542 | extern void print_frame_info (struct frame_info *, int, int, int); |
c906108c | 543 | |
a14ed312 | 544 | extern void show_frame_info (struct frame_info *, int, int, int); |
c906108c | 545 | |
a14ed312 | 546 | extern struct frame_info *block_innermost_frame (struct block *); |
c906108c | 547 | |
135c175f AC |
548 | /* NOTE: cagney/2002-09-13: There is no need for this function. |
549 | Instead either of frame_unwind_signed_register() or | |
550 | frame_unwind_unsigned_register() can be used. */ | |
551 | extern CORE_ADDR deprecated_read_register_dummy (CORE_ADDR pc, | |
552 | CORE_ADDR fp, int); | |
a14ed312 KB |
553 | extern void generic_push_dummy_frame (void); |
554 | extern void generic_pop_current_frame (void (*)(struct frame_info *)); | |
555 | extern void generic_pop_dummy_frame (void); | |
c906108c | 556 | |
a14ed312 KB |
557 | extern int generic_pc_in_call_dummy (CORE_ADDR pc, |
558 | CORE_ADDR sp, CORE_ADDR fp); | |
da130f98 AC |
559 | |
560 | /* NOTE: cagney/2002-06-26: Targets should no longer use this | |
561 | function. Instead, the contents of a dummy frames registers can be | |
562 | obtained by applying: frame_register_unwind to the dummy frame; or | |
ac2adee5 | 563 | frame_register_unwind() to the next outer frame. */ |
da130f98 AC |
564 | |
565 | extern char *deprecated_generic_find_dummy_frame (CORE_ADDR pc, CORE_ADDR fp); | |
c906108c | 566 | |
248de703 AC |
567 | |
568 | /* The DEPRECATED_GET_SAVED_REGISTER architecture interface is | |
569 | entirely redundant. New architectures should implement per-frame | |
570 | unwinders (ref "frame-unwind.h"). */ | |
bdcdd535 AC |
571 | extern void deprecated_generic_get_saved_register (char *, int *, CORE_ADDR *, |
572 | struct frame_info *, int, | |
573 | enum lval_type *); | |
c906108c | 574 | |
6096c27a AC |
575 | extern void generic_save_call_dummy_addr (CORE_ADDR lo, CORE_ADDR hi); |
576 | ||
5b181d62 AC |
577 | /* FIXME: cagney/2003-02-02: Should be deprecated or replaced with a |
578 | function called frame_read_register_p(). This slightly weird (and | |
579 | older) variant of frame_read_register() returns zero (indicating | |
580 | the register is unavailable) if either: the register isn't cached; | |
581 | or the register has been optimized out. Problem is, neither check | |
582 | is exactly correct. A register can't be optimized out (it may not | |
583 | have been saved as part of a function call); The fact that a | |
584 | register isn't in the register cache doesn't mean that the register | |
585 | isn't available (it could have been fetched from memory). */ | |
586 | ||
cda5a58a AC |
587 | extern int frame_register_read (struct frame_info *frame, int regnum, |
588 | void *buf); | |
589 | ||
36dc181b EZ |
590 | /* From stack.c. */ |
591 | extern void args_info (char *, int); | |
592 | ||
593 | extern void locals_info (char *, int); | |
594 | ||
595 | extern void (*selected_frame_level_changed_hook) (int); | |
596 | ||
597 | extern void return_command (char *, int); | |
598 | ||
abc0af47 AC |
599 | |
600 | /* NOTE: cagney/2002-11-27: | |
601 | ||
602 | You might think that the below global can simply be replaced by a | |
603 | call to either get_selected_frame() or select_frame(). | |
604 | ||
605 | Unfortunatly, it isn't that easy. | |
606 | ||
607 | The relevant code needs to be audited to determine if it is | |
608 | possible (or pratical) to instead pass the applicable frame in as a | |
609 | parameter. For instance, DEPRECATED_DO_REGISTERS_INFO() relied on | |
6e7f8b9c | 610 | the deprecated_selected_frame global, while its replacement, |
abc0af47 AC |
611 | PRINT_REGISTERS_INFO(), is parameterized with the selected frame. |
612 | The only real exceptions occure at the edge (in the CLI code) where | |
613 | user commands need to pick up the selected frame before proceeding. | |
614 | ||
615 | This is important. GDB is trying to stamp out the hack: | |
616 | ||
6e7f8b9c AC |
617 | saved_frame = deprecated_selected_frame; |
618 | deprecated_selected_frame = ...; | |
abc0af47 | 619 | hack_using_global_selected_frame (); |
6e7f8b9c | 620 | deprecated_selected_frame = saved_frame; |
abc0af47 AC |
621 | |
622 | Take care! */ | |
623 | ||
6e7f8b9c | 624 | extern struct frame_info *deprecated_selected_frame; |
abc0af47 AC |
625 | |
626 | ||
18ea5ba4 | 627 | /* Create a frame using the specified BASE and PC. */ |
abc0af47 | 628 | |
18ea5ba4 | 629 | extern struct frame_info *create_new_frame (CORE_ADDR base, CORE_ADDR pc); |
abc0af47 | 630 | |
0394eb2a | 631 | |
2c517d0e AC |
632 | /* Create/access the frame's `extra info'. The extra info is used by |
633 | older code to store information such as the analyzed prologue. The | |
634 | zalloc() should only be called by the INIT_EXTRA_INFO method. */ | |
0394eb2a | 635 | |
2c517d0e AC |
636 | extern struct frame_extra_info *frame_extra_info_zalloc (struct frame_info *fi, |
637 | long size); | |
0394eb2a AC |
638 | extern struct frame_extra_info *get_frame_extra_info (struct frame_info *fi); |
639 | ||
6baff1d2 AC |
640 | /* Create/access the frame's `saved_regs'. The saved regs are used by |
641 | older code to store the address of each register (except for | |
642 | SP_REGNUM where the value of the register in the previous frame is | |
643 | stored). */ | |
644 | extern CORE_ADDR *frame_saved_regs_zalloc (struct frame_info *); | |
645 | extern CORE_ADDR *get_frame_saved_regs (struct frame_info *); | |
646 | ||
b87efeee AC |
647 | /* FIXME: cagney/2002-12-06: Has the PC in the current frame changed? |
648 | "infrun.c", Thanks to DECR_PC_AFTER_BREAK, can change the PC after | |
ef6e7e13 AC |
649 | the initial frame create. This puts things back in sync. |
650 | ||
651 | This replaced: frame->pc = ....; */ | |
2f107107 AC |
652 | extern void deprecated_update_frame_pc_hack (struct frame_info *frame, |
653 | CORE_ADDR pc); | |
654 | ||
655 | /* FIXME: cagney/2002-12-18: Has the frame's base changed? Or to be | |
656 | more exact, whas that initial guess at the frame's base as returned | |
0ba6dca9 AC |
657 | by deprecated_read_fp() wrong. If it was, fix it. This shouldn't |
658 | be necessary since the code should be getting the frame's base | |
659 | correct from the outset. | |
ef6e7e13 AC |
660 | |
661 | This replaced: frame->frame = ....; */ | |
2f107107 AC |
662 | extern void deprecated_update_frame_base_hack (struct frame_info *frame, |
663 | CORE_ADDR base); | |
b87efeee | 664 | |
c8b8a898 AC |
665 | /* FIXME: cagney/2003-01-04: Explicitly set the frame's saved_regs |
666 | and/or extra_info. Target code is allocating a fake frame and than | |
667 | initializing that to get around the problem of, when creating the | |
668 | inner most frame, there is no where to cache information such as | |
669 | the prologue analysis. This is fixed by the new unwind mechanism - | |
670 | even the inner most frame has somewhere to store things like the | |
671 | prolog analysis (or at least will once the frame overhaul is | |
672 | finished). */ | |
673 | extern void deprecated_set_frame_saved_regs_hack (struct frame_info *frame, | |
674 | CORE_ADDR *saved_regs); | |
675 | extern void deprecated_set_frame_extra_info_hack (struct frame_info *frame, | |
676 | struct frame_extra_info *extra_info); | |
677 | ||
678 | /* FIXME: cagney/2003-01-04: Allocate a frame from the heap (rather | |
679 | than the frame obstack). Targets do this as a way of saving the | |
680 | prologue analysis from the inner most frame before that frame has | |
681 | been created. By always creating a frame, this problem goes away. */ | |
682 | extern struct frame_info *deprecated_frame_xmalloc (void); | |
683 | ||
f6c609c4 AC |
684 | /* FIXME: cagney/2003-01-05: Allocate a frame, along with the |
685 | saved_regs and extra_info. Set up cleanups for all three. Same as | |
686 | for deprecated_frame_xmalloc, targets are calling this when | |
687 | creating a scratch `struct frame_info'. The frame overhaul makes | |
688 | this unnecessary since all frame queries are parameterized with a | |
689 | common cache parameter and a frame. */ | |
690 | extern struct frame_info *deprecated_frame_xmalloc_with_cleanup (long sizeof_saved_regs, | |
691 | long sizeof_extra_info); | |
692 | ||
483d36b2 AC |
693 | /* FIXME: cagney/2003-01-07: These are just nasty. Code shouldn't be |
694 | doing this. I suspect it dates back to the days when every field | |
695 | of an allocated structure was explicitly initialized. */ | |
696 | extern void deprecated_set_frame_next_hack (struct frame_info *fi, | |
697 | struct frame_info *next); | |
698 | extern void deprecated_set_frame_prev_hack (struct frame_info *fi, | |
699 | struct frame_info *prev); | |
700 | ||
2d75187b AC |
701 | /* FIXME: cagney/2003-01-07: Instead of the dwarf2cfi having its own |
702 | dedicated `struct frame_info . context' field, the code should use | |
703 | the per frame `unwind_cache' that is passed to the | |
704 | frame_pc_unwind(), frame_register_unwind() and frame_id_unwind() | |
705 | methods. | |
706 | ||
707 | See "dummy-frame.c" for an example of how a cfi-frame object can be | |
708 | implemented using this. */ | |
709 | extern struct context *deprecated_get_frame_context (struct frame_info *fi); | |
710 | extern void deprecated_set_frame_context (struct frame_info *fi, | |
711 | struct context *context); | |
712 | ||
1594fa56 AC |
713 | /* Return non-zero if the architecture is relying on legacy frame |
714 | code. */ | |
715 | extern int legacy_frame_p (struct gdbarch *gdbarch); | |
716 | ||
c906108c | 717 | #endif /* !defined (FRAME_H) */ |