gdb/frame.h

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