1 /* Definitions for dealing with stack frames, for GDB, the GNU debugger.
3 Copyright (C) 1986-2020 Free Software Foundation, Inc.
4 Copyright (C) 2019-2020 Advanced Micro Devices, Inc. All rights reserved.
6 This file is part of GDB.
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 3 of the License, or
11 (at your option) any later version.
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.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #if !defined (FRAME_H)
24 /* The following is the intended naming schema for frame functions.
25 It isn't 100% consistent, but it is approaching that. Frame naming
30 get_frame_WHAT...(): Get WHAT from the THIS frame (functionally
31 equivalent to THIS->next->unwind->what)
33 frame_unwind_WHAT...(): Unwind THIS frame's WHAT from the NEXT
36 frame_unwind_caller_WHAT...(): Unwind WHAT for NEXT stack frame's
37 real caller. Any inlined functions in NEXT's stack frame are
38 skipped. Use these to ignore any potentially inlined functions,
39 e.g. inlined into the first instruction of a library trampoline.
41 get_stack_frame_WHAT...(): Get WHAT for THIS frame, but if THIS is
42 inlined, skip to the containing stack frame.
44 put_frame_WHAT...(): Put a value into this frame (unsafe, need to
45 invalidate the frame / regcache afterwards) (better name more
46 strongly hinting at its unsafeness)
48 safe_....(): Safer version of various functions, doesn't throw an
49 error (leave this for later?). Returns non-zero / non-NULL if the
50 request succeeds, zero / NULL otherwize.
54 void /frame/_WHAT(): Read WHAT's value into the buffer parameter.
56 ULONGEST /frame/_WHAT_unsigned(): Return an unsigned value (the
57 alternative is *frame_unsigned_WHAT).
59 LONGEST /frame/_WHAT_signed(): Return WHAT signed value.
63 /frame/_memory* (frame, coreaddr, len [, buf]): Extract/return
66 /frame/_register* (frame, regnum [, buf]): extract/return register.
68 CORE_ADDR /frame/_{pc,sp,...} (frame): Resume address, innner most
74 #include "cli/cli-option.h"
76 struct symtab_and_line
;
83 struct frame_print_options
;
85 /* Status of a given frame's stack. */
87 enum frame_id_stack_status
89 /* Stack address is invalid. E.g., this frame is the outermost
90 (i.e., _start), and the stack hasn't been setup yet. */
91 FID_STACK_INVALID
= 0,
93 /* Stack address is valid, and is found in the stack_addr field. */
97 FID_STACK_SENTINEL
= 2,
99 /* Stack address is unavailable. I.e., there's a valid stack, but
100 we don't know where it is (because memory or registers we'd
101 compute it from were not collected). */
102 FID_STACK_UNAVAILABLE
= -1
105 /* The frame object. */
109 /* The frame object's ID. This provides a per-frame unique identifier
110 that can be used to relocate a `struct frame_info' after a target
111 resume or a frame cache destruct. It of course assumes that the
112 inferior hasn't unwound the stack past that frame. */
116 /* The frame's stack address. This shall be constant through out
117 the lifetime of a frame. Note that this requirement applies to
118 not just the function body, but also the prologue and (in theory
119 at least) the epilogue. Since that value needs to fall either on
120 the boundary, or within the frame's address range, the frame's
121 outer-most address (the inner-most address of the previous frame)
122 is used. Watch out for all the legacy targets that still use the
123 function pointer register or stack pointer register. They are
126 This field is valid only if frame_id.stack_status is
127 FID_STACK_VALID. It will be 0 for other
128 FID_STACK_... statuses. */
129 CORE_ADDR stack_addr
;
131 /* The frame's code address. This shall be constant through out the
132 lifetime of the frame. While the PC (a.k.a. resume address)
133 changes as the function is executed, this code address cannot.
134 Typically, it is set to the address of the entry point of the
135 frame's function (as returned by get_frame_func).
137 For inlined functions (INLINE_DEPTH != 0), this is the address of
138 the first executed instruction in the block corresponding to the
141 This field is valid only if code_addr_p is true. Otherwise, this
142 frame is considered to have a wildcard code address, i.e. one that
143 matches every address value in frame comparisons. */
146 /* The frame's special address. This shall be constant through out the
147 lifetime of the frame. This is used for architectures that may have
148 frames that do not change the stack but are still distinct and have
149 some form of distinct identifier (e.g. the ia64 which uses a 2nd
150 stack for registers). This field is treated as unordered - i.e. will
151 not be used in frame ordering comparisons.
153 This field is valid only if special_addr_p is true. Otherwise, this
154 frame is considered to have a wildcard special address, i.e. one that
155 matches every address value in frame comparisons. */
156 CORE_ADDR special_addr
;
158 /* Flags to indicate the above fields have valid contents. */
159 ENUM_BITFIELD(frame_id_stack_status
) stack_status
: 3;
160 unsigned int code_addr_p
: 1;
161 unsigned int special_addr_p
: 1;
163 /* It is non-zero for a frame made up by GDB without stack data
164 representation in inferior, such as INLINE_FRAME or TAILCALL_FRAME.
165 Caller of inlined function will have it zero, each more inner called frame
166 will have it increasingly one, two etc. Similarly for TAILCALL_FRAME. */
167 int artificial_depth
;
170 /* Save and restore the currently selected frame. */
172 class scoped_restore_selected_frame
175 /* Save the currently selected frame. */
176 scoped_restore_selected_frame ();
178 /* Restore the currently selected frame. */
179 ~scoped_restore_selected_frame ();
181 DISABLE_COPY_AND_ASSIGN (scoped_restore_selected_frame
);
185 /* The ID of the previously selected frame. */
186 struct frame_id m_fid
;
189 /* Methods for constructing and comparing Frame IDs. */
191 /* For convenience. All fields are zero. This means "there is no frame". */
192 extern const struct frame_id null_frame_id
;
194 /* Sentinel frame. */
195 extern const struct frame_id sentinel_frame_id
;
197 /* This means "there is no frame ID, but there is a frame". It should be
198 replaced by best-effort frame IDs for the outermost frame, somehow.
199 The implementation is only special_addr_p, and possibly
200 artificial_depth, set. */
201 extern const struct frame_id outer_frame_id
;
203 /* Flag to control debugging. */
205 extern unsigned int frame_debug
;
207 /* Construct a frame ID. The first parameter is the frame's constant
208 stack address (typically the outer-bound), and the second the
209 frame's constant code address (typically the entry point).
210 The special identifier address is set to indicate a wild card. */
211 extern struct frame_id
frame_id_build (CORE_ADDR stack_addr
,
212 CORE_ADDR code_addr
);
214 /* Construct a special frame ID. The first parameter is the frame's constant
215 stack address (typically the outer-bound), the second is the
216 frame's constant code address (typically the entry point),
217 and the third parameter is the frame's special identifier address. */
218 extern struct frame_id
frame_id_build_special (CORE_ADDR stack_addr
,
220 CORE_ADDR special_addr
);
222 /* Construct a frame ID representing a frame where the stack address
223 exists, but is unavailable. CODE_ADDR is the frame's constant code
224 address (typically the entry point). The special identifier
225 address is set to indicate a wild card. */
226 extern struct frame_id
frame_id_build_unavailable_stack (CORE_ADDR code_addr
);
228 /* Construct a frame ID representing a frame where the stack address
229 exists, but is unavailable. CODE_ADDR is the frame's constant code
230 address (typically the entry point). SPECIAL_ADDR is the special
231 identifier address. */
232 extern struct frame_id
233 frame_id_build_unavailable_stack_special (CORE_ADDR code_addr
,
234 CORE_ADDR special_addr
);
236 /* Construct a wild card frame ID. The parameter is the frame's constant
237 stack address (typically the outer-bound). The code address as well
238 as the special identifier address are set to indicate wild cards. */
239 extern struct frame_id
frame_id_build_wild (CORE_ADDR stack_addr
);
241 /* Returns non-zero when L is a valid frame (a valid frame has a
242 non-zero .base). The outermost frame and any frames inlined into it
243 are valid even without an ID. */
244 extern int frame_id_p (struct frame_id l
);
246 /* Returns non-zero when L is a valid frame representing a frame made up by GDB
247 without stack data representation in inferior, such as INLINE_FRAME or
249 extern int frame_id_artificial_p (struct frame_id l
);
251 /* Returns non-zero when L and R identify the same frame, or, if
252 either L or R have a zero .func, then the same frame base. */
253 extern int frame_id_eq (struct frame_id l
, struct frame_id r
);
255 /* Write the internal representation of a frame ID on the specified
257 extern void fprint_frame_id (struct ui_file
*file
, struct frame_id id
);
260 /* Frame types. Some are real, some are signal trampolines, and some
261 are completely artificial (dummy). */
265 /* A true stack frame, created by the target program during normal
268 /* A fake frame, created by GDB when performing an inferior function
271 /* A frame representing an inlined function, associated with an
272 upcoming (prev, outer, older) NORMAL_FRAME. */
274 /* A virtual frame of a tail call - see dwarf2_tailcall_frame_unwind. */
276 /* In a signal handler, various OSs handle this in various ways.
277 The main thing is that the frame may be far from normal. */
279 /* Fake frame representing a cross-architecture call. */
281 /* Sentinel or registers frame. This frame obtains register values
282 direct from the inferior's registers. */
286 /* For every stopped thread, GDB tracks two frames: current and
287 selected. Current frame is the inner most frame of the selected
288 thread. Selected frame is the one being examined by the GDB
289 CLI (selected using `up', `down', ...). The frames are created
290 on-demand (via get_prev_frame()) and then held in a frame cache. */
291 /* FIXME: cagney/2002-11-28: Er, there is a lie here. If you do the
292 sequence: `thread 1; up; thread 2; thread 1' you lose thread 1's
293 selected frame. At present GDB only tracks the selected frame of
294 the current thread. But be warned, that might change. */
295 /* FIXME: cagney/2002-11-14: At any time, only one thread's selected
296 and current frame can be active. Switching threads causes gdb to
297 discard all that cached frame information. Ulgh! Instead, current
298 and selected frame should be bound to a thread. */
300 /* On demand, create the inner most frame using information found in
301 the inferior. If the inner most frame can't be created, throw an
303 extern struct frame_info
*get_current_frame (void);
305 /* Does the current target interface have enough state to be able to
306 query the current inferior for frame info, and is the inferior in a
307 state where that is possible? */
308 extern int has_stack_frames (void);
310 /* Invalidates the frame cache (this function should have been called
311 invalidate_cached_frames).
313 FIXME: cagney/2002-11-28: There should be two methods: one that
314 reverts the thread's selected frame back to current frame (for when
315 the inferior resumes) and one that does not (for when the user
316 modifies the target invalidating the frame cache). */
317 extern void reinit_frame_cache (void);
319 /* On demand, create the selected frame and then return it. If the
320 selected frame can not be created, this function prints then throws
321 an error. When MESSAGE is non-NULL, use it for the error message,
322 otherwize use a generic error message. */
323 /* FIXME: cagney/2002-11-28: At present, when there is no selected
324 frame, this function always returns the current (inner most) frame.
325 It should instead, when a thread has previously had its frame
326 selected (but not resumed) and the frame cache invalidated, find
327 and then return that thread's previously selected frame. */
328 extern struct frame_info
*get_selected_frame (const char *message
);
330 /* If there is a selected frame, return it. Otherwise, return NULL. */
331 extern struct frame_info
*get_selected_frame_if_set (void);
333 /* Select a specific frame. NULL, apparently implies re-select the
335 extern void select_frame (struct frame_info
*);
337 /* Given a FRAME, return the next (more inner, younger) or previous
338 (more outer, older) frame. */
339 extern struct frame_info
*get_prev_frame (struct frame_info
*);
340 extern struct frame_info
*get_next_frame (struct frame_info
*);
342 /* Like get_next_frame(), but allows return of the sentinel frame. NULL
343 is never returned. */
344 extern struct frame_info
*get_next_frame_sentinel_okay (struct frame_info
*);
346 /* Return a "struct frame_info" corresponding to the frame that called
347 THIS_FRAME. Returns NULL if there is no such frame.
349 Unlike get_prev_frame, this function always tries to unwind the
351 extern struct frame_info
*get_prev_frame_always (struct frame_info
*);
353 /* Given a frame's ID, relocate the frame. Returns NULL if the frame
355 extern struct frame_info
*frame_find_by_id (struct frame_id id
);
357 /* Given a frame's ID, find the previous frame's ID. Returns null_frame_id
358 if the frame is not found. */
359 extern struct frame_id
get_prev_frame_id_by_id (struct frame_id id
);
361 /* Base attributes of a frame: */
363 /* The frame's `resume' address. Where the program will resume in
366 This replaced: frame->pc; */
367 extern CORE_ADDR
get_frame_pc (struct frame_info
*);
369 /* Same as get_frame_pc, but return a boolean indication of whether
370 the PC is actually available, instead of throwing an error. */
372 extern int get_frame_pc_if_available (struct frame_info
*frame
,
375 /* An address (not necessarily aligned to an instruction boundary)
376 that falls within THIS frame's code block.
378 When a function call is the last statement in a block, the return
379 address for the call may land at the start of the next block.
380 Similarly, if a no-return function call is the last statement in
381 the function, the return address may end up pointing beyond the
382 function, and possibly at the start of the next function.
384 These methods make an allowance for this. For call frames, this
385 function returns the frame's PC-1 which "should" be an address in
386 the frame's block. */
388 extern CORE_ADDR
get_frame_address_in_block (struct frame_info
*this_frame
);
390 /* Same as get_frame_address_in_block, but returns a boolean
391 indication of whether the frame address is determinable (when the
392 PC is unavailable, it will not be), instead of possibly throwing an
393 error trying to read an unavailable PC. */
396 get_frame_address_in_block_if_available (struct frame_info
*this_frame
,
399 /* The frame's inner-most bound. AKA the stack-pointer. Confusingly
400 known as top-of-stack. */
402 extern CORE_ADDR
get_frame_sp (struct frame_info
*);
404 /* Following on from the `resume' address. Return the entry point
405 address of the function containing that resume address, or zero if
406 that function isn't known. */
407 extern CORE_ADDR
get_frame_func (struct frame_info
*fi
);
409 /* Same as get_frame_func, but returns a boolean indication of whether
410 the frame function is determinable (when the PC is unavailable, it
411 will not be), instead of possibly throwing an error trying to read
412 an unavailable PC. */
414 extern int get_frame_func_if_available (struct frame_info
*fi
, CORE_ADDR
*);
416 /* Closely related to the resume address, various symbol table
417 attributes that are determined by the PC. Note that for a normal
418 frame, the PC refers to the resume address after the return, and
419 not the call instruction. In such a case, the address is adjusted
420 so that it (approximately) identifies the call site (and not the
423 NOTE: cagney/2002-11-28: The frame cache could be used to cache the
424 computed value. Working on the assumption that the bottle-neck is
425 in the single step code, and that code causes the frame cache to be
426 constantly flushed, caching things in a frame is probably of little
427 benefit. As they say `show us the numbers'.
429 NOTE: cagney/2002-11-28: Plenty more where this one came from:
430 find_frame_block(), find_frame_partial_function(),
431 find_frame_symtab(), find_frame_function(). Each will need to be
432 carefully considered to determine if the real intent was for it to
433 apply to the PC or the adjusted PC. */
434 extern symtab_and_line
find_frame_sal (frame_info
*frame
);
436 /* Set the current source and line to the location given by frame
437 FRAME, if possible. */
439 void set_current_sal_from_frame (struct frame_info
*);
441 /* Return the frame base (what ever that is) (DEPRECATED).
443 Old code was trying to use this single method for two conflicting
444 purposes. Such code needs to be updated to use either of:
446 get_frame_id: A low level frame unique identifier, that consists of
447 both a stack and a function address, that can be used to uniquely
448 identify a frame. This value is determined by the frame's
449 low-level unwinder, the stack part [typically] being the
450 top-of-stack of the previous frame, and the function part being the
451 function's start address. Since the correct identification of a
452 frameless function requires both a stack and function address,
453 the old get_frame_base method was not sufficient.
455 get_frame_base_address: get_frame_locals_address:
456 get_frame_args_address: A set of high-level debug-info dependant
457 addresses that fall within the frame. These addresses almost
458 certainly will not match the stack address part of a frame ID (as
459 returned by get_frame_base).
461 This replaced: frame->frame; */
463 extern CORE_ADDR
get_frame_base (struct frame_info
*);
465 /* Return the per-frame unique identifer. Can be used to relocate a
466 frame after a frame cache flush (and other similar operations). If
467 FI is NULL, return the null_frame_id.
469 NOTE: kettenis/20040508: These functions return a structure. On
470 platforms where structures are returned in static storage (vax,
471 m68k), this may trigger compiler bugs in code like:
473 if (frame_id_eq (get_frame_id (l), get_frame_id (r)))
475 where the return value from the first get_frame_id (l) gets
476 overwritten by the second get_frame_id (r). Please avoid writing
477 code like this. Use code like:
479 struct frame_id id = get_frame_id (l);
480 if (frame_id_eq (id, get_frame_id (r)))
482 instead, since that avoids the bug. */
483 extern struct frame_id
get_frame_id (struct frame_info
*fi
);
484 extern struct frame_id
get_stack_frame_id (struct frame_info
*fi
);
485 extern struct frame_id
frame_unwind_caller_id (struct frame_info
*next_frame
);
487 /* Assuming that a frame is `normal', return its base-address, or 0 if
488 the information isn't available. NOTE: This address is really only
489 meaningful to the frame's high-level debug info. */
490 extern CORE_ADDR
get_frame_base_address (struct frame_info
*);
492 /* Assuming that a frame is `normal', return the base-address of the
493 local variables, or 0 if the 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_locals_address (struct frame_info
*);
499 /* Assuming that a frame is `normal', return the base-address of the
500 parameter list, or 0 if that information isn't available. NOTE:
501 This address is really only meaningful to the frame's high-level
502 debug info. Typically, the argument and locals share a single
504 extern CORE_ADDR
get_frame_args_address (struct frame_info
*);
506 /* The frame's level: 0 for innermost, 1 for its caller, ...; or -1
507 for an invalid frame). */
508 extern int frame_relative_level (struct frame_info
*fi
);
510 /* Return the frame's type. */
512 extern enum frame_type
get_frame_type (struct frame_info
*);
514 /* Return the frame's program space. */
515 extern struct program_space
*get_frame_program_space (struct frame_info
*);
517 /* Unwind THIS frame's program space from the NEXT frame. */
518 extern struct program_space
*frame_unwind_program_space (struct frame_info
*);
522 /* Return the frame's address space. */
523 extern const address_space
*get_frame_address_space (struct frame_info
*);
525 /* For frames where we can not unwind further, describe why. */
527 enum unwind_stop_reason
529 #define SET(name, description) name,
530 #define FIRST_ENTRY(name) UNWIND_FIRST = name,
531 #define LAST_ENTRY(name) UNWIND_LAST = name,
532 #define FIRST_ERROR(name) UNWIND_FIRST_ERROR = name,
534 #include "unwind_stop_reasons.def"
541 /* Return the reason why we can't unwind past this frame. */
543 enum unwind_stop_reason
get_frame_unwind_stop_reason (struct frame_info
*);
545 /* Translate a reason code to an informative string. This converts the
546 generic stop reason codes into a generic string describing the code.
547 For a possibly frame specific string explaining the stop reason, use
548 FRAME_STOP_REASON_STRING instead. */
550 const char *unwind_stop_reason_to_string (enum unwind_stop_reason
);
552 /* Return a possibly frame specific string explaining why the unwind
553 stopped here. E.g., if unwinding tripped on a memory error, this
554 will return the error description string, which includes the address
555 that we failed to access. If there's no specific reason stored for
556 a frame then a generic reason string will be returned.
558 Should only be called for frames that don't have a previous frame. */
560 const char *frame_stop_reason_string (struct frame_info
*);
562 /* Unwind the stack frame so that the value of REGNUM, in the previous
563 (up, older) frame is returned. If VALUEP is NULL, don't
564 fetch/compute the value. Instead just return the location of the
566 extern void frame_register_unwind (frame_info
*frame
, int regnum
,
567 int *optimizedp
, int *unavailablep
,
568 enum lval_type
*lvalp
,
569 CORE_ADDR
*addrp
, int *realnump
,
572 /* Fetch a register from this, or unwind a register from the next
573 frame. Note that the get_frame methods are wrappers to
574 frame->next->unwind. They all [potentially] throw an error if the
575 fetch fails. The value methods never return NULL, but usually
576 do return a lazy value. */
578 extern void frame_unwind_register (frame_info
*next_frame
,
579 int regnum
, gdb_byte
*buf
);
580 extern void get_frame_register (struct frame_info
*frame
,
581 int regnum
, gdb_byte
*buf
);
583 struct value
*frame_unwind_register_value (frame_info
*next_frame
,
585 struct value
*get_frame_register_value (struct frame_info
*frame
,
588 extern LONGEST
frame_unwind_register_signed (frame_info
*next_frame
,
590 extern LONGEST
get_frame_register_signed (struct frame_info
*frame
,
592 extern ULONGEST
frame_unwind_register_unsigned (frame_info
*frame
,
594 extern ULONGEST
get_frame_register_unsigned (struct frame_info
*frame
,
597 /* Read a register from this, or unwind a register from the next
598 frame. Note that the read_frame methods are wrappers to
599 get_frame_register_value, that do not throw if the result is
600 optimized out or unavailable. */
602 extern int read_frame_register_unsigned (struct frame_info
*frame
,
603 int regnum
, ULONGEST
*val
);
605 /* Get the value of the register that belongs to this FRAME. This
606 function is a wrapper to the call sequence ``frame_register_unwind
607 (get_next_frame (FRAME))''. As per frame_register_unwind(), if
608 VALUEP is NULL, the registers value is not fetched/computed. */
610 extern void frame_register (struct frame_info
*frame
, int regnum
,
611 int *optimizedp
, int *unavailablep
,
612 enum lval_type
*lvalp
,
613 CORE_ADDR
*addrp
, int *realnump
,
616 /* The reverse. Store a register value relative to the specified
617 frame. Note: this call makes the frame's state undefined. The
618 register and frame caches must be flushed. */
619 extern void put_frame_register (struct frame_info
*frame
, int regnum
,
620 const gdb_byte
*buf
);
622 /* Read LEN bytes from one or multiple registers starting with REGNUM
623 in frame FRAME, starting at OFFSET, into BUF. If the register
624 contents are optimized out or unavailable, set *OPTIMIZEDP,
625 *UNAVAILABLEP accordingly. */
626 extern int get_frame_register_bytes (struct frame_info
*frame
, int regnum
,
627 CORE_ADDR offset
, int len
,
629 int *optimizedp
, int *unavailablep
);
631 /* Write LEN bytes to one or multiple registers starting with REGNUM
632 in frame FRAME, starting at OFFSET, into BUF. */
633 extern void put_frame_register_bytes (struct frame_info
*frame
, int regnum
,
634 CORE_ADDR offset
, int len
,
635 const gdb_byte
*myaddr
);
637 /* Unwind the PC. Strictly speaking return the resume address of the
638 calling frame. For GDB, `pc' is the resume address and not a
639 specific register. */
641 extern CORE_ADDR
frame_unwind_caller_pc (struct frame_info
*frame
);
643 /* Discard the specified frame. Restoring the registers to the state
645 extern void frame_pop (struct frame_info
*frame
);
647 /* Return memory from the specified frame. A frame knows its thread /
648 LWP and hence can find its way down to a target. The assumption
649 here is that the current and previous frame share a common address
652 If the memory read fails, these methods throw an error.
654 NOTE: cagney/2003-06-03: Should there be unwind versions of these
655 methods? That isn't clear. Can code, for instance, assume that
656 this and the previous frame's memory or architecture are identical?
657 If architecture / memory changes are always separated by special
658 adaptor frames this should be ok. */
660 extern void get_frame_memory (struct frame_info
*this_frame
, CORE_ADDR addr
,
661 gdb_byte
*buf
, int len
);
662 extern LONGEST
get_frame_memory_signed (struct frame_info
*this_frame
,
663 CORE_ADDR memaddr
, int len
);
664 extern ULONGEST
get_frame_memory_unsigned (struct frame_info
*this_frame
,
665 CORE_ADDR memaddr
, int len
);
667 /* Same as above, but return non-zero when the entire memory read
668 succeeds, zero otherwize. */
669 extern int safe_frame_unwind_memory (struct frame_info
*this_frame
,
670 CORE_ADDR addr
, gdb_byte
*buf
, int len
);
672 /* Return this frame's architecture. */
673 extern struct gdbarch
*get_frame_arch (struct frame_info
*this_frame
);
675 /* Return the previous frame's architecture. */
676 extern struct gdbarch
*frame_unwind_arch (frame_info
*next_frame
);
678 /* Return the previous frame's architecture, skipping inline functions. */
679 extern struct gdbarch
*frame_unwind_caller_arch (struct frame_info
*frame
);
682 /* Values for the source flag to be used in print_frame_info ().
683 For all the cases below, the address is never printed if
684 'set print address' is off. When 'set print address' is on,
685 the address is printed if the program counter is not at the
686 beginning of the source line of the frame
687 and PRINT_WHAT is != LOC_AND_ADDRESS. */
690 /* Print only the address, source line, like in stepi. */
692 /* Print only the location, i.e. level, address,
693 function, args (as controlled by 'set print frame-arguments'),
694 file, line, line num. */
696 /* Print both of the above. */
698 /* Print location only, print the address even if the program counter
699 is at the beginning of the source line. */
701 /* Print only level and function,
702 i.e. location only, without address, file, line, line num. */
706 /* Allocate zero initialized memory from the frame cache obstack.
707 Appendices to the frame info (such as the unwind cache) should
708 allocate memory using this method. */
710 extern void *frame_obstack_zalloc (unsigned long size
);
711 #define FRAME_OBSTACK_ZALLOC(TYPE) \
712 ((TYPE *) frame_obstack_zalloc (sizeof (TYPE)))
713 #define FRAME_OBSTACK_CALLOC(NUMBER,TYPE) \
714 ((TYPE *) frame_obstack_zalloc ((NUMBER) * sizeof (TYPE)))
716 class readonly_detached_regcache
;
717 /* Create a regcache, and copy the frame's registers into it. */
718 std::unique_ptr
<readonly_detached_regcache
> frame_save_as_regcache
719 (struct frame_info
*this_frame
);
721 extern const struct block
*get_frame_block (struct frame_info
*,
722 CORE_ADDR
*addr_in_block
);
724 /* Return the `struct block' that belongs to the selected thread's
725 selected frame. If the inferior has no state, return NULL.
727 NOTE: cagney/2002-11-29:
729 No state? Does the inferior have any execution state (a core file
730 does, an executable does not). At present the code tests
731 `target_has_stack' but I'm left wondering if it should test
732 `target_has_registers' or, even, a merged target_has_state.
734 Should it look at the most recently specified SAL? If the target
735 has no state, should this function try to extract a block from the
736 most recently selected SAL? That way `list foo' would give it some
737 sort of reference point. Then again, perhaps that would confuse
740 Calls to this function can be broken down into two categories: Code
741 that uses the selected block as an additional, but optional, data
742 point; Code that uses the selected block as a prop, when it should
743 have the relevant frame/block/pc explicitly passed in.
745 The latter can be eliminated by correctly parameterizing the code,
746 the former though is more interesting. Per the "address" command,
747 it occurs in the CLI code and makes it possible for commands to
748 work, even when the inferior has no state. */
750 extern const struct block
*get_selected_block (CORE_ADDR
*addr_in_block
);
752 extern struct symbol
*get_frame_function (struct frame_info
*);
754 extern CORE_ADDR
get_pc_function_start (CORE_ADDR
);
756 extern struct frame_info
*find_relative_frame (struct frame_info
*, int *);
758 /* Wrapper over print_stack_frame modifying current_uiout with UIOUT for
759 the function call. */
761 extern void print_stack_frame_to_uiout (struct ui_out
*uiout
,
762 struct frame_info
*, int print_level
,
763 enum print_what print_what
,
764 int set_current_sal
);
766 extern void print_stack_frame (struct frame_info
*, int print_level
,
767 enum print_what print_what
,
768 int set_current_sal
);
770 extern void print_frame_info (const frame_print_options
&fp_opts
,
771 struct frame_info
*, int print_level
,
772 enum print_what print_what
, int args
,
773 int set_current_sal
);
775 extern struct frame_info
*block_innermost_frame (const struct block
*);
777 extern int deprecated_frame_register_read (struct frame_info
*frame
, int regnum
,
782 /* The possible choices of "set print frame-arguments". */
783 extern const char print_frame_arguments_all
[];
784 extern const char print_frame_arguments_scalars
[];
785 extern const char print_frame_arguments_none
[];
787 /* The possible choices of "set print frame-info". */
788 extern const char print_frame_info_auto
[];
789 extern const char print_frame_info_source_line
[];
790 extern const char print_frame_info_location
[];
791 extern const char print_frame_info_source_and_location
[];
792 extern const char print_frame_info_location_and_address
[];
793 extern const char print_frame_info_short_location
[];
795 /* The possible choices of "set print entry-values". */
796 extern const char print_entry_values_no
[];
797 extern const char print_entry_values_only
[];
798 extern const char print_entry_values_preferred
[];
799 extern const char print_entry_values_if_needed
[];
800 extern const char print_entry_values_both
[];
801 extern const char print_entry_values_compact
[];
802 extern const char print_entry_values_default
[];
804 /* Data for the frame-printing "set print" settings exposed as command
807 struct frame_print_options
809 const char *print_frame_arguments
= print_frame_arguments_scalars
;
810 const char *print_frame_info
= print_frame_info_auto
;
811 const char *print_entry_values
= print_entry_values_default
;
813 /* If true, don't invoke pretty-printers for frame
815 bool print_raw_frame_arguments
;
818 /* The values behind the global "set print ..." settings. */
819 extern frame_print_options user_frame_print_options
;
821 /* Inferior function parameter value read in from a frame. */
825 /* Symbol for this parameter used for example for its name. */
826 struct symbol
*sym
= nullptr;
828 /* Value of the parameter. It is NULL if ERROR is not NULL; if both VAL and
829 ERROR are NULL this parameter's value should not be printed. */
830 struct value
*val
= nullptr;
832 /* String containing the error message, it is more usually NULL indicating no
833 error occured reading this parameter. */
834 gdb::unique_xmalloc_ptr
<char> error
;
836 /* One of the print_entry_values_* entries as appropriate specifically for
837 this frame_arg. It will be different from print_entry_values. With
838 print_entry_values_no this frame_arg should be printed as a normal
839 parameter. print_entry_values_only says it should be printed as entry
840 value parameter. print_entry_values_compact says it should be printed as
841 both as a normal parameter and entry values parameter having the same
842 value - print_entry_values_compact is not permitted fi ui_out_is_mi_like_p
843 (in such case print_entry_values_no and print_entry_values_only is used
844 for each parameter kind specifically. */
845 const char *entry_kind
= nullptr;
848 extern void read_frame_arg (const frame_print_options
&fp_opts
,
849 symbol
*sym
, frame_info
*frame
,
850 struct frame_arg
*argp
,
851 struct frame_arg
*entryargp
);
852 extern void read_frame_local (struct symbol
*sym
, struct frame_info
*frame
,
853 struct frame_arg
*argp
);
855 extern void info_args_command (const char *, int);
857 extern void info_locals_command (const char *, int);
859 extern void return_command (const char *, int);
861 /* Set FRAME's unwinder temporarily, so that we can call a sniffer.
862 If sniffing fails, the caller should be sure to call
863 frame_cleanup_after_sniffer. */
865 extern void frame_prepare_for_sniffer (struct frame_info
*frame
,
866 const struct frame_unwind
*unwind
);
868 /* Clean up after a failed (wrong unwinder) attempt to unwind past
871 extern void frame_cleanup_after_sniffer (struct frame_info
*frame
);
873 /* Notes (cagney/2002-11-27, drow/2003-09-06):
875 You might think that calls to this function can simply be replaced by a
876 call to get_selected_frame().
878 Unfortunately, it isn't that easy.
880 The relevant code needs to be audited to determine if it is
881 possible (or practical) to instead pass the applicable frame in as a
882 parameter. For instance, DEPRECATED_DO_REGISTERS_INFO() relied on
883 the deprecated_selected_frame global, while its replacement,
884 PRINT_REGISTERS_INFO(), is parameterized with the selected frame.
885 The only real exceptions occur at the edge (in the CLI code) where
886 user commands need to pick up the selected frame before proceeding.
888 There are also some functions called with a NULL frame meaning either "the
889 program is not running" or "use the selected frame".
891 This is important. GDB is trying to stamp out the hack:
893 saved_frame = deprecated_safe_get_selected_frame ();
895 hack_using_global_selected_frame ();
896 select_frame (saved_frame);
900 This function calls get_selected_frame if the inferior should have a
901 frame, or returns NULL otherwise. */
903 extern struct frame_info
*deprecated_safe_get_selected_frame (void);
905 /* Create a frame using the specified BASE and PC. */
907 extern struct frame_info
*create_new_frame (CORE_ADDR base
, CORE_ADDR pc
);
909 /* Return true if the frame unwinder for frame FI is UNWINDER; false
912 extern int frame_unwinder_is (struct frame_info
*fi
,
913 const struct frame_unwind
*unwinder
);
915 /* Return the language of FRAME. */
917 extern enum language
get_frame_language (struct frame_info
*frame
);
919 /* Return the first non-tailcall frame above FRAME or FRAME if it is not a
920 tailcall frame. Return NULL if FRAME is the start of a tailcall-only
923 extern struct frame_info
*skip_tailcall_frames (struct frame_info
*frame
);
925 /* Return the first frame above FRAME or FRAME of which the code is
928 extern struct frame_info
*skip_unwritable_frames (struct frame_info
*frame
);
930 /* Data for the "set backtrace" settings. */
932 struct set_backtrace_options
934 /* Flag to indicate whether backtraces should continue past
936 bool backtrace_past_main
= false;
938 /* Flag to indicate whether backtraces should continue past
940 bool backtrace_past_entry
= false;
942 /* Upper bound on the number of backtrace levels. Note this is not
943 exposed as a command option, because "backtrace" and "frame
944 apply" already have other means to set a frame count limit. */
945 unsigned int backtrace_limit
= UINT_MAX
;
948 /* The corresponding option definitions. */
949 extern const gdb::option::option_def set_backtrace_option_defs
[2];
951 /* The values behind the global "set backtrace ..." settings. */
952 extern set_backtrace_options user_set_backtrace_options
;
954 /* Mark that the PC value is masked for the previous frame. */
956 extern void set_frame_previous_pc_masked (struct frame_info
*frame
);
958 /* Get whether the PC value is masked for the given frame. */
960 extern bool get_frame_pc_masked (const struct frame_info
*frame
);
963 #endif /* !defined (FRAME_H) */