gdb/frame.h

   1 /* Definitions for dealing with stack frames, for GDB, the GNU debugger.
   2
   3    Copyright (C) 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1996, 1997,
   4    1998, 1999, 2000, 2001, 2002, 2003, 2004, 2007, 2008, 2009
   5    Free Software Foundation, Inc.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #if !defined (FRAME_H)
  23 #define FRAME_H 1
  24
  25 /* The following is the intended naming schema for frame functions.
  26    It isn't 100% consistent, but it is aproaching that.  Frame naming
  27    schema:
  28
  29    Prefixes:
  30
  31    get_frame_WHAT...(): Get WHAT from the THIS frame (functionaly
  32    equivalent to THIS->next->unwind->what)
  33
  34    frame_unwind_WHAT...(): Unwind THIS frame's WHAT from the NEXT
  35    frame.
  36
  37    frame_unwind_caller_WHAT...(): Unwind WHAT for NEXT stack frame's
  38    real caller.  Any inlined functions in NEXT's stack frame are
  39    skipped.  Use these to ignore any potentially inlined functions,
  40    e.g. inlined into the first instruction of a library trampoline.
  41
  42    get_stack_frame_WHAT...(): Get WHAT for THIS frame, but if THIS is
  43    inlined, skip to the containing stack frame.
  44
  45    put_frame_WHAT...(): Put a value into this frame (unsafe, need to
  46    invalidate the frame / regcache afterwards) (better name more
  47    strongly hinting at its unsafeness)
  48
  49    safe_....(): Safer version of various functions, doesn't throw an
  50    error (leave this for later?).  Returns non-zero / non-NULL if the
  51    request succeeds, zero / NULL otherwize.
  52
  53    Suffixes:
  54
  55    void /frame/_WHAT(): Read WHAT's value into the buffer parameter.
  56
  57    ULONGEST /frame/_WHAT_unsigned(): Return an unsigned value (the
  58    alternative is *frame_unsigned_WHAT).
  59
  60    LONGEST /frame/_WHAT_signed(): Return WHAT signed value.
  61
  62    What:
  63
  64    /frame/_memory* (frame, coreaddr, len [, buf]): Extract/return
  65    *memory.
  66
  67    /frame/_register* (frame, regnum [, buf]): extract/return register.
  68
  69    CORE_ADDR /frame/_{pc,sp,...} (frame): Resume address, innner most
  70    stack *address, ...
  71
  72    */
  73
  74 struct symtab_and_line;
  75 struct frame_unwind;
  76 struct frame_base;
  77 struct block;
  78 struct gdbarch;
  79 struct ui_file;
  80
  81 /* The frame object.  */
  82
  83 struct frame_info;
  84
  85 /* The frame object's ID.  This provides a per-frame unique identifier
  86    that can be used to relocate a `struct frame_info' after a target
  87    resume or a frame cache destruct.  It of course assumes that the
  88    inferior hasn't unwound the stack past that frame.  */
  89
  90 struct frame_id
  91 {
  92   /* The frame's stack address.  This shall be constant through out
  93      the lifetime of a frame.  Note that this requirement applies to
  94      not just the function body, but also the prologue and (in theory
  95      at least) the epilogue.  Since that value needs to fall either on
  96      the boundary, or within the frame's address range, the frame's
  97      outer-most address (the inner-most address of the previous frame)
  98      is used.  Watch out for all the legacy targets that still use the
  99      function pointer register or stack pointer register.  They are
 100      wrong.
 101
 102      This field is valid only if stack_addr_p is true.  Otherwise, this
 103      frame represents the null frame.  */
 104   CORE_ADDR stack_addr;
 105
 106   /* The frame's code address.  This shall be constant through out the
 107      lifetime of the frame.  While the PC (a.k.a. resume address)
 108      changes as the function is executed, this code address cannot.
 109      Typically, it is set to the address of the entry point of the
 110      frame's function (as returned by get_frame_func).
 111
 112      For inlined functions (INLINE_DEPTH != 0), this is the address of
 113      the first executed instruction in the block corresponding to the
 114      inlined function.
 115
 116      This field is valid only if code_addr_p is true.  Otherwise, this
 117      frame is considered to have a wildcard code address, i.e. one that
 118      matches every address value in frame comparisons.  */
 119   CORE_ADDR code_addr;
 120
 121   /* The frame's special address.  This shall be constant through out the
 122      lifetime of the frame.  This is used for architectures that may have
 123      frames that do not change the stack but are still distinct and have
 124      some form of distinct identifier (e.g. the ia64 which uses a 2nd
 125      stack for registers).  This field is treated as unordered - i.e. will
 126      not be used in frame ordering comparisons.
 127
 128      This field is valid only if special_addr_p is true.  Otherwise, this
 129      frame is considered to have a wildcard special address, i.e. one that
 130      matches every address value in frame comparisons.  */
 131   CORE_ADDR special_addr;
 132
 133   /* Flags to indicate the above fields have valid contents.  */
 134   unsigned int stack_addr_p : 1;
 135   unsigned int code_addr_p : 1;
 136   unsigned int special_addr_p : 1;
 137
 138   /* The inline depth of this frame.  A frame representing a "called"
 139      inlined function will have this set to a nonzero value.  */
 140   int inline_depth;
 141 };
 142
 143 /* Methods for constructing and comparing Frame IDs.  */
 144
 145 /* For convenience.  All fields are zero.  */
 146 extern const struct frame_id null_frame_id;
 147
 148 /* Flag to control debugging.  */
 149
 150 extern int frame_debug;
 151
 152 /* Construct a frame ID.  The first parameter is the frame's constant
 153    stack address (typically the outer-bound), and the second the
 154    frame's constant code address (typically the entry point).
 155    The special identifier address is set to indicate a wild card.  */
 156 extern struct frame_id frame_id_build (CORE_ADDR stack_addr,
 157                                        CORE_ADDR code_addr);
 158
 159 /* Construct a special frame ID.  The first parameter is the frame's constant
 160    stack address (typically the outer-bound), the second is the
 161    frame's constant code address (typically the entry point),
 162    and the third parameter is the frame's special identifier address. */
 163 extern struct frame_id frame_id_build_special (CORE_ADDR stack_addr,
 164                                                CORE_ADDR code_addr,
 165                                                CORE_ADDR special_addr);
 166
 167 /* Construct a wild card frame ID.  The parameter is the frame's constant
 168    stack address (typically the outer-bound).  The code address as well
 169    as the special identifier address are set to indicate wild cards.  */
 170 extern struct frame_id frame_id_build_wild (CORE_ADDR stack_addr);
 171
 172 /* Returns non-zero when L is a valid frame (a valid frame has a
 173    non-zero .base).  */
 174 extern int frame_id_p (struct frame_id l);
 175
 176 /* Returns non-zero when L is a valid frame representing an inlined
 177    function.  */
 178 extern int frame_id_inlined_p (struct frame_id l);
 179
 180 /* Returns non-zero when L and R identify the same frame, or, if
 181    either L or R have a zero .func, then the same frame base.  */
 182 extern int frame_id_eq (struct frame_id l, struct frame_id r);
 183
 184 /* Write the internal representation of a frame ID on the specified
 185    stream.  */
 186 extern void fprint_frame_id (struct ui_file *file, struct frame_id id);
 187
 188
 189 /* Frame types.  Some are real, some are signal trampolines, and some
 190    are completely artificial (dummy).  */
 191
 192 enum frame_type
 193 {
 194   /* A true stack frame, created by the target program during normal
 195      execution.  */
 196   NORMAL_FRAME,
 197   /* A fake frame, created by GDB when performing an inferior function
 198      call.  */
 199   DUMMY_FRAME,
 200   /* A frame representing an inlined function, associated with an
 201      upcoming (next, inner, younger) NORMAL_FRAME.  */
 202   INLINE_FRAME,
 203   /* In a signal handler, various OSs handle this in various ways.
 204      The main thing is that the frame may be far from normal.  */
 205   SIGTRAMP_FRAME,
 206   /* Fake frame representing a cross-architecture call.  */
 207   ARCH_FRAME,
 208   /* Sentinel or registers frame.  This frame obtains register values
 209      direct from the inferior's registers.  */
 210   SENTINEL_FRAME
 211 };
 212
 213 /* For every stopped thread, GDB tracks two frames: current and
 214    selected.  Current frame is the inner most frame of the selected
 215    thread.  Selected frame is the one being examined by the the GDB
 216    CLI (selected using `up', `down', ...).  The frames are created
 217    on-demand (via get_prev_frame()) and then held in a frame cache.  */
 218 /* FIXME: cagney/2002-11-28: Er, there is a lie here.  If you do the
 219    sequence: `thread 1; up; thread 2; thread 1' you lose thread 1's
 220    selected frame.  At present GDB only tracks the selected frame of
 221    the current thread.  But be warned, that might change.  */
 222 /* FIXME: cagney/2002-11-14: At any time, only one thread's selected
 223    and current frame can be active.  Switching threads causes gdb to
 224    discard all that cached frame information.  Ulgh!  Instead, current
 225    and selected frame should be bound to a thread.  */
 226
 227 /* On demand, create the inner most frame using information found in
 228    the inferior.  If the inner most frame can't be created, throw an
 229    error.  */
 230 extern struct frame_info *get_current_frame (void);
 231
 232 /* Does the current target interface have enough state to be able to
 233    query the current inferior for frame info, and is the inferior in a
 234    state where that is possible?  */
 235 extern int has_stack_frames (void);
 236
 237 /* Invalidates the frame cache (this function should have been called
 238    invalidate_cached_frames).
 239
 240    FIXME: cagney/2002-11-28: There should be two methods: one that
 241    reverts the thread's selected frame back to current frame (for when
 242    the inferior resumes) and one that does not (for when the user
 243    modifies the target invalidating the frame cache).  */
 244 extern void reinit_frame_cache (void);
 245
 246 /* On demand, create the selected frame and then return it.  If the
 247    selected frame can not be created, this function prints then throws
 248    an error.  When MESSAGE is non-NULL, use it for the error message,
 249    otherwize use a generic error message.  */
 250 /* FIXME: cagney/2002-11-28: At present, when there is no selected
 251    frame, this function always returns the current (inner most) frame.
 252    It should instead, when a thread has previously had its frame
 253    selected (but not resumed) and the frame cache invalidated, find
 254    and then return that thread's previously selected frame.  */
 255 extern struct frame_info *get_selected_frame (const char *message);
 256
 257 /* Select a specific frame.  NULL, apparently implies re-select the
 258    inner most frame.  */
 259 extern void select_frame (struct frame_info *);
 260
 261 /* Given a FRAME, return the next (more inner, younger) or previous
 262    (more outer, older) frame.  */
 263 extern struct frame_info *get_prev_frame (struct frame_info *);
 264 extern struct frame_info *get_next_frame (struct frame_info *);
 265
 266 /* Given a frame's ID, relocate the frame.  Returns NULL if the frame
 267    is not found.  */
 268 extern struct frame_info *frame_find_by_id (struct frame_id id);
 269
 270 /* Base attributes of a frame: */
 271
 272 /* The frame's `resume' address.  Where the program will resume in
 273    this frame.
 274
 275    This replaced: frame->pc; */
 276 extern CORE_ADDR get_frame_pc (struct frame_info *);
 277
 278 /* An address (not necessarily aligned to an instruction boundary)
 279    that falls within THIS frame's code block.
 280
 281    When a function call is the last statement in a block, the return
 282    address for the call may land at the start of the next block.
 283    Similarly, if a no-return function call is the last statement in
 284    the function, the return address may end up pointing beyond the
 285    function, and possibly at the start of the next function.
 286
 287    These methods make an allowance for this.  For call frames, this
 288    function returns the frame's PC-1 which "should" be an address in
 289    the frame's block.  */
 290
 291 extern CORE_ADDR get_frame_address_in_block (struct frame_info *this_frame);
 292
 293 /* The frame's inner-most bound.  AKA the stack-pointer.  Confusingly
 294    known as top-of-stack.  */
 295
 296 extern CORE_ADDR get_frame_sp (struct frame_info *);
 297
 298 /* Following on from the `resume' address.  Return the entry point
 299    address of the function containing that resume address, or zero if
 300    that function isn't known.  */
 301 extern CORE_ADDR get_frame_func (struct frame_info *fi);
 302
 303 /* Closely related to the resume address, various symbol table
 304    attributes that are determined by the PC.  Note that for a normal
 305    frame, the PC refers to the resume address after the return, and
 306    not the call instruction.  In such a case, the address is adjusted
 307    so that it (approximately) identifies the call site (and not the
 308    return site).
 309
 310    NOTE: cagney/2002-11-28: The frame cache could be used to cache the
 311    computed value.  Working on the assumption that the bottle-neck is
 312    in the single step code, and that code causes the frame cache to be
 313    constantly flushed, caching things in a frame is probably of little
 314    benefit.  As they say `show us the numbers'.
 315
 316    NOTE: cagney/2002-11-28: Plenty more where this one came from:
 317    find_frame_block(), find_frame_partial_function(),
 318    find_frame_symtab(), find_frame_function().  Each will need to be
 319    carefully considered to determine if the real intent was for it to
 320    apply to the PC or the adjusted PC.  */
 321 extern void find_frame_sal (struct frame_info *frame,
 322                             struct symtab_and_line *sal);
 323
 324 /* Set the current source and line to the location given by frame
 325    FRAME, if possible.  When CENTER is true, adjust so the relevant
 326    line is in the center of the next 'list'.  */
 327
 328 void set_current_sal_from_frame (struct frame_info *, int);
 329
 330 /* Return the frame base (what ever that is) (DEPRECATED).
 331
 332    Old code was trying to use this single method for two conflicting
 333    purposes.  Such code needs to be updated to use either of:
 334
 335    get_frame_id: A low level frame unique identifier, that consists of
 336    both a stack and a function address, that can be used to uniquely
 337    identify a frame.  This value is determined by the frame's
 338    low-level unwinder, the stack part [typically] being the
 339    top-of-stack of the previous frame, and the function part being the
 340    function's start address.  Since the correct identification of a
 341    frameless function requires both the a stack and function address,
 342    the old get_frame_base method was not sufficient.
 343
 344    get_frame_base_address: get_frame_locals_address:
 345    get_frame_args_address: A set of high-level debug-info dependant
 346    addresses that fall within the frame.  These addresses almost
 347    certainly will not match the stack address part of a frame ID (as
 348    returned by get_frame_base).
 349
 350    This replaced: frame->frame; */
 351
 352 extern CORE_ADDR get_frame_base (struct frame_info *);
 353
 354 /* Return the per-frame unique identifer.  Can be used to relocate a
 355    frame after a frame cache flush (and other similar operations).  If
 356    FI is NULL, return the null_frame_id.
 357
 358    NOTE: kettenis/20040508: These functions return a structure.  On
 359    platforms where structures are returned in static storage (vax,
 360    m68k), this may trigger compiler bugs in code like:
 361
 362    if (frame_id_eq (get_frame_id (l), get_frame_id (r)))
 363
 364    where the return value from the first get_frame_id (l) gets
 365    overwritten by the second get_frame_id (r).  Please avoid writing
 366    code like this.  Use code like:
 367
 368    struct frame_id id = get_frame_id (l);
 369    if (frame_id_eq (id, get_frame_id (r)))
 370
 371    instead, since that avoids the bug.  */
 372 extern struct frame_id get_frame_id (struct frame_info *fi);
 373 extern struct frame_id get_stack_frame_id (struct frame_info *fi);
 374 extern struct frame_id frame_unwind_caller_id (struct frame_info *next_frame);
 375
 376 /* Assuming that a frame is `normal', return its base-address, or 0 if
 377    the information isn't available.  NOTE: This address is really only
 378    meaningful to the frame's high-level debug info.  */
 379 extern CORE_ADDR get_frame_base_address (struct frame_info *);
 380
 381 /* Assuming that a frame is `normal', return the base-address of the
 382    local variables, or 0 if the information isn't available.  NOTE:
 383    This address is really only meaningful to the frame's high-level
 384    debug info.  Typically, the argument and locals share a single
 385    base-address.  */
 386 extern CORE_ADDR get_frame_locals_address (struct frame_info *);
 387
 388 /* Assuming that a frame is `normal', return the base-address of the
 389    parameter list, or 0 if that information isn't available.  NOTE:
 390    This address is really only meaningful to the frame's high-level
 391    debug info.  Typically, the argument and locals share a single
 392    base-address.  */
 393 extern CORE_ADDR get_frame_args_address (struct frame_info *);
 394
 395 /* The frame's level: 0 for innermost, 1 for its caller, ...; or -1
 396    for an invalid frame).  */
 397 extern int frame_relative_level (struct frame_info *fi);
 398
 399 /* Return the frame's type.  */
 400
 401 extern enum frame_type get_frame_type (struct frame_info *);
 402
 403 /* For frames where we can not unwind further, describe why.  */
 404
 405 enum unwind_stop_reason
 406   {
 407     /* No particular reason; either we haven't tried unwinding yet,
 408        or we didn't fail.  */
 409     UNWIND_NO_REASON,
 410
 411     /* The previous frame's analyzer returns an invalid result
 412        from this_id.
 413
 414        FIXME drow/2006-08-16: This is how GDB used to indicate end of
 415        stack.  We should migrate to a model where frames always have a
 416        valid ID, and this becomes not just an error but an internal
 417        error.  But that's a project for another day.  */
 418     UNWIND_NULL_ID,
 419
 420     /* All the conditions after this point are considered errors;
 421        abnormal stack termination.  If a backtrace stops for one
 422        of these reasons, we'll let the user know.  This marker
 423        is not a valid stop reason.  */
 424     UNWIND_FIRST_ERROR,
 425
 426     /* This frame ID looks like it ought to belong to a NEXT frame,
 427        but we got it for a PREV frame.  Normally, this is a sign of
 428        unwinder failure.  It could also indicate stack corruption.  */
 429     UNWIND_INNER_ID,
 430
 431     /* This frame has the same ID as the previous one.  That means
 432        that unwinding further would almost certainly give us another
 433        frame with exactly the same ID, so break the chain.  Normally,
 434        this is a sign of unwinder failure.  It could also indicate
 435        stack corruption.  */
 436     UNWIND_SAME_ID,
 437
 438     /* The frame unwinder didn't find any saved PC, but we needed
 439        one to unwind further.  */
 440     UNWIND_NO_SAVED_PC,
 441   };
 442
 443 /* Return the reason why we can't unwind past this frame.  */
 444
 445 enum unwind_stop_reason get_frame_unwind_stop_reason (struct frame_info *);
 446
 447 /* Translate a reason code to an informative string.  */
 448
 449 const char *frame_stop_reason_string (enum unwind_stop_reason);
 450
 451 /* Unwind the stack frame so that the value of REGNUM, in the previous
 452    (up, older) frame is returned.  If VALUEP is NULL, don't
 453    fetch/compute the value.  Instead just return the location of the
 454    value.  */
 455 extern void frame_register_unwind (struct frame_info *frame, int regnum,
 456                                    int *optimizedp, enum lval_type *lvalp,
 457                                    CORE_ADDR *addrp, int *realnump,
 458                                    gdb_byte *valuep);
 459
 460 /* Fetch a register from this, or unwind a register from the next
 461    frame.  Note that the get_frame methods are wrappers to
 462    frame->next->unwind.  They all [potentially] throw an error if the
 463    fetch fails.  The value methods never return NULL, but usually
 464    do return a lazy value.  */
 465
 466 extern void frame_unwind_register (struct frame_info *frame,
 467                                    int regnum, gdb_byte *buf);
 468 extern void get_frame_register (struct frame_info *frame,
 469                                 int regnum, gdb_byte *buf);
 470
 471 struct value *frame_unwind_register_value (struct frame_info *frame,
 472                                            int regnum);
 473 struct value *get_frame_register_value (struct frame_info *frame,
 474                                         int regnum);
 475
 476 extern LONGEST frame_unwind_register_signed (struct frame_info *frame,
 477                                              int regnum);
 478 extern LONGEST get_frame_register_signed (struct frame_info *frame,
 479                                           int regnum);
 480 extern ULONGEST frame_unwind_register_unsigned (struct frame_info *frame,
 481                                                int regnum);
 482 extern ULONGEST get_frame_register_unsigned (struct frame_info *frame,
 483                                              int regnum);
 484
 485
 486 /* Get the value of the register that belongs to this FRAME.  This
 487    function is a wrapper to the call sequence ``frame_register_unwind
 488    (get_next_frame (FRAME))''.  As per frame_register_unwind(), if
 489    VALUEP is NULL, the registers value is not fetched/computed.  */
 490
 491 extern void frame_register (struct frame_info *frame, int regnum,
 492                             int *optimizedp, enum lval_type *lvalp,
 493                             CORE_ADDR *addrp, int *realnump,
 494                             gdb_byte *valuep);
 495
 496 /* The reverse.  Store a register value relative to the specified
 497    frame.  Note: this call makes the frame's state undefined.  The
 498    register and frame caches must be flushed.  */
 499 extern void put_frame_register (struct frame_info *frame, int regnum,
 500                                 const gdb_byte *buf);
 501
 502 /* Read LEN bytes from one or multiple registers starting with REGNUM
 503    in frame FRAME, starting at OFFSET, into BUF.  */
 504 extern int get_frame_register_bytes (struct frame_info *frame, int regnum,
 505                                      CORE_ADDR offset, int len,
 506                                      gdb_byte *myaddr);
 507
 508 /* Write LEN bytes to one or multiple registers starting with REGNUM
 509    in frame FRAME, starting at OFFSET, into BUF.  */
 510 extern void put_frame_register_bytes (struct frame_info *frame, int regnum,
 511                                       CORE_ADDR offset, int len,
 512                                       const gdb_byte *myaddr);
 513
 514 /* Unwind the PC.  Strictly speaking return the resume address of the
 515    calling frame.  For GDB, `pc' is the resume address and not a
 516    specific register.  */
 517
 518 extern CORE_ADDR frame_unwind_caller_pc (struct frame_info *frame);
 519
 520 /* Discard the specified frame.  Restoring the registers to the state
 521    of the caller.  */
 522 extern void frame_pop (struct frame_info *frame);
 523
 524 /* Return memory from the specified frame.  A frame knows its thread /
 525    LWP and hence can find its way down to a target.  The assumption
 526    here is that the current and previous frame share a common address
 527    space.
 528
 529    If the memory read fails, these methods throw an error.
 530
 531    NOTE: cagney/2003-06-03: Should there be unwind versions of these
 532    methods?  That isn't clear.  Can code, for instance, assume that
 533    this and the previous frame's memory or architecture are identical?
 534    If architecture / memory changes are always separated by special
 535    adaptor frames this should be ok.  */
 536
 537 extern void get_frame_memory (struct frame_info *this_frame, CORE_ADDR addr,
 538                               gdb_byte *buf, int len);
 539 extern LONGEST get_frame_memory_signed (struct frame_info *this_frame,
 540                                         CORE_ADDR memaddr, int len);
 541 extern ULONGEST get_frame_memory_unsigned (struct frame_info *this_frame,
 542                                            CORE_ADDR memaddr, int len);
 543
 544 /* Same as above, but return non-zero when the entire memory read
 545    succeeds, zero otherwize.  */
 546 extern int safe_frame_unwind_memory (struct frame_info *this_frame,
 547                                      CORE_ADDR addr, gdb_byte *buf, int len);
 548
 549 /* Return this frame's architecture.  */
 550 extern struct gdbarch *get_frame_arch (struct frame_info *this_frame);
 551
 552 /* Return the previous frame's architecture.  */
 553 extern struct gdbarch *frame_unwind_arch (struct frame_info *frame);
 554
 555 /* Return the previous frame's architecture, skipping inline functions.  */
 556 extern struct gdbarch *frame_unwind_caller_arch (struct frame_info *frame);
 557
 558
 559 /* Values for the source flag to be used in print_frame_info_base().  */
 560 enum print_what
 561   {
 562     /* Print only the source line, like in stepi. */
 563     SRC_LINE = -1,
 564     /* Print only the location, i.e. level, address (sometimes)
 565        function, args, file, line, line num. */
 566     LOCATION,
 567     /* Print both of the above. */
 568     SRC_AND_LOC,
 569     /* Print location only, but always include the address. */
 570     LOC_AND_ADDRESS
 571   };
 572
 573 /* Allocate zero initialized memory from the frame cache obstack.
 574    Appendices to the frame info (such as the unwind cache) should
 575    allocate memory using this method.  */
 576
 577 extern void *frame_obstack_zalloc (unsigned long size);
 578 #define FRAME_OBSTACK_ZALLOC(TYPE) ((TYPE *) frame_obstack_zalloc (sizeof (TYPE)))
 579 #define FRAME_OBSTACK_CALLOC(NUMBER,TYPE) ((TYPE *) frame_obstack_zalloc ((NUMBER) * sizeof (TYPE)))
 580
 581 /* Create a regcache, and copy the frame's registers into it.  */
 582 struct regcache *frame_save_as_regcache (struct frame_info *this_frame);
 583
 584 extern struct block *get_frame_block (struct frame_info *,
 585                                       CORE_ADDR *addr_in_block);
 586
 587 /* Return the `struct block' that belongs to the selected thread's
 588    selected frame.  If the inferior has no state, return NULL.
 589
 590    NOTE: cagney/2002-11-29:
 591
 592    No state?  Does the inferior have any execution state (a core file
 593    does, an executable does not).  At present the code tests
 594    `target_has_stack' but I'm left wondering if it should test
 595    `target_has_registers' or, even, a merged target_has_state.
 596
 597    Should it look at the most recently specified SAL?  If the target
 598    has no state, should this function try to extract a block from the
 599    most recently selected SAL?  That way `list foo' would give it some
 600    sort of reference point.  Then again, perhaps that would confuse
 601    things.
 602
 603    Calls to this function can be broken down into two categories: Code
 604    that uses the selected block as an additional, but optional, data
 605    point; Code that uses the selected block as a prop, when it should
 606    have the relevant frame/block/pc explicitly passed in.
 607
 608    The latter can be eliminated by correctly parameterizing the code,
 609    the former though is more interesting.  Per the "address" command,
 610    it occurs in the CLI code and makes it possible for commands to
 611    work, even when the inferior has no state.  */
 612
 613 extern struct block *get_selected_block (CORE_ADDR *addr_in_block);
 614
 615 extern struct symbol *get_frame_function (struct frame_info *);
 616
 617 extern CORE_ADDR get_pc_function_start (CORE_ADDR);
 618
 619 extern struct frame_info *find_relative_frame (struct frame_info *, int *);
 620
 621 extern void show_and_print_stack_frame (struct frame_info *fi, int print_level,
 622                                         enum print_what print_what);
 623
 624 extern void print_stack_frame (struct frame_info *, int print_level,
 625                                enum print_what print_what);
 626
 627 extern void print_frame_info (struct frame_info *, int print_level,
 628                               enum print_what print_what, int args);
 629
 630 extern struct frame_info *block_innermost_frame (struct block *);
 631
 632 extern int deprecated_pc_in_call_dummy (struct gdbarch *gdbarch, CORE_ADDR pc);
 633
 634 /* FIXME: cagney/2003-02-02: Should be deprecated or replaced with a
 635    function called get_frame_register_p().  This slightly weird (and
 636    older) variant of get_frame_register() returns zero (indicating the
 637    register is unavailable) if either: the register isn't cached; or
 638    the register has been optimized out.  Problem is, neither check is
 639    exactly correct.  A register can't be optimized out (it may not
 640    have been saved as part of a function call); The fact that a
 641    register isn't in the register cache doesn't mean that the register
 642    isn't available (it could have been fetched from memory).  */
 643
 644 extern int frame_register_read (struct frame_info *frame, int regnum,
 645                                 gdb_byte *buf);
 646
 647 /* From stack.c.  */
 648 extern void args_info (char *, int);
 649
 650 extern void locals_info (char *, int);
 651
 652 extern void (*deprecated_selected_frame_level_changed_hook) (int);
 653
 654 extern void return_command (char *, int);
 655
 656 /* Set FRAME's unwinder temporarily, so that we can call a sniffer.
 657    Return a cleanup which should be called if unwinding fails, and
 658    discarded if it succeeds.  */
 659
 660 struct cleanup *frame_prepare_for_sniffer (struct frame_info *frame,
 661                                            const struct frame_unwind *unwind);
 662
 663 /* Notes (cagney/2002-11-27, drow/2003-09-06):
 664
 665    You might think that calls to this function can simply be replaced by a
 666    call to get_selected_frame().
 667
 668    Unfortunately, it isn't that easy.
 669
 670    The relevant code needs to be audited to determine if it is
 671    possible (or practical) to instead pass the applicable frame in as a
 672    parameter.  For instance, DEPRECATED_DO_REGISTERS_INFO() relied on
 673    the deprecated_selected_frame global, while its replacement,
 674    PRINT_REGISTERS_INFO(), is parameterized with the selected frame.
 675    The only real exceptions occur at the edge (in the CLI code) where
 676    user commands need to pick up the selected frame before proceeding.
 677
 678    There are also some functions called with a NULL frame meaning either "the
 679    program is not running" or "use the selected frame".
 680
 681    This is important.  GDB is trying to stamp out the hack:
 682
 683    saved_frame = deprecated_safe_get_selected_frame ();
 684    select_frame (...);
 685    hack_using_global_selected_frame ();
 686    select_frame (saved_frame);
 687
 688    Take care!
 689
 690    This function calls get_selected_frame if the inferior should have a
 691    frame, or returns NULL otherwise.  */
 692
 693 extern struct frame_info *deprecated_safe_get_selected_frame (void);
 694
 695 /* Create a frame using the specified BASE and PC.  */
 696
 697 extern struct frame_info *create_new_frame (CORE_ADDR base, CORE_ADDR pc);
 698
 699 /* Return true if the frame unwinder for frame FI is UNWINDER; false
 700    otherwise.  */
 701
 702 extern int frame_unwinder_is (struct frame_info *fi,
 703                               const struct frame_unwind *unwinder);
 704
 705 #endif /* !defined (FRAME_H)  */