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