[thirdparty/binutils-gdb.git] / gdb / frame.h

/* Definitions for dealing with stack frames, for GDB, the GNU debugger.

   Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1996,
   1997, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.  */

#if !defined (FRAME_H)
#define FRAME_H 1

/* Return the location (and possibly value) of REGNUM for the previous
   (older, up) frame.  All parameters except VALUEP can be assumed to
   be non NULL.  When VALUEP is NULL, just the location of the
   register should be returned.

   UNWIND_CACHE is provided as mechanism for implementing a per-frame
   local cache.  It's initial value being NULL.  Memory for that cache
   should be allocated using frame_obstack_alloc().

   Register window architectures (eg SPARC) should note that REGNUM
   identifies the register for the previous frame.  For instance, a
   request for the value of "o1" for the previous frame would be found
   in the register "i1" in this FRAME.  */

typedef void (frame_register_unwind_ftype) (struct frame_info *frame,
					    void **unwind_cache,
					    int regnum,
					    int *optimized,
					    enum lval_type *lvalp,
					    CORE_ADDR *addrp,
					    int *realnump,
					    void *valuep);

/* Describe the saved registers of a frame.  */

#if defined (EXTRA_FRAME_INFO) || defined (FRAME_FIND_SAVED_REGS)
/* XXXX - deprecated */
struct frame_saved_regs
  {
    /* For each register R (except the SP), regs[R] is the address at
       which it was saved on entry to the frame, or zero if it was not
       saved on entry to this frame.  This includes special registers
       such as pc and fp saved in special ways in the stack frame.

       regs[SP_REGNUM] is different.  It holds the actual SP, not the
       address at which it was saved.  */

    CORE_ADDR regs[NUM_REGS];
  };
#endif

/* We keep a cache of stack frames, each of which is a "struct
   frame_info".  The innermost one gets allocated (in
   wait_for_inferior) each time the inferior stops; current_frame
   points to it.  Additional frames get allocated (in
   get_prev_frame) as needed, and are chained through the next
   and prev fields.  Any time that the frame cache becomes invalid
   (most notably when we execute something, but also if we change how
   we interpret the frames (e.g. "set heuristic-fence-post" in
   mips-tdep.c, or anything which reads new symbols)), we should call
   reinit_frame_cache.  */

struct frame_info
  {
    /* Nominal address of the frame described.  See comments at FRAME_FP
       about what this means outside the *FRAME* macros; in the *FRAME*
       macros, it can mean whatever makes most sense for this machine.  */
    CORE_ADDR frame;

    /* Address at which execution is occurring in this frame.
       For the innermost frame, it's the current pc.
       For other frames, it is a pc saved in the next frame.  */
    CORE_ADDR pc;

    /* Level of this frame.  The inner-most (youngest) frame is at
       level 0.  As you move towards the outer-most (oldest) frame,
       the level increases.  This is a cached value.  It could just as
       easily be computed by counting back from the selected frame to
       the inner most frame.  */
    /* NOTE: cagney/2002-04-05: Perhaphs a level of ``-1'' should be
       reserved to indicate a bogus frame - one that has been created
       just to keep GDB happy (GDB always needs a frame).  For the
       moment leave this as speculation.  */
    int level;

    /* Nonzero if this is a frame associated with calling a signal handler.

       Set by machine-dependent code.  On some machines, if
       the machine-dependent code fails to check for this, the backtrace
       will look relatively normal.  For example, on the i386
       #3  0x158728 in sighold ()
       On other machines (e.g. rs6000), the machine-dependent code better
       set this to prevent us from trying to print it like a normal frame.  */
    int signal_handler_caller;

    /* For each register, address of where it was saved on entry to
       the frame, or zero if it was not saved on entry to this frame.
       This includes special registers such as pc and fp saved in
       special ways in the stack frame.  The SP_REGNUM is even more
       special, the address here is the sp for the previous frame, not
       the address where the sp was saved.  */
    /* Allocated by frame_saved_regs_zalloc () which is called /
       initialized by FRAME_INIT_SAVED_REGS(). */
    CORE_ADDR *saved_regs;	/*NUM_REGS + NUM_PSEUDO_REGS*/

#ifdef EXTRA_FRAME_INFO
    /* XXXX - deprecated */
    /* Anything extra for this structure that may have been defined
       in the machine dependent files. */
      EXTRA_FRAME_INFO
#endif

    /* Anything extra for this structure that may have been defined
       in the machine dependent files. */
    /* Allocated by frame_obstack_alloc () which is called /
       initialized by INIT_EXTRA_FRAME_INFO */
    struct frame_extra_info *extra_info;

    /* If dwarf2 unwind frame informations is used, this structure holds all
       related unwind data.  */
    struct context *context;

    /* See description above.  Return the register value for the
       previous frame.  */
    frame_register_unwind_ftype *register_unwind;
    void *register_unwind_cache;

    /* Pointers to the next (down, inner) and previous (up, outer)
       frame_info's in the frame cache.  */
    struct frame_info *next; /* down, inner */
    struct frame_info *prev; /* up, outer */
  };

