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