1 /* Definitions for dealing with stack frames, for GDB, the GNU debugger.
3 Copyright (C) 1986-2021 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. */
89 FID_STACK_INVALID
= 0,
91 /* Stack address is valid, and is found in the stack_addr field. */
95 FID_STACK_SENTINEL
= 2,
97 /* Outer frame. Since a frame's stack address is typically defined as the
98 value the stack pointer had prior to the activation of the frame, an outer
99 frame doesn't have a stack address. The frame ids of frames inlined in the
100 outer frame are also of this type. */
103 /* Stack address is unavailable. I.e., there's a valid stack, but
104 we don't know where it is (because memory or registers we'd
105 compute it from were not collected). */
106 FID_STACK_UNAVAILABLE
= -1
109 /* The frame object. */
113 /* The frame object's ID. This provides a per-frame unique identifier
114 that can be used to relocate a `struct frame_info' after a target
115 resume or a frame cache destruct. It of course assumes that the
116 inferior hasn't unwound the stack past that frame. */
120 /* The frame's stack address. This shall be constant through out
121 the lifetime of a frame. Note that this requirement applies to
122 not just the function body, but also the prologue and (in theory
123 at least) the epilogue. Since that value needs to fall either on
124 the boundary, or within the frame's address range, the frame's
125 outer-most address (the inner-most address of the previous frame)
126 is used. Watch out for all the legacy targets that still use the
127 function pointer register or stack pointer register. They are
130 This field is valid only if frame_id.stack_status is
131 FID_STACK_VALID. It will be 0 for other
132 FID_STACK_... statuses. */
133 CORE_ADDR stack_addr
;
135 /* The frame's code address. This shall be constant through out the
136 lifetime of the frame. While the PC (a.k.a. resume address)
137 changes as the function is executed, this code address cannot.
138 Typically, it is set to the address of the entry point of the
139 frame's function (as returned by get_frame_func).
141 For inlined functions (INLINE_DEPTH != 0), this is the address of
142 the first executed instruction in the block corresponding to the
145 This field is valid only if code_addr_p is true. Otherwise, this
146 frame is considered to have a wildcard code address, i.e. one that
147 matches every address value in frame comparisons. */
150 /* The frame's special address. This shall be constant through out the
151 lifetime of the frame. This is used for architectures that may have
152 frames that do not change the stack but are still distinct and have
153 some form of distinct identifier (e.g. the ia64 which uses a 2nd
154 stack for registers). This field is treated as unordered - i.e. will
155 not be used in frame ordering comparisons.
157 This field is valid only if special_addr_p is true. Otherwise, this
158 frame is considered to have a wildcard special address, i.e. one that
159 matches every address value in frame comparisons. */
160 CORE_ADDR special_addr
;
162 /* Flags to indicate the above fields have valid contents. */
163 ENUM_BITFIELD(frame_id_stack_status
) stack_status
: 3;
164 unsigned int code_addr_p
: 1;
165 unsigned int special_addr_p
: 1;
167 /* It is non-zero for a frame made up by GDB without stack data
168 representation in inferior, such as INLINE_FRAME or TAILCALL_FRAME.
169 Caller of inlined function will have it zero, each more inner called frame
170 will have it increasingly one, two etc. Similarly for TAILCALL_FRAME. */
171 int artificial_depth
;
173 /* Return a string representation of this frame id. */
174 std::string
to_string () const;
177 /* Save and restore the currently selected frame. */
179 class scoped_restore_selected_frame
182 /* Save the currently selected frame. */
183 scoped_restore_selected_frame ();
185 /* Restore the currently selected frame. */
186 ~scoped_restore_selected_frame ();
188 DISABLE_COPY_AND_ASSIGN (scoped_restore_selected_frame
);
192 /* The ID and level of the previously selected frame. */
193 struct frame_id m_fid
;
196 /* Save/restore the language as well, because selecting a frame
197 changes the current language to the frame's language if "set
199 enum language m_lang
;
202 /* Methods for constructing and comparing Frame IDs. */
204 /* For convenience. All fields are zero. This means "there is no frame". */
205 extern const struct frame_id null_frame_id
;
207 /* Sentinel frame. */
208 extern const struct frame_id sentinel_frame_id
;
210 /* This means "there is no frame ID, but there is a frame". It should be
211 replaced by best-effort frame IDs for the outermost frame, somehow.
212 The implementation is only special_addr_p set. */
213 extern const struct frame_id outer_frame_id
;
215 /* Flag to control debugging. */
217 extern unsigned int frame_debug
;
219 /* Construct a frame ID. The first parameter is the frame's constant
220 stack address (typically the outer-bound), and the second the
221 frame's constant code address (typically the entry point).
222 The special identifier address is set to indicate a wild card. */
223 extern struct frame_id
frame_id_build (CORE_ADDR stack_addr
,
224 CORE_ADDR code_addr
);
226 /* Construct a special frame ID. The first parameter is the frame's constant
227 stack address (typically the outer-bound), the second is the
228 frame's constant code address (typically the entry point),
229 and the third parameter is the frame's special identifier address. */
230 extern struct frame_id
frame_id_build_special (CORE_ADDR stack_addr
,
232 CORE_ADDR special_addr
);
234 /* Construct a frame ID representing a frame where the stack address
235 exists, but is unavailable. CODE_ADDR is the frame's constant code
236 address (typically the entry point). The special identifier
237 address is set to indicate a wild card. */
238 extern struct frame_id
frame_id_build_unavailable_stack (CORE_ADDR code_addr
);
240 /* Construct a frame ID representing a frame where the stack address
241 exists, but is unavailable. CODE_ADDR is the frame's constant code
242 address (typically the entry point). SPECIAL_ADDR is the special
243 identifier address. */
244 extern struct frame_id
245 frame_id_build_unavailable_stack_special (CORE_ADDR code_addr
,
246 CORE_ADDR special_addr
);
248 /* Construct a wild card frame ID. The parameter is the frame's constant
249 stack address (typically the outer-bound). The code address as well
250 as the special identifier address are set to indicate wild cards. */
251 extern struct frame_id
frame_id_build_wild (CORE_ADDR stack_addr
);
253 /* Returns true when L is a valid frame. */
254 extern bool frame_id_p (frame_id l
);
256 /* Returns true when L is a valid frame representing a frame made up by GDB
257 without stack data representation in inferior, such as INLINE_FRAME or
259 extern bool frame_id_artificial_p (frame_id l
);
261 /* Returns true when L and R identify the same frame. */
262 extern bool frame_id_eq (frame_id l
, frame_id r
);
264 /* Frame types. Some are real, some are signal trampolines, and some
265 are completely artificial (dummy). */
269 /* A true stack frame, created by the target program during normal
272 /* A fake frame, created by GDB when performing an inferior function
275 /* A frame representing an inlined function, associated with an
276 upcoming (prev, outer, older) NORMAL_FRAME. */
278 /* A virtual frame of a tail call - see dwarf2_tailcall_frame_unwind. */
280 /* In a signal handler, various OSs handle this in various ways.
281 The main thing is that the frame may be far from normal. */
283 /* Fake frame representing a cross-architecture call. */
285 /* Sentinel or registers frame. This frame obtains register values
286 direct from the inferior's registers. */
290 /* For every stopped thread, GDB tracks two frames: current and
291 selected. Current frame is the inner most frame of the selected
292 thread. Selected frame is the one being examined by the GDB
293 CLI (selected using `up', `down', ...). The frames are created
294 on-demand (via get_prev_frame()) and then held in a frame cache. */
295 /* FIXME: cagney/2002-11-28: Er, there is a lie here. If you do the
296 sequence: `thread 1; up; thread 2; thread 1' you lose thread 1's
297 selected frame. At present GDB only tracks the selected frame of
298 the current thread. But be warned, that might change. */
299 /* FIXME: cagney/2002-11-14: At any time, only one thread's selected
300 and current frame can be active. Switching threads causes gdb to
301 discard all that cached frame information. Ulgh! Instead, current
302 and selected frame should be bound to a thread. */
304 /* On demand, create the inner most frame using information found in
305 the inferior. If the inner most frame can't be created, throw an
307 extern struct frame_info
*get_current_frame (void);
309 /* Does the current target interface have enough state to be able to
310 query the current inferior for frame info, and is the inferior in a
311 state where that is possible? */
312 extern bool has_stack_frames ();
314 /* Invalidates the frame cache (this function should have been called
315 invalidate_cached_frames).
317 FIXME: cagney/2002-11-28: There should be two methods: one that
318 reverts the thread's selected frame back to current frame (for when
319 the inferior resumes) and one that does not (for when the user
320 modifies the target invalidating the frame cache). */
321 extern void reinit_frame_cache (void);
323 /* Return the selected frame. Always returns non-NULL. If there
324 isn't an inferior sufficient for creating a frame, an error is
325 thrown. When MESSAGE is non-NULL, use it for the error message,
326 otherwise use a generic error message. */
327 /* FIXME: cagney/2002-11-28: At present, when there is no selected
328 frame, this function always returns the current (inner most) frame.
329 It should instead, when a thread has previously had its frame
330 selected (but not resumed) and the frame cache invalidated, find
331 and then return that thread's previously selected frame. */
332 extern struct frame_info
*get_selected_frame (const char *message
= nullptr);
334 /* Select a specific frame. NULL implies re-select the inner most
336 extern void select_frame (struct frame_info
*);
338 /* Save the frame ID and frame level of the selected frame in FRAME_ID
339 and FRAME_LEVEL, to be restored later with restore_selected_frame.
341 This is preferred over getting the same info out of
342 get_selected_frame directly because this function does not create
343 the selected-frame's frame_info object if it hasn't been created
344 yet, and thus is more efficient and doesn't throw. */
345 extern void save_selected_frame (frame_id
*frame_id
, int *frame_level
)
348 /* Restore selected frame as saved with save_selected_frame.
350 Does not try to find the corresponding frame_info object. Instead
351 the next call to get_selected_frame will look it up and cache the
354 This function does not throw. It is designed to be safe to called
355 from the destructors of RAII types. */
356 extern void restore_selected_frame (frame_id frame_id
, int frame_level
)
359 /* Lookup the frame_info object for the selected frame FRAME_ID /
360 FRAME_LEVEL and cache the result.
362 If FRAME_LEVEL > 0 and the originally selected frame isn't found,
363 warn and select the innermost (current) frame. */
364 extern void lookup_selected_frame (frame_id frame_id
, int frame_level
);
366 /* Given a FRAME, return the next (more inner, younger) or previous
367 (more outer, older) frame. */
368 extern struct frame_info
*get_prev_frame (struct frame_info
*);
369 extern struct frame_info
*get_next_frame (struct frame_info
*);
371 /* Like get_next_frame(), but allows return of the sentinel frame. NULL
372 is never returned. */
373 extern struct frame_info
*get_next_frame_sentinel_okay (struct frame_info
*);
375 /* Return a "struct frame_info" corresponding to the frame that called
376 THIS_FRAME. Returns NULL if there is no such frame.
378 Unlike get_prev_frame, this function always tries to unwind the
380 extern struct frame_info
*get_prev_frame_always (struct frame_info
*);
382 /* Given a frame's ID, relocate the frame. Returns NULL if the frame
384 extern struct frame_info
*frame_find_by_id (struct frame_id id
);
386 /* Given a frame's ID, find the previous frame's ID. Returns null_frame_id
387 if the frame is not found. */
388 extern struct frame_id
get_prev_frame_id_by_id (struct frame_id id
);
390 /* Base attributes of a frame: */
392 /* The frame's `resume' address. Where the program will resume in
395 This replaced: frame->pc; */
396 extern CORE_ADDR
get_frame_pc (struct frame_info
*);
398 /* Same as get_frame_pc, but return a boolean indication of whether
399 the PC is actually available, instead of throwing an error. */
401 extern bool get_frame_pc_if_available (frame_info
*frame
, CORE_ADDR
*pc
);
403 /* An address (not necessarily aligned to an instruction boundary)
404 that falls within THIS frame's code block.
406 When a function call is the last statement in a block, the return
407 address for the call may land at the start of the next block.
408 Similarly, if a no-return function call is the last statement in
409 the function, the return address may end up pointing beyond the
410 function, and possibly at the start of the next function.
412 These methods make an allowance for this. For call frames, this
413 function returns the frame's PC-1 which "should" be an address in
414 the frame's block. */
416 extern CORE_ADDR
get_frame_address_in_block (struct frame_info
*this_frame
);
418 /* Same as get_frame_address_in_block, but returns a boolean
419 indication of whether the frame address is determinable (when the
420 PC is unavailable, it will not be), instead of possibly throwing an
421 error trying to read an unavailable PC. */
423 extern bool get_frame_address_in_block_if_available (frame_info
*this_frame
,
426 /* The frame's inner-most bound. AKA the stack-pointer. Confusingly
427 known as top-of-stack. */
429 extern CORE_ADDR
get_frame_sp (struct frame_info
*);
431 /* Following on from the `resume' address. Return the entry point
432 address of the function containing that resume address, or zero if
433 that function isn't known. */
434 extern CORE_ADDR
get_frame_func (struct frame_info
*fi
);
436 /* Same as get_frame_func, but returns a boolean indication of whether
437 the frame function is determinable (when the PC is unavailable, it
438 will not be), instead of possibly throwing an error trying to read
439 an unavailable PC. */
441 extern bool get_frame_func_if_available (frame_info
*fi
, CORE_ADDR
*);
443 /* Closely related to the resume address, various symbol table
444 attributes that are determined by the PC. Note that for a normal
445 frame, the PC refers to the resume address after the return, and
446 not the call instruction. In such a case, the address is adjusted
447 so that it (approximately) identifies the call site (and not the
450 NOTE: cagney/2002-11-28: The frame cache could be used to cache the
451 computed value. Working on the assumption that the bottle-neck is
452 in the single step code, and that code causes the frame cache to be
453 constantly flushed, caching things in a frame is probably of little
454 benefit. As they say `show us the numbers'.
456 NOTE: cagney/2002-11-28: Plenty more where this one came from:
457 find_frame_block(), find_frame_partial_function(),
458 find_frame_symtab(), find_frame_function(). Each will need to be
459 carefully considered to determine if the real intent was for it to
460 apply to the PC or the adjusted PC. */
461 extern symtab_and_line
find_frame_sal (frame_info
*frame
);
463 /* Set the current source and line to the location given by frame
464 FRAME, if possible. */
466 void set_current_sal_from_frame (struct frame_info
*);
468 /* Return the frame base (what ever that is) (DEPRECATED).
470 Old code was trying to use this single method for two conflicting
471 purposes. Such code needs to be updated to use either of:
473 get_frame_id: A low level frame unique identifier, that consists of
474 both a stack and a function address, that can be used to uniquely
475 identify a frame. This value is determined by the frame's
476 low-level unwinder, the stack part [typically] being the
477 top-of-stack of the previous frame, and the function part being the
478 function's start address. Since the correct identification of a
479 frameless function requires both a stack and function address,
480 the old get_frame_base method was not sufficient.
482 get_frame_base_address: get_frame_locals_address:
483 get_frame_args_address: A set of high-level debug-info dependant
484 addresses that fall within the frame. These addresses almost
485 certainly will not match the stack address part of a frame ID (as
486 returned by get_frame_base).
488 This replaced: frame->frame; */
490 extern CORE_ADDR
get_frame_base (struct frame_info
*);
492 /* Return the per-frame unique identifer. Can be used to relocate a
493 frame after a frame cache flush (and other similar operations). If
494 FI is NULL, return the null_frame_id.
496 NOTE: kettenis/20040508: These functions return a structure. On
497 platforms where structures are returned in static storage (vax,
498 m68k), this may trigger compiler bugs in code like:
500 if (frame_id_eq (get_frame_id (l), get_frame_id (r)))
502 where the return value from the first get_frame_id (l) gets
503 overwritten by the second get_frame_id (r). Please avoid writing
504 code like this. Use code like:
506 struct frame_id id = get_frame_id (l);
507 if (frame_id_eq (id, get_frame_id (r)))
509 instead, since that avoids the bug. */
510 extern struct frame_id
get_frame_id (struct frame_info
*fi
);
511 extern struct frame_id
get_stack_frame_id (struct frame_info
*fi
);
512 extern struct frame_id
frame_unwind_caller_id (struct frame_info
*next_frame
);
514 /* Assuming that a frame is `normal', return its base-address, or 0 if
515 the information isn't available. NOTE: This address is really only
516 meaningful to the frame's high-level debug info. */
517 extern CORE_ADDR
get_frame_base_address (struct frame_info
*);
519 /* Assuming that a frame is `normal', return the base-address of the
520 local variables, or 0 if the information isn't available. NOTE:
521 This address is really only meaningful to the frame's high-level
522 debug info. Typically, the argument and locals share a single
524 extern CORE_ADDR
get_frame_locals_address (struct frame_info
*);
526 /* Assuming that a frame is `normal', return the base-address of the
527 parameter list, or 0 if that information isn't available. NOTE:
528 This address is really only meaningful to the frame's high-level
529 debug info. Typically, the argument and locals share a single
531 extern CORE_ADDR
get_frame_args_address (struct frame_info
*);
533 /* The frame's level: 0 for innermost, 1 for its caller, ...; or -1
534 for an invalid frame). */
535 extern int frame_relative_level (struct frame_info
*fi
);
537 /* Return the frame's type. */
539 extern enum frame_type
get_frame_type (struct frame_info
*);
541 /* Return the frame's program space. */
542 extern struct program_space
*get_frame_program_space (struct frame_info
*);
544 /* Unwind THIS frame's program space from the NEXT frame. */
545 extern struct program_space
*frame_unwind_program_space (struct frame_info
*);
549 /* Return the frame's address space. */
550 extern const address_space
*get_frame_address_space (struct frame_info
*);
552 /* For frames where we can not unwind further, describe why. */
554 enum unwind_stop_reason
556 #define SET(name, description) name,
557 #define FIRST_ENTRY(name) UNWIND_FIRST = name,
558 #define LAST_ENTRY(name) UNWIND_LAST = name,
559 #define FIRST_ERROR(name) UNWIND_FIRST_ERROR = name,
561 #include "unwind_stop_reasons.def"
568 /* Return the reason why we can't unwind past this frame. */
570 enum unwind_stop_reason
get_frame_unwind_stop_reason (struct frame_info
*);
572 /* Translate a reason code to an informative string. This converts the
573 generic stop reason codes into a generic string describing the code.
574 For a possibly frame specific string explaining the stop reason, use
575 FRAME_STOP_REASON_STRING instead. */
577 const char *unwind_stop_reason_to_string (enum unwind_stop_reason
);
579 /* Return a possibly frame specific string explaining why the unwind
580 stopped here. E.g., if unwinding tripped on a memory error, this
581 will return the error description string, which includes the address
582 that we failed to access. If there's no specific reason stored for
583 a frame then a generic reason string will be returned.
585 Should only be called for frames that don't have a previous frame. */
587 const char *frame_stop_reason_string (struct frame_info
*);
589 /* Unwind the stack frame so that the value of REGNUM, in the previous
590 (up, older) frame is returned. If VALUEP is NULL, don't
591 fetch/compute the value. Instead just return the location of the
593 extern void frame_register_unwind (frame_info
*frame
, int regnum
,
594 int *optimizedp
, int *unavailablep
,
595 enum lval_type
*lvalp
,
596 CORE_ADDR
*addrp
, int *realnump
,
599 /* Fetch a register from this, or unwind a register from the next
600 frame. Note that the get_frame methods are wrappers to
601 frame->next->unwind. They all [potentially] throw an error if the
602 fetch fails. The value methods never return NULL, but usually
603 do return a lazy value. */
605 extern void frame_unwind_register (frame_info
*next_frame
,
606 int regnum
, gdb_byte
*buf
);
607 extern void get_frame_register (struct frame_info
*frame
,
608 int regnum
, gdb_byte
*buf
);
610 struct value
*frame_unwind_register_value (frame_info
*next_frame
,
612 struct value
*get_frame_register_value (struct frame_info
*frame
,
615 extern LONGEST
frame_unwind_register_signed (frame_info
*next_frame
,
617 extern LONGEST
get_frame_register_signed (struct frame_info
*frame
,
619 extern ULONGEST
frame_unwind_register_unsigned (frame_info
*frame
,
621 extern ULONGEST
get_frame_register_unsigned (struct frame_info
*frame
,
624 /* Read a register from this, or unwind a register from the next
625 frame. Note that the read_frame methods are wrappers to
626 get_frame_register_value, that do not throw if the result is
627 optimized out or unavailable. */
629 extern bool read_frame_register_unsigned (frame_info
*frame
,
630 int regnum
, ULONGEST
*val
);
632 /* Get the value of the register that belongs to this FRAME. This
633 function is a wrapper to the call sequence ``frame_register_unwind
634 (get_next_frame (FRAME))''. As per frame_register_unwind(), if
635 VALUEP is NULL, the registers value is not fetched/computed. */
637 extern void frame_register (struct frame_info
*frame
, int regnum
,
638 int *optimizedp
, int *unavailablep
,
639 enum lval_type
*lvalp
,
640 CORE_ADDR
*addrp
, int *realnump
,
643 /* The reverse. Store a register value relative to the specified
644 frame. Note: this call makes the frame's state undefined. The
645 register and frame caches must be flushed. */
646 extern void put_frame_register (struct frame_info
*frame
, int regnum
,
647 const gdb_byte
*buf
);
649 /* Read LEN bytes from one or multiple registers starting with REGNUM
650 in frame FRAME, starting at OFFSET, into BUF. If the register
651 contents are optimized out or unavailable, set *OPTIMIZEDP,
652 *UNAVAILABLEP accordingly. */
653 extern bool get_frame_register_bytes (frame_info
*frame
, int regnum
,
655 gdb::array_view
<gdb_byte
> buffer
,
656 int *optimizedp
, int *unavailablep
);
658 /* Write bytes from BUFFER to one or multiple registers starting with REGNUM
659 in frame FRAME, starting at OFFSET. */
660 extern void put_frame_register_bytes (struct frame_info
*frame
, int regnum
,
662 gdb::array_view
<const gdb_byte
> buffer
);
664 /* Unwind the PC. Strictly speaking return the resume address of the
665 calling frame. For GDB, `pc' is the resume address and not a
666 specific register. */
668 extern CORE_ADDR
frame_unwind_caller_pc (struct frame_info
*frame
);
670 /* Discard the specified frame. Restoring the registers to the state
672 extern void frame_pop (struct frame_info
*frame
);
674 /* Return memory from the specified frame. A frame knows its thread /
675 LWP and hence can find its way down to a target. The assumption
676 here is that the current and previous frame share a common address
679 If the memory read fails, these methods throw an error.
681 NOTE: cagney/2003-06-03: Should there be unwind versions of these
682 methods? That isn't clear. Can code, for instance, assume that
683 this and the previous frame's memory or architecture are identical?
684 If architecture / memory changes are always separated by special
685 adaptor frames this should be ok. */
687 extern void get_frame_memory (struct frame_info
*this_frame
, CORE_ADDR addr
,
688 gdb::array_view
<gdb_byte
> buffer
);
689 extern LONGEST
get_frame_memory_signed (struct frame_info
*this_frame
,
690 CORE_ADDR memaddr
, int len
);
691 extern ULONGEST
get_frame_memory_unsigned (struct frame_info
*this_frame
,
692 CORE_ADDR memaddr
, int len
);
694 /* Same as above, but return true zero when the entire memory read
695 succeeds, false otherwise. */
696 extern bool safe_frame_unwind_memory (frame_info
*this_frame
, CORE_ADDR addr
,
697 gdb::array_view
<gdb_byte
> buffer
);
699 /* Return this frame's architecture. */
700 extern struct gdbarch
*get_frame_arch (struct frame_info
*this_frame
);
702 /* Return the previous frame's architecture. */
703 extern struct gdbarch
*frame_unwind_arch (frame_info
*next_frame
);
705 /* Return the previous frame's architecture, skipping inline functions. */
706 extern struct gdbarch
*frame_unwind_caller_arch (struct frame_info
*frame
);
709 /* Values for the source flag to be used in print_frame_info ().
710 For all the cases below, the address is never printed if
711 'set print address' is off. When 'set print address' is on,
712 the address is printed if the program counter is not at the
713 beginning of the source line of the frame
714 and PRINT_WHAT is != LOC_AND_ADDRESS. */
717 /* Print only the address, source line, like in stepi. */
719 /* Print only the location, i.e. level, address,
720 function, args (as controlled by 'set print frame-arguments'),
721 file, line, line num. */
723 /* Print both of the above. */
725 /* Print location only, print the address even if the program counter
726 is at the beginning of the source line. */
728 /* Print only level and function,
729 i.e. location only, without address, file, line, line num. */
733 /* Allocate zero initialized memory from the frame cache obstack.
734 Appendices to the frame info (such as the unwind cache) should
735 allocate memory using this method. */
737 extern void *frame_obstack_zalloc (unsigned long size
);
738 #define FRAME_OBSTACK_ZALLOC(TYPE) \
739 ((TYPE *) frame_obstack_zalloc (sizeof (TYPE)))
740 #define FRAME_OBSTACK_CALLOC(NUMBER,TYPE) \
741 ((TYPE *) frame_obstack_zalloc ((NUMBER) * sizeof (TYPE)))
743 class readonly_detached_regcache
;
744 /* Create a regcache, and copy the frame's registers into it. */
745 std::unique_ptr
<readonly_detached_regcache
> frame_save_as_regcache
746 (struct frame_info
*this_frame
);
748 extern const struct block
*get_frame_block (struct frame_info
*,
749 CORE_ADDR
*addr_in_block
);
751 /* Return the `struct block' that belongs to the selected thread's
752 selected frame. If the inferior has no state, return NULL.
754 NOTE: cagney/2002-11-29:
756 No state? Does the inferior have any execution state (a core file
757 does, an executable does not). At present the code tests
758 `target_has_stack' but I'm left wondering if it should test
759 `target_has_registers' or, even, a merged target_has_state.
761 Should it look at the most recently specified SAL? If the target
762 has no state, should this function try to extract a block from the
763 most recently selected SAL? That way `list foo' would give it some
764 sort of reference point. Then again, perhaps that would confuse
767 Calls to this function can be broken down into two categories: Code
768 that uses the selected block as an additional, but optional, data
769 point; Code that uses the selected block as a prop, when it should
770 have the relevant frame/block/pc explicitly passed in.
772 The latter can be eliminated by correctly parameterizing the code,
773 the former though is more interesting. Per the "address" command,
774 it occurs in the CLI code and makes it possible for commands to
775 work, even when the inferior has no state. */
777 extern const struct block
*get_selected_block (CORE_ADDR
*addr_in_block
);
779 extern struct symbol
*get_frame_function (struct frame_info
*);
781 extern CORE_ADDR
get_pc_function_start (CORE_ADDR
);
783 extern struct frame_info
*find_relative_frame (struct frame_info
*, int *);
785 /* Wrapper over print_stack_frame modifying current_uiout with UIOUT for
786 the function call. */
788 extern void print_stack_frame_to_uiout (struct ui_out
*uiout
,
789 struct frame_info
*, int print_level
,
790 enum print_what print_what
,
791 int set_current_sal
);
793 extern void print_stack_frame (struct frame_info
*, int print_level
,
794 enum print_what print_what
,
795 int set_current_sal
);
797 extern void print_frame_info (const frame_print_options
&fp_opts
,
798 struct frame_info
*, int print_level
,
799 enum print_what print_what
, int args
,
800 int set_current_sal
);
802 extern struct frame_info
*block_innermost_frame (const struct block
*);
804 extern bool deprecated_frame_register_read (frame_info
*frame
, int regnum
,
809 /* The possible choices of "set print frame-arguments". */
810 extern const char print_frame_arguments_all
[];
811 extern const char print_frame_arguments_scalars
[];
812 extern const char print_frame_arguments_none
[];
814 /* The possible choices of "set print frame-info". */
815 extern const char print_frame_info_auto
[];
816 extern const char print_frame_info_source_line
[];
817 extern const char print_frame_info_location
[];
818 extern const char print_frame_info_source_and_location
[];
819 extern const char print_frame_info_location_and_address
[];
820 extern const char print_frame_info_short_location
[];
822 /* The possible choices of "set print entry-values". */
823 extern const char print_entry_values_no
[];
824 extern const char print_entry_values_only
[];
825 extern const char print_entry_values_preferred
[];
826 extern const char print_entry_values_if_needed
[];
827 extern const char print_entry_values_both
[];
828 extern const char print_entry_values_compact
[];
829 extern const char print_entry_values_default
[];
831 /* Data for the frame-printing "set print" settings exposed as command
834 struct frame_print_options
836 const char *print_frame_arguments
= print_frame_arguments_scalars
;
837 const char *print_frame_info
= print_frame_info_auto
;
838 const char *print_entry_values
= print_entry_values_default
;
840 /* If true, don't invoke pretty-printers for frame
842 bool print_raw_frame_arguments
;
845 /* The values behind the global "set print ..." settings. */
846 extern frame_print_options user_frame_print_options
;
848 /* Inferior function parameter value read in from a frame. */
852 /* Symbol for this parameter used for example for its name. */
853 struct symbol
*sym
= nullptr;
855 /* Value of the parameter. It is NULL if ERROR is not NULL; if both VAL and
856 ERROR are NULL this parameter's value should not be printed. */
857 struct value
*val
= nullptr;
859 /* String containing the error message, it is more usually NULL indicating no
860 error occured reading this parameter. */
861 gdb::unique_xmalloc_ptr
<char> error
;
863 /* One of the print_entry_values_* entries as appropriate specifically for
864 this frame_arg. It will be different from print_entry_values. With
865 print_entry_values_no this frame_arg should be printed as a normal
866 parameter. print_entry_values_only says it should be printed as entry
867 value parameter. print_entry_values_compact says it should be printed as
868 both as a normal parameter and entry values parameter having the same
869 value - print_entry_values_compact is not permitted fi ui_out_is_mi_like_p
870 (in such case print_entry_values_no and print_entry_values_only is used
871 for each parameter kind specifically. */
872 const char *entry_kind
= nullptr;
875 extern void read_frame_arg (const frame_print_options
&fp_opts
,
876 symbol
*sym
, frame_info
*frame
,
877 struct frame_arg
*argp
,
878 struct frame_arg
*entryargp
);
879 extern void read_frame_local (struct symbol
*sym
, struct frame_info
*frame
,
880 struct frame_arg
*argp
);
882 extern void info_args_command (const char *, int);
884 extern void info_locals_command (const char *, int);
886 extern void return_command (const char *, int);
888 /* Set FRAME's unwinder temporarily, so that we can call a sniffer.
889 If sniffing fails, the caller should be sure to call
890 frame_cleanup_after_sniffer. */
892 extern void frame_prepare_for_sniffer (struct frame_info
*frame
,
893 const struct frame_unwind
*unwind
);
895 /* Clean up after a failed (wrong unwinder) attempt to unwind past
898 extern void frame_cleanup_after_sniffer (struct frame_info
*frame
);
900 /* Notes (cagney/2002-11-27, drow/2003-09-06):
902 You might think that calls to this function can simply be replaced by a
903 call to get_selected_frame().
905 Unfortunately, it isn't that easy.
907 The relevant code needs to be audited to determine if it is
908 possible (or practical) to instead pass the applicable frame in as a
909 parameter. For instance, DEPRECATED_DO_REGISTERS_INFO() relied on
910 the deprecated_selected_frame global, while its replacement,
911 PRINT_REGISTERS_INFO(), is parameterized with the selected frame.
912 The only real exceptions occur at the edge (in the CLI code) where
913 user commands need to pick up the selected frame before proceeding.
915 There are also some functions called with a NULL frame meaning either "the
916 program is not running" or "use the selected frame".
918 This is important. GDB is trying to stamp out the hack:
920 saved_frame = deprecated_safe_get_selected_frame ();
922 hack_using_global_selected_frame ();
923 select_frame (saved_frame);
927 This function calls get_selected_frame if the inferior should have a
928 frame, or returns NULL otherwise. */
930 extern struct frame_info
*deprecated_safe_get_selected_frame (void);
932 /* Create a frame using the specified BASE and PC. */
934 extern struct frame_info
*create_new_frame (CORE_ADDR base
, CORE_ADDR pc
);
936 /* Return true if the frame unwinder for frame FI is UNWINDER; false
939 extern bool frame_unwinder_is (frame_info
*fi
, const frame_unwind
*unwinder
);
941 /* Return the language of FRAME. */
943 extern enum language
get_frame_language (struct frame_info
*frame
);
945 /* Return the first non-tailcall frame above FRAME or FRAME if it is not a
946 tailcall frame. Return NULL if FRAME is the start of a tailcall-only
949 extern struct frame_info
*skip_tailcall_frames (struct frame_info
*frame
);
951 /* Return the first frame above FRAME or FRAME of which the code is
954 extern struct frame_info
*skip_unwritable_frames (struct frame_info
*frame
);
956 /* Data for the "set backtrace" settings. */
958 struct set_backtrace_options
960 /* Flag to indicate whether backtraces should continue past
962 bool backtrace_past_main
= false;
964 /* Flag to indicate whether backtraces should continue past
966 bool backtrace_past_entry
= false;
968 /* Upper bound on the number of backtrace levels. Note this is not
969 exposed as a command option, because "backtrace" and "frame
970 apply" already have other means to set a frame count limit. */
971 unsigned int backtrace_limit
= UINT_MAX
;
974 /* The corresponding option definitions. */
975 extern const gdb::option::option_def set_backtrace_option_defs
[2];
977 /* The values behind the global "set backtrace ..." settings. */
978 extern set_backtrace_options user_set_backtrace_options
;
980 /* Get the number of calls to reinit_frame_cache. */
982 unsigned int get_frame_cache_generation ();
984 /* Mark that the PC value is masked for the previous frame. */
986 extern void set_frame_previous_pc_masked (struct frame_info
*frame
);
988 /* Get whether the PC value is masked for the given frame. */
990 extern bool get_frame_pc_masked (const struct frame_info
*frame
);
993 #endif /* !defined (FRAME_H) */