/* Values for the source flag to be used in print_frame_info_base(). */
enum print_what
  { 
    /* Print only the source line, like in stepi. */
    SRC_LINE = -1, 
    /* Print only the location, i.e. level, address (sometimes)
       function, args, file, line, line num. */
    LOCATION,
    /* Print both of the above. */
    SRC_AND_LOC, 
    /* Print location only, but always include the address. */
    LOC_AND_ADDRESS 
  };

/* Allocate additional space for appendices to a struct frame_info.
   NOTE: Much of GDB's code works on the assumption that the allocated
   saved_regs[] array is the size specified below.  If you try to make
   that array smaller, GDB will happily walk off its end. */

#ifdef SIZEOF_FRAME_SAVED_REGS
#error "SIZEOF_FRAME_SAVED_REGS can not be re-defined"
#endif
#define SIZEOF_FRAME_SAVED_REGS \
        (sizeof (CORE_ADDR) * (NUM_REGS+NUM_PSEUDO_REGS))

extern void *frame_obstack_alloc (unsigned long size);
extern void frame_saved_regs_zalloc (struct frame_info *);

/* Return the frame address from FI.  Except in the machine-dependent
   *FRAME* macros, a frame address has no defined meaning other than
   as a magic cookie which identifies a frame over calls to the
   inferior.  The only known exception is inferior.h
   (PC_IN_CALL_DUMMY) [ON_STACK]; see comments there.  You cannot
   assume that a frame address contains enough information to
   reconstruct the frame; if you want more than just to identify the
   frame (e.g. be able to fetch variables relative to that frame),
   then save the whole struct frame_info (and the next struct
   frame_info, since the latter is used for fetching variables on some
   machines).  */

#define FRAME_FP(fi) ((fi)->frame)

/* Level of the frame: 0 for innermost, 1 for its caller, ...; or -1
   for an invalid frame.  */

extern int frame_relative_level (struct frame_info *fi);

/* Define a default FRAME_CHAIN_VALID, in the form that is suitable for most
   targets.  If FRAME_CHAIN_VALID returns zero it means that the given frame
   is the outermost one and has no caller.

   XXXX - both default and alternate frame_chain_valid functions are
   deprecated.  New code should use dummy frames and one of the
   generic functions. */

extern int file_frame_chain_valid (CORE_ADDR, struct frame_info *);
extern int func_frame_chain_valid (CORE_ADDR, struct frame_info *);
extern int nonnull_frame_chain_valid (CORE_ADDR, struct frame_info *);
extern int generic_file_frame_chain_valid (CORE_ADDR, struct frame_info *);
extern int generic_func_frame_chain_valid (CORE_ADDR, struct frame_info *);
extern void generic_save_dummy_frame_tos (CORE_ADDR sp);

/* The stack frame that the user has specified for commands to act on.
   Note that one cannot assume this is the address of valid data.  */

extern struct frame_info *selected_frame;

/* Level of the selected frame:
   0 for innermost, 1 for its caller, ...
   or -1 for frame specified by address with no defined level.  */

