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 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, return the true next (more inner, younger) frame.
 226    This one exposes the sentinel frame and, hence, never returns NULL.
 227    It is here strictly to help old targets in their migration path to
 228    the new frame code - the new code requires the NEXT, and not THIS
 229    frame.  */
 230 extern struct frame_info *deprecated_get_next_frame_hack (struct frame_info *);
 231
 232 /* Given a frame's ID, relocate the frame.  Returns NULL if the frame
 233    is not found.  */
 234 extern struct frame_info *frame_find_by_id (struct frame_id id);
 235
 236 /* Base attributes of a frame: */
 237
 238 /* The frame's `resume' address.  Where the program will resume in
 239    this frame.
 240
 241    This replaced: frame->pc; */
 242 extern CORE_ADDR get_frame_pc (struct frame_info *);
 243
 244 /* An address (not necessarily alligned to an instruction boundary)
 245    that falls within THIS frame's code block.
 246
 247    When a function call is the last statement in a block, the return
 248    address for the call may land at the start of the next block.
 249    Similarly, if a no-return function call is the last statement in
 250    the function, the return address may end up pointing beyond the
 251    function, and possibly at the start of the next function.
 252
 253    These methods make an allowance for this.  For call frames, this
 254    function returns the frame's PC-1 which "should" be an address in
 255    the frame's block.  */
 256
 257 extern CORE_ADDR get_frame_address_in_block (struct frame_info *this_frame);
 258 extern CORE_ADDR frame_unwind_address_in_block (struct frame_info *next_frame);
 259
 260 /* The frame's inner-most bound.  AKA the stack-pointer.  Confusingly
 261    known as top-of-stack.  */
 262
 263 extern CORE_ADDR get_frame_sp (struct frame_info *);
 264 extern CORE_ADDR frame_sp_unwind (struct frame_info *);
 265
 266
 267 /* Following on from the `resume' address.  Return the entry point
 268    address of the function containing that resume address, or zero if
 269    that function isn't known.  */
 270 extern CORE_ADDR frame_func_unwind (struct frame_info *fi);
 271 extern CORE_ADDR get_frame_func (struct frame_info *fi);
 272
 273 /* Closely related to the resume address, various symbol table
 274    attributes that are determined by the PC.  Note that for a normal
 275    frame, the PC refers to the resume address after the return, and
 276    not the call instruction.  In such a case, the address is adjusted
 277    so that it (approximatly) identifies the call site (and not return
 278    site).
 279
 280    NOTE: cagney/2002-11-28: The frame cache could be used to cache the
 281    computed value.  Working on the assumption that the bottle-neck is
 282    in the single step code, and that code causes the frame cache to be
 283    constantly flushed, caching things in a frame is probably of little
 284    benefit.  As they say `show us the numbers'.
 285
 286    NOTE: cagney/2002-11-28: Plenty more where this one came from:
 287    find_frame_block(), find_frame_partial_function(),
 288    find_frame_symtab(), find_frame_function().  Each will need to be
 289    carefully considered to determine if the real intent was for it to
 290    apply to the PC or the adjusted PC.  */
 291 extern void find_frame_sal (struct frame_info *frame,
 292                             struct symtab_and_line *sal);
 293
 294 /* Return the frame base (what ever that is) (DEPRECATED).
 295
 296    Old code was trying to use this single method for two conflicting
 297    purposes.  Such code needs to be updated to use either of:
 298
 299    get_frame_id: A low level frame unique identifier, that consists of
 300    both a stack and a function address, that can be used to uniquely
 301    identify a frame.  This value is determined by the frame's
 302    low-level unwinder, the stack part [typically] being the
 303    top-of-stack of the previous frame, and the function part being the
 304    function's start address.  Since the correct identification of a
 305    frameless function requires both the a stack and function address,
 306    the old get_frame_base method was not sufficient.
 307
 308    get_frame_base_address: get_frame_locals_address:
 309    get_frame_args_address: A set of high-level debug-info dependant
 310    addresses that fall within the frame.  These addresses almost
 311    certainly will not match the stack address part of a frame ID (as
 312    returned by get_frame_base).
 313
 314    This replaced: frame->frame; */
 315
 316 extern CORE_ADDR get_frame_base (struct frame_info *);
 317
 318 /* Return the per-frame unique identifer.  Can be used to relocate a
 319    frame after a frame cache flush (and other similar operations).  If
 320    FI is NULL, return the null_frame_id.  */
 321 extern struct frame_id get_frame_id (struct frame_info *fi);
 322
 323 /* Assuming that a frame is `normal', return its base-address, or 0 if
 324    the information isn't available.  NOTE: This address is really only
 325    meaningful to the frame's high-level debug info.  */
 326 extern CORE_ADDR get_frame_base_address (struct frame_info *);
 327
 328 /* Assuming that a frame is `normal', return the base-address of the
 329    local variables, or 0 if the 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_locals_address (struct frame_info *);
 334
 335 /* Assuming that a frame is `normal', return the base-address of the
 336    parameter list, or 0 if that information isn't available.  NOTE:
 337    This address is really only meaningful to the frame's high-level
 338    debug info.  Typically, the argument and locals share a single
 339    base-address.  */
 340 extern CORE_ADDR get_frame_args_address (struct frame_info *);
 341
 342 /* The frame's level: 0 for innermost, 1 for its caller, ...; or -1
 343    for an invalid frame).  */
 344 extern int frame_relative_level (struct frame_info *fi);
 345
 346 /* Return the frame's type.  Some are real, some are signal
 347    trampolines, and some are completly artificial (dummy).  */
 348
 349 enum frame_type
 350 {
 351   /* The frame's type hasn't yet been defined.  This is a catch-all
 352      for legacy code that uses really strange technicques, such as
 353      deprecated_set_frame_type, to set the frame's type.  New code
 354      should not use this value.  */
 355   UNKNOWN_FRAME,
 356   /* A true stack frame, created by the target program during normal
 357      execution.  */
 358   NORMAL_FRAME,
 359   /* A fake frame, created by GDB when performing an inferior function
 360      call.  */
 361   DUMMY_FRAME,
 362   /* In a signal handler, various OSs handle this in various ways.
 363      The main thing is that the frame may be far from normal.  */
 364   SIGTRAMP_FRAME
 365 };
 366 extern enum frame_type get_frame_type (struct frame_info *);
 367
 368 /* FIXME: cagney/2002-11-10: Some targets want to directly mark a
 369    frame as being of a specific type.  This shouldn't be necessary.
 370    PC_IN_SIGTRAMP() indicates a SIGTRAMP_FRAME and
 371    DEPRECATED_PC_IN_CALL_DUMMY() indicates a DUMMY_FRAME.  I suspect
 372    the real problem here is that get_prev_frame() only sets
 373    initialized after DEPRECATED_INIT_EXTRA_FRAME_INFO as been called.
 374    Consequently, some targets found that the frame's type was wrong
 375    and tried to fix it.  The correct fix is to modify get_prev_frame()
 376    so that it initializes the frame's type before calling any other
 377    functions.  */
 378 extern void deprecated_set_frame_type (struct frame_info *,
 379                                        enum frame_type type);
 380
 381 /* Unwind the stack frame so that the value of REGNUM, in the previous
 382    (up, older) frame is returned.  If VALUEP is NULL, don't
 383    fetch/compute the value.  Instead just return the location of the
 384    value.  */
 385 extern void frame_register_unwind (struct frame_info *frame, int regnum,
 386                                    int *optimizedp, enum lval_type *lvalp,
 387                                    CORE_ADDR *addrp, int *realnump,
 388                                    void *valuep);
 389
 390 /* Fetch a register from this, or unwind a register from the next
 391    frame.  Note that the get_frame methods are wrappers to
 392    frame->next->unwind.  They all [potentially] throw an error if the
 393    fetch fails.  */
 394
 395 extern void frame_unwind_register (struct frame_info *frame,
 396                                    int regnum, void *buf);
 397 extern void get_frame_register (struct frame_info *frame,
 398                                 int regnum, void *buf);
 399
 400 extern LONGEST frame_unwind_register_signed (struct frame_info *frame,
 401                                              int regnum);
 402 extern LONGEST get_frame_register_signed (struct frame_info *frame,
 403                                           int regnum);
 404 extern ULONGEST frame_unwind_register_unsigned (struct frame_info *frame,
 405                                                int regnum);
 406 extern ULONGEST get_frame_register_unsigned (struct frame_info *frame,
 407                                              int regnum);
 408
 409
 410 /* Use frame_unwind_register_signed.  */
 411 extern void frame_unwind_signed_register (struct frame_info *frame,
 412                                           int regnum, LONGEST *val);
 413
 414 /* Use frame_unwind_register_signed.  */
 415 extern void frame_unwind_unsigned_register (struct frame_info *frame,
 416                                             int regnum, ULONGEST *val);
 417
 418 /* Get the value of the register that belongs to this FRAME.  This
 419    function is a wrapper to the call sequence ``frame_unwind_register
 420    (get_next_frame (FRAME))''.  As per frame_register_unwind(), if
 421    VALUEP is NULL, the registers value is not fetched/computed.  */
 422
 423 extern void frame_register (struct frame_info *frame, int regnum,
 424                             int *optimizedp, enum lval_type *lvalp,
 425                             CORE_ADDR *addrp, int *realnump,
 426                             void *valuep);
 427
 428 /* The reverse.  Store a register value relative to the specified
 429    frame.  Note: this call makes the frame's state undefined.  The
 430    register and frame caches must be flushed.  */
 431 extern void put_frame_register (struct frame_info *frame, int regnum,
 432                                 const void *buf);
 433
 434 /* Map between a frame register number and its name.  A frame register
 435    space is a superset of the cooked register space --- it also
 436    includes builtin registers.  If NAMELEN is negative, use the NAME's
 437    length when doing the comparison.  */
 438
 439 extern int frame_map_name_to_regnum (struct frame_info *frame,
 440                                      const char *name, int namelen);
 441 extern const char *frame_map_regnum_to_name (struct frame_info *frame,
 442                                              int regnum);
 443
 444 /* Unwind the PC.  Strictly speaking return the resume address of the
 445    calling frame.  For GDB, `pc' is the resume address and not a
 446    specific register.  */
 447
 448 extern CORE_ADDR frame_pc_unwind (struct frame_info *frame);
 449
 450 /* Discard the specified frame.  Restoring the registers to the state
 451    of the caller.  */
 452 extern void frame_pop (struct frame_info *frame);
 453
 454 /* Return memory from the specified frame.  A frame knows its thread /
 455    LWP and hence can find its way down to a target.  The assumption
 456    here is that the current and previous frame share a common address
 457    space.
 458
 459    If the memory read fails, these methods throw an error.
 460
 461    NOTE: cagney/2003-06-03: Should there be unwind versions of these
 462    methods?  That isn't clear.  Can code, for instance, assume that
 463    this and the previous frame's memory or architecture are identical?
 464    If architecture / memory changes are always separated by special
 465    adaptor frames this should be ok.  */
 466
 467 extern void get_frame_memory (struct frame_info *this_frame, CORE_ADDR addr,
 468                               void *buf, int len);
 469 extern LONGEST get_frame_memory_signed (struct frame_info *this_frame,
 470                                         CORE_ADDR memaddr, int len);
 471 extern ULONGEST get_frame_memory_unsigned (struct frame_info *this_frame,
 472                                            CORE_ADDR memaddr, int len);
 473
 474 /* Return this frame's architecture.  */
 475
 476 extern struct gdbarch *get_frame_arch (struct frame_info *this_frame);
 477
 478
 479 /* Values for the source flag to be used in print_frame_info_base(). */
 480 enum print_what
 481   {
 482     /* Print only the source line, like in stepi. */
 483     SRC_LINE = -1,
 484     /* Print only the location, i.e. level, address (sometimes)
 485        function, args, file, line, line num. */
 486     LOCATION,
 487     /* Print both of the above. */
 488     SRC_AND_LOC,
 489     /* Print location only, but always include the address. */
 490     LOC_AND_ADDRESS
 491   };
 492
 493 /* Allocate additional space for appendices to a struct frame_info.
 494    NOTE: Much of GDB's code works on the assumption that the allocated
 495    saved_regs[] array is the size specified below.  If you try to make
 496    that array smaller, GDB will happily walk off its end. */
 497
 498 #ifdef SIZEOF_FRAME_SAVED_REGS
 499 #error "SIZEOF_FRAME_SAVED_REGS can not be re-defined"
 500 #endif
 501 #define SIZEOF_FRAME_SAVED_REGS \
 502         (sizeof (CORE_ADDR) * (NUM_REGS+NUM_PSEUDO_REGS))
 503
 504 /* Allocate zero initialized memory from the frame cache obstack.
 505    Appendices to the frame info (such as the unwind cache) should
 506    allocate memory using this method.  */
 507
 508 extern void *frame_obstack_zalloc (unsigned long size);
 509 #define FRAME_OBSTACK_ZALLOC(TYPE) ((TYPE *) frame_obstack_zalloc (sizeof (TYPE)))
 510 #define FRAME_OBSTACK_CALLOC(NUMBER,TYPE) ((TYPE *) frame_obstack_zalloc ((NUMBER) * sizeof (TYPE)))
 511
 512 /* If legacy_frame_chain_valid() returns zero it means that the given
 513    frame is the outermost one and has no caller.
 514
 515    This method has been superseeded by the per-architecture
 516    frame_unwind_pc() (returns 0 to indicate an invalid return address)
 517    and per-frame this_id() (returns a NULL frame ID to indicate an
 518    invalid frame).  */
 519 extern int legacy_frame_chain_valid (CORE_ADDR, struct frame_info *);
 520
 521 extern void generic_save_dummy_frame_tos (CORE_ADDR sp);
 522
 523 extern struct block *get_frame_block (struct frame_info *,
 524                                       CORE_ADDR *addr_in_block);
 525
 526 /* Return the `struct block' that belongs to the selected thread's
 527    selected frame.  If the inferior has no state, return NULL.
 528
 529    NOTE: cagney/2002-11-29:
 530
 531    No state?  Does the inferior have any execution state (a core file
 532    does, an executable does not).  At present the code tests
 533    `target_has_stack' but I'm left wondering if it should test
 534    `target_has_registers' or, even, a merged target_has_state.
 535
 536    Should it look at the most recently specified SAL?  If the target
 537    has no state, should this function try to extract a block from the
 538    most recently selected SAL?  That way `list foo' would give it some
 539    sort of reference point.  Then again, perhaphs that would confuse
 540    things.
 541
 542    Calls to this function can be broken down into two categories: Code
 543    that uses the selected block as an additional, but optional, data
 544    point; Code that uses the selected block as a prop, when it should
 545    have the relevant frame/block/pc explicitly passed in.
 546
 547    The latter can be eliminated by correctly parameterizing the code,
 548    the former though is more interesting.  Per the "address" command,
 549    it occures in the CLI code and makes it possible for commands to
 550    work, even when the inferior has no state.  */
 551
 552 extern struct block *get_selected_block (CORE_ADDR *addr_in_block);
 553
 554 extern struct symbol *get_frame_function (struct frame_info *);
 555
 556 extern CORE_ADDR get_pc_function_start (CORE_ADDR);
 557
 558 extern int frameless_look_for_prologue (struct frame_info *);
 559
 560 extern struct frame_info *find_relative_frame (struct frame_info *, int *);
 561
 562 extern void show_and_print_stack_frame (struct frame_info *fi, int level,
 563                                         int source);
 564
 565 extern void print_stack_frame (struct frame_info *, int, int);
 566
 567 extern void show_stack_frame (struct frame_info *);
 568
 569 extern void print_frame_info (struct frame_info *, int, int, int);
 570
 571 extern void show_frame_info (struct frame_info *, int, int, int);
 572
 573 extern struct frame_info *block_innermost_frame (struct block *);
 574
 575 /* NOTE: cagney/2002-09-13: There is no need for this function.
 576    Instead either of frame_unwind_signed_register() or
 577    frame_unwind_unsigned_register() can be used.  */
 578 extern CORE_ADDR deprecated_read_register_dummy (CORE_ADDR pc,
 579                                                  CORE_ADDR fp, int);
 580 extern void generic_push_dummy_frame (void);
 581 extern void generic_pop_current_frame (void (*)(struct frame_info *));
 582 extern void generic_pop_dummy_frame (void);
 583
 584 extern int generic_pc_in_call_dummy (CORE_ADDR pc,
 585                                      CORE_ADDR sp, CORE_ADDR fp);
 586
 587 /* NOTE: cagney/2002-06-26: Targets should no longer use this
 588    function.  Instead, the contents of a dummy frames registers can be
 589    obtained by applying: frame_register_unwind to the dummy frame; or
 590    frame_register_unwind() to the next outer frame.  */
 591
 592 extern char *deprecated_generic_find_dummy_frame (CORE_ADDR pc, CORE_ADDR fp);
 593
 594
 595 /* The DEPRECATED_GET_SAVED_REGISTER architecture interface is
 596    entirely redundant.  New architectures should implement per-frame
 597    unwinders (ref "frame-unwind.h").  */
 598 extern void deprecated_generic_get_saved_register (char *, int *, CORE_ADDR *,
 599                                                    struct frame_info *, int,
 600                                                    enum lval_type *);
 601
 602 extern void generic_save_call_dummy_addr (CORE_ADDR lo, CORE_ADDR hi);
 603
 604 /* FIXME: cagney/2003-02-02: Should be deprecated or replaced with a
 605    function called get_frame_register_p().  This slightly weird (and
 606    older) variant of get_frame_register() returns zero (indicating the
 607    register is unavailable) if either: the register isn't cached; or
 608    the register has been optimized out.  Problem is, neither check is
 609    exactly correct.  A register can't be optimized out (it may not
 610    have been saved as part of a function call); The fact that a
 611    register isn't in the register cache doesn't mean that the register
 612    isn't available (it could have been fetched from memory).  */
 613
 614 extern int frame_register_read (struct frame_info *frame, int regnum,
 615                                 void *buf);
 616
 617 /* From stack.c.  */
 618 extern void args_info (char *, int);
 619
 620 extern void locals_info (char *, int);
 621
 622 extern void (*selected_frame_level_changed_hook) (int);
 623
 624 extern void return_command (char *, int);
 625
 626
 627 /* NOTE: cagney/2002-11-27:
 628
 629    You might think that the below global can simply be replaced by a
 630    call to either get_selected_frame() or select_frame().
 631
 632    Unfortunately, it isn't that easy.
 633
 634    The relevant code needs to be audited to determine if it is
 635    possible (or pratical) to instead pass the applicable frame in as a
 636    parameter.  For instance, DEPRECATED_DO_REGISTERS_INFO() relied on
 637    the deprecated_selected_frame global, while its replacement,
 638    PRINT_REGISTERS_INFO(), is parameterized with the selected frame.
 639    The only real exceptions occure at the edge (in the CLI code) where
 640    user commands need to pick up the selected frame before proceeding.
 641
 642    This is important.  GDB is trying to stamp out the hack:
 643
 644    saved_frame = deprecated_selected_frame;
 645    deprecated_selected_frame = ...;
 646    hack_using_global_selected_frame ();
 647    deprecated_selected_frame = saved_frame;
 648
 649    Take care!  */
 650
 651 extern struct frame_info *deprecated_selected_frame;
 652
 653 /* NOTE: drow/2003-09-06:
 654
 655    This function is "a step sideways" for uses of deprecated_selected_frame.
 656    They should be fixed as above, but meanwhile, we needed a solution for
 657    cases where functions are called with a NULL frame meaning either "the
 658    program is not running" or "use the selected frame".  Lazy building of
 659    deprecated_selected_frame confuses the situation, because now
 660    deprecated_selected_frame can be NULL even when the inferior is running.
 661
 662    This function calls get_selected_frame if the inferior should have a
 663    frame, or returns NULL otherwise.  */
 664
 665 extern struct frame_info *deprecated_safe_get_selected_frame (void);
 666
 667 /* Create a frame using the specified BASE and PC.  */
 668
 669 extern struct frame_info *create_new_frame (CORE_ADDR base, CORE_ADDR pc);
 670
 671
 672 /* Create/access the frame's `extra info'.  The extra info is used by
 673    older code to store information such as the analyzed prologue.  The
 674    zalloc() should only be called by the INIT_EXTRA_INFO method.  */
 675
 676 extern struct frame_extra_info *frame_extra_info_zalloc (struct frame_info *fi,
 677                                                          long size);
 678 extern struct frame_extra_info *get_frame_extra_info (struct frame_info *fi);
 679
 680 /* Create/access the frame's `saved_regs'.  The saved regs are used by
 681    older code to store the address of each register (except for
 682    SP_REGNUM where the value of the register in the previous frame is
 683    stored).  */
 684 extern CORE_ADDR *frame_saved_regs_zalloc (struct frame_info *);
 685 extern CORE_ADDR *deprecated_get_frame_saved_regs (struct frame_info *);
 686
 687 /* FIXME: cagney/2002-12-06: Has the PC in the current frame changed?
 688    "infrun.c", Thanks to DECR_PC_AFTER_BREAK, can change the PC after
 689    the initial frame create.  This puts things back in sync.
 690
 691    This replaced: frame->pc = ....; */
 692 extern void deprecated_update_frame_pc_hack (struct frame_info *frame,
 693                                              CORE_ADDR pc);
 694
 695 /* FIXME: cagney/2002-12-18: Has the frame's base changed?  Or to be
 696    more exact, was that initial guess at the frame's base as returned
 697    by deprecated_read_fp() wrong?  If it was, fix it.  This shouldn't
 698    be necessary since the code should be getting the frame's base
 699    correct from the outset.
 700
 701    This replaced: frame->frame = ....; */
 702 extern void deprecated_update_frame_base_hack (struct frame_info *frame,
 703                                                CORE_ADDR base);
 704
 705 /* FIXME: cagney/2003-01-04: Explicitly set the frame's saved_regs
 706    and/or extra_info.  Target code is allocating a fake frame and than
 707    initializing that to get around the problem of, when creating the
 708    inner most frame, there is no where to cache information such as
 709    the prologue analysis.  This is fixed by the new unwind mechanism -
 710    even the inner most frame has somewhere to store things like the
 711    prolog analysis (or at least will once the frame overhaul is
 712    finished).  */
 713 extern void deprecated_set_frame_saved_regs_hack (struct frame_info *frame,
 714                                                   CORE_ADDR *saved_regs);
 715 extern void deprecated_set_frame_extra_info_hack (struct frame_info *frame,
 716                                                   struct frame_extra_info *extra_info);
 717
 718 /* FIXME: cagney/2003-01-04: Allocate a frame from the heap (rather
 719    than the frame obstack).  Targets do this as a way of saving the
 720    prologue analysis from the inner most frame before that frame has
 721    been created.  By always creating a frame, this problem goes away.  */
 722 extern struct frame_info *deprecated_frame_xmalloc (void);
 723
 724 /* FIXME: cagney/2003-01-05: Allocate a frame, along with the
 725    saved_regs and extra_info.  Set up cleanups for all three.  Same as
 726    for deprecated_frame_xmalloc, targets are calling this when
 727    creating a scratch `struct frame_info'.  The frame overhaul makes
 728    this unnecessary since all frame queries are parameterized with a
 729    common cache parameter and a frame.  */
 730 extern struct frame_info *deprecated_frame_xmalloc_with_cleanup (long sizeof_saved_regs,
 731                                                                  long sizeof_extra_info);
 732
 733 /* FIXME: cagney/2003-01-07: These are just nasty.  Code shouldn't be
 734    doing this.  I suspect it dates back to the days when every field
 735    of an allocated structure was explicitly initialized.  */
 736 extern void deprecated_set_frame_next_hack (struct frame_info *fi,
 737                                             struct frame_info *next);
 738 extern void deprecated_set_frame_prev_hack (struct frame_info *fi,
 739                                             struct frame_info *prev);
 740
 741 /* FIXME: cagney/2003-01-07: Instead of the dwarf2cfi having its own
 742    dedicated `struct frame_info . context' field, the code should use
 743    the per frame `unwind_cache' that is passed to the
 744    frame_pc_unwind(), frame_register_unwind() and frame_id_unwind()
 745    methods.
 746
 747    See "dummy-frame.c" for an example of how a cfi-frame object can be
 748    implemented using this.  */
 749 extern struct context *deprecated_get_frame_context (struct frame_info *fi);
 750 extern void deprecated_set_frame_context (struct frame_info *fi,
 751                                           struct context *context);
 752
 753 /* Return non-zero if the architecture is relying on legacy frame
 754    code.  */
 755 extern int legacy_frame_p (struct gdbarch *gdbarch);
 756
 757 #endif /* !defined (FRAME_H)  */