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
  29 /* The traditional frame unwinder.  */
  30 extern const struct frame_unwind *trad_frame_unwind;
  31
  32 /* The frame object.  */
  33
  34 struct frame_info;
  35
  36 /* The frame object's ID.  This provides a per-frame unique identifier
  37    that can be used to relocate a `struct frame_info' after a target
  38    resume or a frame cache destruct.  It of course assumes that the
  39    inferior hasn't unwound the stack past that frame.  */
  40
  41 struct frame_id
  42 {
  43   /* The frame's address.  This should be constant through out the
  44      lifetime of a frame.  */
  45   /* NOTE: cagney/2002-11-16: The ia64 has two stacks and hence two
  46      frame bases.  This will need to be expanded to accomodate that.  */
  47   CORE_ADDR base;
  48   /* The frame's current PC.  While the PC within the function may
  49      change, the function that contains the PC does not.  Should this
  50      instead be the frame's function?  */
  51   CORE_ADDR pc;
  52 };
  53
  54 /* Methods for constructing and comparing Frame IDs.
  55
  56    NOTE: Given frameless functions A and B, where A calls B (and hence
  57    B is inner-to A).  The relationships: !eq(A,B); !eq(B,A);
  58    !inner(A,B); !inner(B,A); all hold.  This is because, while B is
  59    inner to A, B is not strictly inner to A (being frameless, they
  60    have the same .base value).  */
  61
  62 /* For convenience.  All fields are zero.  */
  63 extern const struct frame_id null_frame_id;
  64
  65 /* Construct a frame ID.  The second parameter isn't yet well defined.
  66    It might be the containing function, or the resume PC (see comment
  67    above in `struct frame_id')?  A func/pc of zero indicates a
  68    wildcard (i.e., do not use func in frame ID comparisons).  */
  69 extern struct frame_id frame_id_build (CORE_ADDR base,
  70                                        CORE_ADDR func_or_pc);
  71
  72 /* Returns non-zero when L is a valid frame (a valid frame has a
  73    non-zero .base).  */
  74 extern int frame_id_p (struct frame_id l);
  75
  76 /* Returns non-zero when L and R identify the same frame, or, if
  77    either L or R have a zero .func, then the same frame base.  */
  78 extern int frame_id_eq (struct frame_id l, struct frame_id r);
  79
  80 /* Returns non-zero when L is strictly inner-than R (they have
  81    different frame .bases).  Neither L, nor R can be `null'.  See note
  82    above about frameless functions.  */
  83 extern int frame_id_inner (struct frame_id l, struct frame_id r);
  84
  85
  86 /* For every stopped thread, GDB tracks two frames: current and
  87    selected.  Current frame is the inner most frame of the selected
  88    thread.  Selected frame is the one being examined by the the GDB
  89    CLI (selected using `up', `down', ...).  The frames are created
  90    on-demand (via get_prev_frame()) and then held in a frame cache.  */
  91 /* FIXME: cagney/2002-11-28: Er, there is a lie here.  If you do the
  92    sequence: `thread 1; up; thread 2; thread 1' you loose thread 1's
  93    selected frame.  At present GDB only tracks the selected frame of
  94    the current thread.  But be warned, that might change.  */
  95 /* FIXME: cagney/2002-11-14: At any time, only one thread's selected
  96    and current frame can be active.  Switching threads causes gdb to
  97    discard all that cached frame information.  Ulgh!  Instead, current
  98    and selected frame should be bound to a thread.  */
  99
 100 /* On demand, create the inner most frame using information found in
 101    the inferior.  If the inner most frame can't be created, throw an
 102    error.  */
 103 extern struct frame_info *get_current_frame (void);
 104
 105 /* Invalidates the frame cache (this function should have been called
 106    invalidate_cached_frames).
 107
 108    FIXME: cagney/2002-11-28: The only difference between
 109    flush_cached_frames() and reinit_frame_cache() is that the latter
 110    explicitly sets the selected frame back to the current frame there
 111    isn't any real difference (except that one delays the selection of
 112    a new frame).  Code can instead simply rely on get_selected_frame()
 113    to reinit's the selected frame as needed.  As for invalidating the
 114    cache, there should be two methods one that reverts the thread's
 115    selected frame back to current frame (for when the inferior
 116    resumes) and one that does not (for when the user modifies the
 117    target invalidating the frame cache).  */
 118 extern void flush_cached_frames (void);
 119 extern void reinit_frame_cache (void);
 120
 121 /* On demand, create the selected frame and then return it.  If the
 122    selected frame can not be created, this function throws an error.  */
 123 /* FIXME: cagney/2002-11-28: At present, when there is no selected
 124    frame, this function always returns the current (inner most) frame.
 125    It should instead, when a thread has previously had its frame
 126    selected (but not resumed) and the frame cache invalidated, find
 127    and then return that thread's previously selected frame.  */
 128 extern struct frame_info *get_selected_frame (void);
 129
 130 /* Select a specific frame.  NULL, apparently implies re-select the
 131    inner most frame.  */
 132 extern void select_frame (struct frame_info *);
 133
 134 /* Given a FRAME, return the next (more inner, younger) or previous
 135    (more outer, older) frame.  */
 136 extern struct frame_info *get_prev_frame (struct frame_info *);
 137 extern struct frame_info *get_next_frame (struct frame_info *);
 138
 139 /* Given a frame's ID, relocate the frame.  Returns NULL if the frame
 140    is not found.  */
 141 extern struct frame_info *frame_find_by_id (struct frame_id id);
 142
 143 /* Base attributes of a frame: */
 144
 145 /* The frame's `resume' address.  Where the program will resume in
 146    this frame.  */
 147 extern CORE_ADDR get_frame_pc (struct frame_info *);
 148
 149 /* Closely related to the resume address, various symbol table
 150    attributes that are determined by the PC.  Note that for a normal
 151    frame, the PC refers to the resume address after the return, and
 152    not the call instruction.  In such a case, the address is adjusted
 153    so that it (approximatly) identifies the call site (and not return
 154    site).
 155
 156    NOTE: cagney/2002-11-28: The frame cache could be used to cache the
 157    computed value.  Working on the assumption that the bottle-neck is
 158    in the single step code, and that code causes the frame cache to be
 159    constantly flushed, caching things in a frame is probably of little
 160    benefit.  As they say `show us the numbers'.
 161
 162    NOTE: cagney/2002-11-28: Plenty more where this one came from:
 163    find_frame_block(), find_frame_partial_function(),
 164    find_frame_symtab(), find_frame_function().  Each will need to be
 165    carefully considered to determine if the real intent was for it to
 166    apply to the PC or the adjusted PC.  */
 167 extern void find_frame_sal (struct frame_info *frame,
 168                             struct symtab_and_line *sal);
 169
 170 /* Return the frame address from FI.  Except in the machine-dependent
 171    *FRAME* macros, a frame address has no defined meaning other than
 172    as a magic cookie which identifies a frame over calls to the
 173    inferior (um, SEE NOTE BELOW).  The only known exception is
 174    inferior.h (DEPRECATED_PC_IN_CALL_DUMMY) [ON_STACK]; see comments
 175    there.  You cannot assume that a frame address contains enough
 176    information to reconstruct the frame; if you want more than just to
 177    identify the frame (e.g. be able to fetch variables relative to
 178    that frame), then save the whole struct frame_info (and the next
 179    struct frame_info, since the latter is used for fetching variables
 180    on some machines) (um, again SEE NOTE BELOW).
 181
 182    NOTE: cagney/2002-11-18: Actually, the frame address isn't
 183    sufficient for identifying a frame, and the counter examples are
 184    wrong!
 185
 186    Code that needs to (re)identify a frame must use get_frame_id() and
 187    frame_find_by_id() (and in the future, a frame_compare() function
 188    instead of INNER_THAN()).  Two reasons: an architecture (e.g.,
 189    ia64) can have more than one frame address (due to multiple stack
 190    pointers) (frame ID is going to be expanded to accomodate this);
 191    successive frameless function calls can only be differientated by
 192    comparing both the frame's base and the frame's enclosing function
 193    (frame_find_by_id() is going to be modified to perform this test).
 194
 195    The generic dummy frame version of DEPRECATED_PC_IN_CALL_DUMMY() is
 196    able to identify a dummy frame using only the PC value.  So the
 197    frame address is not needed.  In fact, most
 198    DEPRECATED_PC_IN_CALL_DUMMY() calls now pass zero as the frame/sp
 199    values as the caller knows that those values won't be used.  Once
 200    all architectures are using generic dummy frames,
 201    DEPRECATED_PC_IN_CALL_DUMMY() can drop the sp/frame parameters.
 202    When it comes to finding a dummy frame, the next frame's frame ID
 203    (with out duing an unwind) can be used (ok, could if it wasn't for
 204    the need to change the way the PPC defined frame base in a strange
 205    way).
 206
 207    Modern architectures should be using something like dwarf2's
 208    location expression to describe where a variable lives.  Such
 209    expressions specify their own debug info centric frame address.
 210    Consequently, a generic frame address is pretty meaningless.  */
 211
 212 extern CORE_ADDR get_frame_base (struct frame_info *);
 213
 214 /* Return the per-frame unique identifer.  Can be used to relocate a
 215    frame after a frame cache flush (and other similar operations).  If
 216    FI is NULL, return the null_frame_id.  */
 217 extern struct frame_id get_frame_id (struct frame_info *fi);
 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 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 /* Unwind the frame ID.  Return an ID that uniquely identifies the
 313    caller's frame.  */
 314 extern struct frame_id frame_id_unwind (struct frame_info *frame);
 315
 316 /* Discard the specified frame.  Restoring the registers to the state
 317    of the caller.  */
 318 extern void frame_pop (struct frame_info *frame);
 319
 320 /* Describe the saved registers of a frame.  */
 321
 322 #if defined (EXTRA_FRAME_INFO) || defined (FRAME_FIND_SAVED_REGS)
 323 /* XXXX - deprecated */
 324 struct frame_saved_regs
 325   {
 326     /* For each register R (except the SP), regs[R] is the address at
 327        which it was saved on entry to the frame, or zero if it was not
 328        saved on entry to this frame.  This includes special registers
 329        such as pc and fp saved in special ways in the stack frame.
 330
 331        regs[SP_REGNUM] is different.  It holds the actual SP, not the
 332        address at which it was saved.  */
 333
 334     CORE_ADDR regs[NUM_REGS];
 335   };
 336 #endif
 337
 338 /* We keep a cache of stack frames, each of which is a "struct
 339    frame_info".  The innermost one gets allocated (in
 340    wait_for_inferior) each time the inferior stops; current_frame
 341    points to it.  Additional frames get allocated (in
 342    get_prev_frame) as needed, and are chained through the next
 343    and prev fields.  Any time that the frame cache becomes invalid
 344    (most notably when we execute something, but also if we change how
 345    we interpret the frames (e.g. "set heuristic-fence-post" in
 346    mips-tdep.c, or anything which reads new symbols)), we should call
 347    reinit_frame_cache.  */
 348
 349 struct frame_info
 350   {
 351     /* Nominal address of the frame described.  See comments at
 352        get_frame_base() about what this means outside the *FRAME*
 353        macros; in the *FRAME* macros, it can mean whatever makes most
 354        sense for this machine.  */
 355     CORE_ADDR frame;
 356
 357     /* Address at which execution is occurring in this frame.
 358        For the innermost frame, it's the current pc.
 359        For other frames, it is a pc saved in the next frame.  */
 360     CORE_ADDR pc;
 361
 362     /* Level of this frame.  The inner-most (youngest) frame is at
 363        level 0.  As you move towards the outer-most (oldest) frame,
 364        the level increases.  This is a cached value.  It could just as
 365        easily be computed by counting back from the selected frame to
 366        the inner most frame.  */
 367     /* NOTE: cagney/2002-04-05: Perhaphs a level of ``-1'' should be
 368        reserved to indicate a bogus frame - one that has been created
 369        just to keep GDB happy (GDB always needs a frame).  For the
 370        moment leave this as speculation.  */
 371     int level;
 372
 373     /* The frame's type.  */
 374     enum frame_type type;
 375
 376     /* For each register, address of where it was saved on entry to
 377        the frame, or zero if it was not saved on entry to this frame.
 378        This includes special registers such as pc and fp saved in
 379        special ways in the stack frame.  The SP_REGNUM is even more
 380        special, the address here is the sp for the previous frame, not
 381        the address where the sp was saved.  */
 382     /* Allocated by frame_saved_regs_zalloc () which is called /
 383        initialized by FRAME_INIT_SAVED_REGS(). */
 384     CORE_ADDR *saved_regs;      /*NUM_REGS + NUM_PSEUDO_REGS*/
 385
 386 #ifdef EXTRA_FRAME_INFO
 387     /* XXXX - deprecated */
 388     /* Anything extra for this structure that may have been defined
 389        in the machine dependent files. */
 390       EXTRA_FRAME_INFO
 391 #endif
 392
 393     /* Anything extra for this structure that may have been defined
 394        in the machine dependent files. */
 395     /* Allocated by frame_extra_info_zalloc () which is called /
 396        initialized by INIT_EXTRA_FRAME_INFO */
 397     struct frame_extra_info *extra_info;
 398
 399     /* If dwarf2 unwind frame informations is used, this structure holds all
 400        related unwind data.  */
 401     struct context *context;
 402
 403     /* Unwind cache shared between the unwind functions - they had
 404        better all agree as to the contents.  */
 405     void *unwind_cache;
 406
 407     /* The frame's unwinder.  */
 408     const struct frame_unwind *unwind;
 409
 410     /* Cached copy of the previous frame's resume address.  */
 411     int pc_unwind_cache_p;
 412     CORE_ADDR pc_unwind_cache;
 413
 414     /* Cached copy of the previous frame's ID.  */
 415     int id_unwind_cache_p;
 416     struct frame_id id_unwind_cache;
 417
 418     /* Pointers to the next (down, inner, younger) and previous (up,
 419        outer, older) frame_info's in the frame cache.  */
 420     struct frame_info *next; /* down, inner, younger */
 421     int prev_p;
 422     struct frame_info *prev; /* up, outer, older */
 423   };
 424
 425 /* Values for the source flag to be used in print_frame_info_base(). */
 426 enum print_what
 427   {
 428     /* Print only the source line, like in stepi. */
 429     SRC_LINE = -1,
 430     /* Print only the location, i.e. level, address (sometimes)
 431        function, args, file, line, line num. */
 432     LOCATION,
 433     /* Print both of the above. */
 434     SRC_AND_LOC,
 435     /* Print location only, but always include the address. */
 436     LOC_AND_ADDRESS
 437   };
 438
 439 /* Allocate additional space for appendices to a struct frame_info.
 440    NOTE: Much of GDB's code works on the assumption that the allocated
 441    saved_regs[] array is the size specified below.  If you try to make
 442    that array smaller, GDB will happily walk off its end. */
 443
 444 #ifdef SIZEOF_FRAME_SAVED_REGS
 445 #error "SIZEOF_FRAME_SAVED_REGS can not be re-defined"
 446 #endif
 447 #define SIZEOF_FRAME_SAVED_REGS \
 448         (sizeof (CORE_ADDR) * (NUM_REGS+NUM_PSEUDO_REGS))
 449
 450 /* Allocate zero initialized memory from the frame cache obstack.
 451    Appendices to the frame info (such as the unwind cache) should
 452    allocate memory using this method.  */
 453
 454 extern void *frame_obstack_zalloc (unsigned long size);
 455 #define FRAME_OBSTACK_ZALLOC(TYPE) ((TYPE *) frame_obstack_zalloc (sizeof (TYPE)))
 456
 457 /* If FRAME_CHAIN_VALID returns zero it means that the given frame
 458    is the outermost one and has no caller.  */
 459
 460 extern int frame_chain_valid (CORE_ADDR, struct frame_info *);
 461
 462 extern void generic_save_dummy_frame_tos (CORE_ADDR sp);
 463
 464
 465 #ifdef FRAME_FIND_SAVED_REGS
 466 /* XXX - deprecated */
 467 #define FRAME_INIT_SAVED_REGS(FI) deprecated_get_frame_saved_regs (FI, NULL)
 468 extern void deprecated_get_frame_saved_regs (struct frame_info *,
 469                                              struct frame_saved_regs *);
 470 #endif
 471
 472 extern struct block *get_frame_block (struct frame_info *,
 473                                       CORE_ADDR *addr_in_block);
 474
 475 /* Return the `struct block' that belongs to the selected thread's
 476    selected frame.  If the inferior has no state, return NULL.
 477
 478    NOTE: cagney/2002-11-29:
 479
 480    No state?  Does the inferior have any execution state (a core file
 481    does, an executable does not).  At present the code tests
 482    `target_has_stack' but I'm left wondering if it should test
 483    `target_has_registers' or, even, a merged target_has_state.
 484
 485    Should it look at the most recently specified SAL?  If the target
 486    has no state, should this function try to extract a block from the
 487    most recently selected SAL?  That way `list foo' would give it some
 488    sort of reference point.  Then again, perhaphs that would confuse
 489    things.
 490
 491    Calls to this function can be broken down into two categories: Code
 492    that uses the selected block as an additional, but optional, data
 493    point; Code that uses the selected block as a prop, when it should
 494    have the relevant frame/block/pc explicitly passed in.
 495
 496    The latter can be eliminated by correctly parameterizing the code,
 497    the former though is more interesting.  Per the "address" command,
 498    it occures in the CLI code and makes it possible for commands to
 499    work, even when the inferior has no state.  */
 500
 501 extern struct block *get_selected_block (CORE_ADDR *addr_in_block);
 502
 503 extern struct symbol *get_frame_function (struct frame_info *);
 504
 505 extern CORE_ADDR frame_address_in_block (struct frame_info *);
 506
 507 extern CORE_ADDR get_pc_function_start (CORE_ADDR);
 508
 509 extern struct block *block_for_pc (CORE_ADDR);
 510
 511 extern struct block *block_for_pc_sect (CORE_ADDR, asection *);
 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    get_saved_register to the next outer frame.  */
 549
 550 extern char *deprecated_generic_find_dummy_frame (CORE_ADDR pc, CORE_ADDR fp);
 551
 552 extern void generic_fix_call_dummy (char *dummy, CORE_ADDR pc, CORE_ADDR fun,
 553                                     int nargs, struct value **args,
 554                                     struct type *type, int gcc_p);
 555
 556 /* The function generic_get_saved_register() has been made obsolete.
 557    GET_SAVED_REGISTER now defaults to the recursive equivalent -
 558    generic_unwind_get_saved_register() - so there is no need to even
 559    set GET_SAVED_REGISTER.  Architectures that need to override the
 560    register unwind mechanism should modify frame->unwind().  */
 561 extern void deprecated_generic_get_saved_register (char *, int *, CORE_ADDR *,
 562                                                    struct frame_info *, int,
 563                                                    enum lval_type *);
 564
 565 extern void generic_save_call_dummy_addr (CORE_ADDR lo, CORE_ADDR hi);
 566
 567 extern void get_saved_register (char *raw_buffer, int *optimized,
 568                                 CORE_ADDR * addrp,
 569                                 struct frame_info *frame,
 570                                 int regnum, enum lval_type *lval);
 571
 572 /* FIXME: cagney/2003-02-02: Should be deprecated or replaced with a
 573    function called frame_read_register_p().  This slightly weird (and
 574    older) variant of frame_read_register() returns zero (indicating
 575    the register is unavailable) if either: the register isn't cached;
 576    or the register has been optimized out.  Problem is, neither check
 577    is exactly correct.  A register can't be optimized out (it may not
 578    have been saved as part of a function call); The fact that a
 579    register isn't in the register cache doesn't mean that the register
 580    isn't available (it could have been fetched from memory).  */
 581
 582 extern int frame_register_read (struct frame_info *frame, int regnum,
 583                                 void *buf);
 584
 585 /* From stack.c.  */
 586 extern void args_info (char *, int);
 587
 588 extern void locals_info (char *, int);
 589
 590 extern void (*selected_frame_level_changed_hook) (int);
 591
 592 extern void return_command (char *, int);
 593
 594
 595 /* NOTE: cagney/2002-11-27:
 596
 597    You might think that the below global can simply be replaced by a
 598    call to either get_selected_frame() or select_frame().
 599
 600    Unfortunatly, it isn't that easy.
 601
 602    The relevant code needs to be audited to determine if it is
 603    possible (or pratical) to instead pass the applicable frame in as a
 604    parameter.  For instance, DEPRECATED_DO_REGISTERS_INFO() relied on
 605    the deprecated_selected_frame global, while its replacement,
 606    PRINT_REGISTERS_INFO(), is parameterized with the selected frame.
 607    The only real exceptions occure at the edge (in the CLI code) where
 608    user commands need to pick up the selected frame before proceeding.
 609
 610    This is important.  GDB is trying to stamp out the hack:
 611
 612    saved_frame = deprecated_selected_frame;
 613    deprecated_selected_frame = ...;
 614    hack_using_global_selected_frame ();
 615    deprecated_selected_frame = saved_frame;
 616
 617    Take care!  */
 618
 619 extern struct frame_info *deprecated_selected_frame;
 620
 621
 622 /* Create a frame using the specified BASE and PC.  */
 623
 624 extern struct frame_info *create_new_frame (CORE_ADDR base, CORE_ADDR pc);
 625
 626
 627 /* Create/access the frame's `extra info'.  The extra info is used by
 628    older code to store information such as the analyzed prologue.  The
 629    zalloc() should only be called by the INIT_EXTRA_INFO method.  */
 630
 631 extern struct frame_extra_info *frame_extra_info_zalloc (struct frame_info *fi,
 632                                                          long size);
 633 extern struct frame_extra_info *get_frame_extra_info (struct frame_info *fi);
 634
 635 /* Create/access the frame's `saved_regs'.  The saved regs are used by
 636    older code to store the address of each register (except for
 637    SP_REGNUM where the value of the register in the previous frame is
 638    stored).  */
 639 extern CORE_ADDR *frame_saved_regs_zalloc (struct frame_info *);
 640 extern CORE_ADDR *get_frame_saved_regs (struct frame_info *);
 641
 642 /* FIXME: cagney/2002-12-06: Has the PC in the current frame changed?
 643    "infrun.c", Thanks to DECR_PC_AFTER_BREAK, can change the PC after
 644    the initial frame create.  This puts things back in sync.  */
 645 extern void deprecated_update_frame_pc_hack (struct frame_info *frame,
 646                                              CORE_ADDR pc);
 647
 648 /* FIXME: cagney/2002-12-18: Has the frame's base changed?  Or to be
 649    more exact, whas that initial guess at the frame's base as returned
 650    by read_fp() wrong.  If it was, fix it.  This shouldn't be
 651    necessary since the code should be getting the frame's base correct
 652    from the outset.  */
 653 extern void deprecated_update_frame_base_hack (struct frame_info *frame,
 654                                                CORE_ADDR base);
 655
 656 /* FIXME: cagney/2003-01-04: Explicitly set the frame's saved_regs
 657    and/or extra_info.  Target code is allocating a fake frame and than
 658    initializing that to get around the problem of, when creating the
 659    inner most frame, there is no where to cache information such as
 660    the prologue analysis.  This is fixed by the new unwind mechanism -
 661    even the inner most frame has somewhere to store things like the
 662    prolog analysis (or at least will once the frame overhaul is
 663    finished).  */
 664 extern void deprecated_set_frame_saved_regs_hack (struct frame_info *frame,
 665                                                   CORE_ADDR *saved_regs);
 666 extern void deprecated_set_frame_extra_info_hack (struct frame_info *frame,
 667                                                   struct frame_extra_info *extra_info);
 668
 669 /* FIXME: cagney/2003-01-04: Allocate a frame from the heap (rather
 670    than the frame obstack).  Targets do this as a way of saving the
 671    prologue analysis from the inner most frame before that frame has
 672    been created.  By always creating a frame, this problem goes away.  */
 673 extern struct frame_info *deprecated_frame_xmalloc (void);
 674
 675 /* FIXME: cagney/2003-01-05: Allocate a frame, along with the
 676    saved_regs and extra_info.  Set up cleanups for all three.  Same as
 677    for deprecated_frame_xmalloc, targets are calling this when
 678    creating a scratch `struct frame_info'.  The frame overhaul makes
 679    this unnecessary since all frame queries are parameterized with a
 680    common cache parameter and a frame.  */
 681 extern struct frame_info *deprecated_frame_xmalloc_with_cleanup (long sizeof_saved_regs,
 682                                                                  long sizeof_extra_info);
 683
 684 /* FIXME: cagney/2003-01-07: These are just nasty.  Code shouldn't be
 685    doing this.  I suspect it dates back to the days when every field
 686    of an allocated structure was explicitly initialized.  */
 687 extern void deprecated_set_frame_next_hack (struct frame_info *fi,
 688                                             struct frame_info *next);
 689 extern void deprecated_set_frame_prev_hack (struct frame_info *fi,
 690                                             struct frame_info *prev);
 691
 692 /* FIXME: cagney/2003-01-07: Instead of the dwarf2cfi having its own
 693    dedicated `struct frame_info . context' field, the code should use
 694    the per frame `unwind_cache' that is passed to the
 695    frame_pc_unwind(), frame_register_unwind() and frame_id_unwind()
 696    methods.
 697
 698    See "dummy-frame.c" for an example of how a cfi-frame object can be
 699    implemented using this.  */
 700 extern struct context *deprecated_get_frame_context (struct frame_info *fi);
 701 extern void deprecated_set_frame_context (struct frame_info *fi,
 702                                           struct context *context);
 703
 704 #endif /* !defined (FRAME_H)  */