extern struct frame_info *create_new_frame (CORE_ADDR, CORE_ADDR);

extern void flush_cached_frames (void);

extern void reinit_frame_cache (void);


#ifdef FRAME_FIND_SAVED_REGS
/* XXX - deprecated */
#define FRAME_INIT_SAVED_REGS(FI) get_frame_saved_regs (FI, NULL)
extern void get_frame_saved_regs (struct frame_info *,
				  struct frame_saved_regs *);
#endif

extern void set_current_frame (struct frame_info *);

extern struct frame_info *get_prev_frame (struct frame_info *);

extern struct frame_info *get_current_frame (void);

extern struct frame_info *get_next_frame (struct frame_info *);

extern struct block *get_frame_block (struct frame_info *,
                                      CORE_ADDR *addr_in_block);

extern struct block *get_current_block (CORE_ADDR *addr_in_block);

extern struct block *get_selected_block (CORE_ADDR *addr_in_block);

extern struct symbol *get_frame_function (struct frame_info *);

extern CORE_ADDR get_frame_pc (struct frame_info *);

extern CORE_ADDR frame_address_in_block (struct frame_info *);

extern CORE_ADDR get_pc_function_start (CORE_ADDR);

extern struct block *block_for_pc (CORE_ADDR);

extern struct block *block_for_pc_sect (CORE_ADDR, asection *);

extern int frameless_look_for_prologue (struct frame_info *);

extern void print_frame_args (struct symbol *, struct frame_info *,
			      int, struct ui_file *);

extern struct frame_info *find_relative_frame (struct frame_info *, int *);

extern void show_and_print_stack_frame (struct frame_info *fi, int level,
					int source);

extern void print_stack_frame (struct frame_info *, int, int);

extern void print_only_stack_frame (struct frame_info *, int, int);

extern void show_stack_frame (struct frame_info *);

extern void select_frame (struct frame_info *);

/* Return an ID that can be used to re-find a frame.  */

struct frame_id
{
  /* The frame's address.  This should be constant through out the
     lifetime of a frame.  */
  CORE_ADDR base;
  /* The frame's current PC.  While this changes, the function that
     the PC falls into, does not.  */
  CORE_ADDR pc;
};

extern void get_frame_id (struct frame_info *fi, struct frame_id *id);

extern struct frame_info *frame_find_by_id (struct frame_id id);

extern void print_frame_info (struct frame_info *, int, int, int);

extern void show_frame_info (struct frame_info *, int, int, int);

extern struct frame_info *block_innermost_frame (struct block *);

extern struct frame_info *find_frame_addr_in_frame_chain (CORE_ADDR);

extern CORE_ADDR sigtramp_saved_pc (struct frame_info *);

/* NOTE: cagney/2002-09-13: There is no need for this function.
   Instead either of frame_unwind_signed_register() or
   frame_unwind_unsigned_register() can be used.  */
extern CORE_ADDR deprecated_read_register_dummy (CORE_ADDR pc,
						 CORE_ADDR fp, int);
extern void generic_push_dummy_frame (void);
extern void generic_pop_current_frame (void (*)(struct frame_info *));
extern void generic_pop_dummy_frame (void);

extern int generic_pc_in_call_dummy (CORE_ADDR pc,
				     CORE_ADDR sp, CORE_ADDR fp);

/* NOTE: cagney/2002-06-26: Targets should no longer use this
   function.  Instead, the contents of a dummy frames registers can be
   obtained by applying: frame_register_unwind to the dummy frame; or
   get_saved_register to the next outer frame.  */

extern char *deprecated_generic_find_dummy_frame (CORE_ADDR pc, CORE_ADDR fp);

extern void generic_fix_call_dummy (char *dummy, CORE_ADDR pc, CORE_ADDR fun,
				    int nargs, struct value **args,
				    struct type *type, int gcc_p);

extern void generic_get_saved_register (char *, int *, CORE_ADDR *,
					struct frame_info *, int,
					enum lval_type *);

extern void generic_unwind_get_saved_register (char *raw_buffer,
					       int *optimized,
					       CORE_ADDR * addrp,
					       struct frame_info *frame,
					       int regnum,
					       enum lval_type *lval);

