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