* configure.in: Restore CFLAGS if GM P isn't present.
[deliverable/binutils-gdb.git] / gdb / frame.h
CommitLineData
c906108c 1/* Definitions for dealing with stack frames, for GDB, the GNU debugger.
7cc19214 2
197e01b6 3 Copyright (C) 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
197e01b6
EZ
20 Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, 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 221/* On demand, create the selected frame and then return it. If the
b04f3ab4
AC
222 selected frame can not be created, this function prints then throws
223 an error. When MESSAGE is non-NULL, use it for the error message,
224 otherwize use a generic error message. */
6e7f8b9c
AC
225/* FIXME: cagney/2002-11-28: At present, when there is no selected
226 frame, this function always returns the current (inner most) frame.
227 It should instead, when a thread has previously had its frame
228 selected (but not resumed) and the frame cache invalidated, find
229 and then return that thread's previously selected frame. */
b04f3ab4 230extern struct frame_info *get_selected_frame (const char *message);
6e7f8b9c 231
abc0af47
AC
232/* Select a specific frame. NULL, apparently implies re-select the
233 inner most frame. */
234extern void select_frame (struct frame_info *);
235
c97eb5d9
AC
236/* Given a FRAME, return the next (more inner, younger) or previous
237 (more outer, older) frame. */
238extern struct frame_info *get_prev_frame (struct frame_info *);
239extern struct frame_info *get_next_frame (struct frame_info *);
240
241/* Given a frame's ID, relocate the frame. Returns NULL if the frame
242 is not found. */
243extern struct frame_info *frame_find_by_id (struct frame_id id);
244
245/* Base attributes of a frame: */
246
247/* The frame's `resume' address. Where the program will resume in
ef6e7e13
AC
248 this frame.
249
250 This replaced: frame->pc; */
c97eb5d9
AC
251extern CORE_ADDR get_frame_pc (struct frame_info *);
252
4a0e2f88 253/* An address (not necessarily aligned to an instruction boundary)
8edd5d01
AC
254 that falls within THIS frame's code block.
255
256 When a function call is the last statement in a block, the return
257 address for the call may land at the start of the next block.
258 Similarly, if a no-return function call is the last statement in
259 the function, the return address may end up pointing beyond the
260 function, and possibly at the start of the next function.
261
262 These methods make an allowance for this. For call frames, this
263 function returns the frame's PC-1 which "should" be an address in
264 the frame's block. */
265
266extern CORE_ADDR get_frame_address_in_block (struct frame_info *this_frame);
267extern CORE_ADDR frame_unwind_address_in_block (struct frame_info *next_frame);
268
a9e5fdc2
AC
269/* The frame's inner-most bound. AKA the stack-pointer. Confusingly
270 known as top-of-stack. */
271
272extern CORE_ADDR get_frame_sp (struct frame_info *);
273extern CORE_ADDR frame_sp_unwind (struct frame_info *);
274
275
be41e9f4
AC
276/* Following on from the `resume' address. Return the entry point
277 address of the function containing that resume address, or zero if
278 that function isn't known. */
279extern CORE_ADDR frame_func_unwind (struct frame_info *fi);
280extern CORE_ADDR get_frame_func (struct frame_info *fi);
281
1058bca7
AC
282/* Closely related to the resume address, various symbol table
283 attributes that are determined by the PC. Note that for a normal
284 frame, the PC refers to the resume address after the return, and
285 not the call instruction. In such a case, the address is adjusted
4a0e2f88
JM
286 so that it (approximately) identifies the call site (and not the
287 return site).
1058bca7
AC
288
289 NOTE: cagney/2002-11-28: The frame cache could be used to cache the
290 computed value. Working on the assumption that the bottle-neck is
291 in the single step code, and that code causes the frame cache to be
292 constantly flushed, caching things in a frame is probably of little
293 benefit. As they say `show us the numbers'.
294
295 NOTE: cagney/2002-11-28: Plenty more where this one came from:
296 find_frame_block(), find_frame_partial_function(),
297 find_frame_symtab(), find_frame_function(). Each will need to be
298 carefully considered to determine if the real intent was for it to
299 apply to the PC or the adjusted PC. */
300extern void find_frame_sal (struct frame_info *frame,
301 struct symtab_and_line *sal);
302
7abfe014
DJ
303/* Set the current source and line to the location given by frame
304 FRAME, if possible. When CENTER is true, adjust so the relevant
305 line is in the center of the next 'list'. */
306
307void set_current_sal_from_frame (struct frame_info *, int);
308
da62e633
AC
309/* Return the frame base (what ever that is) (DEPRECATED).
310
311 Old code was trying to use this single method for two conflicting
312 purposes. Such code needs to be updated to use either of:
313
314 get_frame_id: A low level frame unique identifier, that consists of
315 both a stack and a function address, that can be used to uniquely
316 identify a frame. This value is determined by the frame's
317 low-level unwinder, the stack part [typically] being the
318 top-of-stack of the previous frame, and the function part being the
319 function's start address. Since the correct identification of a
320 frameless function requires both the a stack and function address,
321 the old get_frame_base method was not sufficient.
322
323 get_frame_base_address: get_frame_locals_address:
324 get_frame_args_address: A set of high-level debug-info dependant
325 addresses that fall within the frame. These addresses almost
326 certainly will not match the stack address part of a frame ID (as
ef6e7e13
AC
327 returned by get_frame_base).
328
329 This replaced: frame->frame; */
c193f6ac
AC
330
331extern CORE_ADDR get_frame_base (struct frame_info *);
332
c97eb5d9 333/* Return the per-frame unique identifer. Can be used to relocate a
7a424e99 334 frame after a frame cache flush (and other similar operations). If
756e95f1
MK
335 FI is NULL, return the null_frame_id.
336
337 NOTE: kettenis/20040508: These functions return a structure. On
338 platforms where structures are returned in static storage (vax,
339 m68k), this may trigger compiler bugs in code like:
340
341 if (frame_id_eq (get_frame_id (l), get_frame_id (r)))
342
343 where the return value from the first get_frame_id (l) gets
344 overwritten by the second get_frame_id (r). Please avoid writing
345 code like this. Use code like:
346
347 struct frame_id id = get_frame_id (l);
348 if (frame_id_eq (id, get_frame_id (r)))
349
350 instead, since that avoids the bug. */
7a424e99 351extern struct frame_id get_frame_id (struct frame_info *fi);
5613d8d3 352extern struct frame_id frame_unwind_id (struct frame_info *next_frame);
c97eb5d9 353
da62e633
AC
354/* Assuming that a frame is `normal', return its base-address, or 0 if
355 the information isn't available. NOTE: This address is really only
356 meaningful to the frame's high-level debug info. */
357extern CORE_ADDR get_frame_base_address (struct frame_info *);
358
6bfb3e36
AC
359/* Assuming that a frame is `normal', return the base-address of the
360 local variables, or 0 if the information isn't available. NOTE:
da62e633
AC
361 This address is really only meaningful to the frame's high-level
362 debug info. Typically, the argument and locals share a single
363 base-address. */
364extern CORE_ADDR get_frame_locals_address (struct frame_info *);
365
6bfb3e36
AC
366/* Assuming that a frame is `normal', return the base-address of the
367 parameter list, or 0 if that information isn't available. NOTE:
368 This address is really only meaningful to the frame's high-level
369 debug info. Typically, the argument and locals share a single
da62e633
AC
370 base-address. */
371extern CORE_ADDR get_frame_args_address (struct frame_info *);
372
c97eb5d9
AC
373/* The frame's level: 0 for innermost, 1 for its caller, ...; or -1
374 for an invalid frame). */
375extern int frame_relative_level (struct frame_info *fi);
376
5a203e44 377/* Return the frame's type. Some are real, some are signal
9564ee9f 378 trampolines, and some are completely artificial (dummy). */
5a203e44
AC
379
380enum frame_type
381{
382 /* A true stack frame, created by the target program during normal
383 execution. */
384 NORMAL_FRAME,
385 /* A fake frame, created by GDB when performing an inferior function
386 call. */
387 DUMMY_FRAME,
388 /* In a signal handler, various OSs handle this in various ways.
389 The main thing is that the frame may be far from normal. */
0e100dab
AC
390 SIGTRAMP_FRAME,
391 /* Sentinel or registers frame. This frame obtains register values
392 direct from the inferior's registers. */
393 SENTINEL_FRAME
5a203e44
AC
394};
395extern enum frame_type get_frame_type (struct frame_info *);
396
c97eb5d9
AC
397/* Unwind the stack frame so that the value of REGNUM, in the previous
398 (up, older) frame is returned. If VALUEP is NULL, don't
399 fetch/compute the value. Instead just return the location of the
400 value. */
401extern void frame_register_unwind (struct frame_info *frame, int regnum,
402 int *optimizedp, enum lval_type *lvalp,
403 CORE_ADDR *addrp, int *realnump,
10c42a71 404 gdb_byte *valuep);
c97eb5d9 405
f0e7d0e8
AC
406/* Fetch a register from this, or unwind a register from the next
407 frame. Note that the get_frame methods are wrappers to
408 frame->next->unwind. They all [potentially] throw an error if the
409 fetch fails. */
c97eb5d9 410
5b181d62 411extern void frame_unwind_register (struct frame_info *frame,
10c42a71 412 int regnum, gdb_byte *buf);
f0e7d0e8 413extern void get_frame_register (struct frame_info *frame,
10c42a71 414 int regnum, gdb_byte *buf);
f0e7d0e8
AC
415
416extern LONGEST frame_unwind_register_signed (struct frame_info *frame,
417 int regnum);
418extern LONGEST get_frame_register_signed (struct frame_info *frame,
419 int regnum);
420extern ULONGEST frame_unwind_register_unsigned (struct frame_info *frame,
421 int regnum);
422extern ULONGEST get_frame_register_unsigned (struct frame_info *frame,
423 int regnum);
424
5b181d62 425
f0e7d0e8 426/* Use frame_unwind_register_signed. */
c97eb5d9
AC
427extern void frame_unwind_unsigned_register (struct frame_info *frame,
428 int regnum, ULONGEST *val);
429
430/* Get the value of the register that belongs to this FRAME. This
7c679d16 431 function is a wrapper to the call sequence ``frame_register_unwind
c97eb5d9
AC
432 (get_next_frame (FRAME))''. As per frame_register_unwind(), if
433 VALUEP is NULL, the registers value is not fetched/computed. */
434
435extern void frame_register (struct frame_info *frame, int regnum,
436 int *optimizedp, enum lval_type *lvalp,
437 CORE_ADDR *addrp, int *realnump,
10c42a71 438 gdb_byte *valuep);
c97eb5d9 439
ff2e87ac
AC
440/* The reverse. Store a register value relative to the specified
441 frame. Note: this call makes the frame's state undefined. The
442 register and frame caches must be flushed. */
443extern void put_frame_register (struct frame_info *frame, int regnum,
10c42a71 444 const gdb_byte *buf);
ff2e87ac 445
c97eb5d9
AC
446/* Map between a frame register number and its name. A frame register
447 space is a superset of the cooked register space --- it also
5f601589
AC
448 includes builtin registers. If NAMELEN is negative, use the NAME's
449 length when doing the comparison. */
c97eb5d9 450
eb8bc282
AC
451extern int frame_map_name_to_regnum (struct frame_info *frame,
452 const char *name, int namelen);
453extern const char *frame_map_regnum_to_name (struct frame_info *frame,
454 int regnum);
c97eb5d9 455
f18c5a73
AC
456/* Unwind the PC. Strictly speaking return the resume address of the
457 calling frame. For GDB, `pc' is the resume address and not a
458 specific register. */
459
460extern CORE_ADDR frame_pc_unwind (struct frame_info *frame);
461
dbe9fe58
AC
462/* Discard the specified frame. Restoring the registers to the state
463 of the caller. */
464extern void frame_pop (struct frame_info *frame);
465
ae1e7417
AC
466/* Return memory from the specified frame. A frame knows its thread /
467 LWP and hence can find its way down to a target. The assumption
468 here is that the current and previous frame share a common address
469 space.
470
471 If the memory read fails, these methods throw an error.
472
473 NOTE: cagney/2003-06-03: Should there be unwind versions of these
474 methods? That isn't clear. Can code, for instance, assume that
475 this and the previous frame's memory or architecture are identical?
476 If architecture / memory changes are always separated by special
477 adaptor frames this should be ok. */
478
479extern void get_frame_memory (struct frame_info *this_frame, CORE_ADDR addr,
10c42a71 480 gdb_byte *buf, int len);
ae1e7417
AC
481extern LONGEST get_frame_memory_signed (struct frame_info *this_frame,
482 CORE_ADDR memaddr, int len);
483extern ULONGEST get_frame_memory_unsigned (struct frame_info *this_frame,
484 CORE_ADDR memaddr, int len);
485
304396fb
AC
486/* Same as above, but return non-zero when the entire memory read
487 succeeds, zero otherwize. */
488extern int safe_frame_unwind_memory (struct frame_info *this_frame,
10c42a71 489 CORE_ADDR addr, gdb_byte *buf, int len);
304396fb 490
ae1e7417
AC
491/* Return this frame's architecture. */
492
493extern struct gdbarch *get_frame_arch (struct frame_info *this_frame);
494
495
4a0e2f88 496/* Values for the source flag to be used in print_frame_info_base(). */
c5394b80
JM
497enum print_what
498 {
499 /* Print only the source line, like in stepi. */
500 SRC_LINE = -1,
501 /* Print only the location, i.e. level, address (sometimes)
502 function, args, file, line, line num. */
503 LOCATION,
504 /* Print both of the above. */
505 SRC_AND_LOC,
506 /* Print location only, but always include the address. */
507 LOC_AND_ADDRESS
508 };
509
64485362
AC
510/* Allocate additional space for appendices to a struct frame_info.
511 NOTE: Much of GDB's code works on the assumption that the allocated
512 saved_regs[] array is the size specified below. If you try to make
4a0e2f88 513 that array smaller, GDB will happily walk off its end. */
c906108c 514
64485362
AC
515#ifdef SIZEOF_FRAME_SAVED_REGS
516#error "SIZEOF_FRAME_SAVED_REGS can not be re-defined"
c906108c 517#endif
64485362
AC
518#define SIZEOF_FRAME_SAVED_REGS \
519 (sizeof (CORE_ADDR) * (NUM_REGS+NUM_PSEUDO_REGS))
520
479ab5a0
AC
521/* Allocate zero initialized memory from the frame cache obstack.
522 Appendices to the frame info (such as the unwind cache) should
523 allocate memory using this method. */
524
525extern void *frame_obstack_zalloc (unsigned long size);
eb4f72c5 526#define FRAME_OBSTACK_ZALLOC(TYPE) ((TYPE *) frame_obstack_zalloc (sizeof (TYPE)))
f75493ed 527#define FRAME_OBSTACK_CALLOC(NUMBER,TYPE) ((TYPE *) frame_obstack_zalloc ((NUMBER) * sizeof (TYPE)))
c906108c 528
a81dcb05
AC
529/* Create a regcache, and copy the frame's registers into it. */
530struct regcache *frame_save_as_regcache (struct frame_info *this_frame);
531
ae767bfb
JB
532extern struct block *get_frame_block (struct frame_info *,
533 CORE_ADDR *addr_in_block);
c906108c 534
805e2818
AC
535/* Return the `struct block' that belongs to the selected thread's
536 selected frame. If the inferior has no state, return NULL.
537
538 NOTE: cagney/2002-11-29:
539
540 No state? Does the inferior have any execution state (a core file
541 does, an executable does not). At present the code tests
542 `target_has_stack' but I'm left wondering if it should test
543 `target_has_registers' or, even, a merged target_has_state.
544
545 Should it look at the most recently specified SAL? If the target
546 has no state, should this function try to extract a block from the
547 most recently selected SAL? That way `list foo' would give it some
4a0e2f88 548 sort of reference point. Then again, perhaps that would confuse
805e2818
AC
549 things.
550
551 Calls to this function can be broken down into two categories: Code
552 that uses the selected block as an additional, but optional, data
553 point; Code that uses the selected block as a prop, when it should
554 have the relevant frame/block/pc explicitly passed in.
555
556 The latter can be eliminated by correctly parameterizing the code,
557 the former though is more interesting. Per the "address" command,
4a0e2f88 558 it occurs in the CLI code and makes it possible for commands to
805e2818
AC
559 work, even when the inferior has no state. */
560
ae767bfb 561extern struct block *get_selected_block (CORE_ADDR *addr_in_block);
c906108c 562
a14ed312 563extern struct symbol *get_frame_function (struct frame_info *);
c906108c 564
a14ed312 565extern CORE_ADDR get_pc_function_start (CORE_ADDR);
c906108c 566
a14ed312 567extern struct frame_info *find_relative_frame (struct frame_info *, int *);
c906108c 568
0faf0076
AC
569extern void show_and_print_stack_frame (struct frame_info *fi, int print_level,
570 enum print_what print_what);
7a292a7a 571
0faf0076
AC
572extern void print_stack_frame (struct frame_info *, int print_level,
573 enum print_what print_what);
c906108c 574
a14ed312 575extern void show_stack_frame (struct frame_info *);
c906108c 576
0faf0076
AC
577extern void print_frame_info (struct frame_info *, int print_level,
578 enum print_what print_what, int args);
c906108c 579
a14ed312 580extern struct frame_info *block_innermost_frame (struct block *);
c906108c 581
30a4a8e0 582extern int deprecated_pc_in_call_dummy (CORE_ADDR pc);
da130f98 583
5b181d62 584/* FIXME: cagney/2003-02-02: Should be deprecated or replaced with a
7f5f525d
AC
585 function called get_frame_register_p(). This slightly weird (and
586 older) variant of get_frame_register() returns zero (indicating the
587 register is unavailable) if either: the register isn't cached; or
588 the register has been optimized out. Problem is, neither check is
589 exactly correct. A register can't be optimized out (it may not
5b181d62
AC
590 have been saved as part of a function call); The fact that a
591 register isn't in the register cache doesn't mean that the register
592 isn't available (it could have been fetched from memory). */
593
cda5a58a 594extern int frame_register_read (struct frame_info *frame, int regnum,
10c42a71 595 gdb_byte *buf);
cda5a58a 596
36dc181b
EZ
597/* From stack.c. */
598extern void args_info (char *, int);
599
600extern void locals_info (char *, int);
601
9a4105ab 602extern void (*deprecated_selected_frame_level_changed_hook) (int);
36dc181b
EZ
603
604extern void return_command (char *, int);
605
abc0af47
AC
606
607/* NOTE: cagney/2002-11-27:
608
609 You might think that the below global can simply be replaced by a
610 call to either get_selected_frame() or select_frame().
611
ce2826aa 612 Unfortunately, it isn't that easy.
abc0af47
AC
613
614 The relevant code needs to be audited to determine if it is
4a0e2f88 615 possible (or practical) to instead pass the applicable frame in as a
abc0af47 616 parameter. For instance, DEPRECATED_DO_REGISTERS_INFO() relied on
6e7f8b9c 617 the deprecated_selected_frame global, while its replacement,
abc0af47 618 PRINT_REGISTERS_INFO(), is parameterized with the selected frame.
4a0e2f88 619 The only real exceptions occur at the edge (in the CLI code) where
abc0af47
AC
620 user commands need to pick up the selected frame before proceeding.
621
622 This is important. GDB is trying to stamp out the hack:
623
6e7f8b9c
AC
624 saved_frame = deprecated_selected_frame;
625 deprecated_selected_frame = ...;
abc0af47 626 hack_using_global_selected_frame ();
6e7f8b9c 627 deprecated_selected_frame = saved_frame;
abc0af47
AC
628
629 Take care! */
630
6e7f8b9c 631extern struct frame_info *deprecated_selected_frame;
abc0af47 632
7dd88986
DJ
633/* NOTE: drow/2003-09-06:
634
635 This function is "a step sideways" for uses of deprecated_selected_frame.
636 They should be fixed as above, but meanwhile, we needed a solution for
637 cases where functions are called with a NULL frame meaning either "the
638 program is not running" or "use the selected frame". Lazy building of
639 deprecated_selected_frame confuses the situation, because now
640 deprecated_selected_frame can be NULL even when the inferior is running.
641
642 This function calls get_selected_frame if the inferior should have a
643 frame, or returns NULL otherwise. */
644
645extern struct frame_info *deprecated_safe_get_selected_frame (void);
abc0af47 646
18ea5ba4 647/* Create a frame using the specified BASE and PC. */
abc0af47 648
18ea5ba4 649extern struct frame_info *create_new_frame (CORE_ADDR base, CORE_ADDR pc);
abc0af47 650
b87efeee
AC
651/* FIXME: cagney/2002-12-06: Has the PC in the current frame changed?
652 "infrun.c", Thanks to DECR_PC_AFTER_BREAK, can change the PC after
ef6e7e13
AC
653 the initial frame create. This puts things back in sync.
654
655 This replaced: frame->pc = ....; */
2f107107
AC
656extern void deprecated_update_frame_pc_hack (struct frame_info *frame,
657 CORE_ADDR pc);
658
659/* FIXME: cagney/2002-12-18: Has the frame's base changed? Or to be
f3efb16c 660 more exact, was that initial guess at the frame's base as returned
9c8dbfa9 661 by the deleted read_fp() wrong? If it was, fix it. This shouldn't
0ba6dca9
AC
662 be necessary since the code should be getting the frame's base
663 correct from the outset.
ef6e7e13
AC
664
665 This replaced: frame->frame = ....; */
2f107107
AC
666extern void deprecated_update_frame_base_hack (struct frame_info *frame,
667 CORE_ADDR base);
b87efeee 668
c906108c 669#endif /* !defined (FRAME_H) */
This page took 0.497085 seconds and 4 git commands to generate.