[deliverable/binutils-gdb.git] / gdb / regcache.h

/* Cache and manage the values of registers for GDB, the GNU debugger.

   Copyright (C) 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000, 2001,
   2002, 2007, 2008, 2009, 2010 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 REGCACHE_H
#define REGCACHE_H

struct regcache;
struct gdbarch;
struct address_space;

extern struct regcache *get_current_regcache (void);
extern struct regcache *get_thread_regcache (ptid_t ptid);
extern struct regcache *get_thread_arch_regcache (ptid_t, struct gdbarch *);

void regcache_xfree (struct regcache *regcache);
struct cleanup *make_cleanup_regcache_xfree (struct regcache *regcache);
struct regcache *regcache_xmalloc (struct gdbarch *gdbarch);

/* Return REGCACHE's architecture.  */

extern struct gdbarch *get_regcache_arch (const struct regcache *regcache);

/* Return REGCACHE's address space.  */

extern struct address_space *get_regcache_aspace (const struct regcache *regcache);

/* Transfer a raw register [0..NUM_REGS) between core-gdb and the
   regcache. */

void regcache_raw_read (struct regcache *regcache, int rawnum, gdb_byte *buf);
void regcache_raw_write (struct regcache *regcache, int rawnum,
			 const gdb_byte *buf);
extern void regcache_raw_read_signed (struct regcache *regcache,
				      int regnum, LONGEST *val);
extern void regcache_raw_read_unsigned (struct regcache *regcache,
					int regnum, ULONGEST *val);
extern void regcache_raw_write_signed (struct regcache *regcache,
				       int regnum, LONGEST val);
extern void regcache_raw_write_unsigned (struct regcache *regcache,
					 int regnum, ULONGEST val);

/* Partial transfer of a raw registers.  These perform read, modify,
   write style operations.  */

void regcache_raw_read_part (struct regcache *regcache, int regnum,
			     int offset, int len, gdb_byte *buf);
void regcache_raw_write_part (struct regcache *regcache, int regnum,
			      int offset, int len, const gdb_byte *buf);

int regcache_valid_p (const struct regcache *regcache, int regnum);

void regcache_invalidate (struct regcache *regcache, int regnum);

/* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS).  */
void regcache_cooked_read (struct regcache *regcache, int rawnum,
			   gdb_byte *buf);
void regcache_cooked_write (struct regcache *regcache, int rawnum,
			    const gdb_byte *buf);

/* NOTE: cagney/2002-08-13: At present GDB has no reliable mechanism
   for indicating when a ``cooked'' register was constructed from
   invalid or unavailable ``raw'' registers.  One fairly easy way of
   adding such a mechanism would be for the cooked functions to return
   a register valid indication.  Given the possibility of such a
   change, the extract functions below use a reference parameter,
   rather than a function result.  */

/* Read a register as a signed/unsigned quantity.  */
extern void regcache_cooked_read_signed (struct regcache *regcache,
					 int regnum, LONGEST *val);
extern void regcache_cooked_read_unsigned (struct regcache *regcache,
					   int regnum, ULONGEST *val);
extern void regcache_cooked_write_signed (struct regcache *regcache,
					  int regnum, LONGEST val);
extern void regcache_cooked_write_unsigned (struct regcache *regcache,
					    int regnum, ULONGEST val);

/* Partial transfer of a cooked register.  These perform read, modify,
   write style operations.  */

void regcache_cooked_read_part (struct regcache *regcache, int regnum,
				int offset, int len, gdb_byte *buf);
void regcache_cooked_write_part (struct regcache *regcache, int regnum,
				 int offset, int len, const gdb_byte *buf);

/* Special routines to read/write the PC.  */

extern CORE_ADDR regcache_read_pc (struct regcache *regcache);
extern void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc);

/* Transfer a raw register [0..NUM_REGS) between the regcache and the
   target.  These functions are called by the target in response to a
   target_fetch_registers() or target_store_registers().  */

extern void regcache_raw_supply (struct regcache *regcache,
				 int regnum, const void *buf);
extern void regcache_raw_collect (const struct regcache *regcache,
				  int regnum, void *buf);


/* The type of a register.  This function is slightly more efficient
   then its gdbarch vector counterpart since it returns a precomputed
   value stored in a table.  */

extern struct type *register_type (struct gdbarch *gdbarch, int regnum);


/* Return the size of register REGNUM.  All registers should have only
   one size.  */
   
extern int register_size (struct gdbarch *gdbarch, int regnum);


/* Save/restore a register cache.  The set of registers saved /
   restored into the DST regcache determined by the save_reggroup /
   restore_reggroup respectively.  COOKED_READ returns zero iff the
   register's value can't be returned.  */

