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 if the fetch
  44    succeeds.   Return a freshly allocated error message?
  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 loose 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's 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 alligned 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 (approximatly) identifies the call site (and not return
 271    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
 316 /* Assuming that a frame is `normal', return its base-address, or 0 if
 317    the information isn't available.  NOTE: This address is really only
 318    meaningful to the frame's high-level debug info.  */
 319 extern CORE_ADDR get_frame_base_address (struct frame_info *);
 320
 321 /* Assuming that a frame is `normal', return the base-address of the
 322    local variables, or 0 if the information isn't available.  NOTE:
 323    This address is really only meaningful to the frame's high-level
 324    debug info.  Typically, the argument and locals share a single
 325    base-address.  */
 326 extern CORE_ADDR get_frame_locals_address (struct frame_info *);
 327
 328 /* Assuming that a frame is `normal', return the base-address of the
 329    parameter list, or 0 if that information isn't available.  NOTE:
 330    This address is really only meaningful to the frame's high-level
 331    debug info.  Typically, the argument and locals share a single
 332    base-address.  */
 333 extern CORE_ADDR get_frame_args_address (struct frame_info *);
 334
 335 /* The frame's level: 0 for innermost, 1 for its caller, ...; or -1
 336    for an invalid frame).  */
 337 extern int frame_relative_level (struct frame_info *fi);
 338
 339 /* Return the frame's type.  Some are real, some are signal
 340    trampolines, and some are completely artificial (dummy).  */
 341
 342 enum frame_type
 343 {
 344   /* The frame's type hasn't yet been defined.  This is a catch-all
 345      for legacy code that uses really strange technicques, such as
 346      deprecated_set_frame_type, to set the frame's type.  New code
 347      should not use this value.  */
 348   UNKNOWN_FRAME,
 349   /* A true stack frame, created by the target program during normal
 350      execution.  */
 351   NORMAL_FRAME,
 352   /* A fake frame, created by GDB when performing an inferior function
 353      call.  */
 354   DUMMY_FRAME,
 355   /* In a signal handler, various OSs handle this in various ways.
 356      The main thing is that the frame may be far from normal.  */
 357   SIGTRAMP_FRAME
 358 };
 359 extern enum frame_type get_frame_type (struct frame_info *);
 360
 361 /* FIXME: cagney/2002-11-10: Some targets want to directly mark a
 362    frame as being of a specific type.  This shouldn't be necessary.
 363    PC_IN_SIGTRAMP() indicates a SIGTRAMP_FRAME and
 364    DEPRECATED_PC_IN_CALL_DUMMY() indicates a DUMMY_FRAME.  I suspect
 365    the real problem here is that get_prev_frame() only sets
 366    initialized after DEPRECATED_INIT_EXTRA_FRAME_INFO as been called.
 367    Consequently, some targets found that the frame's type was wrong
 368    and tried to fix it.  The correct fix is to modify get_prev_frame()
 369    so that it initializes the frame's type before calling any other
 370    functions.  */
 371 extern void deprecated_set_frame_type (struct frame_info *,
 372                                        enum frame_type type);
 373
 374 /* Unwind the stack frame so that the value of REGNUM, in the previous
 375    (up, older) frame is returned.  If VALUEP is NULL, don't
 376    fetch/compute the value.  Instead just return the location of the
 377    value.  */
 378 extern void frame_register_unwind (struct frame_info *frame, int regnum,
 379                                    int *optimizedp, enum lval_type *lvalp,
 380                                    CORE_ADDR *addrp, int *realnump,
 381                                    void *valuep);
 382
 383 /* Fetch a register from this, or unwind a register from the next
 384    frame.  Note that the get_frame methods are wrappers to
 385    frame->next->unwind.  They all [potentially] throw an error if the
 386    fetch fails.  */
 387
 388 extern void frame_unwind_register (struct frame_info *frame,
 389                                    int regnum, void *buf);
 390 extern void get_frame_register (struct frame_info *frame,
 391                                 int regnum, void *buf);
 392
 393 extern LONGEST frame_unwind_register_signed (struct frame_info *frame,
 394                                              int regnum);
 395 extern LONGEST get_frame_register_signed (struct frame_info *frame,
 396                                           int regnum);
 397 extern ULONGEST frame_unwind_register_unsigned (struct frame_info *frame,
 398                                                int regnum);
 399 extern ULONGEST get_frame_register_unsigned (struct frame_info *frame,
 400                                              int regnum);
 401
 402
 403 /* Use frame_unwind_register_signed.  */
 404 extern void frame_unwind_unsigned_register (struct frame_info *frame,
 405                                             int regnum, ULONGEST *val);
 406
 407 /* Get the value of the register that belongs to this FRAME.  This
 408    function is a wrapper to the call sequence ``frame_unwind_register
 409    (get_next_frame (FRAME))''.  As per frame_register_unwind(), if
 410    VALUEP is NULL, the registers value is not fetched/computed.  */
 411
 412 extern void frame_register (struct frame_info *frame, int regnum,
 413                             int *optimizedp, enum lval_type *lvalp,
 414                             CORE_ADDR *addrp, int *realnump,
 415                             void *valuep);
 416
 417 /* The reverse.  Store a register value relative to the specified
 418    frame.  Note: this call makes the frame's state undefined.  The
 419    register and frame caches must be flushed.  */
 420 extern void put_frame_register (struct frame_info *frame, int regnum,
 421                                 const void *buf);
 422
 423 /* Map between a frame register number and its name.  A frame register
 424    space is a superset of the cooked register space --- it also
 425    includes builtin registers.  If NAMELEN is negative, use the NAME's
 426    length when doing the comparison.  */
 427
 428 extern int frame_map_name_to_regnum (struct frame_info *frame,
 429                                      const char *name, int namelen);
 430 extern const char *frame_map_regnum_to_name (struct frame_info *frame,
 431                                              int regnum);
 432
 433 /* Unwind the PC.  Strictly speaking return the resume address of the
 434    calling frame.  For GDB, `pc' is the resume address and not a
 435    specific register.  */
 436
 437 extern CORE_ADDR frame_pc_unwind (struct frame_info *frame);
 438
 439 /* Discard the specified frame.  Restoring the registers to the state
 440    of the caller.  */
 441 extern void frame_pop (struct frame_info *frame);
 442
 443 /* Return memory from the specified frame.  A frame knows its thread /
 444    LWP and hence can find its way down to a target.  The assumption
 445    here is that the current and previous frame share a common address
 446    space.
 447
 448    If the memory read fails, these methods throw an error.
 449
 450    NOTE: cagney/2003-06-03: Should there be unwind versions of these
 451    methods?  That isn't clear.  Can code, for instance, assume that
 452    this and the previous frame's memory or architecture are identical?
 453    If architecture / memory changes are always separated by special
 454    adaptor frames this should be ok.  */
 455
 456 extern void get_frame_memory (struct frame_info *this_frame, CORE_ADDR addr,
 457                               void *buf, int len);
 458 extern LONGEST get_frame_memory_signed (struct frame_info *this_frame,
 459                                         CORE_ADDR memaddr, int len);
 460 extern ULONGEST get_frame_memory_unsigned (struct frame_info *this_frame,
 461                                            CORE_ADDR memaddr, int len);
 462
 463 /* Return this frame's architecture.  */
 464
 465 extern struct gdbarch *get_frame_arch (struct frame_info *this_frame);
 466
 467
 468 /* Values for the source flag to be used in print_frame_info_base(). */
 469 enum print_what
 470   {
 471     /* Print only the source line, like in stepi. */
 472     SRC_LINE = -1,
 473     /* Print only the location, i.e. level, address (sometimes)
 474        function, args, file, line, line num. */
 475     LOCATION,
 476     /* Print both of the above. */
 477     SRC_AND_LOC,
 478     /* Print location only, but always include the address. */
 479     LOC_AND_ADDRESS
 480   };
 481
 482 /* Allocate additional space for appendices to a struct frame_info.
 483    NOTE: Much of GDB's code works on the assumption that the allocated
 484    saved_regs[] array is the size specified below.  If you try to make
 485    that array smaller, GDB will happily walk off its end. */
 486
 487 #ifdef SIZEOF_FRAME_SAVED_REGS
 488 #error "SIZEOF_FRAME_SAVED_REGS can not be re-defined"
 489 #endif
 490 #define SIZEOF_FRAME_SAVED_REGS \
 491         (sizeof (CORE_ADDR) * (NUM_REGS+NUM_PSEUDO_REGS))
 492
 493 /* Allocate zero initialized memory from the frame cache obstack.
 494    Appendices to the frame info (such as the unwind cache) should
 495    allocate memory using this method.  */
 496
 497 extern void *frame_obstack_zalloc (unsigned long size);
 498 #define FRAME_OBSTACK_ZALLOC(TYPE) ((TYPE *) frame_obstack_zalloc (sizeof (TYPE)))
 499 #define FRAME_OBSTACK_CALLOC(NUMBER,TYPE) ((TYPE *) frame_obstack_zalloc ((NUMBER) * sizeof (TYPE)))
 500
 501 /* If legacy_frame_chain_valid() returns zero it means that the given
 502    frame is the outermost one and has no caller.
 503
 504    This method has been superseeded by the per-architecture
 505    frame_unwind_pc() (returns 0 to indicate an invalid return address)
 506    and per-frame this_id() (returns a NULL frame ID to indicate an
 507    invalid frame).  */
 508 extern int legacy_frame_chain_valid (CORE_ADDR, struct frame_info *);
 509
 510 extern void generic_save_dummy_frame_tos (CORE_ADDR sp);
 511
 512 extern struct block *get_frame_block (struct frame_info *,
 513                                       CORE_ADDR *addr_in_block);
 514
 515 /* Return the `struct block' that belongs to the selected thread's
 516    selected frame.  If the inferior has no state, return NULL.
 517
 518    NOTE: cagney/2002-11-29:
 519
 520    No state?  Does the inferior have any execution state (a core file
 521    does, an executable does not).  At present the code tests
 522    `target_has_stack' but I'm left wondering if it should test
 523    `target_has_registers' or, even, a merged target_has_state.
 524
 525    Should it look at the most recently specified SAL?  If the target
 526    has no state, should this function try to extract a block from the
 527    most recently selected SAL?  That way `list foo' would give it some
 528    sort of reference point.  Then again, perhaphs that would confuse
 529    things.
 530
 531    Calls to this function can be broken down into two categories: Code
 532    that uses the selected block as an additional, but optional, data
 533    point; Code that uses the selected block as a prop, when it should
 534    have the relevant frame/block/pc explicitly passed in.
 535
 536    The latter can be eliminated by correctly parameterizing the code,
 537    the former though is more interesting.  Per the "address" command,
 538    it occures in the CLI code and makes it possible for commands to
 539    work, even when the inferior has no state.  */
 540
 541 extern struct block *get_selected_block (CORE_ADDR *addr_in_block);
 542
 543 extern struct symbol *get_frame_function (struct frame_info *);
 544
 545 extern CORE_ADDR get_pc_function_start (CORE_ADDR);
 546
 547 extern int legacy_frameless_look_for_prologue (struct frame_info *);
 548
 549 extern struct frame_info *find_relative_frame (struct frame_info *, int *);
 550
 551 extern void show_and_print_stack_frame (struct frame_info *fi, int level,
 552                                         int source);
 553
 554 extern void print_stack_frame (struct frame_info *, int, int);
 555
 556 extern void show_stack_frame (struct frame_info *);
 557
 558 extern void print_frame_info (struct frame_info *, int, int, int);
 559
 560 extern void show_frame_info (struct frame_info *, int, int, int);
 561
 562 extern struct frame_info *block_innermost_frame (struct block *);
 563
 564 /* NOTE: cagney/2002-09-13: There is no need for this function.   */
 565 extern CORE_ADDR deprecated_read_register_dummy (CORE_ADDR pc,
 566                                                  CORE_ADDR fp, int);
 567 extern void generic_push_dummy_frame (void);
 568 extern void generic_pop_current_frame (void (*)(struct frame_info *));
 569 extern void generic_pop_dummy_frame (void);
 570
 571 extern int generic_pc_in_call_dummy (CORE_ADDR pc,
 572                                      CORE_ADDR sp, CORE_ADDR fp);
 573
 574 /* NOTE: cagney/2002-06-26: Targets should no longer use this
 575    function.  Instead, the contents of a dummy frames registers can be
 576    obtained by applying: frame_register_unwind to the dummy frame; or
 577    frame_register_unwind() to the next outer frame.  */
 578
 579 extern char *deprecated_generic_find_dummy_frame (CORE_ADDR pc, CORE_ADDR fp);
 580
 581
 582 /* The DEPRECATED_GET_SAVED_REGISTER architecture interface is
 583    entirely redundant.  New architectures should implement per-frame
 584    unwinders (ref "frame-unwind.h").  */
 585 extern void deprecated_generic_get_saved_register (char *, int *, CORE_ADDR *,
 586                                                    struct frame_info *, int,
 587                                                    enum lval_type *);
 588
 589 extern void generic_save_call_dummy_addr (CORE_ADDR lo, CORE_ADDR hi);
 590
 591 /* FIXME: cagney/2003-02-02: Should be deprecated or replaced with a
 592    function called get_frame_register_p().  This slightly weird (and
 593    older) variant of get_frame_register() returns zero (indicating the
 594    register is unavailable) if either: the register isn't cached; or
 595    the register has been optimized out.  Problem is, neither check is
 596    exactly correct.  A register can't be optimized out (it may not
 597    have been saved as part of a function call); The fact that a
 598    register isn't in the register cache doesn't mean that the register
 599    isn't available (it could have been fetched from memory).  */
 600
 601 extern int frame_register_read (struct frame_info *frame, int regnum,
 602                                 void *buf);
 603
 604 /* From stack.c.  */
 605 extern void args_info (char *, int);
 606
 607 extern void locals_info (char *, int);
 608
 609 extern void (*selected_frame_level_changed_hook) (int);
 610
 611 extern void return_command (char *, int);
 612
 613
 614 /* NOTE: cagney/2002-11-27:
 615
 616    You might think that the below global can simply be replaced by a
 617    call to either get_selected_frame() or select_frame().
 618
 619    Unfortunately, it isn't that easy.
 620
 621    The relevant code needs to be audited to determine if it is
 622    possible (or pratical) to instead pass the applicable frame in as a
 623    parameter.  For instance, DEPRECATED_DO_REGISTERS_INFO() relied on
 624    the deprecated_selected_frame global, while its replacement,
 625    PRINT_REGISTERS_INFO(), is parameterized with the selected frame.
 626    The only real exceptions occure at the edge (in the CLI code) where
 627    user commands need to pick up the selected frame before proceeding.
 628
 629    This is important.  GDB is trying to stamp out the hack:
 630
 631    saved_frame = deprecated_selected_frame;
 632    deprecated_selected_frame = ...;
 633    hack_using_global_selected_frame ();
 634    deprecated_selected_frame = saved_frame;
 635
 636    Take care!  */
 637
 638 extern struct frame_info *deprecated_selected_frame;
 639
 640 /* NOTE: drow/2003-09-06:
 641
 642    This function is "a step sideways" for uses of deprecated_selected_frame.
 643    They should be fixed as above, but meanwhile, we needed a solution for
 644    cases where functions are called with a NULL frame meaning either "the
 645    program is not running" or "use the selected frame".  Lazy building of
 646    deprecated_selected_frame confuses the situation, because now
 647    deprecated_selected_frame can be NULL even when the inferior is running.
 648
 649    This function calls get_selected_frame if the inferior should have a
 650    frame, or returns NULL otherwise.  */
 651
 652 extern struct frame_info *deprecated_safe_get_selected_frame (void);
 653
 654 /* Create a frame using the specified BASE and PC.  */
 655
 656 extern struct frame_info *create_new_frame (CORE_ADDR base, CORE_ADDR pc);
 657
 658
 659 /* Create/access the frame's `extra info'.  The extra info is used by
 660    older code to store information such as the analyzed prologue.  The
 661    zalloc() should only be called by the INIT_EXTRA_INFO method.  */
 662
 663 extern struct frame_extra_info *frame_extra_info_zalloc (struct frame_info *fi,
 664                                                          long size);
 665 extern struct frame_extra_info *get_frame_extra_info (struct frame_info *fi);
 666
 667 /* Create/access the frame's `saved_regs'.  The saved regs are used by
 668    older code to store the address of each register (except for
 669    SP_REGNUM where the value of the register in the previous frame is
 670    stored).  */
 671 extern CORE_ADDR *frame_saved_regs_zalloc (struct frame_info *);
 672 extern CORE_ADDR *deprecated_get_frame_saved_regs (struct frame_info *);
 673
 674 /* FIXME: cagney/2002-12-06: Has the PC in the current frame changed?
 675    "infrun.c", Thanks to DECR_PC_AFTER_BREAK, can change the PC after
 676    the initial frame create.  This puts things back in sync.
 677
 678    This replaced: frame->pc = ....; */
 679 extern void deprecated_update_frame_pc_hack (struct frame_info *frame,
 680                                              CORE_ADDR pc);
 681
 682 /* FIXME: cagney/2002-12-18: Has the frame's base changed?  Or to be
 683    more exact, was that initial guess at the frame's base as returned
 684    by deprecated_read_fp() wrong?  If it was, fix it.  This shouldn't
 685    be necessary since the code should be getting the frame's base
 686    correct from the outset.
 687
 688    This replaced: frame->frame = ....; */
 689 extern void deprecated_update_frame_base_hack (struct frame_info *frame,
 690                                                CORE_ADDR base);
 691
 692 /* FIXME: cagney/2003-01-05: Allocate a frame, along with the
 693    saved_regs and extra_info.  Set up cleanups for all three.  Same as
 694    for deprecated_frame_xmalloc, targets are calling this when
 695    creating a scratch `struct frame_info'.  The frame overhaul makes
 696    this unnecessary since all frame queries are parameterized with a
 697    common cache parameter and a frame.  */
 698 extern struct frame_info *deprecated_frame_xmalloc_with_cleanup (long sizeof_saved_regs,
 699                                                                  long sizeof_extra_info);
 700
 701 /* Return non-zero if the architecture is relying on legacy frame
 702    code.  */
 703 extern int legacy_frame_p (struct gdbarch *gdbarch);
 704
 705 #endif /* !defined (FRAME_H)  */