/* Unwind the stack frame so that the value of REGNUM, in the previous
   frame is returned.  If VALUEP is NULL, don't fetch/compute the
   value.  Instead just return the location of the value.  */

extern void frame_register_unwind (struct frame_info *frame, int regnum,
				   int *optimizedp, enum lval_type *lvalp,
				   CORE_ADDR *addrp, int *realnump,
				   void *valuep);

/* Unwind FRAME so that the value of register REGNUM, in the previous
   frame is returned.  Simplified versions of frame_register_unwind.  */
/* NOTE: cagney/2002-09-13: Return void as one day these functions may
   be changed to return an indication that the read succeeded.  */
extern void frame_unwind_signed_register (struct frame_info *frame,
					  int regnum, LONGEST *val);
extern void frame_unwind_unsigned_register (struct frame_info *frame,
					    int regnum, ULONGEST *val);

extern void generic_save_call_dummy_addr (CORE_ADDR lo, CORE_ADDR hi);

extern void get_saved_register (char *raw_buffer, int *optimized,
				CORE_ADDR * addrp,
				struct frame_info *frame,
				int regnum, enum lval_type *lval);

/* Return the register as found on the FRAME.  Return zero if the
   register could not be found.  */
extern int frame_register_read (struct frame_info *frame, int regnum,
				void *buf);

/* Map between a frame register number and its name.  A frame register
   space is a superset of the cooked register space --- it also
   includes builtin registers.  */

extern int frame_map_name_to_regnum (const char *name, int strlen);
extern const char *frame_map_regnum_to_name (int regnum);

#endif /* !defined (FRAME_H)  */
Commit	Line	Data
c906108c	1	/* Definitions for dealing with stack frames, for GDB, the GNU debugger.
7cc19214 AC	2
	3	Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1996,
	4	1997, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
c906108c	5
c5aa993b	6	This file is part of GDB.
c906108c	7
c5aa993b JM	8	This program is free software; you can redistribute it and/or modify
	9	it under the terms of the GNU General Public License as published by
	10	the Free Software Foundation; either version 2 of the License, or
	11	(at your option) any later version.
c906108c	12
c5aa993b JM	13	This program is distributed in the hope that it will be useful,
	14	but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	GNU General Public License for more details.
c906108c	17
c5aa993b JM	18	You should have received a copy of the GNU General Public License
	19	along with this program; if not, write to the Free Software
	20	Foundation, Inc., 59 Temple Place - Suite 330,
	21	Boston, MA 02111-1307, USA. */
c906108c SS	22
	23	#if !defined (FRAME_H)
	24	#define FRAME_H 1
	25
4f460812 AC	26	/* Return the location (and possibly value) of REGNUM for the previous
	27	(older, up) frame. All parameters except VALUEP can be assumed to
	28	be non NULL. When VALUEP is NULL, just the location of the
	29	register should be returned.
	30
	31	UNWIND_CACHE is provided as mechanism for implementing a per-frame
	32	local cache. It's initial value being NULL. Memory for that cache
	33	should be allocated using frame_obstack_alloc().
	34
	35	Register window architectures (eg SPARC) should note that REGNUM
	36	identifies the register for the previous frame. For instance, a
	37	request for the value of "o1" for the previous frame would be found
	38	in the register "i1" in this FRAME. */
	39
	40	typedef void (frame_register_unwind_ftype) (struct frame_info *frame,
	41	void **unwind_cache,
	42	int regnum,
	43	int *optimized,
	44	enum lval_type *lvalp,
	45	CORE_ADDR *addrp,
	46	int *realnump,
	47	void *valuep);
	48
