]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gdb/frame.h
2004-08-01 Andrew Cagney <cagney@gnu.org>
[thirdparty/binutils-gdb.git] / gdb / frame.h
CommitLineData
c906108c 1/* Definitions for dealing with stack frames, for GDB, the GNU debugger.
7cc19214
AC
2
3 Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1996,
9564ee9f 4 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
c906108c 5
c5aa993b 6 This file is part of GDB.
c906108c 7
c5aa993b
JM
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 2 of the License, or
11 (at your option) any later version.
c906108c 12
c5aa993b
JM
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.
c906108c 17
c5aa993b
JM
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
c906108c
SS
22
23#if !defined (FRAME_H)
24#define FRAME_H 1
25
f0e7d0e8
AC
26/* The following is the intended naming schema for frame functions.
27 It isn't 100% consistent, but it is aproaching that. Frame naming
28 schema:
29
30 Prefixes:
31
32 get_frame_WHAT...(): Get WHAT from the THIS frame (functionaly
33 equivalent to THIS->next->unwind->what)
34
35 frame_unwind_WHAT...(): Unwind THIS frame's WHAT from the NEXT
36 frame.
37
38 put_frame_WHAT...(): Put a value into this frame (unsafe, need to
39 invalidate the frame / regcache afterwards) (better name more
40 strongly hinting at its unsafeness)
41
42 safe_....(): Safer version of various functions, doesn't throw an
304396fb
AC
43 error (leave this for later?). Returns non-zero / non-NULL if the
44 request succeeds, zero / NULL otherwize.
f0e7d0e8
AC
45
46 Suffixes:
47
48 void /frame/_WHAT(): Read WHAT's value into the buffer parameter.
49
50 ULONGEST /frame/_WHAT_unsigned(): Return an unsigned value (the
51 alternative is *frame_unsigned_WHAT).
52
53 LONGEST /frame/_WHAT_signed(): Return WHAT signed value.
54
55 What:
56
57 /frame/_memory* (frame, coreaddr, len [, buf]): Extract/return
58 *memory.
59
60 /frame/_register* (frame, regnum [, buf]): extract/return register.
61
62 CORE_ADDR /frame/_{pc,sp,...} (frame): Resume address, innner most
63 stack *address, ...
64
65 */
66
1058bca7 67struct symtab_and_line;
494cca16 68struct frame_unwind;
da62e633 69struct frame_base;
fe898f56 70struct block;
cd983b5c 71struct gdbarch;
30e221b4 72struct ui_file;
494cca16 73
c97eb5d9
AC
74/* The frame object. */
75
76struct frame_info;
77
78/* The frame object's ID. This provides a per-frame unique identifier
79 that can be used to relocate a `struct frame_info' after a target
7a424e99
AC
80 resume or a frame cache destruct. It of course assumes that the
81 inferior hasn't unwound the stack past that frame. */
c97eb5d9
AC
82
83struct frame_id
84{
d0a55772
AC
85 /* The frame's stack address. This shall be constant through out
86 the lifetime of a frame. Note that this requirement applies to
87 not just the function body, but also the prologue and (in theory
88 at least) the epilogue. Since that value needs to fall either on
89 the boundary, or within the frame's address range, the frame's
90 outer-most address (the inner-most address of the previous frame)
91 is used. Watch out for all the legacy targets that still use the
92 function pointer register or stack pointer register. They are
12b0b6de
UW
93 wrong.
94
95 This field is valid only if stack_addr_p is true. Otherwise, this
96 frame represents the null frame. */
d0a55772 97 CORE_ADDR stack_addr;
12b0b6de 98
d0a55772
AC
99 /* The frame's code address. This shall be constant through out the
100 lifetime of the frame. While the PC (a.k.a. resume address)
101 changes as the function is executed, this code address cannot.
102 Typically, it is set to the address of the entry point of the
12b0b6de
UW
103 frame's function (as returned by frame_func_unwind().
104
105 This field is valid only if code_addr_p is true. Otherwise, this
106 frame is considered to have a wildcard code address, i.e. one that
107 matches every address value in frame comparisons. */
d0a55772 108 CORE_ADDR code_addr;
12b0b6de 109
48c66725
JJ
110 /* The frame's special address. This shall be constant through out the
111 lifetime of the frame. This is used for architectures that may have
112 frames that do not change the stack but are still distinct and have
113 some form of distinct identifier (e.g. the ia64 which uses a 2nd
114 stack for registers). This field is treated as unordered - i.e. will
115 not be used in frame ordering comparisons such as frame_id_inner().
12b0b6de
UW
116
117 This field is valid only if special_addr_p is true. Otherwise, this
118 frame is considered to have a wildcard special address, i.e. one that
119 matches every address value in frame comparisons. */
48c66725 120 CORE_ADDR special_addr;
12b0b6de
UW
121
122 /* Flags to indicate the above fields have valid contents. */
35809fad
UW
123 unsigned int stack_addr_p : 1;
124 unsigned int code_addr_p : 1;
125 unsigned int special_addr_p : 1;
c97eb5d9
AC
126};
127
7a424e99
AC
128/* Methods for constructing and comparing Frame IDs.
129
48c66725 130 NOTE: Given stackless functions A and B, where A calls B (and hence
7a424e99 131 B is inner-to A). The relationships: !eq(A,B); !eq(B,A);
48c66725
JJ
132 !inner(A,B); !inner(B,A); all hold.
133
134 This is because, while B is inner-to A, B is not strictly inner-to A.
135 Being stackless, they have an identical .stack_addr value, and differ
136 only by their unordered .code_addr and/or .special_addr values.
137
138 Because frame_id_inner is only used as a safety net (e.g.,
139 detect a corrupt stack) the lack of strictness is not a problem.
140 Code needing to determine an exact relationship between two frames
141 must instead use frame_id_eq and frame_id_unwind. For instance,
142 in the above, to determine that A stepped-into B, the equation
143 "A.id != B.id && A.id == id_unwind (B)" can be used. */
7a424e99
AC
144
145/* For convenience. All fields are zero. */
146extern const struct frame_id null_frame_id;
147
d0a55772
AC
148/* Construct a frame ID. The first parameter is the frame's constant
149 stack address (typically the outer-bound), and the second the
12b0b6de
UW
150 frame's constant code address (typically the entry point).
151 The special identifier address is set to indicate a wild card. */
d0a55772
AC
152extern struct frame_id frame_id_build (CORE_ADDR stack_addr,
153 CORE_ADDR code_addr);
7a424e99 154
48c66725
JJ
155/* Construct a special frame ID. The first parameter is the frame's constant
156 stack address (typically the outer-bound), the second is the
12b0b6de
UW
157 frame's constant code address (typically the entry point),
158 and the third parameter is the frame's special identifier address. */
48c66725
JJ
159extern struct frame_id frame_id_build_special (CORE_ADDR stack_addr,
160 CORE_ADDR code_addr,
161 CORE_ADDR special_addr);
162
12b0b6de
UW
163/* Construct a wild card frame ID. The parameter is the frame's constant
164 stack address (typically the outer-bound). The code address as well
165 as the special identifier address are set to indicate wild cards. */
166extern struct frame_id frame_id_build_wild (CORE_ADDR stack_addr);
167
7a424e99
AC
168/* Returns non-zero when L is a valid frame (a valid frame has a
169 non-zero .base). */
170extern int frame_id_p (struct frame_id l);
171
172/* Returns non-zero when L and R identify the same frame, or, if
173 either L or R have a zero .func, then the same frame base. */
174extern int frame_id_eq (struct frame_id l, struct frame_id r);
175
176/* Returns non-zero when L is strictly inner-than R (they have
177 different frame .bases). Neither L, nor R can be `null'. See note
178 above about frameless functions. */
179extern int frame_id_inner (struct frame_id l, struct frame_id r);
180
00905d52
AC
181/* Write the internal representation of a frame ID on the specified
182 stream. */
183extern void fprint_frame_id (struct ui_file *file, struct frame_id id);
184
7a424e99 185
c97eb5d9
AC
186/* For every stopped thread, GDB tracks two frames: current and
187 selected. Current frame is the inner most frame of the selected
abc0af47
AC
188 thread. Selected frame is the one being examined by the the GDB
189 CLI (selected using `up', `down', ...). The frames are created
190 on-demand (via get_prev_frame()) and then held in a frame cache. */
191/* FIXME: cagney/2002-11-28: Er, there is a lie here. If you do the
4a0e2f88 192 sequence: `thread 1; up; thread 2; thread 1' you lose thread 1's
abc0af47
AC
193 selected frame. At present GDB only tracks the selected frame of
194 the current thread. But be warned, that might change. */
c97eb5d9
AC
195/* FIXME: cagney/2002-11-14: At any time, only one thread's selected
196 and current frame can be active. Switching threads causes gdb to
197 discard all that cached frame information. Ulgh! Instead, current
198 and selected frame should be bound to a thread. */
199
abc0af47
AC
200/* On demand, create the inner most frame using information found in
201 the inferior. If the inner most frame can't be created, throw an
202 error. */
c97eb5d9
AC
203extern struct frame_info *get_current_frame (void);
204
abc0af47
AC
205/* Invalidates the frame cache (this function should have been called
206 invalidate_cached_frames).
207
208 FIXME: cagney/2002-11-28: The only difference between
209 flush_cached_frames() and reinit_frame_cache() is that the latter
4a0e2f88 210 explicitly sets the selected frame back to the current frame -- there
abc0af47 211 isn't any real difference (except that one delays the selection of
6e7f8b9c 212 a new frame). Code can instead simply rely on get_selected_frame()
4a0e2f88
JM
213 to reinit the selected frame as needed. As for invalidating the
214 cache, there should be two methods: one that reverts the thread's
6e7f8b9c
AC
215 selected frame back to current frame (for when the inferior
216 resumes) and one that does not (for when the user modifies the
217 target invalidating the frame cache). */
c97eb5d9 218extern void flush_cached_frames (void);
c97eb5d9
AC
219extern void reinit_frame_cache (void);
220
6e7f8b9c
AC
221/* On demand, create the selected frame and then return it. If the
222 selected frame can not be created, this function throws an error. */
223/* FIXME: cagney/2002-11-28: At present, when there is no selected
224 frame, this function always returns the current (inner most) frame.
225 It should instead, when a thread has previously had its frame
226 selected (but not resumed) and the frame cache invalidated, find
227 and then return that thread's previously selected frame. */
228extern struct frame_info *get_selected_frame (void);
229
abc0af47
AC
230/* Select a specific frame. NULL, apparently implies re-select the
231 inner most frame. */
232extern void select_frame (struct frame_info *);
233
c97eb5d9
AC
234/* Given a FRAME, return the next (more inner, younger) or previous
235 (more outer, older) frame. */
236extern struct frame_info *get_prev_frame (struct frame_info *);
237extern struct frame_info *get_next_frame (struct frame_info *);
238
239/* Given a frame's ID, relocate the frame. Returns NULL if the frame
240 is not found. */
241extern struct frame_info *frame_find_by_id (struct frame_id id);
242
243/* Base attributes of a frame: */
244
245/* The frame's `resume' address. Where the program will resume in
ef6e7e13
AC
246 this frame.
247
248 This replaced: frame->pc; */
c97eb5d9
AC
249extern CORE_ADDR get_frame_pc (struct frame_info *);
250
4a0e2f88 251/* An address (not necessarily aligned to an instruction boundary)
8edd5d01
AC
252 that falls within THIS frame's code block.
253
254 When a function call is the last statement in a block, the return
255 address for the call may land at the start of the next block.
256 Similarly, if a no-return function call is the last statement in
257 the function, the return address may end up pointing beyond the
258 function, and possibly at the start of the next function.
259
260 These methods make an allowance for this. For call frames, this
261 function returns the frame's PC-1 which "should" be an address in
262 the frame's block. */
263
264extern CORE_ADDR get_frame_address_in_block (struct frame_info *this_frame);
265extern CORE_ADDR frame_unwind_address_in_block (struct frame_info *next_frame);
266
a9e5fdc2
AC
267/* The frame's inner-most bound. AKA the stack-pointer. Confusingly
268 known as top-of-stack. */
269
270extern CORE_ADDR get_frame_sp (struct frame_info *);
271extern CORE_ADDR frame_sp_unwind (struct frame_info *);
272
273
be41e9f4
AC
274/* Following on from the `resume' address. Return the entry point
275 address of the function containing that resume address, or zero if
276 that function isn't known. */
277extern CORE_ADDR frame_func_unwind (struct frame_info *fi);
278extern CORE_ADDR get_frame_func (struct frame_info *fi);
279
1058bca7
AC
280/* Closely related to the resume address, various symbol table
281 attributes that are determined by the PC. Note that for a normal
282 frame, the PC refers to the resume address after the return, and
283 not the call instruction. In such a case, the address is adjusted
4a0e2f88
JM
284 so that it (approximately) identifies the call site (and not the
285 return site).
1058bca7
AC
286
287 NOTE: cagney/2002-11-28: The frame cache could be used to cache the
288 computed value. Working on the assumption that the bottle-neck is
289 in the single step code, and that code causes the frame cache to be
290 constantly flushed, caching things in a frame is probably of little
291 benefit. As they say `show us the numbers'.
292
293 NOTE: cagney/2002-11-28: Plenty more where this one came from:
294 find_frame_block(), find_frame_partial_function(),
295 find_frame_symtab(), find_frame_function(). Each will need to be
296 carefully considered to determine if the real intent was for it to
297 apply to the PC or the adjusted PC. */
298extern void find_frame_sal (struct frame_info *frame,
299 struct symtab_and_line *sal);
300
da62e633
AC
301/* Return the frame base (what ever that is) (DEPRECATED).
302
303 Old code was trying to use this single method for two conflicting
304 purposes. Such code needs to be updated to use either of:
305
306 get_frame_id: A low level frame unique identifier, that consists of
307 both a stack and a function address, that can be used to uniquely
308 identify a frame. This value is determined by the frame's
309 low-level unwinder, the stack part [typically] being the
310 top-of-stack of the previous frame, and the function part being the
311 function's start address. Since the correct identification of a
312 frameless function requires both the a stack and function address,
313 the old get_frame_base method was not sufficient.
314
315 get_frame_base_address: get_frame_locals_address:
316 get_frame_args_address: A set of high-level debug-info dependant
317 addresses that fall within the frame. These addresses almost
318 certainly will not match the stack address part of a frame ID (as
ef6e7e13
AC
319 returned by get_frame_base).
320
321 This replaced: frame->frame; */
c193f6ac
AC
322
323extern CORE_ADDR get_frame_base (struct frame_info *);
324
c97eb5d9 325/* Return the per-frame unique identifer. Can be used to relocate a
7a424e99 326 frame after a frame cache flush (and other similar operations). If
756e95f1
MK
327 FI is NULL, return the null_frame_id.
328
329 NOTE: kettenis/20040508: These functions return a structure. On
330 platforms where structures are returned in static storage (vax,
331 m68k), this may trigger compiler bugs in code like:
332
333 if (frame_id_eq (get_frame_id (l), get_frame_id (r)))
334
335 where the return value from the first get_frame_id (l) gets
336 overwritten by the second get_frame_id (r). Please avoid writing
337 code like this. Use code like:
338
339 struct frame_id id = get_frame_id (l);
340 if (frame_id_eq (id, get_frame_id (r)))
341
342 instead, since that avoids the bug. */
7a424e99 343extern struct frame_id get_frame_id (struct frame_info *fi);
5613d8d3 344extern struct frame_id frame_unwind_id (struct frame_info *next_frame);
c97eb5d9 345
da62e633
AC
346/* Assuming that a frame is `normal', return its base-address, or 0 if
347 the information isn't available. NOTE: This address is really only
348 meaningful to the frame's high-level debug info. */
349extern CORE_ADDR get_frame_base_address (struct frame_info *);
350
6bfb3e36
AC
351/* Assuming that a frame is `normal', return the base-address of the
352 local variables, or 0 if the information isn't available. NOTE:
da62e633
AC
353 This address is really only meaningful to the frame's high-level
354 debug info. Typically, the argument and locals share a single
355 base-address. */
356extern CORE_ADDR get_frame_locals_address (struct frame_info *);
357
6bfb3e36
AC
358/* Assuming that a frame is `normal', return the base-address of the
359 parameter list, or 0 if that information isn't available. NOTE:
360 This address is really only meaningful to the frame's high-level
361 debug info. Typically, the argument and locals share a single
da62e633
AC
362 base-address. */
363extern CORE_ADDR get_frame_args_address (struct frame_info *);
364
c97eb5d9
AC
365/* The frame's level: 0 for innermost, 1 for its caller, ...; or -1
366 for an invalid frame). */
367extern int frame_relative_level (struct frame_info *fi);
368
5a203e44 369/* Return the frame's type. Some are real, some are signal
9564ee9f 370 trampolines, and some are completely artificial (dummy). */
5a203e44
AC
371
372enum frame_type
373{
374 /* A true stack frame, created by the target program during normal
375 execution. */
376 NORMAL_FRAME,
377 /* A fake frame, created by GDB when performing an inferior function
378 call. */
379 DUMMY_FRAME,
380 /* In a signal handler, various OSs handle this in various ways.
381 The main thing is that the frame may be far from normal. */
0e100dab
AC
382 SIGTRAMP_FRAME,
383 /* Sentinel or registers frame. This frame obtains register values
384 direct from the inferior's registers. */
385 SENTINEL_FRAME
5a203e44
AC
386};
387extern enum frame_type get_frame_type (struct frame_info *);
388
c97eb5d9
AC
389/* Unwind the stack frame so that the value of REGNUM, in the previous
390 (up, older) frame is returned. If VALUEP is NULL, don't
391 fetch/compute the value. Instead just return the location of the
392 value. */
393extern void frame_register_unwind (struct frame_info *frame, int regnum,
394 int *optimizedp, enum lval_type *lvalp,
395 CORE_ADDR *addrp, int *realnump,
396 void *valuep);
397
f0e7d0e8
AC
398/* Fetch a register from this, or unwind a register from the next
399 frame. Note that the get_frame methods are wrappers to
400 frame->next->unwind. They all [potentially] throw an error if the
401 fetch fails. */
c97eb5d9 402
5b181d62
AC
403extern void frame_unwind_register (struct frame_info *frame,
404 int regnum, void *buf);
f0e7d0e8
AC
405extern void get_frame_register (struct frame_info *frame,
406 int regnum, void *buf);
407
408extern LONGEST frame_unwind_register_signed (struct frame_info *frame,
409 int regnum);
410extern LONGEST get_frame_register_signed (struct frame_info *frame,
411 int regnum);
412extern ULONGEST frame_unwind_register_unsigned (struct frame_info *frame,
413 int regnum);
414extern ULONGEST get_frame_register_unsigned (struct frame_info *frame,
415 int regnum);
416
5b181d62 417
f0e7d0e8 418/* Use frame_unwind_register_signed. */
c97eb5d9
AC
419extern void frame_unwind_unsigned_register (struct frame_info *frame,
420 int regnum, ULONGEST *val);
421
422/* Get the value of the register that belongs to this FRAME. This
423 function is a wrapper to the call sequence ``frame_unwind_register
424 (get_next_frame (FRAME))''. As per frame_register_unwind(), if
425 VALUEP is NULL, the registers value is not fetched/computed. */
426
427extern void frame_register (struct frame_info *frame, int regnum,
428 int *optimizedp, enum lval_type *lvalp,
429 CORE_ADDR *addrp, int *realnump,
430 void *valuep);
431
ff2e87ac
AC
432/* The reverse. Store a register value relative to the specified
433 frame. Note: this call makes the frame's state undefined. The
434 register and frame caches must be flushed. */
435extern void put_frame_register (struct frame_info *frame, int regnum,
436 const void *buf);
437
c97eb5d9
AC
438/* Map between a frame register number and its name. A frame register
439 space is a superset of the cooked register space --- it also
5f601589
AC
440 includes builtin registers. If NAMELEN is negative, use the NAME's
441 length when doing the comparison. */
c97eb5d9 442
eb8bc282
AC
443extern int frame_map_name_to_regnum (struct frame_info *frame,
444 const char *name, int namelen);
445extern const char *frame_map_regnum_to_name (struct frame_info *frame,
446 int regnum);
c97eb5d9 447
f18c5a73
AC
448/* Unwind the PC. Strictly speaking return the resume address of the
449 calling frame. For GDB, `pc' is the resume address and not a
450 specific register. */
451
452extern CORE_ADDR frame_pc_unwind (struct frame_info *frame);
453
dbe9fe58
AC
454/* Discard the specified frame. Restoring the registers to the state
455 of the caller. */
456extern void frame_pop (struct frame_info *frame);
457
ae1e7417
AC
458/* Return memory from the specified frame. A frame knows its thread /
459 LWP and hence can find its way down to a target. The assumption
460 here is that the current and previous frame share a common address
461 space.
462
463 If the memory read fails, these methods throw an error.
464
465 NOTE: cagney/2003-06-03: Should there be unwind versions of these
466 methods? That isn't clear. Can code, for instance, assume that
467 this and the previous frame's memory or architecture are identical?
468 If architecture / memory changes are always separated by special
469 adaptor frames this should be ok. */
470
471extern void get_frame_memory (struct frame_info *this_frame, CORE_ADDR addr,
472 void *buf, int len);
473extern LONGEST get_frame_memory_signed (struct frame_info *this_frame,
474 CORE_ADDR memaddr, int len);
475extern ULONGEST get_frame_memory_unsigned (struct frame_info *this_frame,
476 CORE_ADDR memaddr, int len);
477
304396fb
AC
478/* Same as above, but return non-zero when the entire memory read
479 succeeds, zero otherwize. */
480extern int safe_frame_unwind_memory (struct frame_info *this_frame,
481 CORE_ADDR addr, void *buf, int len);
482
ae1e7417
AC
483/* Return this frame's architecture. */
484
485extern struct gdbarch *get_frame_arch (struct frame_info *this_frame);
486
487
4a0e2f88 488/* Values for the source flag to be used in print_frame_info_base(). */
c5394b80
JM
489enum print_what
490 {
491 /* Print only the source line, like in stepi. */
492 SRC_LINE = -1,
493 /* Print only the location, i.e. level, address (sometimes)
494 function, args, file, line, line num. */
495 LOCATION,
496 /* Print both of the above. */
497 SRC_AND_LOC,
498 /* Print location only, but always include the address. */
499 LOC_AND_ADDRESS
500 };
501
64485362
AC
502/* Allocate additional space for appendices to a struct frame_info.
503 NOTE: Much of GDB's code works on the assumption that the allocated
504 saved_regs[] array is the size specified below. If you try to make
4a0e2f88 505 that array smaller, GDB will happily walk off its end. */
c906108c 506
64485362
AC
507#ifdef SIZEOF_FRAME_SAVED_REGS
508#error "SIZEOF_FRAME_SAVED_REGS can not be re-defined"
c906108c 509#endif
64485362
AC
510#define SIZEOF_FRAME_SAVED_REGS \
511 (sizeof (CORE_ADDR) * (NUM_REGS+NUM_PSEUDO_REGS))
512
479ab5a0
AC
513/* Allocate zero initialized memory from the frame cache obstack.
514 Appendices to the frame info (such as the unwind cache) should
515 allocate memory using this method. */
516
517extern void *frame_obstack_zalloc (unsigned long size);
eb4f72c5 518#define FRAME_OBSTACK_ZALLOC(TYPE) ((TYPE *) frame_obstack_zalloc (sizeof (TYPE)))
f75493ed 519#define FRAME_OBSTACK_CALLOC(NUMBER,TYPE) ((TYPE *) frame_obstack_zalloc ((NUMBER) * sizeof (TYPE)))
c906108c 520
a14ed312 521extern void generic_save_dummy_frame_tos (CORE_ADDR sp);
c906108c 522
ae767bfb
JB
523extern struct block *get_frame_block (struct frame_info *,
524 CORE_ADDR *addr_in_block);
c906108c 525
805e2818
AC
526/* Return the `struct block' that belongs to the selected thread's
527 selected frame. If the inferior has no state, return NULL.
528
529 NOTE: cagney/2002-11-29:
530
531 No state? Does the inferior have any execution state (a core file
532 does, an executable does not). At present the code tests
533 `target_has_stack' but I'm left wondering if it should test
534 `target_has_registers' or, even, a merged target_has_state.
535
536 Should it look at the most recently specified SAL? If the target
537 has no state, should this function try to extract a block from the
538 most recently selected SAL? That way `list foo' would give it some
4a0e2f88 539 sort of reference point. Then again, perhaps that would confuse
805e2818
AC
540 things.
541
542 Calls to this function can be broken down into two categories: Code
543 that uses the selected block as an additional, but optional, data
544 point; Code that uses the selected block as a prop, when it should
545 have the relevant frame/block/pc explicitly passed in.
546
547 The latter can be eliminated by correctly parameterizing the code,
548 the former though is more interesting. Per the "address" command,
4a0e2f88 549 it occurs in the CLI code and makes it possible for commands to
805e2818
AC
550 work, even when the inferior has no state. */
551
ae767bfb 552extern struct block *get_selected_block (CORE_ADDR *addr_in_block);
c906108c 553
a14ed312 554extern struct symbol *get_frame_function (struct frame_info *);
c906108c 555
a14ed312 556extern CORE_ADDR get_pc_function_start (CORE_ADDR);
c906108c 557
19772a2c 558extern int legacy_frameless_look_for_prologue (struct frame_info *);
c906108c 559
a14ed312 560extern struct frame_info *find_relative_frame (struct frame_info *, int *);
c906108c 561
0faf0076
AC
562extern void show_and_print_stack_frame (struct frame_info *fi, int print_level,
563 enum print_what print_what);
7a292a7a 564
0faf0076
AC
565extern void print_stack_frame (struct frame_info *, int print_level,
566 enum print_what print_what);
c906108c 567
a14ed312 568extern void show_stack_frame (struct frame_info *);
c906108c 569
0faf0076
AC
570extern void print_frame_info (struct frame_info *, int print_level,
571 enum print_what print_what, int args);
c906108c 572
a14ed312 573extern struct frame_info *block_innermost_frame (struct block *);
c906108c 574
a14ed312 575extern void generic_push_dummy_frame (void);
c906108c 576
30a4a8e0 577extern int deprecated_pc_in_call_dummy (CORE_ADDR pc);
da130f98 578
6096c27a
AC
579extern void generic_save_call_dummy_addr (CORE_ADDR lo, CORE_ADDR hi);
580
5b181d62 581/* FIXME: cagney/2003-02-02: Should be deprecated or replaced with a
7f5f525d
AC
582 function called get_frame_register_p(). This slightly weird (and
583 older) variant of get_frame_register() returns zero (indicating the
584 register is unavailable) if either: the register isn't cached; or
585 the register has been optimized out. Problem is, neither check is
586 exactly correct. A register can't be optimized out (it may not
5b181d62
AC
587 have been saved as part of a function call); The fact that a
588 register isn't in the register cache doesn't mean that the register
589 isn't available (it could have been fetched from memory). */
590
cda5a58a
AC
591extern int frame_register_read (struct frame_info *frame, int regnum,
592 void *buf);
593
36dc181b
EZ
594/* From stack.c. */
595extern void args_info (char *, int);
596
597extern void locals_info (char *, int);
598
9a4105ab 599extern void (*deprecated_selected_frame_level_changed_hook) (int);
36dc181b
EZ
600
601extern void return_command (char *, int);
602
abc0af47
AC
603
604/* NOTE: cagney/2002-11-27:
605
606 You might think that the below global can simply be replaced by a
607 call to either get_selected_frame() or select_frame().
608
ce2826aa 609 Unfortunately, it isn't that easy.
abc0af47
AC
610
611 The relevant code needs to be audited to determine if it is
4a0e2f88 612 possible (or practical) to instead pass the applicable frame in as a
abc0af47 613 parameter. For instance, DEPRECATED_DO_REGISTERS_INFO() relied on
6e7f8b9c 614 the deprecated_selected_frame global, while its replacement,
abc0af47 615 PRINT_REGISTERS_INFO(), is parameterized with the selected frame.
4a0e2f88 616 The only real exceptions occur at the edge (in the CLI code) where
abc0af47
AC
617 user commands need to pick up the selected frame before proceeding.
618
619 This is important. GDB is trying to stamp out the hack:
620
6e7f8b9c
AC
621 saved_frame = deprecated_selected_frame;
622 deprecated_selected_frame = ...;
abc0af47 623 hack_using_global_selected_frame ();
6e7f8b9c 624 deprecated_selected_frame = saved_frame;
abc0af47
AC
625
626 Take care! */
627
6e7f8b9c 628extern struct frame_info *deprecated_selected_frame;
abc0af47 629
7dd88986
DJ
630/* NOTE: drow/2003-09-06:
631
632 This function is "a step sideways" for uses of deprecated_selected_frame.
633 They should be fixed as above, but meanwhile, we needed a solution for
634 cases where functions are called with a NULL frame meaning either "the
635 program is not running" or "use the selected frame". Lazy building of
636 deprecated_selected_frame confuses the situation, because now
637 deprecated_selected_frame can be NULL even when the inferior is running.
638
639 This function calls get_selected_frame if the inferior should have a
640 frame, or returns NULL otherwise. */
641
642extern struct frame_info *deprecated_safe_get_selected_frame (void);
abc0af47 643
18ea5ba4 644/* Create a frame using the specified BASE and PC. */
abc0af47 645
18ea5ba4 646extern struct frame_info *create_new_frame (CORE_ADDR base, CORE_ADDR pc);
abc0af47 647
b87efeee
AC
648/* FIXME: cagney/2002-12-06: Has the PC in the current frame changed?
649 "infrun.c", Thanks to DECR_PC_AFTER_BREAK, can change the PC after
ef6e7e13
AC
650 the initial frame create. This puts things back in sync.
651
652 This replaced: frame->pc = ....; */
2f107107
AC
653extern void deprecated_update_frame_pc_hack (struct frame_info *frame,
654 CORE_ADDR pc);
655
656/* FIXME: cagney/2002-12-18: Has the frame's base changed? Or to be
f3efb16c
MS
657 more exact, was that initial guess at the frame's base as returned
658 by deprecated_read_fp() wrong? If it was, fix it. This shouldn't
0ba6dca9
AC
659 be necessary since the code should be getting the frame's base
660 correct from the outset.
ef6e7e13
AC
661
662 This replaced: frame->frame = ....; */
2f107107
AC
663extern void deprecated_update_frame_base_hack (struct frame_info *frame,
664 CORE_ADDR base);
b87efeee 665
c906108c 666#endif /* !defined (FRAME_H) */