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