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