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

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

   Copyright (C) 2003, 2004, 2007 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 3 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, see <http://www.gnu.org/licenses/>.  */

#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_this_base (struct trad_frame_cache *this_trad_cache,
			       CORE_ADDR this_base);
CORE_ADDR trad_frame_get_this_base (struct trad_frame_cache *this_trad_cache);

void trad_frame_set_reg_realreg (struct trad_frame_cache *this_trad_cache,
				 int regnum, int realreg);
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_set_reg_value (struct trad_frame_cache *this_cache,
			       int regnum, LONGEST val);

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, gdb_byte *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_get_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, gdb_byte *bufferp);

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