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