daily update
[deliverable/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,
51603483 4 1997, 1998, 1999, 2000, 2001, 2002, 2003 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
1058bca7 26struct symtab_and_line;
494cca16 27struct frame_unwind;
da62e633 28struct frame_base;
fe898f56 29struct block;
cd983b5c 30struct gdbarch;
494cca16 31
6dc42492
AC
32/* A legacy unwinder to prop up architectures using the old style
33 saved regs array. */
34extern const struct frame_unwind *legacy_saved_regs_unwind;
1058bca7 35
c97eb5d9
AC
36/* The frame object. */
37
38struct frame_info;
39
40/* The frame object's ID. This provides a per-frame unique identifier
41 that can be used to relocate a `struct frame_info' after a target
7a424e99
AC
42 resume or a frame cache destruct. It of course assumes that the
43 inferior hasn't unwound the stack past that frame. */
c97eb5d9
AC
44
45struct frame_id
46{
d0a55772
AC
47 /* The frame's stack address. This shall be constant through out
48 the lifetime of a frame. Note that this requirement applies to
49 not just the function body, but also the prologue and (in theory
50 at least) the epilogue. Since that value needs to fall either on
51 the boundary, or within the frame's address range, the frame's
52 outer-most address (the inner-most address of the previous frame)
53 is used. Watch out for all the legacy targets that still use the
54 function pointer register or stack pointer register. They are
55 wrong. */
c97eb5d9
AC
56 /* NOTE: cagney/2002-11-16: The ia64 has two stacks and hence two
57 frame bases. This will need to be expanded to accomodate that. */
d0a55772
AC
58 CORE_ADDR stack_addr;
59 /* The frame's code address. This shall be constant through out the
60 lifetime of the frame. While the PC (a.k.a. resume address)
61 changes as the function is executed, this code address cannot.
62 Typically, it is set to the address of the entry point of the
63 frame's function (as returned by frame_func_unwind(). */
64 CORE_ADDR code_addr;
c97eb5d9
AC
65};
66
7a424e99
AC
67/* Methods for constructing and comparing Frame IDs.
68
69 NOTE: Given frameless functions A and B, where A calls B (and hence
70 B is inner-to A). The relationships: !eq(A,B); !eq(B,A);
71 !inner(A,B); !inner(B,A); all hold. This is because, while B is
72 inner to A, B is not strictly inner to A (being frameless, they
73 have the same .base value). */
74
75/* For convenience. All fields are zero. */
76extern const struct frame_id null_frame_id;
77
d0a55772
AC
78/* Construct a frame ID. The first parameter is the frame's constant
79 stack address (typically the outer-bound), and the second the
80 frame's constant code address (typically the entry point) (or zero,
81 to indicate a wild card). */
82extern struct frame_id frame_id_build (CORE_ADDR stack_addr,
83 CORE_ADDR code_addr);
7a424e99
AC
84
85/* Returns non-zero when L is a valid frame (a valid frame has a
86 non-zero .base). */
87extern int frame_id_p (struct frame_id l);
88
89/* Returns non-zero when L and R identify the same frame, or, if
90 either L or R have a zero .func, then the same frame base. */
91extern int frame_id_eq (struct frame_id l, struct frame_id r);
92
93/* Returns non-zero when L is strictly inner-than R (they have
94 different frame .bases). Neither L, nor R can be `null'. See note
95 above about frameless functions. */
96extern int frame_id_inner (struct frame_id l, struct frame_id r);
97
00905d52
AC
98/* Write the internal representation of a frame ID on the specified
99 stream. */
100extern void fprint_frame_id (struct ui_file *file, struct frame_id id);
101
7a424e99 102
c97eb5d9
AC
103/* For every stopped thread, GDB tracks two frames: current and
104 selected. Current frame is the inner most frame of the selected
abc0af47
AC
105 thread. Selected frame is the one being examined by the the GDB
106 CLI (selected using `up', `down', ...). The frames are created
107 on-demand (via get_prev_frame()) and then held in a frame cache. */
108/* FIXME: cagney/2002-11-28: Er, there is a lie here. If you do the
109 sequence: `thread 1; up; thread 2; thread 1' you loose thread 1's
110 selected frame. At present GDB only tracks the selected frame of
111 the current thread. But be warned, that might change. */
c97eb5d9
AC
112/* FIXME: cagney/2002-11-14: At any time, only one thread's selected
113 and current frame can be active. Switching threads causes gdb to
114 discard all that cached frame information. Ulgh! Instead, current
115 and selected frame should be bound to a thread. */
116
abc0af47
AC
117/* On demand, create the inner most frame using information found in
118 the inferior. If the inner most frame can't be created, throw an
119 error. */
c97eb5d9
AC
120extern struct frame_info *get_current_frame (void);
121
abc0af47
AC
122/* Invalidates the frame cache (this function should have been called
123 invalidate_cached_frames).
124
125 FIXME: cagney/2002-11-28: The only difference between
126 flush_cached_frames() and reinit_frame_cache() is that the latter
127 explicitly sets the selected frame back to the current frame there
128 isn't any real difference (except that one delays the selection of
6e7f8b9c
AC
129 a new frame). Code can instead simply rely on get_selected_frame()
130 to reinit's the selected frame as needed. As for invalidating the
131 cache, there should be two methods one that reverts the thread's
132 selected frame back to current frame (for when the inferior
133 resumes) and one that does not (for when the user modifies the
134 target invalidating the frame cache). */
c97eb5d9 135extern void flush_cached_frames (void);
c97eb5d9
AC
136extern void reinit_frame_cache (void);
137
6e7f8b9c
AC
138/* On demand, create the selected frame and then return it. If the
139 selected frame can not be created, this function throws an error. */
140/* FIXME: cagney/2002-11-28: At present, when there is no selected
141 frame, this function always returns the current (inner most) frame.
142 It should instead, when a thread has previously had its frame
143 selected (but not resumed) and the frame cache invalidated, find
144 and then return that thread's previously selected frame. */
145extern struct frame_info *get_selected_frame (void);
146
abc0af47
AC
147/* Select a specific frame. NULL, apparently implies re-select the
148 inner most frame. */
149extern void select_frame (struct frame_info *);
150
c97eb5d9
AC
151/* Given a FRAME, return the next (more inner, younger) or previous
152 (more outer, older) frame. */
153extern struct frame_info *get_prev_frame (struct frame_info *);
154extern struct frame_info *get_next_frame (struct frame_info *);
155
156/* Given a frame's ID, relocate the frame. Returns NULL if the frame
157 is not found. */
158extern struct frame_info *frame_find_by_id (struct frame_id id);
159
160/* Base attributes of a frame: */
161
162/* The frame's `resume' address. Where the program will resume in
ef6e7e13
AC
163 this frame.
164
165 This replaced: frame->pc; */
c97eb5d9
AC
166extern CORE_ADDR get_frame_pc (struct frame_info *);
167
be41e9f4
AC
168/* Following on from the `resume' address. Return the entry point
169 address of the function containing that resume address, or zero if
170 that function isn't known. */
171extern CORE_ADDR frame_func_unwind (struct frame_info *fi);
172extern CORE_ADDR get_frame_func (struct frame_info *fi);
173
1058bca7
AC
174/* Closely related to the resume address, various symbol table
175 attributes that are determined by the PC. Note that for a normal
176 frame, the PC refers to the resume address after the return, and
177 not the call instruction. In such a case, the address is adjusted
178 so that it (approximatly) identifies the call site (and not return
179 site).
180
181 NOTE: cagney/2002-11-28: The frame cache could be used to cache the
182 computed value. Working on the assumption that the bottle-neck is
183 in the single step code, and that code causes the frame cache to be
184 constantly flushed, caching things in a frame is probably of little
185 benefit. As they say `show us the numbers'.
186
187 NOTE: cagney/2002-11-28: Plenty more where this one came from:
188 find_frame_block(), find_frame_partial_function(),
189 find_frame_symtab(), find_frame_function(). Each will need to be
190 carefully considered to determine if the real intent was for it to
191 apply to the PC or the adjusted PC. */
192extern void find_frame_sal (struct frame_info *frame,
193 struct symtab_and_line *sal);
194
da62e633
AC
195/* Return the frame base (what ever that is) (DEPRECATED).
196
197 Old code was trying to use this single method for two conflicting
198 purposes. Such code needs to be updated to use either of:
199
200 get_frame_id: A low level frame unique identifier, that consists of
201 both a stack and a function address, that can be used to uniquely
202 identify a frame. This value is determined by the frame's
203 low-level unwinder, the stack part [typically] being the
204 top-of-stack of the previous frame, and the function part being the
205 function's start address. Since the correct identification of a
206 frameless function requires both the a stack and function address,
207 the old get_frame_base method was not sufficient.
208
209 get_frame_base_address: get_frame_locals_address:
210 get_frame_args_address: A set of high-level debug-info dependant
211 addresses that fall within the frame. These addresses almost
212 certainly will not match the stack address part of a frame ID (as
ef6e7e13
AC
213 returned by get_frame_base).
214
215 This replaced: frame->frame; */
c193f6ac
AC
216
217extern CORE_ADDR get_frame_base (struct frame_info *);
218
c97eb5d9 219/* Return the per-frame unique identifer. Can be used to relocate a
7a424e99
AC
220 frame after a frame cache flush (and other similar operations). If
221 FI is NULL, return the null_frame_id. */
222extern struct frame_id get_frame_id (struct frame_info *fi);
c97eb5d9 223
da62e633
AC
224/* Assuming that a frame is `normal', return its base-address, or 0 if
225 the information isn't available. NOTE: This address is really only
226 meaningful to the frame's high-level debug info. */
227extern CORE_ADDR get_frame_base_address (struct frame_info *);
228
6bfb3e36
AC
229/* Assuming that a frame is `normal', return the base-address of the
230 local variables, or 0 if the information isn't available. NOTE:
da62e633
AC
231 This address is really only meaningful to the frame's high-level
232 debug info. Typically, the argument and locals share a single
233 base-address. */
234extern CORE_ADDR get_frame_locals_address (struct frame_info *);
235
6bfb3e36
AC
236/* Assuming that a frame is `normal', return the base-address of the
237 parameter list, or 0 if that information isn't available. NOTE:
238 This address is really only meaningful to the frame's high-level
239 debug info. Typically, the argument and locals share a single
da62e633
AC
240 base-address. */
241extern CORE_ADDR get_frame_args_address (struct frame_info *);
242
c97eb5d9
AC
243/* The frame's level: 0 for innermost, 1 for its caller, ...; or -1
244 for an invalid frame). */
245extern int frame_relative_level (struct frame_info *fi);
246
5a203e44
AC
247/* Return the frame's type. Some are real, some are signal
248 trampolines, and some are completly artificial (dummy). */
249
250enum frame_type
251{
7df05f2b
AC
252 /* The frame's type hasn't yet been defined. This is a catch-all
253 for legacy code that uses really strange technicques, such as
254 deprecated_set_frame_type, to set the frame's type. New code
255 should not use this value. */
256 UNKNOWN_FRAME,
5a203e44
AC
257 /* A true stack frame, created by the target program during normal
258 execution. */
259 NORMAL_FRAME,
260 /* A fake frame, created by GDB when performing an inferior function
261 call. */
262 DUMMY_FRAME,
263 /* In a signal handler, various OSs handle this in various ways.
264 The main thing is that the frame may be far from normal. */
265 SIGTRAMP_FRAME
266};
267extern enum frame_type get_frame_type (struct frame_info *);
268
269/* FIXME: cagney/2002-11-10: Some targets want to directly mark a
270 frame as being of a specific type. This shouldn't be necessary.
ae45cd16
AC
271 PC_IN_SIGTRAMP() indicates a SIGTRAMP_FRAME and
272 DEPRECATED_PC_IN_CALL_DUMMY() indicates a DUMMY_FRAME. I suspect
273 the real problem here is that get_prev_frame() only sets
e9582e71 274 initialized after DEPRECATED_INIT_EXTRA_FRAME_INFO as been called.
ae45cd16
AC
275 Consequently, some targets found that the frame's type was wrong
276 and tried to fix it. The correct fix is to modify get_prev_frame()
277 so that it initializes the frame's type before calling any other
278 functions. */
5a203e44
AC
279extern void deprecated_set_frame_type (struct frame_info *,
280 enum frame_type type);
281
c97eb5d9
AC
282/* Unwind the stack frame so that the value of REGNUM, in the previous
283 (up, older) frame is returned. If VALUEP is NULL, don't
284 fetch/compute the value. Instead just return the location of the
285 value. */
286extern void frame_register_unwind (struct frame_info *frame, int regnum,
287 int *optimizedp, enum lval_type *lvalp,
288 CORE_ADDR *addrp, int *realnump,
289 void *valuep);
290
291/* More convenient interface to frame_register_unwind(). */
292/* NOTE: cagney/2002-09-13: Return void as one day these functions may
293 be changed to return an indication that the read succeeded. */
294
5b181d62
AC
295extern void frame_unwind_register (struct frame_info *frame,
296 int regnum, void *buf);
297
c97eb5d9
AC
298extern void frame_unwind_signed_register (struct frame_info *frame,
299 int regnum, LONGEST *val);
300
301extern void frame_unwind_unsigned_register (struct frame_info *frame,
302 int regnum, ULONGEST *val);
303
304/* Get the value of the register that belongs to this FRAME. This
305 function is a wrapper to the call sequence ``frame_unwind_register
306 (get_next_frame (FRAME))''. As per frame_register_unwind(), if
307 VALUEP is NULL, the registers value is not fetched/computed. */
308
309extern void frame_register (struct frame_info *frame, int regnum,
310 int *optimizedp, enum lval_type *lvalp,
311 CORE_ADDR *addrp, int *realnump,
312 void *valuep);
313
314/* More convenient interface to frame_register(). */
315/* NOTE: cagney/2002-09-13: Return void as one day these functions may
316 be changed to return an indication that the read succeeded. */
317
5b181d62
AC
318extern void frame_read_register (struct frame_info *frame, int regnum,
319 void *buf);
320
c97eb5d9
AC
321extern void frame_read_signed_register (struct frame_info *frame,
322 int regnum, LONGEST *val);
323
324extern void frame_read_unsigned_register (struct frame_info *frame,
325 int regnum, ULONGEST *val);
326
327/* Map between a frame register number and its name. A frame register
328 space is a superset of the cooked register space --- it also
5f601589
AC
329 includes builtin registers. If NAMELEN is negative, use the NAME's
330 length when doing the comparison. */
c97eb5d9 331
5f601589 332extern int frame_map_name_to_regnum (const char *name, int namelen);
c97eb5d9
AC
333extern const char *frame_map_regnum_to_name (int regnum);
334
f18c5a73
AC
335/* Unwind the PC. Strictly speaking return the resume address of the
336 calling frame. For GDB, `pc' is the resume address and not a
337 specific register. */
338
339extern CORE_ADDR frame_pc_unwind (struct frame_info *frame);
340
dbe9fe58
AC
341/* Discard the specified frame. Restoring the registers to the state
342 of the caller. */
343extern void frame_pop (struct frame_info *frame);
344
c5394b80
JM
345/* Values for the source flag to be used in print_frame_info_base(). */
346enum print_what
347 {
348 /* Print only the source line, like in stepi. */
349 SRC_LINE = -1,
350 /* Print only the location, i.e. level, address (sometimes)
351 function, args, file, line, line num. */
352 LOCATION,
353 /* Print both of the above. */
354 SRC_AND_LOC,
355 /* Print location only, but always include the address. */
356 LOC_AND_ADDRESS
357 };
358
64485362
AC
359/* Allocate additional space for appendices to a struct frame_info.
360 NOTE: Much of GDB's code works on the assumption that the allocated
361 saved_regs[] array is the size specified below. If you try to make
362 that array smaller, GDB will happily walk off its end. */
c906108c 363
64485362
AC
364#ifdef SIZEOF_FRAME_SAVED_REGS
365#error "SIZEOF_FRAME_SAVED_REGS can not be re-defined"
c906108c 366#endif
64485362
AC
367#define SIZEOF_FRAME_SAVED_REGS \
368 (sizeof (CORE_ADDR) * (NUM_REGS+NUM_PSEUDO_REGS))
369
479ab5a0
AC
370/* Allocate zero initialized memory from the frame cache obstack.
371 Appendices to the frame info (such as the unwind cache) should
372 allocate memory using this method. */
373
374extern void *frame_obstack_zalloc (unsigned long size);
eb4f72c5 375#define FRAME_OBSTACK_ZALLOC(TYPE) ((TYPE *) frame_obstack_zalloc (sizeof (TYPE)))
f75493ed 376#define FRAME_OBSTACK_CALLOC(NUMBER,TYPE) ((TYPE *) frame_obstack_zalloc ((NUMBER) * sizeof (TYPE)))
c906108c 377
e6ba3bc9
AC
378/* If legacy_frame_chain_valid() returns zero it means that the given
379 frame is the outermost one and has no caller.
380
381 This method has been superseeded by the per-architecture
382 frame_unwind_pc() (returns 0 to indicate an invalid return address)
383 and per-frame this_id() (returns a NULL frame ID to indicate an
384 invalid frame). */
385extern int legacy_frame_chain_valid (CORE_ADDR, struct frame_info *);
c906108c 386
a14ed312 387extern void generic_save_dummy_frame_tos (CORE_ADDR sp);
c906108c 388
ae767bfb
JB
389extern struct block *get_frame_block (struct frame_info *,
390 CORE_ADDR *addr_in_block);
c906108c 391
805e2818
AC
392/* Return the `struct block' that belongs to the selected thread's
393 selected frame. If the inferior has no state, return NULL.
394
395 NOTE: cagney/2002-11-29:
396
397 No state? Does the inferior have any execution state (a core file
398 does, an executable does not). At present the code tests
399 `target_has_stack' but I'm left wondering if it should test
400 `target_has_registers' or, even, a merged target_has_state.
401
402 Should it look at the most recently specified SAL? If the target
403 has no state, should this function try to extract a block from the
404 most recently selected SAL? That way `list foo' would give it some
405 sort of reference point. Then again, perhaphs that would confuse
406 things.
407
408 Calls to this function can be broken down into two categories: Code
409 that uses the selected block as an additional, but optional, data
410 point; Code that uses the selected block as a prop, when it should
411 have the relevant frame/block/pc explicitly passed in.
412
413 The latter can be eliminated by correctly parameterizing the code,
414 the former though is more interesting. Per the "address" command,
415 it occures in the CLI code and makes it possible for commands to
416 work, even when the inferior has no state. */
417
ae767bfb 418extern struct block *get_selected_block (CORE_ADDR *addr_in_block);
c906108c 419
a14ed312 420extern struct symbol *get_frame_function (struct frame_info *);
c906108c 421
42f99ac2
JB
422extern CORE_ADDR frame_address_in_block (struct frame_info *);
423
a14ed312 424extern CORE_ADDR get_pc_function_start (CORE_ADDR);
c906108c 425
a14ed312 426extern int frameless_look_for_prologue (struct frame_info *);
c906108c 427
a14ed312
KB
428extern void print_frame_args (struct symbol *, struct frame_info *,
429 int, struct ui_file *);
c906108c 430
a14ed312 431extern struct frame_info *find_relative_frame (struct frame_info *, int *);
c906108c 432
a14ed312
KB
433extern void show_and_print_stack_frame (struct frame_info *fi, int level,
434 int source);
7a292a7a 435
a14ed312 436extern void print_stack_frame (struct frame_info *, int, int);
c906108c 437
a14ed312 438extern void show_stack_frame (struct frame_info *);
c906108c 439
a14ed312 440extern void print_frame_info (struct frame_info *, int, int, int);
c906108c 441
a14ed312 442extern void show_frame_info (struct frame_info *, int, int, int);
c906108c 443
a14ed312 444extern struct frame_info *block_innermost_frame (struct block *);
c906108c 445
135c175f
AC
446/* NOTE: cagney/2002-09-13: There is no need for this function.
447 Instead either of frame_unwind_signed_register() or
448 frame_unwind_unsigned_register() can be used. */
449extern CORE_ADDR deprecated_read_register_dummy (CORE_ADDR pc,
450 CORE_ADDR fp, int);
a14ed312
KB
451extern void generic_push_dummy_frame (void);
452extern void generic_pop_current_frame (void (*)(struct frame_info *));
453extern void generic_pop_dummy_frame (void);
c906108c 454
a14ed312
KB
455extern int generic_pc_in_call_dummy (CORE_ADDR pc,
456 CORE_ADDR sp, CORE_ADDR fp);
da130f98
AC
457
458/* NOTE: cagney/2002-06-26: Targets should no longer use this
459 function. Instead, the contents of a dummy frames registers can be
460 obtained by applying: frame_register_unwind to the dummy frame; or
ac2adee5 461 frame_register_unwind() to the next outer frame. */
da130f98
AC
462
463extern char *deprecated_generic_find_dummy_frame (CORE_ADDR pc, CORE_ADDR fp);
c906108c 464
f796e4be
KB
465void generic_unwind_get_saved_register (char *raw_buffer,
466 int *optimizedp,
467 CORE_ADDR *addrp,
468 struct frame_info *frame,
469 int regnum,
470 enum lval_type *lvalp);
471
bdcdd535 472/* The function generic_get_saved_register() has been made obsolete.
129c1cd6
AC
473 DEPRECATED_GET_SAVED_REGISTER now defaults to the recursive
474 equivalent - generic_unwind_get_saved_register() - so there is no
475 need to even set DEPRECATED_GET_SAVED_REGISTER. Architectures that
476 need to override the register unwind mechanism should modify
477 frame->unwind(). */
bdcdd535
AC
478extern void deprecated_generic_get_saved_register (char *, int *, CORE_ADDR *,
479 struct frame_info *, int,
480 enum lval_type *);
c906108c 481
6096c27a
AC
482extern void generic_save_call_dummy_addr (CORE_ADDR lo, CORE_ADDR hi);
483
5b181d62
AC
484/* FIXME: cagney/2003-02-02: Should be deprecated or replaced with a
485 function called frame_read_register_p(). This slightly weird (and
486 older) variant of frame_read_register() returns zero (indicating
487 the register is unavailable) if either: the register isn't cached;
488 or the register has been optimized out. Problem is, neither check
489 is exactly correct. A register can't be optimized out (it may not
490 have been saved as part of a function call); The fact that a
491 register isn't in the register cache doesn't mean that the register
492 isn't available (it could have been fetched from memory). */
493
cda5a58a
AC
494extern int frame_register_read (struct frame_info *frame, int regnum,
495 void *buf);
496
36dc181b
EZ
497/* From stack.c. */
498extern void args_info (char *, int);
499
500extern void locals_info (char *, int);
501
502extern void (*selected_frame_level_changed_hook) (int);
503
504extern void return_command (char *, int);
505
abc0af47
AC
506
507/* NOTE: cagney/2002-11-27:
508
509 You might think that the below global can simply be replaced by a
510 call to either get_selected_frame() or select_frame().
511
512 Unfortunatly, it isn't that easy.
513
514 The relevant code needs to be audited to determine if it is
515 possible (or pratical) to instead pass the applicable frame in as a
516 parameter. For instance, DEPRECATED_DO_REGISTERS_INFO() relied on
6e7f8b9c 517 the deprecated_selected_frame global, while its replacement,
abc0af47
AC
518 PRINT_REGISTERS_INFO(), is parameterized with the selected frame.
519 The only real exceptions occure at the edge (in the CLI code) where
520 user commands need to pick up the selected frame before proceeding.
521
522 This is important. GDB is trying to stamp out the hack:
523
6e7f8b9c
AC
524 saved_frame = deprecated_selected_frame;
525 deprecated_selected_frame = ...;
abc0af47 526 hack_using_global_selected_frame ();
6e7f8b9c 527 deprecated_selected_frame = saved_frame;
abc0af47
AC
528
529 Take care! */
530
6e7f8b9c 531extern struct frame_info *deprecated_selected_frame;
abc0af47
AC
532
533
18ea5ba4 534/* Create a frame using the specified BASE and PC. */
abc0af47 535
18ea5ba4 536extern struct frame_info *create_new_frame (CORE_ADDR base, CORE_ADDR pc);
abc0af47 537
0394eb2a 538
2c517d0e
AC
539/* Create/access the frame's `extra info'. The extra info is used by
540 older code to store information such as the analyzed prologue. The
541 zalloc() should only be called by the INIT_EXTRA_INFO method. */
0394eb2a 542
2c517d0e
AC
543extern struct frame_extra_info *frame_extra_info_zalloc (struct frame_info *fi,
544 long size);
0394eb2a
AC
545extern struct frame_extra_info *get_frame_extra_info (struct frame_info *fi);
546
6baff1d2
AC
547/* Create/access the frame's `saved_regs'. The saved regs are used by
548 older code to store the address of each register (except for
549 SP_REGNUM where the value of the register in the previous frame is
550 stored). */
551extern CORE_ADDR *frame_saved_regs_zalloc (struct frame_info *);
552extern CORE_ADDR *get_frame_saved_regs (struct frame_info *);
553
b87efeee
AC
554/* FIXME: cagney/2002-12-06: Has the PC in the current frame changed?
555 "infrun.c", Thanks to DECR_PC_AFTER_BREAK, can change the PC after
ef6e7e13
AC
556 the initial frame create. This puts things back in sync.
557
558 This replaced: frame->pc = ....; */
2f107107
AC
559extern void deprecated_update_frame_pc_hack (struct frame_info *frame,
560 CORE_ADDR pc);
561
562/* FIXME: cagney/2002-12-18: Has the frame's base changed? Or to be
563 more exact, whas that initial guess at the frame's base as returned
0ba6dca9
AC
564 by deprecated_read_fp() wrong. If it was, fix it. This shouldn't
565 be necessary since the code should be getting the frame's base
566 correct from the outset.
ef6e7e13
AC
567
568 This replaced: frame->frame = ....; */
2f107107
AC
569extern void deprecated_update_frame_base_hack (struct frame_info *frame,
570 CORE_ADDR base);
b87efeee 571
c8b8a898
AC
572/* FIXME: cagney/2003-01-04: Explicitly set the frame's saved_regs
573 and/or extra_info. Target code is allocating a fake frame and than
574 initializing that to get around the problem of, when creating the
575 inner most frame, there is no where to cache information such as
576 the prologue analysis. This is fixed by the new unwind mechanism -
577 even the inner most frame has somewhere to store things like the
578 prolog analysis (or at least will once the frame overhaul is
579 finished). */
580extern void deprecated_set_frame_saved_regs_hack (struct frame_info *frame,
581 CORE_ADDR *saved_regs);
582extern void deprecated_set_frame_extra_info_hack (struct frame_info *frame,
583 struct frame_extra_info *extra_info);
584
585/* FIXME: cagney/2003-01-04: Allocate a frame from the heap (rather
586 than the frame obstack). Targets do this as a way of saving the
587 prologue analysis from the inner most frame before that frame has
588 been created. By always creating a frame, this problem goes away. */
589extern struct frame_info *deprecated_frame_xmalloc (void);
590
f6c609c4
AC
591/* FIXME: cagney/2003-01-05: Allocate a frame, along with the
592 saved_regs and extra_info. Set up cleanups for all three. Same as
593 for deprecated_frame_xmalloc, targets are calling this when
594 creating a scratch `struct frame_info'. The frame overhaul makes
595 this unnecessary since all frame queries are parameterized with a
596 common cache parameter and a frame. */
597extern struct frame_info *deprecated_frame_xmalloc_with_cleanup (long sizeof_saved_regs,
598 long sizeof_extra_info);
599
483d36b2
AC
600/* FIXME: cagney/2003-01-07: These are just nasty. Code shouldn't be
601 doing this. I suspect it dates back to the days when every field
602 of an allocated structure was explicitly initialized. */
603extern void deprecated_set_frame_next_hack (struct frame_info *fi,
604 struct frame_info *next);
605extern void deprecated_set_frame_prev_hack (struct frame_info *fi,
606 struct frame_info *prev);
607
2d75187b
AC
608/* FIXME: cagney/2003-01-07: Instead of the dwarf2cfi having its own
609 dedicated `struct frame_info . context' field, the code should use
610 the per frame `unwind_cache' that is passed to the
611 frame_pc_unwind(), frame_register_unwind() and frame_id_unwind()
612 methods.
613
614 See "dummy-frame.c" for an example of how a cfi-frame object can be
615 implemented using this. */
616extern struct context *deprecated_get_frame_context (struct frame_info *fi);
617extern void deprecated_set_frame_context (struct frame_info *fi,
618 struct context *context);
619
1594fa56
AC
620/* Return non-zero if the architecture is relying on legacy frame
621 code. */
622extern int legacy_frame_p (struct gdbarch *gdbarch);
623
c906108c 624#endif /* !defined (FRAME_H) */
This page took 0.339677 seconds and 4 git commands to generate.