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