typedef int (regcache_cooked_read_ftype) (void *src, int regnum,
					  gdb_byte *buf);

extern void regcache_save (struct regcache *dst,
			   regcache_cooked_read_ftype *cooked_read,
			   void *cooked_read_context);
extern void regcache_restore (struct regcache *dst,
			      regcache_cooked_read_ftype *cooked_read,
			      void *cooked_read_context);

/* Copy/duplicate the contents of a register cache.  By default, the
   operation is pass-through.  Writes to DST and reads from SRC will
   go through to the target.

   The ``cpy'' functions can not have overlapping SRC and DST buffers.

   ``no passthrough'' versions do not go through to the target.  They
   only transfer values already in the cache.  */

extern struct regcache *regcache_dup (struct regcache *regcache);
extern struct regcache *regcache_dup_no_passthrough (struct regcache *regcache);
extern void regcache_cpy (struct regcache *dest, struct regcache *src);
extern void regcache_cpy_no_passthrough (struct regcache *dest, struct regcache *src);

extern void registers_changed (void);

#endif /* REGCACHE_H */
Commit	Line	Data
4e052eda	1	/* Cache and manage the values of registers for GDB, the GNU debugger.
3fadccb3	2
6aba47ca	3	Copyright (C) 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000, 2001,
4c38e0a4	4	2002, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
4e052eda AC	5
	6	This file is part of GDB.
	7
	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
a9762ec7	10	the Free Software Foundation; either version 3 of the License, or
4e052eda AC	11	(at your option) any later version.
	12
	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.
	17
	18	You should have received a copy of the GNU General Public License
a9762ec7	19	along with this program. If not, see <http://www.gnu.org/licenses/>. */
4e052eda AC	20
	21	#ifndef REGCACHE_H
	22	#define REGCACHE_H
	23
3fadccb3 AC	24	struct regcache;
3fadccb3 AC	25	struct gdbarch;
6c95b8df	26	struct address_space;
3fadccb3	27
594f7785 UW	28	extern struct regcache *get_current_regcache (void);
594f7785 UW	29	extern struct regcache *get_thread_regcache (ptid_t ptid);
c2250ad1	30	extern struct regcache get_thread_arch_regcache (ptid_t, struct gdbarch );
3fadccb3 AC	31
3fadccb3 AC	32	void regcache_xfree (struct regcache *regcache);
36160dc4	33	struct cleanup make_cleanup_regcache_xfree (struct regcache regcache);
3fadccb3 AC	34	struct regcache regcache_xmalloc (struct gdbarch gdbarch);
3fadccb3 AC	35
41d35cb0 MK	36	/* Return REGCACHE's architecture. */
	37
	38	extern struct gdbarch get_regcache_arch (const struct regcache regcache);
	39
6c95b8df PA	40	/* Return REGCACHE's address space. */
	41
	42	extern struct address_space get_regcache_aspace (const struct regcache regcache);
	43
61a0eb5b AC	44	/* Transfer a raw register [0..NUM_REGS) between core-gdb and the
	45	regcache. */
	46
2d522557	47	void regcache_raw_read (struct regcache regcache, int rawnum, gdb_byte buf);
1aaa5f99	48	void regcache_raw_write (struct regcache *regcache, int rawnum,
2d522557	49	const gdb_byte *buf);
28fc6740 AC	50	extern void regcache_raw_read_signed (struct regcache *regcache,
	51	int regnum, LONGEST *val);
	52	extern void regcache_raw_read_unsigned (struct regcache *regcache,
	53	int regnum, ULONGEST *val);
c00dcbe9 MK	54	extern void regcache_raw_write_signed (struct regcache *regcache,
	55	int regnum, LONGEST val);
	56	extern void regcache_raw_write_unsigned (struct regcache *regcache,
	57	int regnum, ULONGEST val);