c906108c SS	49	/* Describe the saved registers of a frame. */
	50
	51	#if defined (EXTRA_FRAME_INFO) \|\| defined (FRAME_FIND_SAVED_REGS)
	52	/* XXXX - deprecated */
	53	struct frame_saved_regs
	54	{
c2c6d25f JM	55	/* For each register R (except the SP), regs[R] is the address at
	56	which it was saved on entry to the frame, or zero if it was not
	57	saved on entry to this frame. This includes special registers
	58	such as pc and fp saved in special ways in the stack frame.
c906108c	59
c2c6d25f JM	60	regs[SP_REGNUM] is different. It holds the actual SP, not the
c2c6d25f JM	61	address at which it was saved. */
c906108c SS	62
	63	CORE_ADDR regs[NUM_REGS];
	64	};
	65	#endif
	66
	67	/* We keep a cache of stack frames, each of which is a "struct
	68	frame_info". The innermost one gets allocated (in
	69	wait_for_inferior) each time the inferior stops; current_frame
	70	points to it. Additional frames get allocated (in
7a292a7a	71	get_prev_frame) as needed, and are chained through the next
c906108c SS	72	and prev fields. Any time that the frame cache becomes invalid
	73	(most notably when we execute something, but also if we change how
	74	we interpret the frames (e.g. "set heuristic-fence-post" in
	75	mips-tdep.c, or anything which reads new symbols)), we should call
	76	reinit_frame_cache. */
	77
	78	struct frame_info
	79	{
	80	/* Nominal address of the frame described. See comments at FRAME_FP
	81	about what this means outside the FRAME macros; in the FRAME
	82	macros, it can mean whatever makes most sense for this machine. */
	83	CORE_ADDR frame;
	84
	85	/* Address at which execution is occurring in this frame.
	86	For the innermost frame, it's the current pc.
	87	For other frames, it is a pc saved in the next frame. */
	88	CORE_ADDR pc;
	89
7cc19214 AC	90	/* Level of this frame. The inner-most (youngest) frame is at
	91	level 0. As you move towards the outer-most (oldest) frame,
	92	the level increases. This is a cached value. It could just as
	93	easily be computed by counting back from the selected frame to
	94	the inner most frame. */
	95	/* NOTE: cagney/2002-04-05: Perhaphs a level of ``-1'' should be
	96	reserved to indicate a bogus frame - one that has been created
	97	just to keep GDB happy (GDB always needs a frame). For the
	98	moment leave this as speculation. */
	99	int level;
	100
c906108c SS	101	/* Nonzero if this is a frame associated with calling a signal handler.
	102
	103	Set by machine-dependent code. On some machines, if
	104	the machine-dependent code fails to check for this, the backtrace
	105	will look relatively normal. For example, on the i386
c5aa993b	106	#3 0x158728 in sighold ()
c906108c SS	107	On other machines (e.g. rs6000), the machine-dependent code better
	108	set this to prevent us from trying to print it like a normal frame. */
	109	int signal_handler_caller;
	110
	111	/* For each register, address of where it was saved on entry to
	112	the frame, or zero if it was not saved on entry to this frame.
	113	This includes special registers such as pc and fp saved in
	114	special ways in the stack frame. The SP_REGNUM is even more
e8759349 AC	115	special, the address here is the sp for the previous frame, not
e8759349 AC	116	the address where the sp was saved. */
c906108c SS	117	/* Allocated by frame_saved_regs_zalloc () which is called /
c906108c SS	118	initialized by FRAME_INIT_SAVED_REGS(). */
64485362	119	CORE_ADDR saved_regs; /NUM_REGS + NUM_PSEUDO_REGS*/
c906108c SS	120
	121	#ifdef EXTRA_FRAME_INFO
	122	/* XXXX - deprecated */
	123	/* Anything extra for this structure that may have been defined
	124	in the machine dependent files. */
c5aa993b	125	EXTRA_FRAME_INFO
c906108c SS	126	#endif
	127
	128	/* Anything extra for this structure that may have been defined
	129	in the machine dependent files. */
	130	/* Allocated by frame_obstack_alloc () which is called /
	131	initialized by INIT_EXTRA_FRAME_INFO */
	132	struct frame_extra_info *extra_info;
	133
b6af0555 JS	134	/* If dwarf2 unwind frame informations is used, this structure holds all
b6af0555 JS	135	related unwind data. */
cc22880b	136	struct context *context;
b6af0555	137
4f460812 AC	138	/* See description above. Return the register value for the
	139	previous frame. */
	140	frame_register_unwind_ftype *register_unwind;
	141	void *register_unwind_cache;
	142
e8759349 AC	143	/* Pointers to the next (down, inner) and previous (up, outer)
	144	frame_info's in the frame cache. */
	145	struct frame_info next; / down, inner */
	146	struct frame_info prev; / up, outer */
c906108c SS	147	};
c906108c SS	148
c5394b80 JM	149	/* Values for the source flag to be used in print_frame_info_base(). */
	150	enum print_what
	151	{
	152	/* Print only the source line, like in stepi. */
	153	SRC_LINE = -1,
	154	/* Print only the location, i.e. level, address (sometimes)
	155	function, args, file, line, line num. */
	156	LOCATION,
	157	/* Print both of the above. */
	158	SRC_AND_LOC,
	159	/* Print location only, but always include the address. */
	160	LOC_AND_ADDRESS
	161	};
	162
