gdb/frame.h

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