Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Definitions for dealing with stack frames, for GDB, the GNU debugger. |
7cc19214 | 2 | |
e2882c85 | 3 | Copyright (C) 1986-2018 Free Software Foundation, Inc. |
c906108c | 4 | |
c5aa993b | 5 | This file is part of GDB. |
c906108c | 6 | |
c5aa993b JM |
7 | This program is free software; you can redistribute it and/or modify |
8 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 9 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 10 | (at your option) any later version. |
c906108c | 11 | |
c5aa993b JM |
12 | This program is distributed in the hope that it will be useful, |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
c906108c | 16 | |
c5aa993b | 17 | You should have received a copy of the GNU General Public License |
a9762ec7 | 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
19 | |
20 | #if !defined (FRAME_H) | |
21 | #define FRAME_H 1 | |
22 | ||
f0e7d0e8 AC |
23 | /* The following is the intended naming schema for frame functions. |
24 | It isn't 100% consistent, but it is aproaching that. Frame naming | |
25 | schema: | |
26 | ||
27 | Prefixes: | |
28 | ||
29 | get_frame_WHAT...(): Get WHAT from the THIS frame (functionaly | |
30 | equivalent to THIS->next->unwind->what) | |
31 | ||
32 | frame_unwind_WHAT...(): Unwind THIS frame's WHAT from the NEXT | |
33 | frame. | |
34 | ||
c7ce8faa DJ |
35 | frame_unwind_caller_WHAT...(): Unwind WHAT for NEXT stack frame's |
36 | real caller. Any inlined functions in NEXT's stack frame are | |
37 | skipped. Use these to ignore any potentially inlined functions, | |
38 | e.g. inlined into the first instruction of a library trampoline. | |
39 | ||
edb3359d DJ |
40 | get_stack_frame_WHAT...(): Get WHAT for THIS frame, but if THIS is |
41 | inlined, skip to the containing stack frame. | |
42 | ||
f0e7d0e8 AC |
43 | put_frame_WHAT...(): Put a value into this frame (unsafe, need to |
44 | invalidate the frame / regcache afterwards) (better name more | |
45 | strongly hinting at its unsafeness) | |
46 | ||
47 | safe_....(): Safer version of various functions, doesn't throw an | |
304396fb AC |
48 | error (leave this for later?). Returns non-zero / non-NULL if the |
49 | request succeeds, zero / NULL otherwize. | |
f0e7d0e8 AC |
50 | |
51 | Suffixes: | |
52 | ||
53 | void /frame/_WHAT(): Read WHAT's value into the buffer parameter. | |
54 | ||
55 | ULONGEST /frame/_WHAT_unsigned(): Return an unsigned value (the | |
56 | alternative is *frame_unsigned_WHAT). | |
57 | ||
58 | LONGEST /frame/_WHAT_signed(): Return WHAT signed value. | |
59 | ||
60 | What: | |
61 | ||
62 | /frame/_memory* (frame, coreaddr, len [, buf]): Extract/return | |
63 | *memory. | |
64 | ||
65 | /frame/_register* (frame, regnum [, buf]): extract/return register. | |
66 | ||
67 | CORE_ADDR /frame/_{pc,sp,...} (frame): Resume address, innner most | |
68 | stack *address, ... | |
69 | ||
70 | */ | |
71 | ||
06096720 AB |
72 | #include "language.h" |
73 | ||
1058bca7 | 74 | struct symtab_and_line; |
494cca16 | 75 | struct frame_unwind; |
da62e633 | 76 | struct frame_base; |
fe898f56 | 77 | struct block; |
cd983b5c | 78 | struct gdbarch; |
30e221b4 | 79 | struct ui_file; |
d73f9c4b | 80 | struct ui_out; |
494cca16 | 81 | |
5ce0145d PA |
82 | /* Status of a given frame's stack. */ |
83 | ||
84 | enum frame_id_stack_status | |
85 | { | |
86 | /* Stack address is invalid. E.g., this frame is the outermost | |
87 | (i.e., _start), and the stack hasn't been setup yet. */ | |
88 | FID_STACK_INVALID = 0, | |
89 | ||
90 | /* Stack address is valid, and is found in the stack_addr field. */ | |
91 | FID_STACK_VALID = 1, | |
92 | ||
df433d31 KB |
93 | /* Sentinel frame. */ |
94 | FID_STACK_SENTINEL = 2, | |
95 | ||
5ce0145d PA |
96 | /* Stack address is unavailable. I.e., there's a valid stack, but |
97 | we don't know where it is (because memory or registers we'd | |
98 | compute it from were not collected). */ | |
99 | FID_STACK_UNAVAILABLE = -1 | |
100 | }; | |
101 | ||
c97eb5d9 AC |
102 | /* The frame object. */ |
103 | ||
104 | struct frame_info; | |
105 | ||
106 | /* The frame object's ID. This provides a per-frame unique identifier | |
107 | that can be used to relocate a `struct frame_info' after a target | |
7a424e99 AC |
108 | resume or a frame cache destruct. It of course assumes that the |
109 | inferior hasn't unwound the stack past that frame. */ | |
c97eb5d9 AC |
110 | |
111 | struct frame_id | |
112 | { | |
d0a55772 AC |
113 | /* The frame's stack address. This shall be constant through out |
114 | the lifetime of a frame. Note that this requirement applies to | |
115 | not just the function body, but also the prologue and (in theory | |
116 | at least) the epilogue. Since that value needs to fall either on | |
117 | the boundary, or within the frame's address range, the frame's | |
118 | outer-most address (the inner-most address of the previous frame) | |
119 | is used. Watch out for all the legacy targets that still use the | |
120 | function pointer register or stack pointer register. They are | |
12b0b6de UW |
121 | wrong. |
122 | ||
5ce0145d PA |
123 | This field is valid only if frame_id.stack_status is |
124 | FID_STACK_VALID. It will be 0 for other | |
125 | FID_STACK_... statuses. */ | |
d0a55772 | 126 | CORE_ADDR stack_addr; |
12b0b6de | 127 | |
d0a55772 AC |
128 | /* The frame's code address. This shall be constant through out the |
129 | lifetime of the frame. While the PC (a.k.a. resume address) | |
130 | changes as the function is executed, this code address cannot. | |
131 | Typically, it is set to the address of the entry point of the | |
ef02daa9 | 132 | frame's function (as returned by get_frame_func). |
12b0b6de | 133 | |
edb3359d DJ |
134 | For inlined functions (INLINE_DEPTH != 0), this is the address of |
135 | the first executed instruction in the block corresponding to the | |
136 | inlined function. | |
137 | ||
12b0b6de UW |
138 | This field is valid only if code_addr_p is true. Otherwise, this |
139 | frame is considered to have a wildcard code address, i.e. one that | |
140 | matches every address value in frame comparisons. */ | |
d0a55772 | 141 | CORE_ADDR code_addr; |
12b0b6de | 142 | |
48c66725 JJ |
143 | /* The frame's special address. This shall be constant through out the |
144 | lifetime of the frame. This is used for architectures that may have | |
145 | frames that do not change the stack but are still distinct and have | |
146 | some form of distinct identifier (e.g. the ia64 which uses a 2nd | |
147 | stack for registers). This field is treated as unordered - i.e. will | |
a45ae3ed | 148 | not be used in frame ordering comparisons. |
12b0b6de UW |
149 | |
150 | This field is valid only if special_addr_p is true. Otherwise, this | |
151 | frame is considered to have a wildcard special address, i.e. one that | |
152 | matches every address value in frame comparisons. */ | |
48c66725 | 153 | CORE_ADDR special_addr; |
12b0b6de UW |
154 | |
155 | /* Flags to indicate the above fields have valid contents. */ | |
df433d31 | 156 | ENUM_BITFIELD(frame_id_stack_status) stack_status : 3; |
35809fad UW |
157 | unsigned int code_addr_p : 1; |
158 | unsigned int special_addr_p : 1; | |
edb3359d | 159 | |
193facb3 JK |
160 | /* It is non-zero for a frame made up by GDB without stack data |
161 | representation in inferior, such as INLINE_FRAME or TAILCALL_FRAME. | |
162 | Caller of inlined function will have it zero, each more inner called frame | |
163 | will have it increasingly one, two etc. Similarly for TAILCALL_FRAME. */ | |
164 | int artificial_depth; | |
c97eb5d9 AC |
165 | }; |
166 | ||
a45ae3ed | 167 | /* Methods for constructing and comparing Frame IDs. */ |
7a424e99 | 168 | |
005ca36a | 169 | /* For convenience. All fields are zero. This means "there is no frame". */ |
7a424e99 AC |
170 | extern const struct frame_id null_frame_id; |
171 | ||
df433d31 KB |
172 | /* Sentinel frame. */ |
173 | extern const struct frame_id sentinel_frame_id; | |
174 | ||
005ca36a JB |
175 | /* This means "there is no frame ID, but there is a frame". It should be |
176 | replaced by best-effort frame IDs for the outermost frame, somehow. | |
177 | The implementation is only special_addr_p set. */ | |
178 | extern const struct frame_id outer_frame_id; | |
179 | ||
669fac23 DJ |
180 | /* Flag to control debugging. */ |
181 | ||
ccce17b0 | 182 | extern unsigned int frame_debug; |
669fac23 | 183 | |
d0a55772 AC |
184 | /* Construct a frame ID. The first parameter is the frame's constant |
185 | stack address (typically the outer-bound), and the second the | |
12b0b6de UW |
186 | frame's constant code address (typically the entry point). |
187 | The special identifier address is set to indicate a wild card. */ | |
d0a55772 AC |
188 | extern struct frame_id frame_id_build (CORE_ADDR stack_addr, |
189 | CORE_ADDR code_addr); | |
7a424e99 | 190 | |
48c66725 JJ |
191 | /* Construct a special frame ID. The first parameter is the frame's constant |
192 | stack address (typically the outer-bound), the second is the | |
12b0b6de | 193 | frame's constant code address (typically the entry point), |
0963b4bd | 194 | and the third parameter is the frame's special identifier address. */ |
48c66725 JJ |
195 | extern struct frame_id frame_id_build_special (CORE_ADDR stack_addr, |
196 | CORE_ADDR code_addr, | |
197 | CORE_ADDR special_addr); | |
198 | ||
5ce0145d PA |
199 | /* Construct a frame ID representing a frame where the stack address |
200 | exists, but is unavailable. CODE_ADDR is the frame's constant code | |
201 | address (typically the entry point). The special identifier | |
202 | address is set to indicate a wild card. */ | |
203 | extern struct frame_id frame_id_build_unavailable_stack (CORE_ADDR code_addr); | |
204 | ||
8372a7cb MM |
205 | /* Construct a frame ID representing a frame where the stack address |
206 | exists, but is unavailable. CODE_ADDR is the frame's constant code | |
207 | address (typically the entry point). SPECIAL_ADDR is the special | |
208 | identifier address. */ | |
209 | extern struct frame_id | |
210 | frame_id_build_unavailable_stack_special (CORE_ADDR code_addr, | |
211 | CORE_ADDR special_addr); | |
212 | ||
12b0b6de UW |
213 | /* Construct a wild card frame ID. The parameter is the frame's constant |
214 | stack address (typically the outer-bound). The code address as well | |
215 | as the special identifier address are set to indicate wild cards. */ | |
216 | extern struct frame_id frame_id_build_wild (CORE_ADDR stack_addr); | |
217 | ||
7a424e99 | 218 | /* Returns non-zero when L is a valid frame (a valid frame has a |
005ca36a JB |
219 | non-zero .base). The outermost frame is valid even without an |
220 | ID. */ | |
7a424e99 AC |
221 | extern int frame_id_p (struct frame_id l); |
222 | ||
193facb3 JK |
223 | /* Returns non-zero when L is a valid frame representing a frame made up by GDB |
224 | without stack data representation in inferior, such as INLINE_FRAME or | |
225 | TAILCALL_FRAME. */ | |
226 | extern int frame_id_artificial_p (struct frame_id l); | |
edb3359d | 227 | |
7a424e99 AC |
228 | /* Returns non-zero when L and R identify the same frame, or, if |
229 | either L or R have a zero .func, then the same frame base. */ | |
230 | extern int frame_id_eq (struct frame_id l, struct frame_id r); | |
231 | ||
00905d52 AC |
232 | /* Write the internal representation of a frame ID on the specified |
233 | stream. */ | |
234 | extern void fprint_frame_id (struct ui_file *file, struct frame_id id); | |
235 | ||
7a424e99 | 236 | |
93d42b30 DJ |
237 | /* Frame types. Some are real, some are signal trampolines, and some |
238 | are completely artificial (dummy). */ | |
239 | ||
240 | enum frame_type | |
241 | { | |
242 | /* A true stack frame, created by the target program during normal | |
243 | execution. */ | |
244 | NORMAL_FRAME, | |
245 | /* A fake frame, created by GDB when performing an inferior function | |
246 | call. */ | |
247 | DUMMY_FRAME, | |
edb3359d | 248 | /* A frame representing an inlined function, associated with an |
ccfc3d6e | 249 | upcoming (prev, outer, older) NORMAL_FRAME. */ |
edb3359d | 250 | INLINE_FRAME, |
111c6489 JK |
251 | /* A virtual frame of a tail call - see dwarf2_tailcall_frame_unwind. */ |
252 | TAILCALL_FRAME, | |
93d42b30 DJ |
253 | /* In a signal handler, various OSs handle this in various ways. |
254 | The main thing is that the frame may be far from normal. */ | |
255 | SIGTRAMP_FRAME, | |
36f15f55 UW |
256 | /* Fake frame representing a cross-architecture call. */ |
257 | ARCH_FRAME, | |
93d42b30 DJ |
258 | /* Sentinel or registers frame. This frame obtains register values |
259 | direct from the inferior's registers. */ | |
260 | SENTINEL_FRAME | |
261 | }; | |
262 | ||
c97eb5d9 AC |
263 | /* For every stopped thread, GDB tracks two frames: current and |
264 | selected. Current frame is the inner most frame of the selected | |
b021a221 | 265 | thread. Selected frame is the one being examined by the GDB |
abc0af47 AC |
266 | CLI (selected using `up', `down', ...). The frames are created |
267 | on-demand (via get_prev_frame()) and then held in a frame cache. */ | |
268 | /* FIXME: cagney/2002-11-28: Er, there is a lie here. If you do the | |
4a0e2f88 | 269 | sequence: `thread 1; up; thread 2; thread 1' you lose thread 1's |
abc0af47 AC |
270 | selected frame. At present GDB only tracks the selected frame of |
271 | the current thread. But be warned, that might change. */ | |
c97eb5d9 AC |
272 | /* FIXME: cagney/2002-11-14: At any time, only one thread's selected |
273 | and current frame can be active. Switching threads causes gdb to | |
274 | discard all that cached frame information. Ulgh! Instead, current | |
275 | and selected frame should be bound to a thread. */ | |
276 | ||
abc0af47 AC |
277 | /* On demand, create the inner most frame using information found in |
278 | the inferior. If the inner most frame can't be created, throw an | |
279 | error. */ | |
c97eb5d9 AC |
280 | extern struct frame_info *get_current_frame (void); |
281 | ||
9d49bdc2 PA |
282 | /* Does the current target interface have enough state to be able to |
283 | query the current inferior for frame info, and is the inferior in a | |
284 | state where that is possible? */ | |
285 | extern int has_stack_frames (void); | |
286 | ||
abc0af47 AC |
287 | /* Invalidates the frame cache (this function should have been called |
288 | invalidate_cached_frames). | |
289 | ||
35f196d9 DJ |
290 | FIXME: cagney/2002-11-28: There should be two methods: one that |
291 | reverts the thread's selected frame back to current frame (for when | |
292 | the inferior resumes) and one that does not (for when the user | |
293 | modifies the target invalidating the frame cache). */ | |
c97eb5d9 AC |
294 | extern void reinit_frame_cache (void); |
295 | ||
6e7f8b9c | 296 | /* On demand, create the selected frame and then return it. If the |
b04f3ab4 AC |
297 | selected frame can not be created, this function prints then throws |
298 | an error. When MESSAGE is non-NULL, use it for the error message, | |
299 | otherwize use a generic error message. */ | |
6e7f8b9c AC |
300 | /* FIXME: cagney/2002-11-28: At present, when there is no selected |
301 | frame, this function always returns the current (inner most) frame. | |
302 | It should instead, when a thread has previously had its frame | |
303 | selected (but not resumed) and the frame cache invalidated, find | |
304 | and then return that thread's previously selected frame. */ | |
b04f3ab4 | 305 | extern struct frame_info *get_selected_frame (const char *message); |
6e7f8b9c | 306 | |
eb8c0621 TT |
307 | /* If there is a selected frame, return it. Otherwise, return NULL. */ |
308 | extern struct frame_info *get_selected_frame_if_set (void); | |
309 | ||
abc0af47 AC |
310 | /* Select a specific frame. NULL, apparently implies re-select the |
311 | inner most frame. */ | |
312 | extern void select_frame (struct frame_info *); | |
313 | ||
c97eb5d9 AC |
314 | /* Given a FRAME, return the next (more inner, younger) or previous |
315 | (more outer, older) frame. */ | |
316 | extern struct frame_info *get_prev_frame (struct frame_info *); | |
317 | extern struct frame_info *get_next_frame (struct frame_info *); | |
318 | ||
df433d31 KB |
319 | /* Like get_next_frame(), but allows return of the sentinel frame. NULL |
320 | is never returned. */ | |
321 | extern struct frame_info *get_next_frame_sentinel_okay (struct frame_info *); | |
322 | ||
51d48146 PA |
323 | /* Return a "struct frame_info" corresponding to the frame that called |
324 | THIS_FRAME. Returns NULL if there is no such frame. | |
325 | ||
326 | Unlike get_prev_frame, this function always tries to unwind the | |
327 | frame. */ | |
328 | extern struct frame_info *get_prev_frame_always (struct frame_info *); | |
329 | ||
c97eb5d9 AC |
330 | /* Given a frame's ID, relocate the frame. Returns NULL if the frame |
331 | is not found. */ | |
332 | extern struct frame_info *frame_find_by_id (struct frame_id id); | |
333 | ||
41b56feb KB |
334 | /* Given a frame's ID, find the previous frame's ID. Returns null_frame_id |
335 | if the frame is not found. */ | |
336 | extern struct frame_id get_prev_frame_id_by_id (struct frame_id id); | |
337 | ||
c97eb5d9 AC |
338 | /* Base attributes of a frame: */ |
339 | ||
340 | /* The frame's `resume' address. Where the program will resume in | |
ef6e7e13 AC |
341 | this frame. |
342 | ||
343 | This replaced: frame->pc; */ | |
c97eb5d9 AC |
344 | extern CORE_ADDR get_frame_pc (struct frame_info *); |
345 | ||
e3eebbd7 PA |
346 | /* Same as get_frame_pc, but return a boolean indication of whether |
347 | the PC is actually available, instead of throwing an error. */ | |
348 | ||
349 | extern int get_frame_pc_if_available (struct frame_info *frame, | |
350 | CORE_ADDR *pc); | |
351 | ||
4a0e2f88 | 352 | /* An address (not necessarily aligned to an instruction boundary) |
8edd5d01 AC |
353 | that falls within THIS frame's code block. |
354 | ||
355 | When a function call is the last statement in a block, the return | |
356 | address for the call may land at the start of the next block. | |
357 | Similarly, if a no-return function call is the last statement in | |
358 | the function, the return address may end up pointing beyond the | |
359 | function, and possibly at the start of the next function. | |
360 | ||
361 | These methods make an allowance for this. For call frames, this | |
362 | function returns the frame's PC-1 which "should" be an address in | |
363 | the frame's block. */ | |
364 | ||
365 | extern CORE_ADDR get_frame_address_in_block (struct frame_info *this_frame); | |
93d42b30 | 366 | |
e3eebbd7 PA |
367 | /* Same as get_frame_address_in_block, but returns a boolean |
368 | indication of whether the frame address is determinable (when the | |
369 | PC is unavailable, it will not be), instead of possibly throwing an | |
370 | error trying to read an unavailable PC. */ | |
371 | ||
372 | extern int | |
373 | get_frame_address_in_block_if_available (struct frame_info *this_frame, | |
374 | CORE_ADDR *pc); | |
375 | ||
a9e5fdc2 AC |
376 | /* The frame's inner-most bound. AKA the stack-pointer. Confusingly |
377 | known as top-of-stack. */ | |
378 | ||
379 | extern CORE_ADDR get_frame_sp (struct frame_info *); | |
a9e5fdc2 | 380 | |
be41e9f4 AC |
381 | /* Following on from the `resume' address. Return the entry point |
382 | address of the function containing that resume address, or zero if | |
383 | that function isn't known. */ | |
be41e9f4 AC |
384 | extern CORE_ADDR get_frame_func (struct frame_info *fi); |
385 | ||
e3eebbd7 PA |
386 | /* Same as get_frame_func, but returns a boolean indication of whether |
387 | the frame function is determinable (when the PC is unavailable, it | |
388 | will not be), instead of possibly throwing an error trying to read | |
389 | an unavailable PC. */ | |
390 | ||
391 | extern int get_frame_func_if_available (struct frame_info *fi, CORE_ADDR *); | |
392 | ||
1058bca7 AC |
393 | /* Closely related to the resume address, various symbol table |
394 | attributes that are determined by the PC. Note that for a normal | |
395 | frame, the PC refers to the resume address after the return, and | |
396 | not the call instruction. In such a case, the address is adjusted | |
4a0e2f88 JM |
397 | so that it (approximately) identifies the call site (and not the |
398 | return site). | |
1058bca7 AC |
399 | |
400 | NOTE: cagney/2002-11-28: The frame cache could be used to cache the | |
401 | computed value. Working on the assumption that the bottle-neck is | |
402 | in the single step code, and that code causes the frame cache to be | |
403 | constantly flushed, caching things in a frame is probably of little | |
404 | benefit. As they say `show us the numbers'. | |
405 | ||
406 | NOTE: cagney/2002-11-28: Plenty more where this one came from: | |
407 | find_frame_block(), find_frame_partial_function(), | |
408 | find_frame_symtab(), find_frame_function(). Each will need to be | |
409 | carefully considered to determine if the real intent was for it to | |
410 | apply to the PC or the adjusted PC. */ | |
51abb421 | 411 | extern symtab_and_line find_frame_sal (frame_info *frame); |
1058bca7 | 412 | |
7abfe014 | 413 | /* Set the current source and line to the location given by frame |
5166082f | 414 | FRAME, if possible. */ |
7abfe014 | 415 | |
5166082f | 416 | void set_current_sal_from_frame (struct frame_info *); |
7abfe014 | 417 | |
da62e633 AC |
418 | /* Return the frame base (what ever that is) (DEPRECATED). |
419 | ||
420 | Old code was trying to use this single method for two conflicting | |
421 | purposes. Such code needs to be updated to use either of: | |
422 | ||
423 | get_frame_id: A low level frame unique identifier, that consists of | |
424 | both a stack and a function address, that can be used to uniquely | |
425 | identify a frame. This value is determined by the frame's | |
426 | low-level unwinder, the stack part [typically] being the | |
427 | top-of-stack of the previous frame, and the function part being the | |
428 | function's start address. Since the correct identification of a | |
766062f6 | 429 | frameless function requires both a stack and function address, |
da62e633 AC |
430 | the old get_frame_base method was not sufficient. |
431 | ||
432 | get_frame_base_address: get_frame_locals_address: | |
433 | get_frame_args_address: A set of high-level debug-info dependant | |
434 | addresses that fall within the frame. These addresses almost | |
435 | certainly will not match the stack address part of a frame ID (as | |
ef6e7e13 AC |
436 | returned by get_frame_base). |
437 | ||
438 | This replaced: frame->frame; */ | |
c193f6ac AC |
439 | |
440 | extern CORE_ADDR get_frame_base (struct frame_info *); | |
441 | ||
c97eb5d9 | 442 | /* Return the per-frame unique identifer. Can be used to relocate a |
7a424e99 | 443 | frame after a frame cache flush (and other similar operations). If |
756e95f1 MK |
444 | FI is NULL, return the null_frame_id. |
445 | ||
446 | NOTE: kettenis/20040508: These functions return a structure. On | |
447 | platforms where structures are returned in static storage (vax, | |
448 | m68k), this may trigger compiler bugs in code like: | |
449 | ||
450 | if (frame_id_eq (get_frame_id (l), get_frame_id (r))) | |
451 | ||
452 | where the return value from the first get_frame_id (l) gets | |
453 | overwritten by the second get_frame_id (r). Please avoid writing | |
454 | code like this. Use code like: | |
455 | ||
456 | struct frame_id id = get_frame_id (l); | |
457 | if (frame_id_eq (id, get_frame_id (r))) | |
458 | ||
459 | instead, since that avoids the bug. */ | |
7a424e99 | 460 | extern struct frame_id get_frame_id (struct frame_info *fi); |
edb3359d | 461 | extern struct frame_id get_stack_frame_id (struct frame_info *fi); |
c7ce8faa | 462 | extern struct frame_id frame_unwind_caller_id (struct frame_info *next_frame); |
c97eb5d9 | 463 | |
da62e633 AC |
464 | /* Assuming that a frame is `normal', return its base-address, or 0 if |
465 | the information isn't available. NOTE: This address is really only | |
466 | meaningful to the frame's high-level debug info. */ | |
467 | extern CORE_ADDR get_frame_base_address (struct frame_info *); | |
468 | ||
6bfb3e36 AC |
469 | /* Assuming that a frame is `normal', return the base-address of the |
470 | local variables, or 0 if the information isn't available. NOTE: | |
da62e633 AC |
471 | This address is really only meaningful to the frame's high-level |
472 | debug info. Typically, the argument and locals share a single | |
473 | base-address. */ | |
474 | extern CORE_ADDR get_frame_locals_address (struct frame_info *); | |
475 | ||
6bfb3e36 AC |
476 | /* Assuming that a frame is `normal', return the base-address of the |
477 | parameter list, or 0 if that information isn't available. NOTE: | |
478 | This address is really only meaningful to the frame's high-level | |
479 | debug info. Typically, the argument and locals share a single | |
da62e633 AC |
480 | base-address. */ |
481 | extern CORE_ADDR get_frame_args_address (struct frame_info *); | |
482 | ||
c97eb5d9 AC |
483 | /* The frame's level: 0 for innermost, 1 for its caller, ...; or -1 |
484 | for an invalid frame). */ | |
485 | extern int frame_relative_level (struct frame_info *fi); | |
486 | ||
93d42b30 | 487 | /* Return the frame's type. */ |
5a203e44 | 488 | |
5a203e44 | 489 | extern enum frame_type get_frame_type (struct frame_info *); |
6c95b8df PA |
490 | |
491 | /* Return the frame's program space. */ | |
492 | extern struct program_space *get_frame_program_space (struct frame_info *); | |
493 | ||
494 | /* Unwind THIS frame's program space from the NEXT frame. */ | |
495 | extern struct program_space *frame_unwind_program_space (struct frame_info *); | |
496 | ||
8b86c959 YQ |
497 | class address_space; |
498 | ||
6c95b8df | 499 | /* Return the frame's address space. */ |
8b86c959 | 500 | extern const address_space *get_frame_address_space (struct frame_info *); |
5a203e44 | 501 | |
55feb689 DJ |
502 | /* For frames where we can not unwind further, describe why. */ |
503 | ||
504 | enum unwind_stop_reason | |
505 | { | |
2231f1fb KP |
506 | #define SET(name, description) name, |
507 | #define FIRST_ENTRY(name) UNWIND_FIRST = name, | |
508 | #define LAST_ENTRY(name) UNWIND_LAST = name, | |
509 | #define FIRST_ERROR(name) UNWIND_FIRST_ERROR = name, | |
510 | ||
511 | #include "unwind_stop_reasons.def" | |
512 | #undef SET | |
513 | #undef FIRST_ENTRY | |
514 | #undef LAST_ENTRY | |
515 | #undef FIRST_ERROR | |
55feb689 DJ |
516 | }; |
517 | ||
518 | /* Return the reason why we can't unwind past this frame. */ | |
519 | ||
520 | enum unwind_stop_reason get_frame_unwind_stop_reason (struct frame_info *); | |
521 | ||
53e8a631 AB |
522 | /* Translate a reason code to an informative string. This converts the |
523 | generic stop reason codes into a generic string describing the code. | |
524 | For a possibly frame specific string explaining the stop reason, use | |
525 | FRAME_STOP_REASON_STRING instead. */ | |
55feb689 | 526 | |
70e38b8e | 527 | const char *unwind_stop_reason_to_string (enum unwind_stop_reason); |
55feb689 | 528 | |
53e8a631 AB |
529 | /* Return a possibly frame specific string explaining why the unwind |
530 | stopped here. E.g., if unwinding tripped on a memory error, this | |
531 | will return the error description string, which includes the address | |
532 | that we failed to access. If there's no specific reason stored for | |
533 | a frame then a generic reason string will be returned. | |
534 | ||
535 | Should only be called for frames that don't have a previous frame. */ | |
536 | ||
537 | const char *frame_stop_reason_string (struct frame_info *); | |
538 | ||
c97eb5d9 AC |
539 | /* Unwind the stack frame so that the value of REGNUM, in the previous |
540 | (up, older) frame is returned. If VALUEP is NULL, don't | |
541 | fetch/compute the value. Instead just return the location of the | |
542 | value. */ | |
543 | extern void frame_register_unwind (struct frame_info *frame, int regnum, | |
0fdb4f18 PA |
544 | int *optimizedp, int *unavailablep, |
545 | enum lval_type *lvalp, | |
c97eb5d9 | 546 | CORE_ADDR *addrp, int *realnump, |
10c42a71 | 547 | gdb_byte *valuep); |
c97eb5d9 | 548 | |
f0e7d0e8 AC |
549 | /* Fetch a register from this, or unwind a register from the next |
550 | frame. Note that the get_frame methods are wrappers to | |
551 | frame->next->unwind. They all [potentially] throw an error if the | |
669fac23 DJ |
552 | fetch fails. The value methods never return NULL, but usually |
553 | do return a lazy value. */ | |
c97eb5d9 | 554 | |
5b181d62 | 555 | extern void frame_unwind_register (struct frame_info *frame, |
10c42a71 | 556 | int regnum, gdb_byte *buf); |
f0e7d0e8 | 557 | extern void get_frame_register (struct frame_info *frame, |
10c42a71 | 558 | int regnum, gdb_byte *buf); |
f0e7d0e8 | 559 | |
669fac23 DJ |
560 | struct value *frame_unwind_register_value (struct frame_info *frame, |
561 | int regnum); | |
562 | struct value *get_frame_register_value (struct frame_info *frame, | |
563 | int regnum); | |
564 | ||
f0e7d0e8 AC |
565 | extern LONGEST frame_unwind_register_signed (struct frame_info *frame, |
566 | int regnum); | |
567 | extern LONGEST get_frame_register_signed (struct frame_info *frame, | |
568 | int regnum); | |
569 | extern ULONGEST frame_unwind_register_unsigned (struct frame_info *frame, | |
570 | int regnum); | |
571 | extern ULONGEST get_frame_register_unsigned (struct frame_info *frame, | |
572 | int regnum); | |
573 | ||
263689d8 | 574 | /* Read a register from this, or unwind a register from the next |
ad5f7d6e PA |
575 | frame. Note that the read_frame methods are wrappers to |
576 | get_frame_register_value, that do not throw if the result is | |
577 | optimized out or unavailable. */ | |
578 | ||
579 | extern int read_frame_register_unsigned (struct frame_info *frame, | |
580 | int regnum, ULONGEST *val); | |
5b181d62 | 581 | |
c97eb5d9 | 582 | /* Get the value of the register that belongs to this FRAME. This |
7c679d16 | 583 | function is a wrapper to the call sequence ``frame_register_unwind |
c97eb5d9 AC |
584 | (get_next_frame (FRAME))''. As per frame_register_unwind(), if |
585 | VALUEP is NULL, the registers value is not fetched/computed. */ | |
586 | ||
587 | extern void frame_register (struct frame_info *frame, int regnum, | |
0fdb4f18 PA |
588 | int *optimizedp, int *unavailablep, |
589 | enum lval_type *lvalp, | |
c97eb5d9 | 590 | CORE_ADDR *addrp, int *realnump, |
10c42a71 | 591 | gdb_byte *valuep); |
c97eb5d9 | 592 | |
ff2e87ac AC |
593 | /* The reverse. Store a register value relative to the specified |
594 | frame. Note: this call makes the frame's state undefined. The | |
595 | register and frame caches must be flushed. */ | |
596 | extern void put_frame_register (struct frame_info *frame, int regnum, | |
10c42a71 | 597 | const gdb_byte *buf); |
ff2e87ac | 598 | |
00fa51f6 | 599 | /* Read LEN bytes from one or multiple registers starting with REGNUM |
8dccd430 PA |
600 | in frame FRAME, starting at OFFSET, into BUF. If the register |
601 | contents are optimized out or unavailable, set *OPTIMIZEDP, | |
602 | *UNAVAILABLEP accordingly. */ | |
00fa51f6 UW |
603 | extern int get_frame_register_bytes (struct frame_info *frame, int regnum, |
604 | CORE_ADDR offset, int len, | |
8dccd430 PA |
605 | gdb_byte *myaddr, |
606 | int *optimizedp, int *unavailablep); | |
00fa51f6 UW |
607 | |
608 | /* Write LEN bytes to one or multiple registers starting with REGNUM | |
609 | in frame FRAME, starting at OFFSET, into BUF. */ | |
610 | extern void put_frame_register_bytes (struct frame_info *frame, int regnum, | |
611 | CORE_ADDR offset, int len, | |
612 | const gdb_byte *myaddr); | |
613 | ||
f18c5a73 AC |
614 | /* Unwind the PC. Strictly speaking return the resume address of the |
615 | calling frame. For GDB, `pc' is the resume address and not a | |
616 | specific register. */ | |
617 | ||
c7ce8faa | 618 | extern CORE_ADDR frame_unwind_caller_pc (struct frame_info *frame); |
f18c5a73 | 619 | |
dbe9fe58 AC |
620 | /* Discard the specified frame. Restoring the registers to the state |
621 | of the caller. */ | |
622 | extern void frame_pop (struct frame_info *frame); | |
623 | ||
ae1e7417 AC |
624 | /* Return memory from the specified frame. A frame knows its thread / |
625 | LWP and hence can find its way down to a target. The assumption | |
626 | here is that the current and previous frame share a common address | |
627 | space. | |
628 | ||
629 | If the memory read fails, these methods throw an error. | |
630 | ||
631 | NOTE: cagney/2003-06-03: Should there be unwind versions of these | |
632 | methods? That isn't clear. Can code, for instance, assume that | |
633 | this and the previous frame's memory or architecture are identical? | |
634 | If architecture / memory changes are always separated by special | |
635 | adaptor frames this should be ok. */ | |
636 | ||
637 | extern void get_frame_memory (struct frame_info *this_frame, CORE_ADDR addr, | |
10c42a71 | 638 | gdb_byte *buf, int len); |
ae1e7417 AC |
639 | extern LONGEST get_frame_memory_signed (struct frame_info *this_frame, |
640 | CORE_ADDR memaddr, int len); | |
641 | extern ULONGEST get_frame_memory_unsigned (struct frame_info *this_frame, | |
642 | CORE_ADDR memaddr, int len); | |
643 | ||
304396fb AC |
644 | /* Same as above, but return non-zero when the entire memory read |
645 | succeeds, zero otherwize. */ | |
646 | extern int safe_frame_unwind_memory (struct frame_info *this_frame, | |
10c42a71 | 647 | CORE_ADDR addr, gdb_byte *buf, int len); |
304396fb | 648 | |
ae1e7417 | 649 | /* Return this frame's architecture. */ |
ae1e7417 AC |
650 | extern struct gdbarch *get_frame_arch (struct frame_info *this_frame); |
651 | ||
36f15f55 UW |
652 | /* Return the previous frame's architecture. */ |
653 | extern struct gdbarch *frame_unwind_arch (struct frame_info *frame); | |
654 | ||
655 | /* Return the previous frame's architecture, skipping inline functions. */ | |
656 | extern struct gdbarch *frame_unwind_caller_arch (struct frame_info *frame); | |
657 | ||
ae1e7417 | 658 | |
4a0e2f88 | 659 | /* Values for the source flag to be used in print_frame_info_base(). */ |
c5394b80 JM |
660 | enum print_what |
661 | { | |
0963b4bd | 662 | /* Print only the source line, like in stepi. */ |
c5394b80 JM |
663 | SRC_LINE = -1, |
664 | /* Print only the location, i.e. level, address (sometimes) | |
0963b4bd | 665 | function, args, file, line, line num. */ |
c5394b80 | 666 | LOCATION, |
0963b4bd | 667 | /* Print both of the above. */ |
c5394b80 | 668 | SRC_AND_LOC, |
0963b4bd | 669 | /* Print location only, but always include the address. */ |
c5394b80 JM |
670 | LOC_AND_ADDRESS |
671 | }; | |
672 | ||
479ab5a0 AC |
673 | /* Allocate zero initialized memory from the frame cache obstack. |
674 | Appendices to the frame info (such as the unwind cache) should | |
675 | allocate memory using this method. */ | |
676 | ||
677 | extern void *frame_obstack_zalloc (unsigned long size); | |
3e43a32a MS |
678 | #define FRAME_OBSTACK_ZALLOC(TYPE) \ |
679 | ((TYPE *) frame_obstack_zalloc (sizeof (TYPE))) | |
680 | #define FRAME_OBSTACK_CALLOC(NUMBER,TYPE) \ | |
681 | ((TYPE *) frame_obstack_zalloc ((NUMBER) * sizeof (TYPE))) | |
c906108c | 682 | |
a81dcb05 | 683 | /* Create a regcache, and copy the frame's registers into it. */ |
9ac86b52 TT |
684 | std::unique_ptr<struct regcache> frame_save_as_regcache |
685 | (struct frame_info *this_frame); | |
a81dcb05 | 686 | |
3977b71f TT |
687 | extern const struct block *get_frame_block (struct frame_info *, |
688 | CORE_ADDR *addr_in_block); | |
c906108c | 689 | |
805e2818 AC |
690 | /* Return the `struct block' that belongs to the selected thread's |
691 | selected frame. If the inferior has no state, return NULL. | |
692 | ||
693 | NOTE: cagney/2002-11-29: | |
694 | ||
695 | No state? Does the inferior have any execution state (a core file | |
696 | does, an executable does not). At present the code tests | |
697 | `target_has_stack' but I'm left wondering if it should test | |
698 | `target_has_registers' or, even, a merged target_has_state. | |
699 | ||
700 | Should it look at the most recently specified SAL? If the target | |
701 | has no state, should this function try to extract a block from the | |
702 | most recently selected SAL? That way `list foo' would give it some | |
4a0e2f88 | 703 | sort of reference point. Then again, perhaps that would confuse |
805e2818 AC |
704 | things. |
705 | ||
706 | Calls to this function can be broken down into two categories: Code | |
707 | that uses the selected block as an additional, but optional, data | |
708 | point; Code that uses the selected block as a prop, when it should | |
709 | have the relevant frame/block/pc explicitly passed in. | |
710 | ||
711 | The latter can be eliminated by correctly parameterizing the code, | |
712 | the former though is more interesting. Per the "address" command, | |
4a0e2f88 | 713 | it occurs in the CLI code and makes it possible for commands to |
805e2818 AC |
714 | work, even when the inferior has no state. */ |
715 | ||
3977b71f | 716 | extern const struct block *get_selected_block (CORE_ADDR *addr_in_block); |
c906108c | 717 | |
a14ed312 | 718 | extern struct symbol *get_frame_function (struct frame_info *); |
c906108c | 719 | |
a14ed312 | 720 | extern CORE_ADDR get_pc_function_start (CORE_ADDR); |
c906108c | 721 | |
a14ed312 | 722 | extern struct frame_info *find_relative_frame (struct frame_info *, int *); |
c906108c | 723 | |
4034d0ff AT |
724 | /* Wrapper over print_stack_frame modifying current_uiout with UIOUT for |
725 | the function call. */ | |
726 | ||
727 | extern void print_stack_frame_to_uiout (struct ui_out *uiout, | |
728 | struct frame_info *, int print_level, | |
729 | enum print_what print_what, | |
730 | int set_current_sal); | |
731 | ||
0faf0076 | 732 | extern void print_stack_frame (struct frame_info *, int print_level, |
08d72866 PA |
733 | enum print_what print_what, |
734 | int set_current_sal); | |
c906108c | 735 | |
0faf0076 | 736 | extern void print_frame_info (struct frame_info *, int print_level, |
08d72866 PA |
737 | enum print_what print_what, int args, |
738 | int set_current_sal); | |
c906108c | 739 | |
9df2fbc4 | 740 | extern struct frame_info *block_innermost_frame (const struct block *); |
c906108c | 741 | |
ca9d61b9 | 742 | extern int deprecated_frame_register_read (struct frame_info *frame, int regnum, |
10c42a71 | 743 | gdb_byte *buf); |
cda5a58a | 744 | |
36dc181b | 745 | /* From stack.c. */ |
93d86cef | 746 | |
e18b2753 JK |
747 | extern const char print_entry_values_no[]; |
748 | extern const char print_entry_values_only[]; | |
749 | extern const char print_entry_values_preferred[]; | |
750 | extern const char print_entry_values_if_needed[]; | |
751 | extern const char print_entry_values_both[]; | |
752 | extern const char print_entry_values_compact[]; | |
753 | extern const char print_entry_values_default[]; | |
754 | extern const char *print_entry_values; | |
755 | ||
93d86cef JK |
756 | /* Inferior function parameter value read in from a frame. */ |
757 | ||
758 | struct frame_arg | |
759 | { | |
760 | /* Symbol for this parameter used for example for its name. */ | |
761 | struct symbol *sym; | |
762 | ||
763 | /* Value of the parameter. It is NULL if ERROR is not NULL; if both VAL and | |
764 | ERROR are NULL this parameter's value should not be printed. */ | |
765 | struct value *val; | |
766 | ||
767 | /* String containing the error message, it is more usually NULL indicating no | |
768 | error occured reading this parameter. */ | |
769 | char *error; | |
e18b2753 JK |
770 | |
771 | /* One of the print_entry_values_* entries as appropriate specifically for | |
772 | this frame_arg. It will be different from print_entry_values. With | |
773 | print_entry_values_no this frame_arg should be printed as a normal | |
774 | parameter. print_entry_values_only says it should be printed as entry | |
775 | value parameter. print_entry_values_compact says it should be printed as | |
776 | both as a normal parameter and entry values parameter having the same | |
777 | value - print_entry_values_compact is not permitted fi ui_out_is_mi_like_p | |
778 | (in such case print_entry_values_no and print_entry_values_only is used | |
779 | for each parameter kind specifically. */ | |
780 | const char *entry_kind; | |
93d86cef JK |
781 | }; |
782 | ||
783 | extern void read_frame_arg (struct symbol *sym, struct frame_info *frame, | |
e18b2753 JK |
784 | struct frame_arg *argp, |
785 | struct frame_arg *entryargp); | |
82a0a75f YQ |
786 | extern void read_frame_local (struct symbol *sym, struct frame_info *frame, |
787 | struct frame_arg *argp); | |
93d86cef | 788 | |
1d12d88f | 789 | extern void info_args_command (const char *, int); |
36dc181b | 790 | |
1d12d88f | 791 | extern void info_locals_command (const char *, int); |
36dc181b | 792 | |
0b39b52e | 793 | extern void return_command (const char *, int); |
36dc181b | 794 | |
669fac23 | 795 | /* Set FRAME's unwinder temporarily, so that we can call a sniffer. |
30a9c02f TT |
796 | If sniffing fails, the caller should be sure to call |
797 | frame_cleanup_after_sniffer. */ | |
669fac23 | 798 | |
30a9c02f TT |
799 | extern void frame_prepare_for_sniffer (struct frame_info *frame, |
800 | const struct frame_unwind *unwind); | |
801 | ||
802 | /* Clean up after a failed (wrong unwinder) attempt to unwind past | |
803 | FRAME. */ | |
804 | ||
805 | extern void frame_cleanup_after_sniffer (struct frame_info *frame); | |
abc0af47 | 806 | |
206415a3 | 807 | /* Notes (cagney/2002-11-27, drow/2003-09-06): |
abc0af47 | 808 | |
206415a3 DJ |
809 | You might think that calls to this function can simply be replaced by a |
810 | call to get_selected_frame(). | |
abc0af47 | 811 | |
ce2826aa | 812 | Unfortunately, it isn't that easy. |
abc0af47 AC |
813 | |
814 | The relevant code needs to be audited to determine if it is | |
4a0e2f88 | 815 | possible (or practical) to instead pass the applicable frame in as a |
abc0af47 | 816 | parameter. For instance, DEPRECATED_DO_REGISTERS_INFO() relied on |
6e7f8b9c | 817 | the deprecated_selected_frame global, while its replacement, |
abc0af47 | 818 | PRINT_REGISTERS_INFO(), is parameterized with the selected frame. |
4a0e2f88 | 819 | The only real exceptions occur at the edge (in the CLI code) where |
abc0af47 AC |
820 | user commands need to pick up the selected frame before proceeding. |
821 | ||
206415a3 DJ |
822 | There are also some functions called with a NULL frame meaning either "the |
823 | program is not running" or "use the selected frame". | |
824 | ||
abc0af47 AC |
825 | This is important. GDB is trying to stamp out the hack: |
826 | ||
206415a3 DJ |
827 | saved_frame = deprecated_safe_get_selected_frame (); |
828 | select_frame (...); | |
abc0af47 | 829 | hack_using_global_selected_frame (); |
206415a3 | 830 | select_frame (saved_frame); |
7dd88986 | 831 | |
206415a3 | 832 | Take care! |
7dd88986 DJ |
833 | |
834 | This function calls get_selected_frame if the inferior should have a | |
835 | frame, or returns NULL otherwise. */ | |
836 | ||
837 | extern struct frame_info *deprecated_safe_get_selected_frame (void); | |
abc0af47 | 838 | |
18ea5ba4 | 839 | /* Create a frame using the specified BASE and PC. */ |
abc0af47 | 840 | |
18ea5ba4 | 841 | extern struct frame_info *create_new_frame (CORE_ADDR base, CORE_ADDR pc); |
abc0af47 | 842 | |
e7802207 TT |
843 | /* Return true if the frame unwinder for frame FI is UNWINDER; false |
844 | otherwise. */ | |
845 | ||
846 | extern int frame_unwinder_is (struct frame_info *fi, | |
847 | const struct frame_unwind *unwinder); | |
848 | ||
06096720 AB |
849 | /* Return the language of FRAME. */ |
850 | ||
851 | extern enum language get_frame_language (struct frame_info *frame); | |
852 | ||
2f3ef606 | 853 | /* Return the first non-tailcall frame above FRAME or FRAME if it is not a |
33b4777c MM |
854 | tailcall frame. Return NULL if FRAME is the start of a tailcall-only |
855 | chain. */ | |
2f3ef606 MM |
856 | |
857 | extern struct frame_info *skip_tailcall_frames (struct frame_info *frame); | |
06096720 | 858 | |
7eb89530 YQ |
859 | /* Return the first frame above FRAME or FRAME of which the code is |
860 | writable. */ | |
861 | ||
862 | extern struct frame_info *skip_unwritable_frames (struct frame_info *frame); | |
863 | ||
c906108c | 864 | #endif /* !defined (FRAME_H) */ |