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