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