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 /* Values for the source flag to be used in print_frame_info_base(). */
 347 enum print_what
 348   {
 349     /* Print only the source line, like in stepi. */
 350     SRC_LINE = -1,
 351     /* Print only the location, i.e. level, address (sometimes)
 352        function, args, file, line, line num. */
 353     LOCATION,
 354     /* Print both of the above. */
 355     SRC_AND_LOC,
 356     /* Print location only, but always include the address. */
 357     LOC_AND_ADDRESS
 358   };
 359
 360 /* Allocate additional space for appendices to a struct frame_info.
 361    NOTE: Much of GDB's code works on the assumption that the allocated
 362    saved_regs[] array is the size specified below.  If you try to make
 363    that array smaller, GDB will happily walk off its end. */
 364
 365 #ifdef SIZEOF_FRAME_SAVED_REGS
 366 #error "SIZEOF_FRAME_SAVED_REGS can not be re-defined"
 367 #endif
 368 #define SIZEOF_FRAME_SAVED_REGS \
 369         (sizeof (CORE_ADDR) * (NUM_REGS+NUM_PSEUDO_REGS))
 370
 371 /* Allocate zero initialized memory from the frame cache obstack.
 372    Appendices to the frame info (such as the unwind cache) should
 373    allocate memory using this method.  */
 374
 375 extern void *frame_obstack_zalloc (unsigned long size);
 376 #define FRAME_OBSTACK_ZALLOC(TYPE) ((TYPE *) frame_obstack_zalloc (sizeof (TYPE)))
 377 #define FRAME_OBSTACK_CALLOC(NUMBER,TYPE) ((TYPE *) frame_obstack_zalloc ((NUMBER) * sizeof (TYPE)))
 378
 379 /* If legacy_frame_chain_valid() returns zero it means that the given
 380    frame is the outermost one and has no caller.
 381
 382    This method has been superseeded by the per-architecture
 383    frame_unwind_pc() (returns 0 to indicate an invalid return address)
 384    and per-frame this_id() (returns a NULL frame ID to indicate an
 385    invalid frame).  */
 386 extern int legacy_frame_chain_valid (CORE_ADDR, struct frame_info *);
 387
 388 extern void generic_save_dummy_frame_tos (CORE_ADDR sp);
 389
 390 extern struct block *get_frame_block (struct frame_info *,
 391                                       CORE_ADDR *addr_in_block);
 392
 393 /* Return the `struct block' that belongs to the selected thread's
 394    selected frame.  If the inferior has no state, return NULL.
 395
 396    NOTE: cagney/2002-11-29:
 397
 398    No state?  Does the inferior have any execution state (a core file
 399    does, an executable does not).  At present the code tests
 400    `target_has_stack' but I'm left wondering if it should test
 401    `target_has_registers' or, even, a merged target_has_state.
 402
 403    Should it look at the most recently specified SAL?  If the target
 404    has no state, should this function try to extract a block from the
 405    most recently selected SAL?  That way `list foo' would give it some
 406    sort of reference point.  Then again, perhaphs that would confuse
 407    things.
 408
 409    Calls to this function can be broken down into two categories: Code
 410    that uses the selected block as an additional, but optional, data
 411    point; Code that uses the selected block as a prop, when it should
 412    have the relevant frame/block/pc explicitly passed in.
 413
 414    The latter can be eliminated by correctly parameterizing the code,
 415    the former though is more interesting.  Per the "address" command,
 416    it occures in the CLI code and makes it possible for commands to
 417    work, even when the inferior has no state.  */
 418
 419 extern struct block *get_selected_block (CORE_ADDR *addr_in_block);
 420
 421 extern struct symbol *get_frame_function (struct frame_info *);
 422
 423 extern CORE_ADDR frame_address_in_block (struct frame_info *);
 424
 425 extern CORE_ADDR get_pc_function_start (CORE_ADDR);
 426
 427 extern int frameless_look_for_prologue (struct frame_info *);
 428
 429 extern void print_frame_args (struct symbol *, struct frame_info *,
 430                               int, struct ui_file *);
 431
 432 extern struct frame_info *find_relative_frame (struct frame_info *, int *);
 433
 434 extern void show_and_print_stack_frame (struct frame_info *fi, int level,
 435                                         int source);
 436
 437 extern void print_stack_frame (struct frame_info *, int, int);
 438
 439 extern void show_stack_frame (struct frame_info *);
 440
 441 extern void print_frame_info (struct frame_info *, int, int, int);
 442
 443 extern void show_frame_info (struct frame_info *, int, int, int);
 444
 445 extern struct frame_info *block_innermost_frame (struct block *);
 446
 447 /* NOTE: cagney/2002-09-13: There is no need for this function.
 448    Instead either of frame_unwind_signed_register() or
 449    frame_unwind_unsigned_register() can be used.  */
 450 extern CORE_ADDR deprecated_read_register_dummy (CORE_ADDR pc,
 451                                                  CORE_ADDR fp, int);
 452 extern void generic_push_dummy_frame (void);
 453 extern void generic_pop_current_frame (void (*)(struct frame_info *));
 454 extern void generic_pop_dummy_frame (void);
 455
 456 extern int generic_pc_in_call_dummy (CORE_ADDR pc,
 457                                      CORE_ADDR sp, CORE_ADDR fp);
 458
 459 /* NOTE: cagney/2002-06-26: Targets should no longer use this
 460    function.  Instead, the contents of a dummy frames registers can be
 461    obtained by applying: frame_register_unwind to the dummy frame; or
 462    frame_register_unwind() to the next outer frame.  */
 463
 464 extern char *deprecated_generic_find_dummy_frame (CORE_ADDR pc, CORE_ADDR fp);
 465
 466 void generic_unwind_get_saved_register (char *raw_buffer,
 467                                         int *optimizedp,
 468                                         CORE_ADDR *addrp,
 469                                         struct frame_info *frame,
 470                                         int regnum,
 471                                         enum lval_type *lvalp);
 472
 473 /* The function generic_get_saved_register() has been made obsolete.
 474    DEPRECATED_GET_SAVED_REGISTER now defaults to the recursive
 475    equivalent - generic_unwind_get_saved_register() - so there is no
 476    need to even set DEPRECATED_GET_SAVED_REGISTER.  Architectures that
 477    need to override the register unwind mechanism should modify
 478    frame->unwind().  */
 479 extern void deprecated_generic_get_saved_register (char *, int *, CORE_ADDR *,
 480                                                    struct frame_info *, int,
 481                                                    enum lval_type *);
 482
 483 extern void generic_save_call_dummy_addr (CORE_ADDR lo, CORE_ADDR hi);
 484
 485 /* FIXME: cagney/2003-02-02: Should be deprecated or replaced with a
 486    function called frame_read_register_p().  This slightly weird (and
 487    older) variant of frame_read_register() returns zero (indicating
 488    the register is unavailable) if either: the register isn't cached;
 489    or the register has been optimized out.  Problem is, neither check
 490    is exactly correct.  A register can't be optimized out (it may not
 491    have been saved as part of a function call); The fact that a
 492    register isn't in the register cache doesn't mean that the register
 493    isn't available (it could have been fetched from memory).  */
 494
 495 extern int frame_register_read (struct frame_info *frame, int regnum,
 496                                 void *buf);
 497
 498 /* From stack.c.  */
 499 extern void args_info (char *, int);
 500
 501 extern void locals_info (char *, int);
 502
 503 extern void (*selected_frame_level_changed_hook) (int);
 504
 505 extern void return_command (char *, int);
 506
 507
 508 /* NOTE: cagney/2002-11-27:
 509
 510    You might think that the below global can simply be replaced by a
 511    call to either get_selected_frame() or select_frame().
 512
 513    Unfortunatly, it isn't that easy.
 514
 515    The relevant code needs to be audited to determine if it is
 516    possible (or pratical) to instead pass the applicable frame in as a
 517    parameter.  For instance, DEPRECATED_DO_REGISTERS_INFO() relied on
 518    the deprecated_selected_frame global, while its replacement,
 519    PRINT_REGISTERS_INFO(), is parameterized with the selected frame.
 520    The only real exceptions occure at the edge (in the CLI code) where
 521    user commands need to pick up the selected frame before proceeding.
 522
 523    This is important.  GDB is trying to stamp out the hack:
 524
 525    saved_frame = deprecated_selected_frame;
 526    deprecated_selected_frame = ...;
 527    hack_using_global_selected_frame ();
 528    deprecated_selected_frame = saved_frame;
 529
 530    Take care!  */
 531
 532 extern struct frame_info *deprecated_selected_frame;
 533
 534
 535 /* Create a frame using the specified BASE and PC.  */
 536
 537 extern struct frame_info *create_new_frame (CORE_ADDR base, CORE_ADDR pc);
 538
 539
 540 /* Create/access the frame's `extra info'.  The extra info is used by
 541    older code to store information such as the analyzed prologue.  The
 542    zalloc() should only be called by the INIT_EXTRA_INFO method.  */
 543
 544 extern struct frame_extra_info *frame_extra_info_zalloc (struct frame_info *fi,
 545                                                          long size);
 546 extern struct frame_extra_info *get_frame_extra_info (struct frame_info *fi);
 547
 548 /* Create/access the frame's `saved_regs'.  The saved regs are used by
 549    older code to store the address of each register (except for
 550    SP_REGNUM where the value of the register in the previous frame is
 551    stored).  */
 552 extern CORE_ADDR *frame_saved_regs_zalloc (struct frame_info *);
 553 extern CORE_ADDR *get_frame_saved_regs (struct frame_info *);
 554
 555 /* FIXME: cagney/2002-12-06: Has the PC in the current frame changed?
 556    "infrun.c", Thanks to DECR_PC_AFTER_BREAK, can change the PC after
 557    the initial frame create.  This puts things back in sync.
 558
 559    This replaced: frame->pc = ....; */
 560 extern void deprecated_update_frame_pc_hack (struct frame_info *frame,
 561                                              CORE_ADDR pc);
 562
 563 /* FIXME: cagney/2002-12-18: Has the frame's base changed?  Or to be
 564    more exact, whas that initial guess at the frame's base as returned
 565    by deprecated_read_fp() wrong.  If it was, fix it.  This shouldn't
 566    be necessary since the code should be getting the frame's base
 567    correct from the outset.
 568
 569    This replaced: frame->frame = ....; */
 570 extern void deprecated_update_frame_base_hack (struct frame_info *frame,
 571                                                CORE_ADDR base);
 572
 573 /* FIXME: cagney/2003-01-04: Explicitly set the frame's saved_regs
 574    and/or extra_info.  Target code is allocating a fake frame and than
 575    initializing that to get around the problem of, when creating the
 576    inner most frame, there is no where to cache information such as
 577    the prologue analysis.  This is fixed by the new unwind mechanism -
 578    even the inner most frame has somewhere to store things like the
 579    prolog analysis (or at least will once the frame overhaul is
 580    finished).  */
 581 extern void deprecated_set_frame_saved_regs_hack (struct frame_info *frame,
 582                                                   CORE_ADDR *saved_regs);
 583 extern void deprecated_set_frame_extra_info_hack (struct frame_info *frame,
 584                                                   struct frame_extra_info *extra_info);
 585
 586 /* FIXME: cagney/2003-01-04: Allocate a frame from the heap (rather
 587    than the frame obstack).  Targets do this as a way of saving the
 588    prologue analysis from the inner most frame before that frame has
 589    been created.  By always creating a frame, this problem goes away.  */
 590 extern struct frame_info *deprecated_frame_xmalloc (void);
 591
 592 /* FIXME: cagney/2003-01-05: Allocate a frame, along with the
 593    saved_regs and extra_info.  Set up cleanups for all three.  Same as
 594    for deprecated_frame_xmalloc, targets are calling this when
 595    creating a scratch `struct frame_info'.  The frame overhaul makes
 596    this unnecessary since all frame queries are parameterized with a
 597    common cache parameter and a frame.  */
 598 extern struct frame_info *deprecated_frame_xmalloc_with_cleanup (long sizeof_saved_regs,
 599                                                                  long sizeof_extra_info);
 600
 601 /* FIXME: cagney/2003-01-07: These are just nasty.  Code shouldn't be
 602    doing this.  I suspect it dates back to the days when every field
 603    of an allocated structure was explicitly initialized.  */
 604 extern void deprecated_set_frame_next_hack (struct frame_info *fi,
 605                                             struct frame_info *next);
 606 extern void deprecated_set_frame_prev_hack (struct frame_info *fi,
 607                                             struct frame_info *prev);
 608
 609 /* FIXME: cagney/2003-01-07: Instead of the dwarf2cfi having its own
 610    dedicated `struct frame_info . context' field, the code should use
 611    the per frame `unwind_cache' that is passed to the
 612    frame_pc_unwind(), frame_register_unwind() and frame_id_unwind()
 613    methods.
 614
 615    See "dummy-frame.c" for an example of how a cfi-frame object can be
 616    implemented using this.  */
 617 extern struct context *deprecated_get_frame_context (struct frame_info *fi);
 618 extern void deprecated_set_frame_context (struct frame_info *fi,
 619                                           struct context *context);
 620
 621 /* Return non-zero if the architecture is relying on legacy frame
 622    code.  */
 623 extern int legacy_frame_p (struct gdbarch *gdbarch);
 624
 625 #endif /* !defined (FRAME_H)  */