64485362 AC	163	/* Allocate additional space for appendices to a struct frame_info.
	164	NOTE: Much of GDB's code works on the assumption that the allocated
	165	saved_regs[] array is the size specified below. If you try to make
	166	that array smaller, GDB will happily walk off its end. */
c906108c	167
64485362 AC	168	#ifdef SIZEOF_FRAME_SAVED_REGS
64485362 AC	169	#error "SIZEOF_FRAME_SAVED_REGS can not be re-defined"
c906108c	170	#endif
64485362 AC	171	#define SIZEOF_FRAME_SAVED_REGS \
	172	(sizeof (CORE_ADDR) * (NUM_REGS+NUM_PSEUDO_REGS))
	173
a14ed312 KB	174	extern void *frame_obstack_alloc (unsigned long size);
a14ed312 KB	175	extern void frame_saved_regs_zalloc (struct frame_info *);
c906108c	176
7036d6ce	177	/* Return the frame address from FI. Except in the machine-dependent
c906108c SS	178	FRAME macros, a frame address has no defined meaning other than
	179	as a magic cookie which identifies a frame over calls to the
	180	inferior. The only known exception is inferior.h
	181	(PC_IN_CALL_DUMMY) [ON_STACK]; see comments there. You cannot
	182	assume that a frame address contains enough information to
	183	reconstruct the frame; if you want more than just to identify the
	184	frame (e.g. be able to fetch variables relative to that frame),
	185	then save the whole struct frame_info (and the next struct
	186	frame_info, since the latter is used for fetching variables on some
	187	machines). */
	188
	189	#define FRAME_FP(fi) ((fi)->frame)
	190
b31da25e AC	191	/* Level of the frame: 0 for innermost, 1 for its caller, ...; or -1
	192	for an invalid frame. */
	193
	194	extern int frame_relative_level (struct frame_info *fi);
	195
c906108c SS	196	/* Define a default FRAME_CHAIN_VALID, in the form that is suitable for most
	197	targets. If FRAME_CHAIN_VALID returns zero it means that the given frame
	198	is the outermost one and has no caller.
	199
c906108c	200	XXXX - both default and alternate frame_chain_valid functions are
c4093a6a JM	201	deprecated. New code should use dummy frames and one of the
c4093a6a JM	202	generic functions. */
c906108c	203
c4093a6a JM	204	extern int file_frame_chain_valid (CORE_ADDR, struct frame_info *);
c4093a6a JM	205	extern int func_frame_chain_valid (CORE_ADDR, struct frame_info *);
a14ed312	206	extern int nonnull_frame_chain_valid (CORE_ADDR, struct frame_info *);
c4093a6a JM	207	extern int generic_file_frame_chain_valid (CORE_ADDR, struct frame_info *);
c4093a6a JM	208	extern int generic_func_frame_chain_valid (CORE_ADDR, struct frame_info *);
a14ed312	209	extern void generic_save_dummy_frame_tos (CORE_ADDR sp);
c906108c	210
c906108c SS	211	/* The stack frame that the user has specified for commands to act on.
	212	Note that one cannot assume this is the address of valid data. */
	213
	214	extern struct frame_info *selected_frame;
	215
	216	/* Level of the selected frame:
	217	0 for innermost, 1 for its caller, ...
	218	or -1 for frame specified by address with no defined level. */
	219
