[deliverable/binutils-gdb.git] / gdb / trad-frame.h

/* Traditional frame unwind support, for GDB the GNU Debugger.

   Copyright 2003, 2004 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.  */

#ifndef TRAD_FRAME_H
#define TRAD_FRAME_H

#include "frame.h"		/* For "struct frame_id".  */

struct frame_info;
struct trad_frame_cache;

/* A simple, or traditional frame cache.

   The entire cache is populated in a single pass and then generic
   routines are used to extract the various cache values.  */

struct trad_frame_cache *trad_frame_cache_zalloc (struct frame_info *next_frame);

/* This frame's ID.  */
void trad_frame_set_id (struct trad_frame_cache *this_trad_cache,
			struct frame_id this_id);
void trad_frame_get_id (struct trad_frame_cache *this_trad_cache,
			struct frame_id *this_id);

void trad_frame_set_reg_unknown (struct trad_frame_cache *this_trad_cache,
				 int regnum, CORE_ADDR addr);
void trad_frame_set_reg_addr (struct trad_frame_cache *this_trad_cache,
			      int regnum, CORE_ADDR addr);
void trad_frame_get_register (struct trad_frame_cache *this_trad_cache,
			      struct frame_info *next_frame,
			      int regnum, int *optimizedp,
			      enum lval_type *lvalp, CORE_ADDR *addrp,
			      int *realregp, void *bufferp);

/* A traditional saved regs table, indexed by REGNUM, encoding where
   the value of REGNUM for the previous frame can be found in this
   frame.

   The table is initialized with an identity encoding (ADDR == -1,
   REALREG == REGNUM) indicating that the value of REGNUM in the
   previous frame can be found in register REGNUM (== REALREG) in this
   frame.

   The initial encoding can then be changed:

   Modify ADDR (REALREG >= 0, ADDR != -1) to indicate that the value
   of register REGNUM in the previous frame can be found in memory at
   ADDR in this frame (addr_p, !realreg_p, !value_p).

   Modify REALREG (REALREG >= 0, ADDR == -1) to indicate that the
   value of register REGNUM in the previous frame is found in register
   REALREG in this frame (!addr_p, realreg_p, !value_p).

   Call trad_frame_set_value (REALREG == -1) to indicate that the
   value of register REGNUM in the previous frame is found in ADDR
   (!addr_p, !realreg_p, value_p).

   Call trad_frame_set_unknown (REALREG == -2) to indicate that the
   register's value is not known.  */

struct trad_frame_saved_reg
{
  LONGEST addr; /* A CORE_ADDR fits in a longest.  */
  int realreg;
};

/* Encode REGNUM value in the trad-frame.  */
void trad_frame_set_value (struct trad_frame_saved_reg this_saved_regs[],
			   int regnum, LONGEST val);

/* Mark REGNUM as unknown.  */
void trad_frame_set_unknown (struct trad_frame_saved_reg this_saved_regs[],
			     int regnum);

/* Convenience functions, return non-zero if the register has been
   encoded as specified.  */
int trad_frame_value_p (struct trad_frame_saved_reg this_saved_regs[],
			int regnum);
int trad_frame_addr_p (struct trad_frame_saved_reg this_saved_regs[],
		       int regnum);
int trad_frame_realreg_p (struct trad_frame_saved_reg this_saved_regs[],
			  int regnum);


/* Return a freshly allocated (and initialized) trad_frame array.  */
struct trad_frame_saved_reg *trad_frame_alloc_saved_regs (struct frame_info *next_frame);

/* Given the trad_frame info, return the location of the specified
   register.  */
void trad_frame_prev_register (struct frame_info *next_frame,
			       struct trad_frame_saved_reg this_saved_regs[],
			       int regnum, int *optimizedp,
			       enum lval_type *lvalp, CORE_ADDR *addrp,
			       int *realregp, void *bufferp);

#endif
Commit	Line	Data
a0f267c7 AC	1	/* Traditional frame unwind support, for GDB the GNU Debugger.
a0f267c7 AC	2
0db9b4b7	3	Copyright 2003, 2004 Free Software Foundation, Inc.
a0f267c7 AC	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 2 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, write to the Free Software
	19	Foundation, Inc., 59 Temple Place - Suite 330,
	20	Boston, MA 02111-1307, USA. */
	21
	22	#ifndef TRAD_FRAME_H
	23	#define TRAD_FRAME_H
	24
