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