1 /* Definitions for dealing with stack frames, for GDB, the GNU debugger.
3 Copyright (C) 1986-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
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
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
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.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #if !defined (FRAME_H)
23 /* The following is the intended naming schema for frame functions.
24 It isn't 100% consistent, but it is approaching that. Frame naming
29 get_frame_WHAT...(): Get WHAT from the THIS frame (functionally
30 equivalent to THIS->next->unwind->what)
32 frame_unwind_WHAT...(): Unwind THIS frame's WHAT from the NEXT
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.
40 get_stack_frame_WHAT...(): Get WHAT for THIS frame, but if THIS is
41 inlined, skip to the containing stack frame.
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)
47 safe_....(): Safer version of various functions, doesn't throw an
48 error (leave this for later?). Returns true / non-NULL if the request
49 succeeds, false / NULL otherwise.
53 void /frame/_WHAT(): Read WHAT's value into the buffer parameter.
55 ULONGEST /frame/_WHAT_unsigned(): Return an unsigned value (the
56 alternative is *frame_unsigned_WHAT).
58 LONGEST /frame/_WHAT_signed(): Return WHAT signed value.
62 /frame/_memory* (frame, coreaddr, len [, buf]): Extract/return
65 /frame/_register* (frame, regnum [, buf]): extract/return register.
67 CORE_ADDR /frame/_{pc,sp,...} (frame): Resume address, innner most
73 #include "cli/cli-option.h"
75 struct symtab_and_line
;
82 struct frame_print_options
;
84 /* Status of a given frame's stack. */
86 enum frame_id_stack_status
88 /* Stack address is invalid. E.g., this frame is the outermost
89 (i.e., _start), and the stack hasn't been setup yet. */
90 FID_STACK_INVALID
= 0,
92 /* Stack address is valid, and is found in the stack_addr field. */
96 FID_STACK_SENTINEL
= 2,
98 /* Stack address is unavailable. I.e., there's a valid stack, but
99 we don't know where it is (because memory or registers we'd
100 compute it from were not collected). */
101 FID_STACK_UNAVAILABLE
= -1
104 /* The frame object. */
108 /* The frame object's ID. This provides a per-frame unique identifier
109 that can be used to relocate a `struct frame_info' after a target
110 resume or a frame cache destruct. It of course assumes that the
111 inferior hasn't unwound the stack past that frame. */
115 /* The frame's stack address. This shall be constant through out
116 the lifetime of a frame. Note that this requirement applies to
117 not just the function body, but also the prologue and (in theory
118 at least) the epilogue. Since that value needs to fall either on
119 the boundary, or within the frame's address range, the frame's
120 outer-most address (the inner-most address of the previous frame)
121 is used. Watch out for all the legacy targets that still use the
122 function pointer register or stack pointer register. They are
125 This field is valid only if frame_id.stack_status is
126 FID_STACK_VALID. It will be 0 for other
127 FID_STACK_... statuses. */
128 CORE_ADDR stack_addr
;
130 /* The frame's code address. This shall be constant through out the
131 lifetime of the frame. While the PC (a.k.a. resume address)
132 changes as the function is executed, this code address cannot.
133 Typically, it is set to the address of the entry point of the
134 frame's function (as returned by get_frame_func).
136 For inlined functions (INLINE_DEPTH != 0), this is the address of
137 the first executed instruction in the block corresponding to the
140 This field is valid only if code_addr_p is true. Otherwise, this
141 frame is considered to have a wildcard code address, i.e. one that
142 matches every address value in frame comparisons. */
145 /* The frame's special address. This shall be constant through out the
146 lifetime of the frame. This is used for architectures that may have
147 frames that do not change the stack but are still distinct and have
148 some form of distinct identifier (e.g. the ia64 which uses a 2nd
149 stack for registers). This field is treated as unordered - i.e. will
150 not be used in frame ordering comparisons.
152 This field is valid only if special_addr_p is true. Otherwise, this
153 frame is considered to have a wildcard special address, i.e. one that
154 matches every address value in frame comparisons. */
155 CORE_ADDR special_addr
;
157 /* Flags to indicate the above fields have valid contents. */
158 ENUM_BITFIELD(frame_id_stack_status
) stack_status
: 3;
159 unsigned int code_addr_p
: 1;
160 unsigned int special_addr_p
: 1;
162 /* It is non-zero for a frame made up by GDB without stack data
163 representation in inferior, such as INLINE_FRAME or TAILCALL_FRAME.
164 Caller of inlined function will have it zero, each more inner called frame
165 will have it increasingly one, two etc. Similarly for TAILCALL_FRAME. */
166 int artificial_depth
;
169 /* Save and restore the currently selected frame. */
171 class scoped_restore_selected_frame
174 /* Save the currently selected frame. */
175 scoped_restore_selected_frame ();
177 /* Restore the currently selected frame. */
178 ~scoped_restore_selected_frame ();
180 DISABLE_COPY_AND_ASSIGN (scoped_restore_selected_frame
);
184 /* The ID of the previously selected frame. */
185 struct frame_id m_fid
;
188 /* Methods for constructing and comparing Frame IDs. */
190 /* For convenience. All fields are zero. This means "there is no frame". */
191 extern const struct frame_id null_frame_id
;
193 /* Sentinel frame. */
194 extern const struct frame_id sentinel_frame_id
;
196 /* This means "there is no frame ID, but there is a frame". It should be
197 replaced by best-effort frame IDs for the outermost frame, somehow.
198 The implementation is only special_addr_p set. */
199 extern const struct frame_id outer_frame_id
;
201 /* Flag to control debugging. */
203 extern unsigned int frame_debug
;
205 /* Construct a frame ID. The first parameter is the frame's constant
206 stack address (typically the outer-bound), and the second the
207 frame's constant code address (typically the entry point).
208 The special identifier address is set to indicate a wild card. */
209 extern struct frame_id
frame_id_build (CORE_ADDR stack_addr
,
210 CORE_ADDR code_addr
);
212 /* Construct a special frame ID. The first parameter is the frame's constant
213 stack address (typically the outer-bound), the second is the
214 frame's constant code address (typically the entry point),
215 and the third parameter is the frame's special identifier address. */
216 extern struct frame_id
frame_id_build_special (CORE_ADDR stack_addr
,
218 CORE_ADDR special_addr
);
220 /* Construct a frame ID representing a frame where the stack address
221 exists, but is unavailable. CODE_ADDR is the frame's constant code
222 address (typically the entry point). The special identifier
223 address is set to indicate a wild card. */
224 extern struct frame_id
frame_id_build_unavailable_stack (CORE_ADDR code_addr
);
226 /* Construct a frame ID representing a frame where the stack address
227 exists, but is unavailable. CODE_ADDR is the frame's constant code
228 address (typically the entry point). SPECIAL_ADDR is the special
229 identifier address. */
230 extern struct frame_id
231 frame_id_build_unavailable_stack_special (CORE_ADDR code_addr
,
232 CORE_ADDR special_addr
);
234 /* Construct a wild card frame ID. The parameter is the frame's constant
235 stack address (typically the outer-bound). The code address as well
236 as the special identifier address are set to indicate wild cards. */
237 extern struct frame_id
frame_id_build_wild (CORE_ADDR stack_addr
);
239 /* Returns true when L is a valid frame. */
240 extern bool frame_id_p (frame_id l
);
242 /* Returns true when L is a valid frame representing a frame made up by GDB
243 without stack data representation in inferior, such as INLINE_FRAME or
245 extern bool frame_id_artificial_p (frame_id l
);
247 /* Returns true when L and R identify the same frame. */
248 extern bool frame_id_eq (frame_id l
, frame_id r
);
250 /* Write the internal representation of a frame ID on the specified
252 extern void fprint_frame_id (struct ui_file
*file
, struct frame_id id
);
255 /* Frame types. Some are real, some are signal trampolines, and some
256 are completely artificial (dummy). */
260 /* A true stack frame, created by the target program during normal
263 /* A fake frame, created by GDB when performing an inferior function
266 /* A frame representing an inlined function, associated with an
267 upcoming (prev, outer, older) NORMAL_FRAME. */
269 /* A virtual frame of a tail call - see dwarf2_tailcall_frame_unwind. */
271 /* In a signal handler, various OSs handle this in various ways.
272 The main thing is that the frame may be far from normal. */
274 /* Fake frame representing a cross-architecture call. */
276 /* Sentinel or registers frame. This frame obtains register values
277 direct from the inferior's registers. */
281 /* For every stopped thread, GDB tracks two frames: current and
282 selected. Current frame is the inner most frame of the selected
283 thread. Selected frame is the one being examined by the GDB
284 CLI (selected using `up', `down', ...). The frames are created
285 on-demand (via get_prev_frame()) and then held in a frame cache. */
286 /* FIXME: cagney/2002-11-28: Er, there is a lie here. If you do the
287 sequence: `thread 1; up; thread 2; thread 1' you lose thread 1's
288 selected frame. At present GDB only tracks the selected frame of
289 the current thread. But be warned, that might change. */
290 /* FIXME: cagney/2002-11-14: At any time, only one thread's selected
291 and current frame can be active. Switching threads causes gdb to
292 discard all that cached frame information. Ulgh! Instead, current
293 and selected frame should be bound to a thread. */
295 /* On demand, create the inner most frame using information found in
296 the inferior. If the inner most frame can't be created, throw an
298 extern struct frame_info
*get_current_frame (void);
300 /* Does the current target interface have enough state to be able to
301 query the current inferior for frame info, and is the inferior in a
302 state where that is possible? */
303 extern bool has_stack_frames ();
305 /* Invalidates the frame cache (this function should have been called
306 invalidate_cached_frames).
308 FIXME: cagney/2002-11-28: There should be two methods: one that
309 reverts the thread's selected frame back to current frame (for when
310 the inferior resumes) and one that does not (for when the user
311 modifies the target invalidating the frame cache). */
312 extern void reinit_frame_cache (void);
314 /* On demand, create the selected frame and then return it. If the
315 selected frame can not be created, this function prints then throws
316 an error. When MESSAGE is non-NULL, use it for the error message,
317 otherwise use a generic error message. */
318 /* FIXME: cagney/2002-11-28: At present, when there is no selected
319 frame, this function always returns the current (inner most) frame.
320 It should instead, when a thread has previously had its frame
321 selected (but not resumed) and the frame cache invalidated, find
322 and then return that thread's previously selected frame. */
323 extern struct frame_info
*get_selected_frame (const char *message
);
325 /* If there is a selected frame, return it. Otherwise, return NULL. */
326 extern struct frame_info
*get_selected_frame_if_set (void);
328 /* Select a specific frame. NULL, apparently implies re-select the
330 extern void select_frame (struct frame_info
*);
332 /* Given a FRAME, return the next (more inner, younger) or previous
333 (more outer, older) frame. */
334 extern struct frame_info
*get_prev_frame (struct frame_info
*);
335 extern struct frame_info
*get_next_frame (struct frame_info
*);
337 /* Like get_next_frame(), but allows return of the sentinel frame. NULL
338 is never returned. */
339 extern struct frame_info
*get_next_frame_sentinel_okay (struct frame_info
*);
341 /* Return a "struct frame_info" corresponding to the frame that called
342 THIS_FRAME. Returns NULL if there is no such frame.
344 Unlike get_prev_frame, this function always tries to unwind the
346 extern struct frame_info
*get_prev_frame_always (struct frame_info
*);
348 /* Given a frame's ID, relocate the frame. Returns NULL if the frame
350 extern struct frame_info
*frame_find_by_id (struct frame_id id
);
352 /* Given a frame's ID, find the previous frame's ID. Returns null_frame_id
353 if the frame is not found. */
354 extern struct frame_id
get_prev_frame_id_by_id (struct frame_id id
);
356 /* Base attributes of a frame: */
358 /* The frame's `resume' address. Where the program will resume in
361 This replaced: frame->pc; */
362 extern CORE_ADDR
get_frame_pc (struct frame_info
*);
364 /* Same as get_frame_pc, but return a boolean indication of whether
365 the PC is actually available, instead of throwing an error. */
367 extern bool get_frame_pc_if_available (frame_info
*frame
, CORE_ADDR
*pc
);
369 /* An address (not necessarily aligned to an instruction boundary)
370 that falls within THIS frame's code block.
372 When a function call is the last statement in a block, the return
373 address for the call may land at the start of the next block.
374 Similarly, if a no-return function call is the last statement in
375 the function, the return address may end up pointing beyond the
376 function, and possibly at the start of the next function.
378 These methods make an allowance for this. For call frames, this
379 function returns the frame's PC-1 which "should" be an address in
380 the frame's block. */
382 extern CORE_ADDR
get_frame_address_in_block (struct frame_info
*this_frame
);
384 /* Same as get_frame_address_in_block, but returns a boolean
385 indication of whether the frame address is determinable (when the
386 PC is unavailable, it will not be), instead of possibly throwing an
387 error trying to read an unavailable PC. */
389 extern bool get_frame_address_in_block_if_available (frame_info
*this_frame
,
392 /* The frame's inner-most bound. AKA the stack-pointer. Confusingly
393 known as top-of-stack. */
395 extern CORE_ADDR
get_frame_sp (struct frame_info
*);
397 /* Following on from the `resume' address. Return the entry point
398 address of the function containing that resume address, or zero if
399 that function isn't known. */
400 extern CORE_ADDR
get_frame_func (struct frame_info
*fi
);
402 /* Same as get_frame_func, but returns a boolean indication of whether
403 the frame function is determinable (when the PC is unavailable, it
404 will not be), instead of possibly throwing an error trying to read
405 an unavailable PC. */
407 extern bool get_frame_func_if_available (frame_info
*fi
, CORE_ADDR
*);
409 /* Closely related to the resume address, various symbol table
410 attributes that are determined by the PC. Note that for a normal
411 frame, the PC refers to the resume address after the return, and
412 not the call instruction. In such a case, the address is adjusted
413 so that it (approximately) identifies the call site (and not the
416 NOTE: cagney/2002-11-28: The frame cache could be used to cache the
417 computed value. Working on the assumption that the bottle-neck is
418 in the single step code, and that code causes the frame cache to be
419 constantly flushed, caching things in a frame is probably of little
420 benefit. As they say `show us the numbers'.
422 NOTE: cagney/2002-11-28: Plenty more where this one came from:
423 find_frame_block(), find_frame_partial_function(),
424 find_frame_symtab(), find_frame_function(). Each will need to be
425 carefully considered to determine if the real intent was for it to
426 apply to the PC or the adjusted PC. */
427 extern symtab_and_line
find_frame_sal (frame_info
*frame
);
429 /* Set the current source and line to the location given by frame
430 FRAME, if possible. */
432 void set_current_sal_from_frame (struct frame_info
*);
434 /* Return the frame base (what ever that is) (DEPRECATED).
436 Old code was trying to use this single method for two conflicting
437 purposes. Such code needs to be updated to use either of:
439 get_frame_id: A low level frame unique identifier, that consists of
440 both a stack and a function address, that can be used to uniquely
441 identify a frame. This value is determined by the frame's
442 low-level unwinder, the stack part [typically] being the
443 top-of-stack of the previous frame, and the function part being the
444 function's start address. Since the correct identification of a
445 frameless function requires both a stack and function address,
446 the old get_frame_base method was not sufficient.
448 get_frame_base_address: get_frame_locals_address:
449 get_frame_args_address: A set of high-level debug-info dependant
450 addresses that fall within the frame. These addresses almost
451 certainly will not match the stack address part of a frame ID (as
452 returned by get_frame_base).
454 This replaced: frame->frame; */
456 extern CORE_ADDR
get_frame_base (struct frame_info
*);
458 /* Return the per-frame unique identifer. Can be used to relocate a
459 frame after a frame cache flush (and other similar operations). If
460 FI is NULL, return the null_frame_id.
462 NOTE: kettenis/20040508: These functions return a structure. On
463 platforms where structures are returned in static storage (vax,
464 m68k), this may trigger compiler bugs in code like:
466 if (frame_id_eq (get_frame_id (l), get_frame_id (r)))
468 where the return value from the first get_frame_id (l) gets
469 overwritten by the second get_frame_id (r). Please avoid writing
470 code like this. Use code like:
472 struct frame_id id = get_frame_id (l);
473 if (frame_id_eq (id, get_frame_id (r)))
475 instead, since that avoids the bug. */
476 extern struct frame_id
get_frame_id (struct frame_info
*fi
);
477 extern struct frame_id
get_stack_frame_id (struct frame_info
*fi
);
478 extern struct frame_id
frame_unwind_caller_id (struct frame_info
*next_frame
);
480 /* Assuming that a frame is `normal', return its base-address, or 0 if
481 the information isn't available. NOTE: This address is really only
482 meaningful to the frame's high-level debug info. */
483 extern CORE_ADDR
get_frame_base_address (struct frame_info
*);
485 /* Assuming that a frame is `normal', return the base-address of the
486 local variables, or 0 if the information isn't available. NOTE:
487 This address is really only meaningful to the frame's high-level
488 debug info. Typically, the argument and locals share a single
490 extern CORE_ADDR
get_frame_locals_address (struct frame_info
*);
492 /* Assuming that a frame is `normal', return the base-address of the
493 parameter list, or 0 if that information isn't available. NOTE:
494 This address is really only meaningful to the frame's high-level
495 debug info. Typically, the argument and locals share a single
497 extern CORE_ADDR
get_frame_args_address (struct frame_info
*);
499 /* The frame's level: 0 for innermost, 1 for its caller, ...; or -1
500 for an invalid frame). */
501 extern int frame_relative_level (struct frame_info
*fi
);
503 /* Return the frame's type. */
505 extern enum frame_type
get_frame_type (struct frame_info
*);
507 /* Return the frame's program space. */
508 extern struct program_space
*get_frame_program_space (struct frame_info
*);
510 /* Unwind THIS frame's program space from the NEXT frame. */
511 extern struct program_space
*frame_unwind_program_space (struct frame_info
*);
515 /* Return the frame's address space. */
516 extern const address_space
*get_frame_address_space (struct frame_info
*);
518 /* For frames where we can not unwind further, describe why. */
520 enum unwind_stop_reason
522 #define SET(name, description) name,
523 #define FIRST_ENTRY(name) UNWIND_FIRST = name,
524 #define LAST_ENTRY(name) UNWIND_LAST = name,
525 #define FIRST_ERROR(name) UNWIND_FIRST_ERROR = name,
527 #include "unwind_stop_reasons.def"
534 /* Return the reason why we can't unwind past this frame. */
536 enum unwind_stop_reason
get_frame_unwind_stop_reason (struct frame_info
*);
538 /* Translate a reason code to an informative string. This converts the
539 generic stop reason codes into a generic string describing the code.
540 For a possibly frame specific string explaining the stop reason, use
541 FRAME_STOP_REASON_STRING instead. */
543 const char *unwind_stop_reason_to_string (enum unwind_stop_reason
);
545 /* Return a possibly frame specific string explaining why the unwind
546 stopped here. E.g., if unwinding tripped on a memory error, this
547 will return the error description string, which includes the address
548 that we failed to access. If there's no specific reason stored for
549 a frame then a generic reason string will be returned.
551 Should only be called for frames that don't have a previous frame. */
553 const char *frame_stop_reason_string (struct frame_info
*);
555 /* Unwind the stack frame so that the value of REGNUM, in the previous
556 (up, older) frame is returned. If VALUEP is NULL, don't
557 fetch/compute the value. Instead just return the location of the
559 extern void frame_register_unwind (frame_info
*frame
, int regnum
,
560 int *optimizedp
, int *unavailablep
,
561 enum lval_type
*lvalp
,
562 CORE_ADDR
*addrp
, int *realnump
,
565 /* Fetch a register from this, or unwind a register from the next
566 frame. Note that the get_frame methods are wrappers to
567 frame->next->unwind. They all [potentially] throw an error if the
568 fetch fails. The value methods never return NULL, but usually
569 do return a lazy value. */
571 extern void frame_unwind_register (frame_info
*next_frame
,
572 int regnum
, gdb_byte
*buf
);
573 extern void get_frame_register (struct frame_info
*frame
,
574 int regnum
, gdb_byte
*buf
);
576 struct value
*frame_unwind_register_value (frame_info
*next_frame
,
578 struct value
*get_frame_register_value (struct frame_info
*frame
,
581 extern LONGEST
frame_unwind_register_signed (frame_info
*next_frame
,
583 extern LONGEST
get_frame_register_signed (struct frame_info
*frame
,
585 extern ULONGEST
frame_unwind_register_unsigned (frame_info
*frame
,
587 extern ULONGEST
get_frame_register_unsigned (struct frame_info
*frame
,
590 /* Read a register from this, or unwind a register from the next
591 frame. Note that the read_frame methods are wrappers to
592 get_frame_register_value, that do not throw if the result is
593 optimized out or unavailable. */
595 extern bool read_frame_register_unsigned (frame_info
*frame
,
596 int regnum
, ULONGEST
*val
);
598 /* Get the value of the register that belongs to this FRAME. This
599 function is a wrapper to the call sequence ``frame_register_unwind
600 (get_next_frame (FRAME))''. As per frame_register_unwind(), if
601 VALUEP is NULL, the registers value is not fetched/computed. */
603 extern void frame_register (struct frame_info
*frame
, int regnum
,
604 int *optimizedp
, int *unavailablep
,
605 enum lval_type
*lvalp
,
606 CORE_ADDR
*addrp
, int *realnump
,
609 /* The reverse. Store a register value relative to the specified
610 frame. Note: this call makes the frame's state undefined. The
611 register and frame caches must be flushed. */
612 extern void put_frame_register (struct frame_info
*frame
, int regnum
,
613 const gdb_byte
*buf
);
615 /* Read LEN bytes from one or multiple registers starting with REGNUM
616 in frame FRAME, starting at OFFSET, into BUF. If the register
617 contents are optimized out or unavailable, set *OPTIMIZEDP,
618 *UNAVAILABLEP accordingly. */
619 extern bool get_frame_register_bytes (frame_info
*frame
, int regnum
,
620 CORE_ADDR offset
, int len
,
622 int *optimizedp
, int *unavailablep
);
624 /* Write LEN bytes to one or multiple registers starting with REGNUM
625 in frame FRAME, starting at OFFSET, into BUF. */
626 extern void put_frame_register_bytes (struct frame_info
*frame
, int regnum
,
627 CORE_ADDR offset
, int len
,
628 const gdb_byte
*myaddr
);
630 /* Unwind the PC. Strictly speaking return the resume address of the
631 calling frame. For GDB, `pc' is the resume address and not a
632 specific register. */
634 extern CORE_ADDR
frame_unwind_caller_pc (struct frame_info
*frame
);
636 /* Discard the specified frame. Restoring the registers to the state
638 extern void frame_pop (struct frame_info
*frame
);
640 /* Return memory from the specified frame. A frame knows its thread /
641 LWP and hence can find its way down to a target. The assumption
642 here is that the current and previous frame share a common address
645 If the memory read fails, these methods throw an error.
647 NOTE: cagney/2003-06-03: Should there be unwind versions of these
648 methods? That isn't clear. Can code, for instance, assume that
649 this and the previous frame's memory or architecture are identical?
650 If architecture / memory changes are always separated by special
651 adaptor frames this should be ok. */
653 extern void get_frame_memory (struct frame_info
*this_frame
, CORE_ADDR addr
,
654 gdb_byte
*buf
, int len
);
655 extern LONGEST
get_frame_memory_signed (struct frame_info
*this_frame
,
656 CORE_ADDR memaddr
, int len
);
657 extern ULONGEST
get_frame_memory_unsigned (struct frame_info
*this_frame
,
658 CORE_ADDR memaddr
, int len
);
660 /* Same as above, but return true zero when the entire memory read
661 succeeds, false otherwise. */
662 extern bool safe_frame_unwind_memory (frame_info
*this_frame
, CORE_ADDR addr
,
663 gdb_byte
*buf
, int len
);
665 /* Return this frame's architecture. */
666 extern struct gdbarch
*get_frame_arch (struct frame_info
*this_frame
);
668 /* Return the previous frame's architecture. */
669 extern struct gdbarch
*frame_unwind_arch (frame_info
*next_frame
);
671 /* Return the previous frame's architecture, skipping inline functions. */
672 extern struct gdbarch
*frame_unwind_caller_arch (struct frame_info
*frame
);
675 /* Values for the source flag to be used in print_frame_info ().
676 For all the cases below, the address is never printed if
677 'set print address' is off. When 'set print address' is on,
678 the address is printed if the program counter is not at the
679 beginning of the source line of the frame
680 and PRINT_WHAT is != LOC_AND_ADDRESS. */
683 /* Print only the address, source line, like in stepi. */
685 /* Print only the location, i.e. level, address,
686 function, args (as controlled by 'set print frame-arguments'),
687 file, line, line num. */
689 /* Print both of the above. */
691 /* Print location only, print the address even if the program counter
692 is at the beginning of the source line. */
694 /* Print only level and function,
695 i.e. location only, without address, file, line, line num. */
699 /* Allocate zero initialized memory from the frame cache obstack.
700 Appendices to the frame info (such as the unwind cache) should
701 allocate memory using this method. */
703 extern void *frame_obstack_zalloc (unsigned long size
);
704 #define FRAME_OBSTACK_ZALLOC(TYPE) \
705 ((TYPE *) frame_obstack_zalloc (sizeof (TYPE)))
706 #define FRAME_OBSTACK_CALLOC(NUMBER,TYPE) \
707 ((TYPE *) frame_obstack_zalloc ((NUMBER) * sizeof (TYPE)))
709 class readonly_detached_regcache
;
710 /* Create a regcache, and copy the frame's registers into it. */
711 std::unique_ptr
<readonly_detached_regcache
> frame_save_as_regcache
712 (struct frame_info
*this_frame
);
714 extern const struct block
*get_frame_block (struct frame_info
*,
715 CORE_ADDR
*addr_in_block
);
717 /* Return the `struct block' that belongs to the selected thread's
718 selected frame. If the inferior has no state, return NULL.
720 NOTE: cagney/2002-11-29:
722 No state? Does the inferior have any execution state (a core file
723 does, an executable does not). At present the code tests
724 `target_has_stack' but I'm left wondering if it should test
725 `target_has_registers' or, even, a merged target_has_state.
727 Should it look at the most recently specified SAL? If the target
728 has no state, should this function try to extract a block from the
729 most recently selected SAL? That way `list foo' would give it some
730 sort of reference point. Then again, perhaps that would confuse
733 Calls to this function can be broken down into two categories: Code
734 that uses the selected block as an additional, but optional, data
735 point; Code that uses the selected block as a prop, when it should
736 have the relevant frame/block/pc explicitly passed in.
738 The latter can be eliminated by correctly parameterizing the code,
739 the former though is more interesting. Per the "address" command,
740 it occurs in the CLI code and makes it possible for commands to
741 work, even when the inferior has no state. */
743 extern const struct block
*get_selected_block (CORE_ADDR
*addr_in_block
);
745 extern struct symbol
*get_frame_function (struct frame_info
*);
747 extern CORE_ADDR
get_pc_function_start (CORE_ADDR
);
749 extern struct frame_info
*find_relative_frame (struct frame_info
*, int *);
751 /* Wrapper over print_stack_frame modifying current_uiout with UIOUT for
752 the function call. */
754 extern void print_stack_frame_to_uiout (struct ui_out
*uiout
,
755 struct frame_info
*, int print_level
,
756 enum print_what print_what
,
757 int set_current_sal
);
759 extern void print_stack_frame (struct frame_info
*, int print_level
,
760 enum print_what print_what
,
761 int set_current_sal
);
763 extern void print_frame_info (const frame_print_options
&fp_opts
,
764 struct frame_info
*, int print_level
,
765 enum print_what print_what
, int args
,
766 int set_current_sal
);
768 extern struct frame_info
*block_innermost_frame (const struct block
*);
770 extern bool deprecated_frame_register_read (frame_info
*frame
, int regnum
,
775 /* The possible choices of "set print frame-arguments". */
776 extern const char print_frame_arguments_all
[];
777 extern const char print_frame_arguments_scalars
[];
778 extern const char print_frame_arguments_none
[];
780 /* The possible choices of "set print frame-info". */
781 extern const char print_frame_info_auto
[];
782 extern const char print_frame_info_source_line
[];
783 extern const char print_frame_info_location
[];
784 extern const char print_frame_info_source_and_location
[];
785 extern const char print_frame_info_location_and_address
[];
786 extern const char print_frame_info_short_location
[];
788 /* The possible choices of "set print entry-values". */
789 extern const char print_entry_values_no
[];
790 extern const char print_entry_values_only
[];
791 extern const char print_entry_values_preferred
[];
792 extern const char print_entry_values_if_needed
[];
793 extern const char print_entry_values_both
[];
794 extern const char print_entry_values_compact
[];
795 extern const char print_entry_values_default
[];
797 /* Data for the frame-printing "set print" settings exposed as command
800 struct frame_print_options
802 const char *print_frame_arguments
= print_frame_arguments_scalars
;
803 const char *print_frame_info
= print_frame_info_auto
;
804 const char *print_entry_values
= print_entry_values_default
;
806 /* If true, don't invoke pretty-printers for frame
808 bool print_raw_frame_arguments
;
811 /* The values behind the global "set print ..." settings. */
812 extern frame_print_options user_frame_print_options
;
814 /* Inferior function parameter value read in from a frame. */
818 /* Symbol for this parameter used for example for its name. */
819 struct symbol
*sym
= nullptr;
821 /* Value of the parameter. It is NULL if ERROR is not NULL; if both VAL and
822 ERROR are NULL this parameter's value should not be printed. */
823 struct value
*val
= nullptr;
825 /* String containing the error message, it is more usually NULL indicating no
826 error occured reading this parameter. */
827 gdb::unique_xmalloc_ptr
<char> error
;
829 /* One of the print_entry_values_* entries as appropriate specifically for
830 this frame_arg. It will be different from print_entry_values. With
831 print_entry_values_no this frame_arg should be printed as a normal
832 parameter. print_entry_values_only says it should be printed as entry
833 value parameter. print_entry_values_compact says it should be printed as
834 both as a normal parameter and entry values parameter having the same
835 value - print_entry_values_compact is not permitted fi ui_out_is_mi_like_p
836 (in such case print_entry_values_no and print_entry_values_only is used
837 for each parameter kind specifically. */
838 const char *entry_kind
= nullptr;
841 extern void read_frame_arg (const frame_print_options
&fp_opts
,
842 symbol
*sym
, frame_info
*frame
,
843 struct frame_arg
*argp
,
844 struct frame_arg
*entryargp
);
845 extern void read_frame_local (struct symbol
*sym
, struct frame_info
*frame
,
846 struct frame_arg
*argp
);
848 extern void info_args_command (const char *, int);
850 extern void info_locals_command (const char *, int);
852 extern void return_command (const char *, int);
854 /* Set FRAME's unwinder temporarily, so that we can call a sniffer.
855 If sniffing fails, the caller should be sure to call
856 frame_cleanup_after_sniffer. */
858 extern void frame_prepare_for_sniffer (struct frame_info
*frame
,
859 const struct frame_unwind
*unwind
);
861 /* Clean up after a failed (wrong unwinder) attempt to unwind past
864 extern void frame_cleanup_after_sniffer (struct frame_info
*frame
);
866 /* Notes (cagney/2002-11-27, drow/2003-09-06):
868 You might think that calls to this function can simply be replaced by a
869 call to get_selected_frame().
871 Unfortunately, it isn't that easy.
873 The relevant code needs to be audited to determine if it is
874 possible (or practical) to instead pass the applicable frame in as a
875 parameter. For instance, DEPRECATED_DO_REGISTERS_INFO() relied on
876 the deprecated_selected_frame global, while its replacement,
877 PRINT_REGISTERS_INFO(), is parameterized with the selected frame.
878 The only real exceptions occur at the edge (in the CLI code) where
879 user commands need to pick up the selected frame before proceeding.
881 There are also some functions called with a NULL frame meaning either "the
882 program is not running" or "use the selected frame".
884 This is important. GDB is trying to stamp out the hack:
886 saved_frame = deprecated_safe_get_selected_frame ();
888 hack_using_global_selected_frame ();
889 select_frame (saved_frame);
893 This function calls get_selected_frame if the inferior should have a
894 frame, or returns NULL otherwise. */
896 extern struct frame_info
*deprecated_safe_get_selected_frame (void);
898 /* Create a frame using the specified BASE and PC. */
900 extern struct frame_info
*create_new_frame (CORE_ADDR base
, CORE_ADDR pc
);
902 /* Return true if the frame unwinder for frame FI is UNWINDER; false
905 extern bool frame_unwinder_is (frame_info
*fi
, const frame_unwind
*unwinder
);
907 /* Return the language of FRAME. */
909 extern enum language
get_frame_language (struct frame_info
*frame
);
911 /* Return the first non-tailcall frame above FRAME or FRAME if it is not a
912 tailcall frame. Return NULL if FRAME is the start of a tailcall-only
915 extern struct frame_info
*skip_tailcall_frames (struct frame_info
*frame
);
917 /* Return the first frame above FRAME or FRAME of which the code is
920 extern struct frame_info
*skip_unwritable_frames (struct frame_info
*frame
);
922 /* Data for the "set backtrace" settings. */
924 struct set_backtrace_options
926 /* Flag to indicate whether backtraces should continue past
928 bool backtrace_past_main
= false;
930 /* Flag to indicate whether backtraces should continue past
932 bool backtrace_past_entry
= false;
934 /* Upper bound on the number of backtrace levels. Note this is not
935 exposed as a command option, because "backtrace" and "frame
936 apply" already have other means to set a frame count limit. */
937 unsigned int backtrace_limit
= UINT_MAX
;
940 /* The corresponding option definitions. */
941 extern const gdb::option::option_def set_backtrace_option_defs
[2];
943 /* The values behind the global "set backtrace ..." settings. */
944 extern set_backtrace_options user_set_backtrace_options
;
946 /* Get the number of calls to reinit_frame_cache. */
948 unsigned int get_frame_cache_generation ();
950 /* Mark that the PC value is masked for the previous frame. */
952 extern void set_frame_previous_pc_masked (struct frame_info
*frame
);
954 /* Get whether the PC value is masked for the given frame. */
956 extern bool get_frame_pc_masked (const struct frame_info
*frame
);
959 #endif /* !defined (FRAME_H) */