a14ed312	220	extern struct frame_info *create_new_frame (CORE_ADDR, CORE_ADDR);
c906108c	221
a14ed312	222	extern void flush_cached_frames (void);
c906108c	223
a14ed312	224	extern void reinit_frame_cache (void);
c906108c SS	225
	226
	227	#ifdef FRAME_FIND_SAVED_REGS
	228	/* XXX - deprecated */
	229	#define FRAME_INIT_SAVED_REGS(FI) get_frame_saved_regs (FI, NULL)
a14ed312 KB	230	extern void get_frame_saved_regs (struct frame_info *,
a14ed312 KB	231	struct frame_saved_regs *);
c906108c	232	#endif
c5aa993b	233
a14ed312	234	extern void set_current_frame (struct frame_info *);
c906108c	235
a14ed312	236	extern struct frame_info get_prev_frame (struct frame_info );
c906108c	237
a14ed312	238	extern struct frame_info *get_current_frame (void);
c906108c	239
a14ed312	240	extern struct frame_info get_next_frame (struct frame_info );
c906108c	241
ae767bfb JB	242	extern struct block get_frame_block (struct frame_info ,
ae767bfb JB	243	CORE_ADDR *addr_in_block);
c906108c	244
ae767bfb	245	extern struct block get_current_block (CORE_ADDR addr_in_block);
c906108c	246
ae767bfb	247	extern struct block get_selected_block (CORE_ADDR addr_in_block);
c906108c	248
a14ed312	249	extern struct symbol get_frame_function (struct frame_info );
c906108c	250
a14ed312	251	extern CORE_ADDR get_frame_pc (struct frame_info *);
c906108c	252
42f99ac2 JB	253	extern CORE_ADDR frame_address_in_block (struct frame_info *);
42f99ac2 JB	254
a14ed312	255	extern CORE_ADDR get_pc_function_start (CORE_ADDR);
c906108c	256
a14ed312	257	extern struct block *block_for_pc (CORE_ADDR);
c906108c	258
a14ed312	259	extern struct block block_for_pc_sect (CORE_ADDR, asection );
c906108c	260
a14ed312	261	extern int frameless_look_for_prologue (struct frame_info *);
c906108c	262
a14ed312 KB	263	extern void print_frame_args (struct symbol , struct frame_info ,
a14ed312 KB	264	int, struct ui_file *);
c906108c	265
a14ed312	266	extern struct frame_info find_relative_frame (struct frame_info , int *);
c906108c	267
a14ed312 KB	268	extern void show_and_print_stack_frame (struct frame_info *fi, int level,
a14ed312 KB	269	int source);
7a292a7a	270
a14ed312	271	extern void print_stack_frame (struct frame_info *, int, int);
c906108c	272
a14ed312	273	extern void print_only_stack_frame (struct frame_info *, int, int);
c906108c	274
a14ed312	275	extern void show_stack_frame (struct frame_info *);
c906108c	276
0f7d239c	277	extern void select_frame (struct frame_info *);
c906108c	278
101dcfbe AC	279	/* Return an ID that can be used to re-find a frame. */
	280
	281	struct frame_id
	282	{
	283	/* The frame's address. This should be constant through out the
	284	lifetime of a frame. */
	285	CORE_ADDR base;
	286	/* The frame's current PC. While this changes, the function that
	287	the PC falls into, does not. */
	288	CORE_ADDR pc;
	289	};
	290
	291	extern void get_frame_id (struct frame_info fi, struct frame_id id);
	292
	293	extern struct frame_info *frame_find_by_id (struct frame_id id);
