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