0db9b4b7 AC	25	#include "frame.h" /* For "struct frame_id". */
0db9b4b7 AC	26
2cdf3c63	27	struct frame_info;
0db9b4b7 AC	28	struct trad_frame_cache;
	29
	30	/* A simple, or traditional frame cache.
	31
	32	The entire cache is populated in a single pass and then generic
	33	routines are used to extract the various cache values. */
	34
	35	struct trad_frame_cache trad_frame_cache_zalloc (struct frame_info next_frame);
	36
	37	/* This frame's ID. */
	38	void trad_frame_set_id (struct trad_frame_cache *this_trad_cache,
	39	struct frame_id this_id);
	40	void trad_frame_get_id (struct trad_frame_cache *this_trad_cache,
	41	struct frame_id *this_id);
	42
	43	void trad_frame_set_reg_unknown (struct trad_frame_cache *this_trad_cache,
	44	int regnum, CORE_ADDR addr);
4be282b4 AC	45	void trad_frame_set_reg_addr (struct trad_frame_cache *this_trad_cache,
4be282b4 AC	46	int regnum, CORE_ADDR addr);
0db9b4b7 AC	47	void trad_frame_get_register (struct trad_frame_cache *this_trad_cache,
	48	struct frame_info *next_frame,
	49	int regnum, int *optimizedp,
	50	enum lval_type lvalp, CORE_ADDR addrp,
	51	int realregp, void bufferp);
2cdf3c63	52
8983bd83 AC	53	/* A traditional saved regs table, indexed by REGNUM, encoding where
	54	the value of REGNUM for the previous frame can be found in this
	55	frame.
	56
3b3850e8 AC	57	The table is initialized with an identity encoding (ADDR == -1,
	58	REALREG == REGNUM) indicating that the value of REGNUM in the
	59	previous frame can be found in register REGNUM (== REALREG) in this
8983bd83 AC	60	frame.
	61
	62	The initial encoding can then be changed:
	63
3b3850e8 AC	64	Modify ADDR (REALREG >= 0, ADDR != -1) to indicate that the value
	65	of register REGNUM in the previous frame can be found in memory at
	66	ADDR in this frame (addr_p, !realreg_p, !value_p).
8983bd83	67
3b3850e8 AC	68	Modify REALREG (REALREG >= 0, ADDR == -1) to indicate that the
	69	value of register REGNUM in the previous frame is found in register
	70	REALREG in this frame (!addr_p, realreg_p, !value_p).
8983bd83	71
3b3850e8 AC	72	Call trad_frame_set_value (REALREG == -1) to indicate that the
	73	value of register REGNUM in the previous frame is found in ADDR
	74	(!addr_p, !realreg_p, value_p).
	75
	76	Call trad_frame_set_unknown (REALREG == -2) to indicate that the
	77	register's value is not known. */
8983bd83 AC	78
8983bd83 AC	79	struct trad_frame_saved_reg
a0f267c7	80	{
8983bd83	81	LONGEST addr; /* A CORE_ADDR fits in a longest. */
3b3850e8	82	int realreg;
a0f267c7 AC	83	};
a0f267c7 AC	84
3b3850e8 AC	85	/* Encode REGNUM value in the trad-frame. */
	86	void trad_frame_set_value (struct trad_frame_saved_reg this_saved_regs[],
	87	int regnum, LONGEST val);
	88
	89	/* Mark REGNUM as unknown. */
	90	void trad_frame_set_unknown (struct trad_frame_saved_reg this_saved_regs[],
	91	int regnum);
	92
	93	/* Convenience functions, return non-zero if the register has been
	94	encoded as specified. */
	95	int trad_frame_value_p (struct trad_frame_saved_reg this_saved_regs[],
	96	int regnum);
	97	int trad_frame_addr_p (struct trad_frame_saved_reg this_saved_regs[],
	98	int regnum);
	99	int trad_frame_realreg_p (struct trad_frame_saved_reg this_saved_regs[],
	100	int regnum);
	101
a0f267c7 AC	102
a0f267c7 AC	103	/* Return a freshly allocated (and initialized) trad_frame array. */
8983bd83	104	struct trad_frame_saved_reg trad_frame_alloc_saved_regs (struct frame_info next_frame);
a0f267c7 AC	105
	106	/* Given the trad_frame info, return the location of the specified
	107	register. */
	108	void trad_frame_prev_register (struct frame_info *next_frame,
8983bd83	109	struct trad_frame_saved_reg this_saved_regs[],
a0f267c7 AC	110	int regnum, int *optimizedp,
a0f267c7 AC	111	enum lval_type lvalp, CORE_ADDR addrp,
3b3850e8	112	int realregp, void bufferp);
a0f267c7 AC	113
a0f267c7 AC	114	#endif