Commit | Line | Data |
---|---|---|
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 | 26 | struct symtab_and_line; |
494cca16 | 27 | struct frame_unwind; |
fe898f56 | 28 | struct block; |
494cca16 AC |
29 | |
30 | /* The traditional frame unwinder. */ | |
31 | extern const struct frame_unwind *trad_frame_unwind; | |
1058bca7 | 32 | |
c97eb5d9 AC |
33 | /* The frame object. */ |
34 | ||
35 | struct frame_info; | |
36 | ||
37 | /* The frame object's ID. This provides a per-frame unique identifier | |
38 | that can be used to relocate a `struct frame_info' after a target | |
7a424e99 AC |
39 | resume or a frame cache destruct. It of course assumes that the |
40 | inferior hasn't unwound the stack past that frame. */ | |
c97eb5d9 AC |
41 | |
42 | struct frame_id | |
43 | { | |
44 | /* The frame's address. This should be constant through out the | |
45 | lifetime of a frame. */ | |
46 | /* NOTE: cagney/2002-11-16: The ia64 has two stacks and hence two | |
47 | frame bases. This will need to be expanded to accomodate that. */ | |
48 | CORE_ADDR base; | |
49 | /* The frame's current PC. While the PC within the function may | |
50 | change, the function that contains the PC does not. Should this | |
51 | instead be the frame's function? */ | |
52 | CORE_ADDR pc; | |
53 | }; | |
54 | ||
7a424e99 AC |
55 | /* Methods for constructing and comparing Frame IDs. |
56 | ||
57 | NOTE: Given frameless functions A and B, where A calls B (and hence | |
58 | B is inner-to A). The relationships: !eq(A,B); !eq(B,A); | |
59 | !inner(A,B); !inner(B,A); all hold. This is because, while B is | |
60 | inner to A, B is not strictly inner to A (being frameless, they | |
61 | have the same .base value). */ | |
62 | ||
63 | /* For convenience. All fields are zero. */ | |
64 | extern const struct frame_id null_frame_id; | |
65 | ||
66 | /* Construct a frame ID. The second parameter isn't yet well defined. | |
67 | It might be the containing function, or the resume PC (see comment | |
68 | above in `struct frame_id')? A func/pc of zero indicates a | |
69 | wildcard (i.e., do not use func in frame ID comparisons). */ | |
70 | extern struct frame_id frame_id_build (CORE_ADDR base, | |
71 | CORE_ADDR func_or_pc); | |
72 | ||
73 | /* Returns non-zero when L is a valid frame (a valid frame has a | |
74 | non-zero .base). */ | |
75 | extern int frame_id_p (struct frame_id l); | |
76 | ||
77 | /* Returns non-zero when L and R identify the same frame, or, if | |
78 | either L or R have a zero .func, then the same frame base. */ | |
79 | extern int frame_id_eq (struct frame_id l, struct frame_id r); | |
80 | ||
81 | /* Returns non-zero when L is strictly inner-than R (they have | |
82 | different frame .bases). Neither L, nor R can be `null'. See note | |
83 | above about frameless functions. */ | |
84 | extern int frame_id_inner (struct frame_id l, struct frame_id r); | |
85 | ||
86 | ||
c97eb5d9 AC |
87 | /* For every stopped thread, GDB tracks two frames: current and |
88 | selected. Current frame is the inner most frame of the selected | |
abc0af47 AC |
89 | thread. Selected frame is the one being examined by the the GDB |
90 | CLI (selected using `up', `down', ...). The frames are created | |
91 | on-demand (via get_prev_frame()) and then held in a frame cache. */ | |
92 | /* FIXME: cagney/2002-11-28: Er, there is a lie here. If you do the | |
93 | sequence: `thread 1; up; thread 2; thread 1' you loose thread 1's | |
94 | selected frame. At present GDB only tracks the selected frame of | |
95 | the current thread. But be warned, that might change. */ | |
c97eb5d9 AC |
96 | /* FIXME: cagney/2002-11-14: At any time, only one thread's selected |
97 | and current frame can be active. Switching threads causes gdb to | |
98 | discard all that cached frame information. Ulgh! Instead, current | |
99 | and selected frame should be bound to a thread. */ | |
100 | ||
abc0af47 AC |
101 | /* On demand, create the inner most frame using information found in |
102 | the inferior. If the inner most frame can't be created, throw an | |
103 | error. */ | |
c97eb5d9 AC |
104 | extern struct frame_info *get_current_frame (void); |
105 | ||
abc0af47 AC |
106 | /* Invalidates the frame cache (this function should have been called |
107 | invalidate_cached_frames). | |
108 | ||
109 | FIXME: cagney/2002-11-28: The only difference between | |
110 | flush_cached_frames() and reinit_frame_cache() is that the latter | |
111 | explicitly sets the selected frame back to the current frame there | |
112 | isn't any real difference (except that one delays the selection of | |
6e7f8b9c AC |
113 | a new frame). Code can instead simply rely on get_selected_frame() |
114 | to reinit's the selected frame as needed. As for invalidating the | |
115 | cache, there should be two methods one that reverts the thread's | |
116 | selected frame back to current frame (for when the inferior | |
117 | resumes) and one that does not (for when the user modifies the | |
118 | target invalidating the frame cache). */ | |
c97eb5d9 | 119 | extern void flush_cached_frames (void); |
c97eb5d9 AC |
120 | extern void reinit_frame_cache (void); |
121 | ||
6e7f8b9c AC |
122 | /* On demand, create the selected frame and then return it. If the |
123 | selected frame can not be created, this function throws an error. */ | |
124 | /* FIXME: cagney/2002-11-28: At present, when there is no selected | |
125 | frame, this function always returns the current (inner most) frame. | |
126 | It should instead, when a thread has previously had its frame | |
127 | selected (but not resumed) and the frame cache invalidated, find | |
128 | and then return that thread's previously selected frame. */ | |
129 | extern struct frame_info *get_selected_frame (void); | |
130 | ||
abc0af47 AC |
131 | /* Select a specific frame. NULL, apparently implies re-select the |
132 | inner most frame. */ | |
133 | extern void select_frame (struct frame_info *); | |
134 | ||
c97eb5d9 AC |
135 | /* Given a FRAME, return the next (more inner, younger) or previous |
136 | (more outer, older) frame. */ | |
137 | extern struct frame_info *get_prev_frame (struct frame_info *); | |
138 | extern struct frame_info *get_next_frame (struct frame_info *); | |
139 | ||
140 | /* Given a frame's ID, relocate the frame. Returns NULL if the frame | |
141 | is not found. */ | |
142 | extern struct frame_info *frame_find_by_id (struct frame_id id); | |
143 | ||
144 | /* Base attributes of a frame: */ | |
145 | ||
146 | /* The frame's `resume' address. Where the program will resume in | |
147 | this frame. */ | |
148 | extern CORE_ADDR get_frame_pc (struct frame_info *); | |
149 | ||
1058bca7 AC |
150 | /* Closely related to the resume address, various symbol table |
151 | attributes that are determined by the PC. Note that for a normal | |
152 | frame, the PC refers to the resume address after the return, and | |
153 | not the call instruction. In such a case, the address is adjusted | |
154 | so that it (approximatly) identifies the call site (and not return | |
155 | site). | |
156 | ||
157 | NOTE: cagney/2002-11-28: The frame cache could be used to cache the | |
158 | computed value. Working on the assumption that the bottle-neck is | |
159 | in the single step code, and that code causes the frame cache to be | |
160 | constantly flushed, caching things in a frame is probably of little | |
161 | benefit. As they say `show us the numbers'. | |
162 | ||
163 | NOTE: cagney/2002-11-28: Plenty more where this one came from: | |
164 | find_frame_block(), find_frame_partial_function(), | |
165 | find_frame_symtab(), find_frame_function(). Each will need to be | |
166 | carefully considered to determine if the real intent was for it to | |
167 | apply to the PC or the adjusted PC. */ | |
168 | extern void find_frame_sal (struct frame_info *frame, | |
169 | struct symtab_and_line *sal); | |
170 | ||
c193f6ac AC |
171 | /* Return the frame address from FI. Except in the machine-dependent |
172 | *FRAME* macros, a frame address has no defined meaning other than | |
173 | as a magic cookie which identifies a frame over calls to the | |
174 | inferior (um, SEE NOTE BELOW). The only known exception is | |
ae45cd16 AC |
175 | inferior.h (DEPRECATED_PC_IN_CALL_DUMMY) [ON_STACK]; see comments |
176 | there. You cannot assume that a frame address contains enough | |
177 | information to reconstruct the frame; if you want more than just to | |
178 | identify the frame (e.g. be able to fetch variables relative to | |
179 | that frame), then save the whole struct frame_info (and the next | |
180 | struct frame_info, since the latter is used for fetching variables | |
181 | on some machines) (um, again SEE NOTE BELOW). | |
c193f6ac AC |
182 | |
183 | NOTE: cagney/2002-11-18: Actually, the frame address isn't | |
184 | sufficient for identifying a frame, and the counter examples are | |
185 | wrong! | |
186 | ||
187 | Code that needs to (re)identify a frame must use get_frame_id() and | |
188 | frame_find_by_id() (and in the future, a frame_compare() function | |
189 | instead of INNER_THAN()). Two reasons: an architecture (e.g., | |
190 | ia64) can have more than one frame address (due to multiple stack | |
191 | pointers) (frame ID is going to be expanded to accomodate this); | |
192 | successive frameless function calls can only be differientated by | |
193 | comparing both the frame's base and the frame's enclosing function | |
194 | (frame_find_by_id() is going to be modified to perform this test). | |
195 | ||
ae45cd16 AC |
196 | The generic dummy frame version of DEPRECATED_PC_IN_CALL_DUMMY() is |
197 | able to identify a dummy frame using only the PC value. So the | |
198 | frame address is not needed. In fact, most | |
199 | DEPRECATED_PC_IN_CALL_DUMMY() calls now pass zero as the frame/sp | |
200 | values as the caller knows that those values won't be used. Once | |
201 | all architectures are using generic dummy frames, | |
202 | DEPRECATED_PC_IN_CALL_DUMMY() can drop the sp/frame parameters. | |
c193f6ac AC |
203 | When it comes to finding a dummy frame, the next frame's frame ID |
204 | (with out duing an unwind) can be used (ok, could if it wasn't for | |
205 | the need to change the way the PPC defined frame base in a strange | |
206 | way). | |
207 | ||
208 | Modern architectures should be using something like dwarf2's | |
209 | location expression to describe where a variable lives. Such | |
210 | expressions specify their own debug info centric frame address. | |
211 | Consequently, a generic frame address is pretty meaningless. */ | |
212 | ||
213 | extern CORE_ADDR get_frame_base (struct frame_info *); | |
214 | ||
c97eb5d9 | 215 | /* Return the per-frame unique identifer. Can be used to relocate a |
7a424e99 AC |
216 | frame after a frame cache flush (and other similar operations). If |
217 | FI is NULL, return the null_frame_id. */ | |
218 | extern struct frame_id get_frame_id (struct frame_info *fi); | |
c97eb5d9 AC |
219 | |
220 | /* The frame's level: 0 for innermost, 1 for its caller, ...; or -1 | |
221 | for an invalid frame). */ | |
222 | extern int frame_relative_level (struct frame_info *fi); | |
223 | ||
5a203e44 AC |
224 | /* Return the frame's type. Some are real, some are signal |
225 | trampolines, and some are completly artificial (dummy). */ | |
226 | ||
227 | enum frame_type | |
228 | { | |
229 | /* A true stack frame, created by the target program during normal | |
230 | execution. */ | |
231 | NORMAL_FRAME, | |
232 | /* A fake frame, created by GDB when performing an inferior function | |
233 | call. */ | |
234 | DUMMY_FRAME, | |
235 | /* In a signal handler, various OSs handle this in various ways. | |
236 | The main thing is that the frame may be far from normal. */ | |
237 | SIGTRAMP_FRAME | |
238 | }; | |
239 | extern enum frame_type get_frame_type (struct frame_info *); | |
240 | ||
241 | /* FIXME: cagney/2002-11-10: Some targets want to directly mark a | |
242 | frame as being of a specific type. This shouldn't be necessary. | |
ae45cd16 AC |
243 | PC_IN_SIGTRAMP() indicates a SIGTRAMP_FRAME and |
244 | DEPRECATED_PC_IN_CALL_DUMMY() indicates a DUMMY_FRAME. I suspect | |
245 | the real problem here is that get_prev_frame() only sets | |
246 | initialized after INIT_EXTRA_FRAME_INFO as been called. | |
247 | Consequently, some targets found that the frame's type was wrong | |
248 | and tried to fix it. The correct fix is to modify get_prev_frame() | |
249 | so that it initializes the frame's type before calling any other | |
250 | functions. */ | |
5a203e44 AC |
251 | extern void deprecated_set_frame_type (struct frame_info *, |
252 | enum frame_type type); | |
253 | ||
c97eb5d9 AC |
254 | /* Unwind the stack frame so that the value of REGNUM, in the previous |
255 | (up, older) frame is returned. If VALUEP is NULL, don't | |
256 | fetch/compute the value. Instead just return the location of the | |
257 | value. */ | |
258 | extern void frame_register_unwind (struct frame_info *frame, int regnum, | |
259 | int *optimizedp, enum lval_type *lvalp, | |
260 | CORE_ADDR *addrp, int *realnump, | |
261 | void *valuep); | |
262 | ||
263 | /* More convenient interface to frame_register_unwind(). */ | |
264 | /* NOTE: cagney/2002-09-13: Return void as one day these functions may | |
265 | be changed to return an indication that the read succeeded. */ | |
266 | ||
5b181d62 AC |
267 | extern void frame_unwind_register (struct frame_info *frame, |
268 | int regnum, void *buf); | |
269 | ||
c97eb5d9 AC |
270 | extern void frame_unwind_signed_register (struct frame_info *frame, |
271 | int regnum, LONGEST *val); | |
272 | ||
273 | extern void frame_unwind_unsigned_register (struct frame_info *frame, | |
274 | int regnum, ULONGEST *val); | |
275 | ||
276 | /* Get the value of the register that belongs to this FRAME. This | |
277 | function is a wrapper to the call sequence ``frame_unwind_register | |
278 | (get_next_frame (FRAME))''. As per frame_register_unwind(), if | |
279 | VALUEP is NULL, the registers value is not fetched/computed. */ | |
280 | ||
281 | extern void frame_register (struct frame_info *frame, int regnum, | |
282 | int *optimizedp, enum lval_type *lvalp, | |
283 | CORE_ADDR *addrp, int *realnump, | |
284 | void *valuep); | |
285 | ||
286 | /* More convenient interface to frame_register(). */ | |
287 | /* NOTE: cagney/2002-09-13: Return void as one day these functions may | |
288 | be changed to return an indication that the read succeeded. */ | |
289 | ||
5b181d62 AC |
290 | extern void frame_read_register (struct frame_info *frame, int regnum, |
291 | void *buf); | |
292 | ||
c97eb5d9 AC |
293 | extern void frame_read_signed_register (struct frame_info *frame, |
294 | int regnum, LONGEST *val); | |
295 | ||
296 | extern void frame_read_unsigned_register (struct frame_info *frame, | |
297 | int regnum, ULONGEST *val); | |
298 | ||
299 | /* Map between a frame register number and its name. A frame register | |
300 | space is a superset of the cooked register space --- it also | |
5f601589 AC |
301 | includes builtin registers. If NAMELEN is negative, use the NAME's |
302 | length when doing the comparison. */ | |
c97eb5d9 | 303 | |
5f601589 | 304 | extern int frame_map_name_to_regnum (const char *name, int namelen); |
c97eb5d9 AC |
305 | extern const char *frame_map_regnum_to_name (int regnum); |
306 | ||
f18c5a73 AC |
307 | /* Unwind the PC. Strictly speaking return the resume address of the |
308 | calling frame. For GDB, `pc' is the resume address and not a | |
309 | specific register. */ | |
310 | ||
311 | extern CORE_ADDR frame_pc_unwind (struct frame_info *frame); | |
312 | ||
c689142b AC |
313 | /* Unwind the frame ID. Return an ID that uniquely identifies the |
314 | caller's frame. */ | |
315 | extern struct frame_id frame_id_unwind (struct frame_info *frame); | |
316 | ||
dbe9fe58 AC |
317 | /* Discard the specified frame. Restoring the registers to the state |
318 | of the caller. */ | |
319 | extern void frame_pop (struct frame_info *frame); | |
320 | ||
c906108c SS |
321 | /* Describe the saved registers of a frame. */ |
322 | ||
323 | #if defined (EXTRA_FRAME_INFO) || defined (FRAME_FIND_SAVED_REGS) | |
324 | /* XXXX - deprecated */ | |
325 | struct frame_saved_regs | |
326 | { | |
c2c6d25f JM |
327 | /* For each register R (except the SP), regs[R] is the address at |
328 | which it was saved on entry to the frame, or zero if it was not | |
329 | saved on entry to this frame. This includes special registers | |
330 | such as pc and fp saved in special ways in the stack frame. | |
c906108c | 331 | |
c2c6d25f JM |
332 | regs[SP_REGNUM] is different. It holds the actual SP, not the |
333 | address at which it was saved. */ | |
c906108c SS |
334 | |
335 | CORE_ADDR regs[NUM_REGS]; | |
336 | }; | |
337 | #endif | |
338 | ||
339 | /* We keep a cache of stack frames, each of which is a "struct | |
340 | frame_info". The innermost one gets allocated (in | |
341 | wait_for_inferior) each time the inferior stops; current_frame | |
342 | points to it. Additional frames get allocated (in | |
7a292a7a | 343 | get_prev_frame) as needed, and are chained through the next |
c906108c SS |
344 | and prev fields. Any time that the frame cache becomes invalid |
345 | (most notably when we execute something, but also if we change how | |
346 | we interpret the frames (e.g. "set heuristic-fence-post" in | |
347 | mips-tdep.c, or anything which reads new symbols)), we should call | |
348 | reinit_frame_cache. */ | |
349 | ||
350 | struct frame_info | |
351 | { | |
c193f6ac AC |
352 | /* Nominal address of the frame described. See comments at |
353 | get_frame_base() about what this means outside the *FRAME* | |
354 | macros; in the *FRAME* macros, it can mean whatever makes most | |
355 | sense for this machine. */ | |
c906108c SS |
356 | CORE_ADDR frame; |
357 | ||
358 | /* Address at which execution is occurring in this frame. | |
359 | For the innermost frame, it's the current pc. | |
360 | For other frames, it is a pc saved in the next frame. */ | |
361 | CORE_ADDR pc; | |
362 | ||
7cc19214 AC |
363 | /* Level of this frame. The inner-most (youngest) frame is at |
364 | level 0. As you move towards the outer-most (oldest) frame, | |
365 | the level increases. This is a cached value. It could just as | |
366 | easily be computed by counting back from the selected frame to | |
367 | the inner most frame. */ | |
368 | /* NOTE: cagney/2002-04-05: Perhaphs a level of ``-1'' should be | |
369 | reserved to indicate a bogus frame - one that has been created | |
370 | just to keep GDB happy (GDB always needs a frame). For the | |
371 | moment leave this as speculation. */ | |
372 | int level; | |
373 | ||
5a203e44 AC |
374 | /* The frame's type. */ |
375 | enum frame_type type; | |
c906108c SS |
376 | |
377 | /* For each register, address of where it was saved on entry to | |
378 | the frame, or zero if it was not saved on entry to this frame. | |
379 | This includes special registers such as pc and fp saved in | |
380 | special ways in the stack frame. The SP_REGNUM is even more | |
e8759349 AC |
381 | special, the address here is the sp for the previous frame, not |
382 | the address where the sp was saved. */ | |
c906108c SS |
383 | /* Allocated by frame_saved_regs_zalloc () which is called / |
384 | initialized by FRAME_INIT_SAVED_REGS(). */ | |
64485362 | 385 | CORE_ADDR *saved_regs; /*NUM_REGS + NUM_PSEUDO_REGS*/ |
c906108c SS |
386 | |
387 | #ifdef EXTRA_FRAME_INFO | |
388 | /* XXXX - deprecated */ | |
389 | /* Anything extra for this structure that may have been defined | |
390 | in the machine dependent files. */ | |
c5aa993b | 391 | EXTRA_FRAME_INFO |
c906108c SS |
392 | #endif |
393 | ||
394 | /* Anything extra for this structure that may have been defined | |
395 | in the machine dependent files. */ | |
479ab5a0 | 396 | /* Allocated by frame_extra_info_zalloc () which is called / |
c906108c SS |
397 | initialized by INIT_EXTRA_FRAME_INFO */ |
398 | struct frame_extra_info *extra_info; | |
399 | ||
b6af0555 JS |
400 | /* If dwarf2 unwind frame informations is used, this structure holds all |
401 | related unwind data. */ | |
cc22880b | 402 | struct context *context; |
b6af0555 | 403 | |
f18c5a73 AC |
404 | /* Unwind cache shared between the unwind functions - they had |
405 | better all agree as to the contents. */ | |
406 | void *unwind_cache; | |
407 | ||
494cca16 AC |
408 | /* The frame's unwinder. */ |
409 | const struct frame_unwind *unwind; | |
f18c5a73 | 410 | |
494cca16 | 411 | /* Cached copy of the previous frame's resume address. */ |
f18c5a73 AC |
412 | int pc_unwind_cache_p; |
413 | CORE_ADDR pc_unwind_cache; | |
4f460812 | 414 | |
494cca16 | 415 | /* Cached copy of the previous frame's ID. */ |
c689142b AC |
416 | int id_unwind_cache_p; |
417 | struct frame_id id_unwind_cache; | |
418 | ||
15220c65 AC |
419 | /* Pointers to the next (down, inner, younger) and previous (up, |
420 | outer, older) frame_info's in the frame cache. */ | |
421 | struct frame_info *next; /* down, inner, younger */ | |
422 | int prev_p; | |
423 | struct frame_info *prev; /* up, outer, older */ | |
c906108c SS |
424 | }; |
425 | ||
c5394b80 JM |
426 | /* Values for the source flag to be used in print_frame_info_base(). */ |
427 | enum print_what | |
428 | { | |
429 | /* Print only the source line, like in stepi. */ | |
430 | SRC_LINE = -1, | |
431 | /* Print only the location, i.e. level, address (sometimes) | |
432 | function, args, file, line, line num. */ | |
433 | LOCATION, | |
434 | /* Print both of the above. */ | |
435 | SRC_AND_LOC, | |
436 | /* Print location only, but always include the address. */ | |
437 | LOC_AND_ADDRESS | |
438 | }; | |
439 | ||
64485362 AC |
440 | /* Allocate additional space for appendices to a struct frame_info. |
441 | NOTE: Much of GDB's code works on the assumption that the allocated | |
442 | saved_regs[] array is the size specified below. If you try to make | |
443 | that array smaller, GDB will happily walk off its end. */ | |
c906108c | 444 | |
64485362 AC |
445 | #ifdef SIZEOF_FRAME_SAVED_REGS |
446 | #error "SIZEOF_FRAME_SAVED_REGS can not be re-defined" | |
c906108c | 447 | #endif |
64485362 AC |
448 | #define SIZEOF_FRAME_SAVED_REGS \ |
449 | (sizeof (CORE_ADDR) * (NUM_REGS+NUM_PSEUDO_REGS)) | |
450 | ||
479ab5a0 AC |
451 | /* Allocate zero initialized memory from the frame cache obstack. |
452 | Appendices to the frame info (such as the unwind cache) should | |
453 | allocate memory using this method. */ | |
454 | ||
455 | extern void *frame_obstack_zalloc (unsigned long size); | |
eb4f72c5 | 456 | #define FRAME_OBSTACK_ZALLOC(TYPE) ((TYPE *) frame_obstack_zalloc (sizeof (TYPE))) |
c906108c | 457 | |
51603483 DJ |
458 | /* If FRAME_CHAIN_VALID returns zero it means that the given frame |
459 | is the outermost one and has no caller. */ | |
c906108c | 460 | |
51603483 | 461 | extern int frame_chain_valid (CORE_ADDR, struct frame_info *); |
c906108c | 462 | |
a14ed312 | 463 | extern void generic_save_dummy_frame_tos (CORE_ADDR sp); |
c906108c | 464 | |
c906108c | 465 | |
c906108c SS |
466 | #ifdef FRAME_FIND_SAVED_REGS |
467 | /* XXX - deprecated */ | |
95486978 AC |
468 | #define FRAME_INIT_SAVED_REGS(FI) deprecated_get_frame_saved_regs (FI, NULL) |
469 | extern void deprecated_get_frame_saved_regs (struct frame_info *, | |
470 | struct frame_saved_regs *); | |
c906108c | 471 | #endif |
c5aa993b | 472 | |
ae767bfb JB |
473 | extern struct block *get_frame_block (struct frame_info *, |
474 | CORE_ADDR *addr_in_block); | |
c906108c | 475 | |
805e2818 AC |
476 | /* Return the `struct block' that belongs to the selected thread's |
477 | selected frame. If the inferior has no state, return NULL. | |
478 | ||
479 | NOTE: cagney/2002-11-29: | |
480 | ||
481 | No state? Does the inferior have any execution state (a core file | |
482 | does, an executable does not). At present the code tests | |
483 | `target_has_stack' but I'm left wondering if it should test | |
484 | `target_has_registers' or, even, a merged target_has_state. | |
485 | ||
486 | Should it look at the most recently specified SAL? If the target | |
487 | has no state, should this function try to extract a block from the | |
488 | most recently selected SAL? That way `list foo' would give it some | |
489 | sort of reference point. Then again, perhaphs that would confuse | |
490 | things. | |
491 | ||
492 | Calls to this function can be broken down into two categories: Code | |
493 | that uses the selected block as an additional, but optional, data | |
494 | point; Code that uses the selected block as a prop, when it should | |
495 | have the relevant frame/block/pc explicitly passed in. | |
496 | ||
497 | The latter can be eliminated by correctly parameterizing the code, | |
498 | the former though is more interesting. Per the "address" command, | |
499 | it occures in the CLI code and makes it possible for commands to | |
500 | work, even when the inferior has no state. */ | |
501 | ||
ae767bfb | 502 | extern struct block *get_selected_block (CORE_ADDR *addr_in_block); |
c906108c | 503 | |
a14ed312 | 504 | extern struct symbol *get_frame_function (struct frame_info *); |
c906108c | 505 | |
42f99ac2 JB |
506 | extern CORE_ADDR frame_address_in_block (struct frame_info *); |
507 | ||
a14ed312 | 508 | extern CORE_ADDR get_pc_function_start (CORE_ADDR); |
c906108c | 509 | |
a14ed312 | 510 | extern int frameless_look_for_prologue (struct frame_info *); |
c906108c | 511 | |
a14ed312 KB |
512 | extern void print_frame_args (struct symbol *, struct frame_info *, |
513 | int, struct ui_file *); | |
c906108c | 514 | |
a14ed312 | 515 | extern struct frame_info *find_relative_frame (struct frame_info *, int *); |
c906108c | 516 | |
a14ed312 KB |
517 | extern void show_and_print_stack_frame (struct frame_info *fi, int level, |
518 | int source); | |
7a292a7a | 519 | |
a14ed312 | 520 | extern void print_stack_frame (struct frame_info *, int, int); |
c906108c | 521 | |
a14ed312 | 522 | extern void show_stack_frame (struct frame_info *); |
c906108c | 523 | |
a14ed312 | 524 | extern void print_frame_info (struct frame_info *, int, int, int); |
c906108c | 525 | |
a14ed312 | 526 | extern void show_frame_info (struct frame_info *, int, int, int); |
c906108c | 527 | |
a14ed312 | 528 | extern struct frame_info *block_innermost_frame (struct block *); |
c906108c | 529 | |
135c175f AC |
530 | /* NOTE: cagney/2002-09-13: There is no need for this function. |
531 | Instead either of frame_unwind_signed_register() or | |
532 | frame_unwind_unsigned_register() can be used. */ | |
533 | extern CORE_ADDR deprecated_read_register_dummy (CORE_ADDR pc, | |
534 | CORE_ADDR fp, int); | |
a14ed312 KB |
535 | extern void generic_push_dummy_frame (void); |
536 | extern void generic_pop_current_frame (void (*)(struct frame_info *)); | |
537 | extern void generic_pop_dummy_frame (void); | |
c906108c | 538 | |
a14ed312 KB |
539 | extern int generic_pc_in_call_dummy (CORE_ADDR pc, |
540 | CORE_ADDR sp, CORE_ADDR fp); | |
da130f98 AC |
541 | |
542 | /* NOTE: cagney/2002-06-26: Targets should no longer use this | |
543 | function. Instead, the contents of a dummy frames registers can be | |
544 | obtained by applying: frame_register_unwind to the dummy frame; or | |
545 | get_saved_register to the next outer frame. */ | |
546 | ||
547 | extern char *deprecated_generic_find_dummy_frame (CORE_ADDR pc, CORE_ADDR fp); | |
c906108c | 548 | |
a14ed312 KB |
549 | extern void generic_fix_call_dummy (char *dummy, CORE_ADDR pc, CORE_ADDR fun, |
550 | int nargs, struct value **args, | |
551 | struct type *type, int gcc_p); | |
cce74817 | 552 | |
f796e4be KB |
553 | void generic_unwind_get_saved_register (char *raw_buffer, |
554 | int *optimizedp, | |
555 | CORE_ADDR *addrp, | |
556 | struct frame_info *frame, | |
557 | int regnum, | |
558 | enum lval_type *lvalp); | |
559 | ||
bdcdd535 AC |
560 | /* The function generic_get_saved_register() has been made obsolete. |
561 | GET_SAVED_REGISTER now defaults to the recursive equivalent - | |
562 | generic_unwind_get_saved_register() - so there is no need to even | |
563 | set GET_SAVED_REGISTER. Architectures that need to override the | |
564 | register unwind mechanism should modify frame->unwind(). */ | |
565 | extern void deprecated_generic_get_saved_register (char *, int *, CORE_ADDR *, | |
566 | struct frame_info *, int, | |
567 | enum lval_type *); | |
c906108c | 568 | |
6096c27a AC |
569 | extern void generic_save_call_dummy_addr (CORE_ADDR lo, CORE_ADDR hi); |
570 | ||
60edd51d AC |
571 | extern void get_saved_register (char *raw_buffer, int *optimized, |
572 | CORE_ADDR * addrp, | |
573 | struct frame_info *frame, | |
574 | int regnum, enum lval_type *lval); | |
575 | ||
5b181d62 AC |
576 | /* FIXME: cagney/2003-02-02: Should be deprecated or replaced with a |
577 | function called frame_read_register_p(). This slightly weird (and | |
578 | older) variant of frame_read_register() returns zero (indicating | |
579 | the register is unavailable) if either: the register isn't cached; | |
580 | or the register has been optimized out. Problem is, neither check | |
581 | is exactly correct. A register can't be optimized out (it may not | |
582 | have been saved as part of a function call); The fact that a | |
583 | register isn't in the register cache doesn't mean that the register | |
584 | isn't available (it could have been fetched from memory). */ | |
585 | ||
cda5a58a AC |
586 | extern int frame_register_read (struct frame_info *frame, int regnum, |
587 | void *buf); | |
588 | ||
36dc181b EZ |
589 | /* From stack.c. */ |
590 | extern void args_info (char *, int); | |
591 | ||
592 | extern void locals_info (char *, int); | |
593 | ||
594 | extern void (*selected_frame_level_changed_hook) (int); | |
595 | ||
596 | extern void return_command (char *, int); | |
597 | ||
abc0af47 AC |
598 | |
599 | /* NOTE: cagney/2002-11-27: | |
600 | ||
601 | You might think that the below global can simply be replaced by a | |
602 | call to either get_selected_frame() or select_frame(). | |
603 | ||
604 | Unfortunatly, it isn't that easy. | |
605 | ||
606 | The relevant code needs to be audited to determine if it is | |
607 | possible (or pratical) to instead pass the applicable frame in as a | |
608 | parameter. For instance, DEPRECATED_DO_REGISTERS_INFO() relied on | |
6e7f8b9c | 609 | the deprecated_selected_frame global, while its replacement, |
abc0af47 AC |
610 | PRINT_REGISTERS_INFO(), is parameterized with the selected frame. |
611 | The only real exceptions occure at the edge (in the CLI code) where | |
612 | user commands need to pick up the selected frame before proceeding. | |
613 | ||
614 | This is important. GDB is trying to stamp out the hack: | |
615 | ||
6e7f8b9c AC |
616 | saved_frame = deprecated_selected_frame; |
617 | deprecated_selected_frame = ...; | |
abc0af47 | 618 | hack_using_global_selected_frame (); |
6e7f8b9c | 619 | deprecated_selected_frame = saved_frame; |
abc0af47 AC |
620 | |
621 | Take care! */ | |
622 | ||
6e7f8b9c | 623 | extern struct frame_info *deprecated_selected_frame; |
abc0af47 AC |
624 | |
625 | ||
18ea5ba4 | 626 | /* Create a frame using the specified BASE and PC. */ |
abc0af47 | 627 | |
18ea5ba4 | 628 | extern struct frame_info *create_new_frame (CORE_ADDR base, CORE_ADDR pc); |
abc0af47 | 629 | |
0394eb2a | 630 | |
2c517d0e AC |
631 | /* Create/access the frame's `extra info'. The extra info is used by |
632 | older code to store information such as the analyzed prologue. The | |
633 | zalloc() should only be called by the INIT_EXTRA_INFO method. */ | |
0394eb2a | 634 | |
2c517d0e AC |
635 | extern struct frame_extra_info *frame_extra_info_zalloc (struct frame_info *fi, |
636 | long size); | |
0394eb2a AC |
637 | extern struct frame_extra_info *get_frame_extra_info (struct frame_info *fi); |
638 | ||
6baff1d2 AC |
639 | /* Create/access the frame's `saved_regs'. The saved regs are used by |
640 | older code to store the address of each register (except for | |
641 | SP_REGNUM where the value of the register in the previous frame is | |
642 | stored). */ | |
643 | extern CORE_ADDR *frame_saved_regs_zalloc (struct frame_info *); | |
644 | extern CORE_ADDR *get_frame_saved_regs (struct frame_info *); | |
645 | ||
b87efeee AC |
646 | /* FIXME: cagney/2002-12-06: Has the PC in the current frame changed? |
647 | "infrun.c", Thanks to DECR_PC_AFTER_BREAK, can change the PC after | |
648 | the initial frame create. This puts things back in sync. */ | |
2f107107 AC |
649 | extern void deprecated_update_frame_pc_hack (struct frame_info *frame, |
650 | CORE_ADDR pc); | |
651 | ||
652 | /* FIXME: cagney/2002-12-18: Has the frame's base changed? Or to be | |
653 | more exact, whas that initial guess at the frame's base as returned | |
654 | by read_fp() wrong. If it was, fix it. This shouldn't be | |
655 | necessary since the code should be getting the frame's base correct | |
656 | from the outset. */ | |
657 | extern void deprecated_update_frame_base_hack (struct frame_info *frame, | |
658 | CORE_ADDR base); | |
b87efeee | 659 | |
c8b8a898 AC |
660 | /* FIXME: cagney/2003-01-04: Explicitly set the frame's saved_regs |
661 | and/or extra_info. Target code is allocating a fake frame and than | |
662 | initializing that to get around the problem of, when creating the | |
663 | inner most frame, there is no where to cache information such as | |
664 | the prologue analysis. This is fixed by the new unwind mechanism - | |
665 | even the inner most frame has somewhere to store things like the | |
666 | prolog analysis (or at least will once the frame overhaul is | |
667 | finished). */ | |
668 | extern void deprecated_set_frame_saved_regs_hack (struct frame_info *frame, | |
669 | CORE_ADDR *saved_regs); | |
670 | extern void deprecated_set_frame_extra_info_hack (struct frame_info *frame, | |
671 | struct frame_extra_info *extra_info); | |
672 | ||
673 | /* FIXME: cagney/2003-01-04: Allocate a frame from the heap (rather | |
674 | than the frame obstack). Targets do this as a way of saving the | |
675 | prologue analysis from the inner most frame before that frame has | |
676 | been created. By always creating a frame, this problem goes away. */ | |
677 | extern struct frame_info *deprecated_frame_xmalloc (void); | |
678 | ||
f6c609c4 AC |
679 | /* FIXME: cagney/2003-01-05: Allocate a frame, along with the |
680 | saved_regs and extra_info. Set up cleanups for all three. Same as | |
681 | for deprecated_frame_xmalloc, targets are calling this when | |
682 | creating a scratch `struct frame_info'. The frame overhaul makes | |
683 | this unnecessary since all frame queries are parameterized with a | |
684 | common cache parameter and a frame. */ | |
685 | extern struct frame_info *deprecated_frame_xmalloc_with_cleanup (long sizeof_saved_regs, | |
686 | long sizeof_extra_info); | |
687 | ||
483d36b2 AC |
688 | /* FIXME: cagney/2003-01-07: These are just nasty. Code shouldn't be |
689 | doing this. I suspect it dates back to the days when every field | |
690 | of an allocated structure was explicitly initialized. */ | |
691 | extern void deprecated_set_frame_next_hack (struct frame_info *fi, | |
692 | struct frame_info *next); | |
693 | extern void deprecated_set_frame_prev_hack (struct frame_info *fi, | |
694 | struct frame_info *prev); | |
695 | ||
2d75187b AC |
696 | /* FIXME: cagney/2003-01-07: Instead of the dwarf2cfi having its own |
697 | dedicated `struct frame_info . context' field, the code should use | |
698 | the per frame `unwind_cache' that is passed to the | |
699 | frame_pc_unwind(), frame_register_unwind() and frame_id_unwind() | |
700 | methods. | |
701 | ||
702 | See "dummy-frame.c" for an example of how a cfi-frame object can be | |
703 | implemented using this. */ | |
704 | extern struct context *deprecated_get_frame_context (struct frame_info *fi); | |
705 | extern void deprecated_set_frame_context (struct frame_info *fi, | |
706 | struct context *context); | |
707 | ||
c906108c | 708 | #endif /* !defined (FRAME_H) */ |