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 block;
  29
  30 /* The traditional frame unwinder.  */
  31 extern const struct frame_unwind *trad_frame_unwind;
  32
  33 /* The frame object.  */
  34
  35 struct frame_info;
  36
  37 /* The frame object's ID.  This provides a per-frame unique identifier
  38    that can be used to relocate a `struct frame_info' after a target
  39    resume or a frame cache destruct.  It of course assumes that the
  40    inferior hasn't unwound the stack past that frame.  */
  41
  42 struct frame_id
  43 {
  44   /* The frame's address.  This should be constant through out the
  45      lifetime of a frame.  */
  46   /* NOTE: cagney/2002-11-16: The ia64 has two stacks and hence two
  47      frame bases.  This will need to be expanded to accomodate that.  */
  48   CORE_ADDR base;
  49   /* The frame's current PC.  While the PC within the function may
  50      change, the function that contains the PC does not.  Should this
  51      instead be the frame's function?  */
  52   CORE_ADDR pc;
  53 };
  54
  55 /* Methods for constructing and comparing Frame IDs.
  56
  57    NOTE: Given frameless functions A and B, where A calls B (and hence
  58    B is inner-to A).  The relationships: !eq(A,B); !eq(B,A);
  59    !inner(A,B); !inner(B,A); all hold.  This is because, while B is
  60    inner to A, B is not strictly inner to A (being frameless, they
  61    have the same .base value).  */
  62
  63 /* For convenience.  All fields are zero.  */
  64 extern const struct frame_id null_frame_id;
  65
  66 /* Construct a frame ID.  The second parameter isn't yet well defined.
  67    It might be the containing function, or the resume PC (see comment
  68    above in `struct frame_id')?  A func/pc of zero indicates a
  69    wildcard (i.e., do not use func in frame ID comparisons).  */
  70 extern struct frame_id frame_id_build (CORE_ADDR base,
  71                                        CORE_ADDR func_or_pc);
  72
  73 /* Returns non-zero when L is a valid frame (a valid frame has a
  74    non-zero .base).  */
  75 extern int frame_id_p (struct frame_id l);
  76
  77 /* Returns non-zero when L and R identify the same frame, or, if
  78    either L or R have a zero .func, then the same frame base.  */
  79 extern int frame_id_eq (struct frame_id l, struct frame_id r);
  80
  81 /* Returns non-zero when L is strictly inner-than R (they have
  82    different frame .bases).  Neither L, nor R can be `null'.  See note
  83    above about frameless functions.  */
  84 extern int frame_id_inner (struct frame_id l, struct frame_id r);
  85
  86
  87 /* For every stopped thread, GDB tracks two frames: current and
  88    selected.  Current frame is the inner most frame of the selected
  89    thread.  Selected frame is the one being examined by the the GDB
  90    CLI (selected using `up', `down', ...).  The frames are created
  91    on-demand (via get_prev_frame()) and then held in a frame cache.  */
  92 /* FIXME: cagney/2002-11-28: Er, there is a lie here.  If you do the
  93    sequence: `thread 1; up; thread 2; thread 1' you loose thread 1's
  94    selected frame.  At present GDB only tracks the selected frame of
  95    the current thread.  But be warned, that might change.  */
  96 /* FIXME: cagney/2002-11-14: At any time, only one thread's selected
  97    and current frame can be active.  Switching threads causes gdb to
  98    discard all that cached frame information.  Ulgh!  Instead, current
  99    and selected frame should be bound to a thread.  */
 100
 101 /* On demand, create the inner most frame using information found in
 102    the inferior.  If the inner most frame can't be created, throw an
 103    error.  */
 104 extern struct frame_info *get_current_frame (void);
 105
 106 /* Invalidates the frame cache (this function should have been called
 107    invalidate_cached_frames).
 108
 109    FIXME: cagney/2002-11-28: The only difference between
 110    flush_cached_frames() and reinit_frame_cache() is that the latter
 111    explicitly sets the selected frame back to the current frame there
 112    isn't any real difference (except that one delays the selection of
 113    a new frame).  Code can instead simply rely on get_selected_frame()
 114    to reinit's the selected frame as needed.  As for invalidating the
 115    cache, there should be two methods one that reverts the thread's
 116    selected frame back to current frame (for when the inferior
 117    resumes) and one that does not (for when the user modifies the
 118    target invalidating the frame cache).  */
 119 extern void flush_cached_frames (void);
 120 extern void reinit_frame_cache (void);
 121
 122 /* On demand, create the selected frame and then return it.  If the
 123    selected frame can not be created, this function throws an error.  */
 124 /* FIXME: cagney/2002-11-28: At present, when there is no selected
 125    frame, this function always returns the current (inner most) frame.
 126    It should instead, when a thread has previously had its frame
 127    selected (but not resumed) and the frame cache invalidated, find
 128    and then return that thread's previously selected frame.  */
 129 extern struct frame_info *get_selected_frame (void);
 130
 131 /* Select a specific frame.  NULL, apparently implies re-select the
 132    inner most frame.  */
 133 extern void select_frame (struct frame_info *);
 134
 135 /* Given a FRAME, return the next (more inner, younger) or previous
 136    (more outer, older) frame.  */
 137 extern struct frame_info *get_prev_frame (struct frame_info *);
 138 extern struct frame_info *get_next_frame (struct frame_info *);
 139
 140 /* Given a frame's ID, relocate the frame.  Returns NULL if the frame
 141    is not found.  */
 142 extern struct frame_info *frame_find_by_id (struct frame_id id);
 143
 144 /* Base attributes of a frame: */
 145
 146 /* The frame's `resume' address.  Where the program will resume in
 147    this frame.  */
 148 extern CORE_ADDR get_frame_pc (struct frame_info *);
 149
 150 /* Closely related to the resume address, various symbol table
 151    attributes that are determined by the PC.  Note that for a normal
 152    frame, the PC refers to the resume address after the return, and
 153    not the call instruction.  In such a case, the address is adjusted
 154    so that it (approximatly) identifies the call site (and not return
 155    site).
 156
 157    NOTE: cagney/2002-11-28: The frame cache could be used to cache the
 158    computed value.  Working on the assumption that the bottle-neck is
 159    in the single step code, and that code causes the frame cache to be
 160    constantly flushed, caching things in a frame is probably of little
 161    benefit.  As they say `show us the numbers'.
 162
 163    NOTE: cagney/2002-11-28: Plenty more where this one came from:
 164    find_frame_block(), find_frame_partial_function(),
 165    find_frame_symtab(), find_frame_function().  Each will need to be
 166    carefully considered to determine if the real intent was for it to
 167    apply to the PC or the adjusted PC.  */
 168 extern void find_frame_sal (struct frame_info *frame,
 169                             struct symtab_and_line *sal);
 170
 171 /* Return the frame address from FI.  Except in the machine-dependent
 172    *FRAME* macros, a frame address has no defined meaning other than
 173    as a magic cookie which identifies a frame over calls to the
 174    inferior (um, SEE NOTE BELOW).  The only known exception is
 175    inferior.h (DEPRECATED_PC_IN_CALL_DUMMY) [ON_STACK]; see comments
 176    there.  You cannot assume that a frame address contains enough
 177    information to reconstruct the frame; if you want more than just to
 178    identify the frame (e.g. be able to fetch variables relative to
 179    that frame), then save the whole struct frame_info (and the next
 180    struct frame_info, since the latter is used for fetching variables
 181    on some machines) (um, again SEE NOTE BELOW).
 182
 183    NOTE: cagney/2002-11-18: Actually, the frame address isn't
 184    sufficient for identifying a frame, and the counter examples are
 185    wrong!
 186
 187    Code that needs to (re)identify a frame must use get_frame_id() and
 188    frame_find_by_id() (and in the future, a frame_compare() function
 189    instead of INNER_THAN()).  Two reasons: an architecture (e.g.,
 190    ia64) can have more than one frame address (due to multiple stack
 191    pointers) (frame ID is going to be expanded to accomodate this);
 192    successive frameless function calls can only be differientated by
 193    comparing both the frame's base and the frame's enclosing function
 194    (frame_find_by_id() is going to be modified to perform this test).
 195
 196    The generic dummy frame version of DEPRECATED_PC_IN_CALL_DUMMY() is
 197    able to identify a dummy frame using only the PC value.  So the
 198    frame address is not needed.  In fact, most
 199    DEPRECATED_PC_IN_CALL_DUMMY() calls now pass zero as the frame/sp
 200    values as the caller knows that those values won't be used.  Once
 201    all architectures are using generic dummy frames,
 202    DEPRECATED_PC_IN_CALL_DUMMY() can drop the sp/frame parameters.
 203    When it comes to finding a dummy frame, the next frame's frame ID
 204    (with out duing an unwind) can be used (ok, could if it wasn't for
 205    the need to change the way the PPC defined frame base in a strange
 206    way).
 207
 208    Modern architectures should be using something like dwarf2's
 209    location expression to describe where a variable lives.  Such
 210    expressions specify their own debug info centric frame address.
 211    Consequently, a generic frame address is pretty meaningless.  */
 212
 213 extern CORE_ADDR get_frame_base (struct frame_info *);
 214
 215 /* Return the per-frame unique identifer.  Can be used to relocate a
 216    frame after a frame cache flush (and other similar operations).  If
 217    FI is NULL, return the null_frame_id.  */
 218 extern struct frame_id get_frame_id (struct frame_info *fi);
 219
 220 /* The frame's level: 0 for innermost, 1 for its caller, ...; or -1
 221    for an invalid frame).  */
 222 extern int frame_relative_level (struct frame_info *fi);
 223
 224 /* Return the frame's type.  Some are real, some are signal
 225    trampolines, and some are completly artificial (dummy).  */
 226
 227 enum frame_type
 228 {
 229   /* A true stack frame, created by the target program during normal
 230      execution.  */
 231   NORMAL_FRAME,
 232   /* A fake frame, created by GDB when performing an inferior function
 233      call.  */
 234   DUMMY_FRAME,
 235   /* In a signal handler, various OSs handle this in various ways.
 236      The main thing is that the frame may be far from normal.  */
 237   SIGTRAMP_FRAME
 238 };
 239 extern enum frame_type get_frame_type (struct frame_info *);
 240
 241 /* FIXME: cagney/2002-11-10: Some targets want to directly mark a
 242    frame as being of a specific type.  This shouldn't be necessary.
 243    PC_IN_SIGTRAMP() indicates a SIGTRAMP_FRAME and
 244    DEPRECATED_PC_IN_CALL_DUMMY() indicates a DUMMY_FRAME.  I suspect
 245    the real problem here is that get_prev_frame() only sets
 246    initialized after DEPRECATED_INIT_EXTRA_FRAME_INFO as been called.
 247    Consequently, some targets found that the frame's type was wrong
 248    and tried to fix it.  The correct fix is to modify get_prev_frame()
 249    so that it initializes the frame's type before calling any other
 250    functions.  */
 251 extern void deprecated_set_frame_type (struct frame_info *,
 252                                        enum frame_type type);
 253
 254 /* Unwind the stack frame so that the value of REGNUM, in the previous
 255    (up, older) frame is returned.  If VALUEP is NULL, don't
 256    fetch/compute the value.  Instead just return the location of the
 257    value.  */
 258 extern void frame_register_unwind (struct frame_info *frame, int regnum,
 259                                    int *optimizedp, enum lval_type *lvalp,
 260                                    CORE_ADDR *addrp, int *realnump,
 261                                    void *valuep);
 262
 263 /* More convenient interface to frame_register_unwind().  */
 264 /* NOTE: cagney/2002-09-13: Return void as one day these functions may
 265    be changed to return an indication that the read succeeded.  */
 266
 267 extern void frame_unwind_register (struct frame_info *frame,
 268                                    int regnum, void *buf);
 269
 270 extern void frame_unwind_signed_register (struct frame_info *frame,
 271                                           int regnum, LONGEST *val);
 272
 273 extern void frame_unwind_unsigned_register (struct frame_info *frame,
 274                                             int regnum, ULONGEST *val);
 275
 276 /* Get the value of the register that belongs to this FRAME.  This
 277    function is a wrapper to the call sequence ``frame_unwind_register
 278    (get_next_frame (FRAME))''.  As per frame_register_unwind(), if
 279    VALUEP is NULL, the registers value is not fetched/computed.  */
 280
 281 extern void frame_register (struct frame_info *frame, int regnum,
 282                             int *optimizedp, enum lval_type *lvalp,
 283                             CORE_ADDR *addrp, int *realnump,
 284                             void *valuep);
 285
 286 /* More convenient interface to frame_register().  */
 287 /* NOTE: cagney/2002-09-13: Return void as one day these functions may
 288    be changed to return an indication that the read succeeded.  */
 289
 290 extern void frame_read_register (struct frame_info *frame, int regnum,
 291                                  void *buf);
 292
 293 extern void frame_read_signed_register (struct frame_info *frame,
 294                                         int regnum, LONGEST *val);
 295
 296 extern void frame_read_unsigned_register (struct frame_info *frame,
 297                                           int regnum, ULONGEST *val);
 298
 299 /* Map between a frame register number and its name.  A frame register
 300    space is a superset of the cooked register space --- it also
 301    includes builtin registers.  If NAMELEN is negative, use the NAME's
 302    length when doing the comparison.  */
 303
 304 extern int frame_map_name_to_regnum (const char *name, int namelen);
 305 extern const char *frame_map_regnum_to_name (int regnum);
 306
 307 /* Unwind the PC.  Strictly speaking return the resume address of the
 308    calling frame.  For GDB, `pc' is the resume address and not a
 309    specific register.  */
 310
 311 extern CORE_ADDR frame_pc_unwind (struct frame_info *frame);
 312
 313 /* Discard the specified frame.  Restoring the registers to the state
 314    of the caller.  */
 315 extern void frame_pop (struct frame_info *frame);
 316
 317 /* Describe the saved registers of a frame.  */
 318
 319 #if defined (EXTRA_FRAME_INFO) || defined (FRAME_FIND_SAVED_REGS)
 320 /* XXXX - deprecated */
 321 struct frame_saved_regs
 322   {
 323     /* For each register R (except the SP), regs[R] is the address at
 324        which it was saved on entry to the frame, or zero if it was not
 325        saved on entry to this frame.  This includes special registers
 326        such as pc and fp saved in special ways in the stack frame.
 327
 328        regs[SP_REGNUM] is different.  It holds the actual SP, not the
 329        address at which it was saved.  */
 330
 331     CORE_ADDR regs[NUM_REGS];
 332   };
 333 #endif
 334
 335 /* We keep a cache of stack frames, each of which is a "struct
 336    frame_info".  The innermost one gets allocated (in
 337    wait_for_inferior) each time the inferior stops; current_frame
 338    points to it.  Additional frames get allocated (in
 339    get_prev_frame) as needed, and are chained through the next
 340    and prev fields.  Any time that the frame cache becomes invalid
 341    (most notably when we execute something, but also if we change how
 342    we interpret the frames (e.g. "set heuristic-fence-post" in
 343    mips-tdep.c, or anything which reads new symbols)), we should call
 344    reinit_frame_cache.  */
 345
 346 struct frame_info
 347   {
 348     /* Nominal address of the frame described.  See comments at
 349        get_frame_base() about what this means outside the *FRAME*
 350        macros; in the *FRAME* macros, it can mean whatever makes most
 351        sense for this machine.  */
 352     CORE_ADDR frame;
 353
 354     /* Address at which execution is occurring in this frame.
 355        For the innermost frame, it's the current pc.
 356        For other frames, it is a pc saved in the next frame.  */
 357     CORE_ADDR pc;
 358
 359     /* Level of this frame.  The inner-most (youngest) frame is at
 360        level 0.  As you move towards the outer-most (oldest) frame,
 361        the level increases.  This is a cached value.  It could just as
 362        easily be computed by counting back from the selected frame to
 363        the inner most frame.  */
 364     /* NOTE: cagney/2002-04-05: Perhaphs a level of ``-1'' should be
 365        reserved to indicate a bogus frame - one that has been created
 366        just to keep GDB happy (GDB always needs a frame).  For the
 367        moment leave this as speculation.  */
 368     int level;
 369
 370     /* The frame's type.  */
 371     enum frame_type type;
 372
 373     /* For each register, address of where it was saved on entry to
 374        the frame, or zero if it was not saved on entry to this frame.
 375        This includes special registers such as pc and fp saved in
 376        special ways in the stack frame.  The SP_REGNUM is even more
 377        special, the address here is the sp for the previous frame, not
 378        the address where the sp was saved.  */
 379     /* Allocated by frame_saved_regs_zalloc () which is called /
 380        initialized by DEPRECATED_FRAME_INIT_SAVED_REGS(). */
 381     CORE_ADDR *saved_regs;      /*NUM_REGS + NUM_PSEUDO_REGS*/
 382
 383 #ifdef EXTRA_FRAME_INFO
 384     /* XXXX - deprecated */
 385     /* Anything extra for this structure that may have been defined
 386        in the machine dependent files. */
 387       EXTRA_FRAME_INFO
 388 #endif
 389
 390     /* Anything extra for this structure that may have been defined
 391        in the machine dependent files. */
 392     /* Allocated by frame_extra_info_zalloc () which is called /
 393        initialized by DEPRECATED_INIT_EXTRA_FRAME_INFO */
 394     struct frame_extra_info *extra_info;
 395
 396     /* If dwarf2 unwind frame informations is used, this structure holds all
 397        related unwind data.  */
 398     struct context *context;
 399
 400     /* Unwind cache shared between the unwind functions - they had
 401        better all agree as to the contents.  */
 402     void *unwind_cache;
 403
 404     /* The frame's unwinder.  */
 405     const struct frame_unwind *unwind;
 406
 407     /* Cached copy of the previous frame's resume address.  */
 408     int pc_unwind_cache_p;
 409     CORE_ADDR pc_unwind_cache;
 410
 411     /* This frame's ID.  Note that the frame's ID, base and PC contain
 412        redundant information.  */
 413     struct frame_id id;
 414
 415     /* Pointers to the next (down, inner, younger) and previous (up,
 416        outer, older) frame_info's in the frame cache.  */
 417     struct frame_info *next; /* down, inner, younger */
 418     int prev_p;
 419     struct frame_info *prev; /* up, outer, older */
 420   };
 421
 422 /* Values for the source flag to be used in print_frame_info_base(). */
 423 enum print_what
 424   {
 425     /* Print only the source line, like in stepi. */
 426     SRC_LINE = -1,
 427     /* Print only the location, i.e. level, address (sometimes)
 428        function, args, file, line, line num. */
 429     LOCATION,
 430     /* Print both of the above. */
 431     SRC_AND_LOC,
 432     /* Print location only, but always include the address. */
 433     LOC_AND_ADDRESS
 434   };
 435
 436 /* Allocate additional space for appendices to a struct frame_info.
 437    NOTE: Much of GDB's code works on the assumption that the allocated
 438    saved_regs[] array is the size specified below.  If you try to make
 439    that array smaller, GDB will happily walk off its end. */
 440
 441 #ifdef SIZEOF_FRAME_SAVED_REGS
 442 #error "SIZEOF_FRAME_SAVED_REGS can not be re-defined"
 443 #endif
 444 #define SIZEOF_FRAME_SAVED_REGS \
 445         (sizeof (CORE_ADDR) * (NUM_REGS+NUM_PSEUDO_REGS))
 446
 447 /* Allocate zero initialized memory from the frame cache obstack.
 448    Appendices to the frame info (such as the unwind cache) should
 449    allocate memory using this method.  */
 450
 451 extern void *frame_obstack_zalloc (unsigned long size);
 452 #define FRAME_OBSTACK_ZALLOC(TYPE) ((TYPE *) frame_obstack_zalloc (sizeof (TYPE)))
 453
 454 /* If FRAME_CHAIN_VALID returns zero it means that the given frame
 455    is the outermost one and has no caller.  */
 456
 457 extern int frame_chain_valid (CORE_ADDR, struct frame_info *);
 458
 459 extern void generic_save_dummy_frame_tos (CORE_ADDR sp);
 460
 461
 462 #ifdef FRAME_FIND_SAVED_REGS
 463 /* XXX - deprecated */
 464 #define DEPRECATED_FRAME_INIT_SAVED_REGS(FI) deprecated_get_frame_saved_regs (FI, NULL)
 465 extern void deprecated_get_frame_saved_regs (struct frame_info *,
 466                                              struct frame_saved_regs *);
 467 #endif
 468
 469 extern struct block *get_frame_block (struct frame_info *,
 470                                       CORE_ADDR *addr_in_block);
 471
 472 /* Return the `struct block' that belongs to the selected thread's
 473    selected frame.  If the inferior has no state, return NULL.
 474
 475    NOTE: cagney/2002-11-29:
 476
 477    No state?  Does the inferior have any execution state (a core file
 478    does, an executable does not).  At present the code tests
 479    `target_has_stack' but I'm left wondering if it should test
 480    `target_has_registers' or, even, a merged target_has_state.
 481
 482    Should it look at the most recently specified SAL?  If the target
 483    has no state, should this function try to extract a block from the
 484    most recently selected SAL?  That way `list foo' would give it some
 485    sort of reference point.  Then again, perhaphs that would confuse
 486    things.
 487
 488    Calls to this function can be broken down into two categories: Code
 489    that uses the selected block as an additional, but optional, data
 490    point; Code that uses the selected block as a prop, when it should
 491    have the relevant frame/block/pc explicitly passed in.
 492
 493    The latter can be eliminated by correctly parameterizing the code,
 494    the former though is more interesting.  Per the "address" command,
 495    it occures in the CLI code and makes it possible for commands to
 496    work, even when the inferior has no state.  */
 497
 498 extern struct block *get_selected_block (CORE_ADDR *addr_in_block);
 499
 500 extern struct symbol *get_frame_function (struct frame_info *);
 501
 502 extern CORE_ADDR frame_address_in_block (struct frame_info *);
 503
 504 extern CORE_ADDR get_pc_function_start (CORE_ADDR);
 505
 506 extern int frameless_look_for_prologue (struct frame_info *);
 507
 508 extern void print_frame_args (struct symbol *, struct frame_info *,
 509                               int, struct ui_file *);
 510
 511 extern struct frame_info *find_relative_frame (struct frame_info *, int *);
 512
 513 extern void show_and_print_stack_frame (struct frame_info *fi, int level,
 514                                         int source);
 515
 516 extern void print_stack_frame (struct frame_info *, int, int);
 517
 518 extern void show_stack_frame (struct frame_info *);
 519
 520 extern void print_frame_info (struct frame_info *, int, int, int);
 521
 522 extern void show_frame_info (struct frame_info *, int, int, int);
 523
 524 extern struct frame_info *block_innermost_frame (struct block *);
 525
 526 /* NOTE: cagney/2002-09-13: There is no need for this function.
 527    Instead either of frame_unwind_signed_register() or
 528    frame_unwind_unsigned_register() can be used.  */
 529 extern CORE_ADDR deprecated_read_register_dummy (CORE_ADDR pc,
 530                                                  CORE_ADDR fp, int);
 531 extern void generic_push_dummy_frame (void);
 532 extern void generic_pop_current_frame (void (*)(struct frame_info *));
 533 extern void generic_pop_dummy_frame (void);
 534
 535 extern int generic_pc_in_call_dummy (CORE_ADDR pc,
 536                                      CORE_ADDR sp, CORE_ADDR fp);
 537
 538 /* NOTE: cagney/2002-06-26: Targets should no longer use this
 539    function.  Instead, the contents of a dummy frames registers can be
 540    obtained by applying: frame_register_unwind to the dummy frame; or
 541    get_saved_register to the next outer frame.  */
 542
 543 extern char *deprecated_generic_find_dummy_frame (CORE_ADDR pc, CORE_ADDR fp);
 544
 545 extern void generic_fix_call_dummy (char *dummy, CORE_ADDR pc, CORE_ADDR fun,
 546                                     int nargs, struct value **args,
 547                                     struct type *type, int gcc_p);
 548
 549 void generic_unwind_get_saved_register (char *raw_buffer,
 550                                         int *optimizedp,
 551                                         CORE_ADDR *addrp,
 552                                         struct frame_info *frame,
 553                                         int regnum,
 554                                         enum lval_type *lvalp);
 555
 556 /* The function generic_get_saved_register() has been made obsolete.
 557    DEPRECATED_GET_SAVED_REGISTER now defaults to the recursive
 558    equivalent - generic_unwind_get_saved_register() - so there is no
 559    need to even set DEPRECATED_GET_SAVED_REGISTER.  Architectures that
 560    need to override the register unwind mechanism should modify
 561    frame->unwind().  */
 562 extern void deprecated_generic_get_saved_register (char *, int *, CORE_ADDR *,
 563                                                    struct frame_info *, int,
 564                                                    enum lval_type *);
 565
 566 extern void generic_save_call_dummy_addr (CORE_ADDR lo, CORE_ADDR hi);
 567
 568 extern void get_saved_register (char *raw_buffer, int *optimized,
 569                                 CORE_ADDR * addrp,
 570                                 struct frame_info *frame,
 571                                 int regnum, enum lval_type *lval);
 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)  */