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