06c0b04e AC	58
	59	/* Partial transfer of a raw registers. These perform read, modify,
	60	write style operations. */
	61
	62	void regcache_raw_read_part (struct regcache *regcache, int regnum,
2d522557	63	int offset, int len, gdb_byte *buf);
06c0b04e	64	void regcache_raw_write_part (struct regcache *regcache, int regnum,
2d522557	65	int offset, int len, const gdb_byte *buf);
06c0b04e	66
6ed7ea50	67	int regcache_valid_p (const struct regcache *regcache, int regnum);
61a0eb5b	68
9c5ea4d9 UW	69	void regcache_invalidate (struct regcache *regcache, int regnum);
9c5ea4d9 UW	70
68365089	71	/* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */
2d522557 AC	72	void regcache_cooked_read (struct regcache *regcache, int rawnum,
2d522557 AC	73	gdb_byte *buf);
68365089	74	void regcache_cooked_write (struct regcache *regcache, int rawnum,
2d522557	75	const gdb_byte *buf);
68365089	76
a378f419 AC	77	/* NOTE: cagney/2002-08-13: At present GDB has no reliable mechanism
	78	for indicating when a ``cooked'' register was constructed from
	79	invalid or unavailable ``raw'' registers. One fairly easy way of
	80	adding such a mechanism would be for the cooked functions to return
	81	a register valid indication. Given the possibility of such a
	82	change, the extract functions below use a reference parameter,
	83	rather than a function result. */
	84
	85	/* Read a register as a signed/unsigned quantity. */
	86	extern void regcache_cooked_read_signed (struct regcache *regcache,
	87	int regnum, LONGEST *val);
	88	extern void regcache_cooked_read_unsigned (struct regcache *regcache,
	89	int regnum, ULONGEST *val);
a66a9c23 AC	90	extern void regcache_cooked_write_signed (struct regcache *regcache,
	91	int regnum, LONGEST val);
	92	extern void regcache_cooked_write_unsigned (struct regcache *regcache,
	93	int regnum, ULONGEST val);
a378f419	94
06c0b04e AC	95	/* Partial transfer of a cooked register. These perform read, modify,
	96	write style operations. */
	97
	98	void regcache_cooked_read_part (struct regcache *regcache, int regnum,
2d522557	99	int offset, int len, gdb_byte *buf);
06c0b04e	100	void regcache_cooked_write_part (struct regcache *regcache, int regnum,
2d522557	101	int offset, int len, const gdb_byte *buf);
06c0b04e	102
515630c5 UW	103	/* Special routines to read/write the PC. */
	104
	105	extern CORE_ADDR regcache_read_pc (struct regcache *regcache);
	106	extern void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc);
	107
193cb69f AC	108	/* Transfer a raw register [0..NUM_REGS) between the regcache and the
	109	target. These functions are called by the target in response to a
	110	target_fetch_registers() or target_store_registers(). */
	111
9a661b68	112	extern void regcache_raw_supply (struct regcache *regcache,
6618125d	113	int regnum, const void *buf);
9a661b68	114	extern void regcache_raw_collect (const struct regcache *regcache,
6618125d	115	int regnum, void *buf);
193cb69f AC	116
193cb69f AC	117
bb425013 AC	118	/* The type of a register. This function is slightly more efficient
bb425013 AC	119	then its gdbarch vector counterpart since it returns a precomputed
01e1877c	120	value stored in a table. */
bb425013 AC	121
	122	extern struct type register_type (struct gdbarch gdbarch, int regnum);
	123
	124
08a617da	125	/* Return the size of register REGNUM. All registers should have only
01e1877c	126	one size. */
08a617da AC	127
	128	extern int register_size (struct gdbarch *gdbarch, int regnum);
	129
	130
5602984a AC	131	/* Save/restore a register cache. The set of registers saved /
	132	restored into the DST regcache determined by the save_reggroup /
	133	restore_reggroup respectively. COOKED_READ returns zero iff the
	134	register's value can't be returned. */
	135
2d522557 AC	136	typedef int (regcache_cooked_read_ftype) (void *src, int regnum,
2d522557 AC	137	gdb_byte *buf);
5602984a AC	138
	139	extern void regcache_save (struct regcache *dst,
	140	regcache_cooked_read_ftype *cooked_read,
2d522557	141	void *cooked_read_context);
5602984a AC	142	extern void regcache_restore (struct regcache *dst,
5602984a AC	143	regcache_cooked_read_ftype *cooked_read,
2d522557	144	void *cooked_read_context);
2d28509a	145
37e71372 AC	146	/* Copy/duplicate the contents of a register cache. By default, the
	147	operation is pass-through. Writes to DST and reads from SRC will
	148	go through to the target.
	149
	150	The ``cpy'' functions can not have overlapping SRC and DST buffers.
3fadccb3 AC	151
3fadccb3 AC	152	``no passthrough'' versions do not go through to the target. They
37e71372	153	only transfer values already in the cache. */
3fadccb3	154
3fadccb3	155	extern struct regcache regcache_dup (struct regcache regcache);
3fadccb3 AC	156	extern struct regcache regcache_dup_no_passthrough (struct regcache regcache);
	157	extern void regcache_cpy (struct regcache dest, struct regcache src);
	158	extern void regcache_cpy_no_passthrough (struct regcache dest, struct regcache src);
	159
4e052eda AC	160	extern void registers_changed (void);
4e052eda AC	161
4e052eda	162	#endif /* REGCACHE_H */