gdb/frame.h

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