c906108c	294
a14ed312	295	extern void print_frame_info (struct frame_info *, int, int, int);
c906108c	296
a14ed312	297	extern void show_frame_info (struct frame_info *, int, int, int);
c906108c	298
a14ed312	299	extern struct frame_info block_innermost_frame (struct block );
c906108c	300
a14ed312	301	extern struct frame_info *find_frame_addr_in_frame_chain (CORE_ADDR);
c906108c	302
a14ed312	303	extern CORE_ADDR sigtramp_saved_pc (struct frame_info *);
c906108c	304
135c175f AC	305	/* NOTE: cagney/2002-09-13: There is no need for this function.
	306	Instead either of frame_unwind_signed_register() or
	307	frame_unwind_unsigned_register() can be used. */
	308	extern CORE_ADDR deprecated_read_register_dummy (CORE_ADDR pc,
	309	CORE_ADDR fp, int);
a14ed312 KB	310	extern void generic_push_dummy_frame (void);
	311	extern void generic_pop_current_frame (void ()(struct frame_info ));
	312	extern void generic_pop_dummy_frame (void);
c906108c	313
a14ed312 KB	314	extern int generic_pc_in_call_dummy (CORE_ADDR pc,
a14ed312 KB	315	CORE_ADDR sp, CORE_ADDR fp);
da130f98 AC	316
	317	/* NOTE: cagney/2002-06-26: Targets should no longer use this
	318	function. Instead, the contents of a dummy frames registers can be
	319	obtained by applying: frame_register_unwind to the dummy frame; or
	320	get_saved_register to the next outer frame. */
	321
	322	extern char *deprecated_generic_find_dummy_frame (CORE_ADDR pc, CORE_ADDR fp);
c906108c	323
a14ed312 KB	324	extern void generic_fix_call_dummy (char *dummy, CORE_ADDR pc, CORE_ADDR fun,
	325	int nargs, struct value **args,
	326	struct type *type, int gcc_p);
cce74817	327
a14ed312 KB	328	extern void generic_get_saved_register (char , int , CORE_ADDR *,
	329	struct frame_info *, int,
	330	enum lval_type *);
c906108c	331
4f460812 AC	332	extern void generic_unwind_get_saved_register (char *raw_buffer,
	333	int *optimized,
	334	CORE_ADDR * addrp,
	335	struct frame_info *frame,
	336	int regnum,
	337	enum lval_type *lval);
	338
	339	/* Unwind the stack frame so that the value of REGNUM, in the previous
	340	frame is returned. If VALUEP is NULL, don't fetch/compute the
	341	value. Instead just return the location of the value. */
	342
	343	extern void frame_register_unwind (struct frame_info *frame, int regnum,
	344	int optimizedp, enum lval_type lvalp,
	345	CORE_ADDR addrp, int realnump,
	346	void *valuep);
	347
135c175f AC	348	/* Unwind FRAME so that the value of register REGNUM, in the previous
	349	frame is returned. Simplified versions of frame_register_unwind. */
	350	/* NOTE: cagney/2002-09-13: Return void as one day these functions may
	351	be changed to return an indication that the read succeeded. */
	352	extern void frame_unwind_signed_register (struct frame_info *frame,
	353	int regnum, LONGEST *val);
	354	extern void frame_unwind_unsigned_register (struct frame_info *frame,
	355	int regnum, ULONGEST *val);
	356
6096c27a AC	357	extern void generic_save_call_dummy_addr (CORE_ADDR lo, CORE_ADDR hi);
6096c27a AC	358
60edd51d AC	359	extern void get_saved_register (char raw_buffer, int optimized,
	360	CORE_ADDR * addrp,
	361	struct frame_info *frame,
	362	int regnum, enum lval_type *lval);
	363
cda5a58a AC	364	/* Return the register as found on the FRAME. Return zero if the
	365	register could not be found. */
	366	extern int frame_register_read (struct frame_info *frame, int regnum,
	367	void *buf);
	368
e36180d7 AC	369	/* Map between a frame register number and its name. A frame register
	370	space is a superset of the cooked register space --- it also
	371	includes builtin registers. */
	372
	373	extern int frame_map_name_to_regnum (const char *name, int strlen);
	374	extern const char *frame_map_regnum_to_name (int regnum);
	375
c906108c	376	#endif /* !defined (FRAME_H) */