1 /* Definitions for dealing with stack frames, for GDB, the GNU debugger.
3 Copyright (C) 1986-2014 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 aproaching that. Frame naming
29 get_frame_WHAT...(): Get WHAT from the THIS frame (functionaly
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 non-zero / non-NULL if the
49 request succeeds, zero / NULL otherwize.
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
72 struct symtab_and_line
;
79 /* Status of a given frame's stack. */
81 enum frame_id_stack_status
83 /* Stack address is invalid. E.g., this frame is the outermost
84 (i.e., _start), and the stack hasn't been setup yet. */
85 FID_STACK_INVALID
= 0,
87 /* Stack address is valid, and is found in the stack_addr field. */
90 /* Stack address is unavailable. I.e., there's a valid stack, but
91 we don't know where it is (because memory or registers we'd
92 compute it from were not collected). */
93 FID_STACK_UNAVAILABLE
= -1
96 /* The frame object. */
100 /* The frame object's ID. This provides a per-frame unique identifier
101 that can be used to relocate a `struct frame_info' after a target
102 resume or a frame cache destruct. It of course assumes that the
103 inferior hasn't unwound the stack past that frame. */
107 /* The frame's stack address. This shall be constant through out
108 the lifetime of a frame. Note that this requirement applies to
109 not just the function body, but also the prologue and (in theory
110 at least) the epilogue. Since that value needs to fall either on
111 the boundary, or within the frame's address range, the frame's
112 outer-most address (the inner-most address of the previous frame)
113 is used. Watch out for all the legacy targets that still use the
114 function pointer register or stack pointer register. They are
117 This field is valid only if frame_id.stack_status is
118 FID_STACK_VALID. It will be 0 for other
119 FID_STACK_... statuses. */
120 CORE_ADDR stack_addr
;
122 /* The frame's code address. This shall be constant through out the
123 lifetime of the frame. While the PC (a.k.a. resume address)
124 changes as the function is executed, this code address cannot.
125 Typically, it is set to the address of the entry point of the
126 frame's function (as returned by get_frame_func).
128 For inlined functions (INLINE_DEPTH != 0), this is the address of
129 the first executed instruction in the block corresponding to the
132 This field is valid only if code_addr_p is true. Otherwise, this
133 frame is considered to have a wildcard code address, i.e. one that
134 matches every address value in frame comparisons. */
137 /* The frame's special address. This shall be constant through out the
138 lifetime of the frame. This is used for architectures that may have
139 frames that do not change the stack but are still distinct and have
140 some form of distinct identifier (e.g. the ia64 which uses a 2nd
141 stack for registers). This field is treated as unordered - i.e. will
142 not be used in frame ordering comparisons.
144 This field is valid only if special_addr_p is true. Otherwise, this
145 frame is considered to have a wildcard special address, i.e. one that
146 matches every address value in frame comparisons. */
147 CORE_ADDR special_addr
;
149 /* Flags to indicate the above fields have valid contents. */
150 ENUM_BITFIELD(frame_id_stack_status
) stack_status
: 2;
151 unsigned int code_addr_p
: 1;
152 unsigned int special_addr_p
: 1;
154 /* It is non-zero for a frame made up by GDB without stack data
155 representation in inferior, such as INLINE_FRAME or TAILCALL_FRAME.
156 Caller of inlined function will have it zero, each more inner called frame
157 will have it increasingly one, two etc. Similarly for TAILCALL_FRAME. */
158 int artificial_depth
;
161 /* Methods for constructing and comparing Frame IDs. */
163 /* For convenience. All fields are zero. This means "there is no frame". */
164 extern const struct frame_id null_frame_id
;
166 /* This means "there is no frame ID, but there is a frame". It should be
167 replaced by best-effort frame IDs for the outermost frame, somehow.
168 The implementation is only special_addr_p set. */
169 extern const struct frame_id outer_frame_id
;
171 /* Flag to control debugging. */
173 extern unsigned int frame_debug
;
175 /* Construct a frame ID. The first parameter is the frame's constant
176 stack address (typically the outer-bound), and the second the
177 frame's constant code address (typically the entry point).
178 The special identifier address is set to indicate a wild card. */
179 extern struct frame_id
frame_id_build (CORE_ADDR stack_addr
,
180 CORE_ADDR code_addr
);
182 /* Construct a special frame ID. The first parameter is the frame's constant
183 stack address (typically the outer-bound), the second is the
184 frame's constant code address (typically the entry point),
185 and the third parameter is the frame's special identifier address. */
186 extern struct frame_id
frame_id_build_special (CORE_ADDR stack_addr
,
188 CORE_ADDR special_addr
);
190 /* Construct a frame ID representing a frame where the stack address
191 exists, but is unavailable. CODE_ADDR is the frame's constant code
192 address (typically the entry point). The special identifier
193 address is set to indicate a wild card. */
194 extern struct frame_id
frame_id_build_unavailable_stack (CORE_ADDR code_addr
);
196 /* Construct a frame ID representing a frame where the stack address
197 exists, but is unavailable. CODE_ADDR is the frame's constant code
198 address (typically the entry point). SPECIAL_ADDR is the special
199 identifier address. */
200 extern struct frame_id
201 frame_id_build_unavailable_stack_special (CORE_ADDR code_addr
,
202 CORE_ADDR special_addr
);
204 /* Construct a wild card frame ID. The parameter is the frame's constant
205 stack address (typically the outer-bound). The code address as well
206 as the special identifier address are set to indicate wild cards. */
207 extern struct frame_id
frame_id_build_wild (CORE_ADDR stack_addr
);
209 /* Returns non-zero when L is a valid frame (a valid frame has a
210 non-zero .base). The outermost frame is valid even without an
212 extern int frame_id_p (struct frame_id l
);
214 /* Returns non-zero when L is a valid frame representing a frame made up by GDB
215 without stack data representation in inferior, such as INLINE_FRAME or
217 extern int frame_id_artificial_p (struct frame_id l
);
219 /* Returns non-zero when L and R identify the same frame, or, if
220 either L or R have a zero .func, then the same frame base. */
221 extern int frame_id_eq (struct frame_id l
, struct frame_id r
);
223 /* Write the internal representation of a frame ID on the specified
225 extern void fprint_frame_id (struct ui_file
*file
, struct frame_id id
);
228 /* Frame types. Some are real, some are signal trampolines, and some
229 are completely artificial (dummy). */
233 /* A true stack frame, created by the target program during normal
236 /* A fake frame, created by GDB when performing an inferior function
239 /* A frame representing an inlined function, associated with an
240 upcoming (prev, outer, older) NORMAL_FRAME. */
242 /* A virtual frame of a tail call - see dwarf2_tailcall_frame_unwind. */
244 /* In a signal handler, various OSs handle this in various ways.
245 The main thing is that the frame may be far from normal. */
247 /* Fake frame representing a cross-architecture call. */
249 /* Sentinel or registers frame. This frame obtains register values
250 direct from the inferior's registers. */
254 /* For every stopped thread, GDB tracks two frames: current and
255 selected. Current frame is the inner most frame of the selected
256 thread. Selected frame is the one being examined by the GDB
257 CLI (selected using `up', `down', ...). The frames are created
258 on-demand (via get_prev_frame()) and then held in a frame cache. */
259 /* FIXME: cagney/2002-11-28: Er, there is a lie here. If you do the
260 sequence: `thread 1; up; thread 2; thread 1' you lose thread 1's
261 selected frame. At present GDB only tracks the selected frame of
262 the current thread. But be warned, that might change. */
263 /* FIXME: cagney/2002-11-14: At any time, only one thread's selected
264 and current frame can be active. Switching threads causes gdb to
265 discard all that cached frame information. Ulgh! Instead, current
266 and selected frame should be bound to a thread. */
268 /* On demand, create the inner most frame using information found in
269 the inferior. If the inner most frame can't be created, throw an
271 extern struct frame_info
*get_current_frame (void);
273 /* Does the current target interface have enough state to be able to
274 query the current inferior for frame info, and is the inferior in a
275 state where that is possible? */
276 extern int has_stack_frames (void);
278 /* Invalidates the frame cache (this function should have been called
279 invalidate_cached_frames).
281 FIXME: cagney/2002-11-28: There should be two methods: one that
282 reverts the thread's selected frame back to current frame (for when
283 the inferior resumes) and one that does not (for when the user
284 modifies the target invalidating the frame cache). */
285 extern void reinit_frame_cache (void);
287 /* On demand, create the selected frame and then return it. If the
288 selected frame can not be created, this function prints then throws
289 an error. When MESSAGE is non-NULL, use it for the error message,
290 otherwize use a generic error message. */
291 /* FIXME: cagney/2002-11-28: At present, when there is no selected
292 frame, this function always returns the current (inner most) frame.
293 It should instead, when a thread has previously had its frame
294 selected (but not resumed) and the frame cache invalidated, find
295 and then return that thread's previously selected frame. */
296 extern struct frame_info
*get_selected_frame (const char *message
);
298 /* If there is a selected frame, return it. Otherwise, return NULL. */
299 extern struct frame_info
*get_selected_frame_if_set (void);
301 /* Select a specific frame. NULL, apparently implies re-select the
303 extern void select_frame (struct frame_info
*);
305 /* Given a FRAME, return the next (more inner, younger) or previous
306 (more outer, older) frame. */
307 extern struct frame_info
*get_prev_frame (struct frame_info
*);
308 extern struct frame_info
*get_next_frame (struct frame_info
*);
310 /* Given a frame's ID, relocate the frame. Returns NULL if the frame
312 extern struct frame_info
*frame_find_by_id (struct frame_id id
);
314 /* Base attributes of a frame: */
316 /* The frame's `resume' address. Where the program will resume in
319 This replaced: frame->pc; */
320 extern CORE_ADDR
get_frame_pc (struct frame_info
*);
322 /* Same as get_frame_pc, but return a boolean indication of whether
323 the PC is actually available, instead of throwing an error. */
325 extern int get_frame_pc_if_available (struct frame_info
*frame
,
328 /* An address (not necessarily aligned to an instruction boundary)
329 that falls within THIS frame's code block.
331 When a function call is the last statement in a block, the return
332 address for the call may land at the start of the next block.
333 Similarly, if a no-return function call is the last statement in
334 the function, the return address may end up pointing beyond the
335 function, and possibly at the start of the next function.
337 These methods make an allowance for this. For call frames, this
338 function returns the frame's PC-1 which "should" be an address in
339 the frame's block. */
341 extern CORE_ADDR
get_frame_address_in_block (struct frame_info
*this_frame
);
343 /* Same as get_frame_address_in_block, but returns a boolean
344 indication of whether the frame address is determinable (when the
345 PC is unavailable, it will not be), instead of possibly throwing an
346 error trying to read an unavailable PC. */
349 get_frame_address_in_block_if_available (struct frame_info
*this_frame
,
352 /* The frame's inner-most bound. AKA the stack-pointer. Confusingly
353 known as top-of-stack. */
355 extern CORE_ADDR
get_frame_sp (struct frame_info
*);
357 /* Following on from the `resume' address. Return the entry point
358 address of the function containing that resume address, or zero if
359 that function isn't known. */
360 extern CORE_ADDR
get_frame_func (struct frame_info
*fi
);
362 /* Same as get_frame_func, but returns a boolean indication of whether
363 the frame function is determinable (when the PC is unavailable, it
364 will not be), instead of possibly throwing an error trying to read
365 an unavailable PC. */
367 extern int get_frame_func_if_available (struct frame_info
*fi
, CORE_ADDR
*);
369 /* Closely related to the resume address, various symbol table
370 attributes that are determined by the PC. Note that for a normal
371 frame, the PC refers to the resume address after the return, and
372 not the call instruction. In such a case, the address is adjusted
373 so that it (approximately) identifies the call site (and not the
376 NOTE: cagney/2002-11-28: The frame cache could be used to cache the
377 computed value. Working on the assumption that the bottle-neck is
378 in the single step code, and that code causes the frame cache to be
379 constantly flushed, caching things in a frame is probably of little
380 benefit. As they say `show us the numbers'.
382 NOTE: cagney/2002-11-28: Plenty more where this one came from:
383 find_frame_block(), find_frame_partial_function(),
384 find_frame_symtab(), find_frame_function(). Each will need to be
385 carefully considered to determine if the real intent was for it to
386 apply to the PC or the adjusted PC. */
387 extern void find_frame_sal (struct frame_info
*frame
,
388 struct symtab_and_line
*sal
);
390 /* Set the current source and line to the location given by frame
391 FRAME, if possible. When CENTER is true, adjust so the relevant
392 line is in the center of the next 'list'. */
394 void set_current_sal_from_frame (struct frame_info
*, int);
396 /* Return the frame base (what ever that is) (DEPRECATED).
398 Old code was trying to use this single method for two conflicting
399 purposes. Such code needs to be updated to use either of:
401 get_frame_id: A low level frame unique identifier, that consists of
402 both a stack and a function address, that can be used to uniquely
403 identify a frame. This value is determined by the frame's
404 low-level unwinder, the stack part [typically] being the
405 top-of-stack of the previous frame, and the function part being the
406 function's start address. Since the correct identification of a
407 frameless function requires both a stack and function address,
408 the old get_frame_base method was not sufficient.
410 get_frame_base_address: get_frame_locals_address:
411 get_frame_args_address: A set of high-level debug-info dependant
412 addresses that fall within the frame. These addresses almost
413 certainly will not match the stack address part of a frame ID (as
414 returned by get_frame_base).
416 This replaced: frame->frame; */
418 extern CORE_ADDR
get_frame_base (struct frame_info
*);
420 /* Return the per-frame unique identifer. Can be used to relocate a
421 frame after a frame cache flush (and other similar operations). If
422 FI is NULL, return the null_frame_id.
424 NOTE: kettenis/20040508: These functions return a structure. On
425 platforms where structures are returned in static storage (vax,
426 m68k), this may trigger compiler bugs in code like:
428 if (frame_id_eq (get_frame_id (l), get_frame_id (r)))
430 where the return value from the first get_frame_id (l) gets
431 overwritten by the second get_frame_id (r). Please avoid writing
432 code like this. Use code like:
434 struct frame_id id = get_frame_id (l);
435 if (frame_id_eq (id, get_frame_id (r)))
437 instead, since that avoids the bug. */
438 extern struct frame_id
get_frame_id (struct frame_info
*fi
);
439 extern struct frame_id
get_stack_frame_id (struct frame_info
*fi
);
440 extern struct frame_id
frame_unwind_caller_id (struct frame_info
*next_frame
);
442 /* Assuming that a frame is `normal', return its base-address, or 0 if
443 the information isn't available. NOTE: This address is really only
444 meaningful to the frame's high-level debug info. */
445 extern CORE_ADDR
get_frame_base_address (struct frame_info
*);
447 /* Assuming that a frame is `normal', return the base-address of the
448 local variables, or 0 if the information isn't available. NOTE:
449 This address is really only meaningful to the frame's high-level
450 debug info. Typically, the argument and locals share a single
452 extern CORE_ADDR
get_frame_locals_address (struct frame_info
*);
454 /* Assuming that a frame is `normal', return the base-address of the
455 parameter list, or 0 if that information isn't available. NOTE:
456 This address is really only meaningful to the frame's high-level
457 debug info. Typically, the argument and locals share a single
459 extern CORE_ADDR
get_frame_args_address (struct frame_info
*);
461 /* The frame's level: 0 for innermost, 1 for its caller, ...; or -1
462 for an invalid frame). */
463 extern int frame_relative_level (struct frame_info
*fi
);
465 /* Return the frame's type. */
467 extern enum frame_type
get_frame_type (struct frame_info
*);
469 /* Return the frame's program space. */
470 extern struct program_space
*get_frame_program_space (struct frame_info
*);
472 /* Unwind THIS frame's program space from the NEXT frame. */
473 extern struct program_space
*frame_unwind_program_space (struct frame_info
*);
475 /* Return the frame's address space. */
476 extern struct address_space
*get_frame_address_space (struct frame_info
*);
478 /* For frames where we can not unwind further, describe why. */
480 enum unwind_stop_reason
482 #define SET(name, description) name,
483 #define FIRST_ENTRY(name) UNWIND_FIRST = name,
484 #define LAST_ENTRY(name) UNWIND_LAST = name,
485 #define FIRST_ERROR(name) UNWIND_FIRST_ERROR = name,
487 #include "unwind_stop_reasons.def"
494 /* Return the reason why we can't unwind past this frame. */
496 enum unwind_stop_reason
get_frame_unwind_stop_reason (struct frame_info
*);
498 /* Translate a reason code to an informative string. */
500 const char *frame_stop_reason_string (enum unwind_stop_reason
);
502 /* Unwind the stack frame so that the value of REGNUM, in the previous
503 (up, older) frame is returned. If VALUEP is NULL, don't
504 fetch/compute the value. Instead just return the location of the
506 extern void frame_register_unwind (struct frame_info
*frame
, int regnum
,
507 int *optimizedp
, int *unavailablep
,
508 enum lval_type
*lvalp
,
509 CORE_ADDR
*addrp
, int *realnump
,
512 /* Fetch a register from this, or unwind a register from the next
513 frame. Note that the get_frame methods are wrappers to
514 frame->next->unwind. They all [potentially] throw an error if the
515 fetch fails. The value methods never return NULL, but usually
516 do return a lazy value. */
518 extern void frame_unwind_register (struct frame_info
*frame
,
519 int regnum
, gdb_byte
*buf
);
520 extern void get_frame_register (struct frame_info
*frame
,
521 int regnum
, gdb_byte
*buf
);
523 struct value
*frame_unwind_register_value (struct frame_info
*frame
,
525 struct value
*get_frame_register_value (struct frame_info
*frame
,
528 extern LONGEST
frame_unwind_register_signed (struct frame_info
*frame
,
530 extern LONGEST
get_frame_register_signed (struct frame_info
*frame
,
532 extern ULONGEST
frame_unwind_register_unsigned (struct frame_info
*frame
,
534 extern ULONGEST
get_frame_register_unsigned (struct frame_info
*frame
,
537 /* Read a register from this, or unwind a register from the next
538 frame. Note that the read_frame methods are wrappers to
539 get_frame_register_value, that do not throw if the result is
540 optimized out or unavailable. */
542 extern int read_frame_register_unsigned (struct frame_info
*frame
,
543 int regnum
, ULONGEST
*val
);
545 /* Get the value of the register that belongs to this FRAME. This
546 function is a wrapper to the call sequence ``frame_register_unwind
547 (get_next_frame (FRAME))''. As per frame_register_unwind(), if
548 VALUEP is NULL, the registers value is not fetched/computed. */
550 extern void frame_register (struct frame_info
*frame
, int regnum
,
551 int *optimizedp
, int *unavailablep
,
552 enum lval_type
*lvalp
,
553 CORE_ADDR
*addrp
, int *realnump
,
556 /* The reverse. Store a register value relative to the specified
557 frame. Note: this call makes the frame's state undefined. The
558 register and frame caches must be flushed. */
559 extern void put_frame_register (struct frame_info
*frame
, int regnum
,
560 const gdb_byte
*buf
);
562 /* Read LEN bytes from one or multiple registers starting with REGNUM
563 in frame FRAME, starting at OFFSET, into BUF. If the register
564 contents are optimized out or unavailable, set *OPTIMIZEDP,
565 *UNAVAILABLEP accordingly. */
566 extern int get_frame_register_bytes (struct frame_info
*frame
, int regnum
,
567 CORE_ADDR offset
, int len
,
569 int *optimizedp
, int *unavailablep
);
571 /* Write LEN bytes to one or multiple registers starting with REGNUM
572 in frame FRAME, starting at OFFSET, into BUF. */
573 extern void put_frame_register_bytes (struct frame_info
*frame
, int regnum
,
574 CORE_ADDR offset
, int len
,
575 const gdb_byte
*myaddr
);
577 /* Unwind the PC. Strictly speaking return the resume address of the
578 calling frame. For GDB, `pc' is the resume address and not a
579 specific register. */
581 extern CORE_ADDR
frame_unwind_caller_pc (struct frame_info
*frame
);
583 /* Discard the specified frame. Restoring the registers to the state
585 extern void frame_pop (struct frame_info
*frame
);
587 /* Return memory from the specified frame. A frame knows its thread /
588 LWP and hence can find its way down to a target. The assumption
589 here is that the current and previous frame share a common address
592 If the memory read fails, these methods throw an error.
594 NOTE: cagney/2003-06-03: Should there be unwind versions of these
595 methods? That isn't clear. Can code, for instance, assume that
596 this and the previous frame's memory or architecture are identical?
597 If architecture / memory changes are always separated by special
598 adaptor frames this should be ok. */
600 extern void get_frame_memory (struct frame_info
*this_frame
, CORE_ADDR addr
,
601 gdb_byte
*buf
, int len
);
602 extern LONGEST
get_frame_memory_signed (struct frame_info
*this_frame
,
603 CORE_ADDR memaddr
, int len
);
604 extern ULONGEST
get_frame_memory_unsigned (struct frame_info
*this_frame
,
605 CORE_ADDR memaddr
, int len
);
607 /* Same as above, but return non-zero when the entire memory read
608 succeeds, zero otherwize. */
609 extern int safe_frame_unwind_memory (struct frame_info
*this_frame
,
610 CORE_ADDR addr
, gdb_byte
*buf
, int len
);
612 /* Return this frame's architecture. */
613 extern struct gdbarch
*get_frame_arch (struct frame_info
*this_frame
);
615 /* Return the previous frame's architecture. */
616 extern struct gdbarch
*frame_unwind_arch (struct frame_info
*frame
);
618 /* Return the previous frame's architecture, skipping inline functions. */
619 extern struct gdbarch
*frame_unwind_caller_arch (struct frame_info
*frame
);
622 /* Values for the source flag to be used in print_frame_info_base(). */
625 /* Print only the source line, like in stepi. */
627 /* Print only the location, i.e. level, address (sometimes)
628 function, args, file, line, line num. */
630 /* Print both of the above. */
632 /* Print location only, but always include the address. */
636 /* Allocate zero initialized memory from the frame cache obstack.
637 Appendices to the frame info (such as the unwind cache) should
638 allocate memory using this method. */
640 extern void *frame_obstack_zalloc (unsigned long size
);
641 #define FRAME_OBSTACK_ZALLOC(TYPE) \
642 ((TYPE *) frame_obstack_zalloc (sizeof (TYPE)))
643 #define FRAME_OBSTACK_CALLOC(NUMBER,TYPE) \
644 ((TYPE *) frame_obstack_zalloc ((NUMBER) * sizeof (TYPE)))
646 /* Create a regcache, and copy the frame's registers into it. */
647 struct regcache
*frame_save_as_regcache (struct frame_info
*this_frame
);
649 extern struct block
*get_frame_block (struct frame_info
*,
650 CORE_ADDR
*addr_in_block
);
652 /* Return the `struct block' that belongs to the selected thread's
653 selected frame. If the inferior has no state, return NULL.
655 NOTE: cagney/2002-11-29:
657 No state? Does the inferior have any execution state (a core file
658 does, an executable does not). At present the code tests
659 `target_has_stack' but I'm left wondering if it should test
660 `target_has_registers' or, even, a merged target_has_state.
662 Should it look at the most recently specified SAL? If the target
663 has no state, should this function try to extract a block from the
664 most recently selected SAL? That way `list foo' would give it some
665 sort of reference point. Then again, perhaps that would confuse
668 Calls to this function can be broken down into two categories: Code
669 that uses the selected block as an additional, but optional, data
670 point; Code that uses the selected block as a prop, when it should
671 have the relevant frame/block/pc explicitly passed in.
673 The latter can be eliminated by correctly parameterizing the code,
674 the former though is more interesting. Per the "address" command,
675 it occurs in the CLI code and makes it possible for commands to
676 work, even when the inferior has no state. */
678 extern struct block
*get_selected_block (CORE_ADDR
*addr_in_block
);
680 extern struct symbol
*get_frame_function (struct frame_info
*);
682 extern CORE_ADDR
get_pc_function_start (CORE_ADDR
);
684 extern struct frame_info
*find_relative_frame (struct frame_info
*, int *);
686 extern void print_stack_frame (struct frame_info
*, int print_level
,
687 enum print_what print_what
,
688 int set_current_sal
);
690 extern void print_frame_info (struct frame_info
*, int print_level
,
691 enum print_what print_what
, int args
,
692 int set_current_sal
);
694 extern struct frame_info
*block_innermost_frame (const struct block
*);
696 extern int deprecated_frame_register_read (struct frame_info
*frame
, int regnum
,
701 extern const char print_entry_values_no
[];
702 extern const char print_entry_values_only
[];
703 extern const char print_entry_values_preferred
[];
704 extern const char print_entry_values_if_needed
[];
705 extern const char print_entry_values_both
[];
706 extern const char print_entry_values_compact
[];
707 extern const char print_entry_values_default
[];
708 extern const char *print_entry_values
;
710 /* Inferior function parameter value read in from a frame. */
714 /* Symbol for this parameter used for example for its name. */
717 /* Value of the parameter. It is NULL if ERROR is not NULL; if both VAL and
718 ERROR are NULL this parameter's value should not be printed. */
721 /* String containing the error message, it is more usually NULL indicating no
722 error occured reading this parameter. */
725 /* One of the print_entry_values_* entries as appropriate specifically for
726 this frame_arg. It will be different from print_entry_values. With
727 print_entry_values_no this frame_arg should be printed as a normal
728 parameter. print_entry_values_only says it should be printed as entry
729 value parameter. print_entry_values_compact says it should be printed as
730 both as a normal parameter and entry values parameter having the same
731 value - print_entry_values_compact is not permitted fi ui_out_is_mi_like_p
732 (in such case print_entry_values_no and print_entry_values_only is used
733 for each parameter kind specifically. */
734 const char *entry_kind
;
737 extern void read_frame_arg (struct symbol
*sym
, struct frame_info
*frame
,
738 struct frame_arg
*argp
,
739 struct frame_arg
*entryargp
);
740 extern void read_frame_local (struct symbol
*sym
, struct frame_info
*frame
,
741 struct frame_arg
*argp
);
743 extern void args_info (char *, int);
745 extern void locals_info (char *, int);
747 extern void (*deprecated_selected_frame_level_changed_hook
) (int);
749 extern void return_command (char *, int);
751 /* Set FRAME's unwinder temporarily, so that we can call a sniffer.
752 Return a cleanup which should be called if unwinding fails, and
753 discarded if it succeeds. */
755 struct cleanup
*frame_prepare_for_sniffer (struct frame_info
*frame
,
756 const struct frame_unwind
*unwind
);
758 /* Notes (cagney/2002-11-27, drow/2003-09-06):
760 You might think that calls to this function can simply be replaced by a
761 call to get_selected_frame().
763 Unfortunately, it isn't that easy.
765 The relevant code needs to be audited to determine if it is
766 possible (or practical) to instead pass the applicable frame in as a
767 parameter. For instance, DEPRECATED_DO_REGISTERS_INFO() relied on
768 the deprecated_selected_frame global, while its replacement,
769 PRINT_REGISTERS_INFO(), is parameterized with the selected frame.
770 The only real exceptions occur at the edge (in the CLI code) where
771 user commands need to pick up the selected frame before proceeding.
773 There are also some functions called with a NULL frame meaning either "the
774 program is not running" or "use the selected frame".
776 This is important. GDB is trying to stamp out the hack:
778 saved_frame = deprecated_safe_get_selected_frame ();
780 hack_using_global_selected_frame ();
781 select_frame (saved_frame);
785 This function calls get_selected_frame if the inferior should have a
786 frame, or returns NULL otherwise. */
788 extern struct frame_info
*deprecated_safe_get_selected_frame (void);
790 /* Create a frame using the specified BASE and PC. */
792 extern struct frame_info
*create_new_frame (CORE_ADDR base
, CORE_ADDR pc
);
794 /* Return true if the frame unwinder for frame FI is UNWINDER; false
797 extern int frame_unwinder_is (struct frame_info
*fi
,
798 const struct frame_unwind
*unwinder
);
800 #endif /* !defined (FRAME_H) */