[thirdparty/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 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., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.  */

#ifndef REGCACHE_H
#define REGCACHE_H

struct regcache;
struct gdbarch;

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

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);

/* 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);

/* 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 register's ``offset''.

   FIXME: cagney/2002-11-07: The frame_register() function, when
   specifying the real location of a register, does so using that
   registers offset in the register cache.  That offset is then used
   by valops.c to determine the location of the register.  The code
   should instead use the register's number and a location expression
   to describe a value spread across multiple registers or memory.  */

extern int register_offset_hack (struct gdbarch *gdbarch, int regnum);


/* 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 DJ	3	Copyright (C) 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000, 2001,
6aba47ca DJ	4	2002, 2007 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
	10	the Free Software Foundation; either version 2 of the License, or
	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
	19	along with this program; if not, write to the Free Software
197e01b6 EZ	20	Foundation, Inc., 51 Franklin Street, Fifth Floor,
197e01b6 EZ	21	Boston, MA 02110-1301, USA. */
4e052eda AC	22
	23	#ifndef REGCACHE_H
	24	#define REGCACHE_H
	25
3fadccb3 AC	26	struct regcache;
	27	struct gdbarch;
	28
594f7785 UW	29	extern struct regcache *get_current_regcache (void);
594f7785 UW	30	extern struct regcache *get_thread_regcache (ptid_t ptid);
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
61a0eb5b AC	40	/* Transfer a raw register [0..NUM_REGS) between core-gdb and the
	41	regcache. */
	42
2d522557	43	void regcache_raw_read (struct regcache regcache, int rawnum, gdb_byte buf);
1aaa5f99	44	void regcache_raw_write (struct regcache *regcache, int rawnum,
2d522557	45	const gdb_byte *buf);
28fc6740 AC	46	extern void regcache_raw_read_signed (struct regcache *regcache,
	47	int regnum, LONGEST *val);
	48	extern void regcache_raw_read_unsigned (struct regcache *regcache,
	49	int regnum, ULONGEST *val);
c00dcbe9 MK	50	extern void regcache_raw_write_signed (struct regcache *regcache,
	51	int regnum, LONGEST val);
	52	extern void regcache_raw_write_unsigned (struct regcache *regcache,
	53	int regnum, ULONGEST val);
06c0b04e AC	54
	55	/* Partial transfer of a raw registers. These perform read, modify,
	56	write style operations. */
	57
	58	void regcache_raw_read_part (struct regcache *regcache, int regnum,
2d522557	59	int offset, int len, gdb_byte *buf);
06c0b04e	60	void regcache_raw_write_part (struct regcache *regcache, int regnum,
2d522557	61	int offset, int len, const gdb_byte *buf);
06c0b04e	62
6ed7ea50	63	int regcache_valid_p (const struct regcache *regcache, int regnum);
61a0eb5b	64
9c5ea4d9 UW	65	void regcache_invalidate (struct regcache *regcache, int regnum);
9c5ea4d9 UW	66
68365089	67	/* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */
2d522557 AC	68	void regcache_cooked_read (struct regcache *regcache, int rawnum,
2d522557 AC	69	gdb_byte *buf);
68365089	70	void regcache_cooked_write (struct regcache *regcache, int rawnum,
2d522557	71	const gdb_byte *buf);
68365089	72
a378f419 AC	73	/* NOTE: cagney/2002-08-13: At present GDB has no reliable mechanism
	74	for indicating when a ``cooked'' register was constructed from
	75	invalid or unavailable ``raw'' registers. One fairly easy way of
	76	adding such a mechanism would be for the cooked functions to return
	77	a register valid indication. Given the possibility of such a
	78	change, the extract functions below use a reference parameter,
	79	rather than a function result. */
	80
	81	/* Read a register as a signed/unsigned quantity. */
	82	extern void regcache_cooked_read_signed (struct regcache *regcache,
	83	int regnum, LONGEST *val);
	84	extern void regcache_cooked_read_unsigned (struct regcache *regcache,
	85	int regnum, ULONGEST *val);
a66a9c23 AC	86	extern void regcache_cooked_write_signed (struct regcache *regcache,
	87	int regnum, LONGEST val);
	88	extern void regcache_cooked_write_unsigned (struct regcache *regcache,
	89	int regnum, ULONGEST val);
a378f419	90
06c0b04e AC	91	/* Partial transfer of a cooked register. These perform read, modify,
	92	write style operations. */
	93
	94	void regcache_cooked_read_part (struct regcache *regcache, int regnum,
2d522557	95	int offset, int len, gdb_byte *buf);
06c0b04e	96	void regcache_cooked_write_part (struct regcache *regcache, int regnum,
2d522557	97	int offset, int len, const gdb_byte *buf);
06c0b04e	98
193cb69f AC	99	/* Transfer a raw register [0..NUM_REGS) between the regcache and the
	100	target. These functions are called by the target in response to a
	101	target_fetch_registers() or target_store_registers(). */
	102
9a661b68	103	extern void regcache_raw_supply (struct regcache *regcache,
6618125d	104	int regnum, const void *buf);
9a661b68	105	extern void regcache_raw_collect (const struct regcache *regcache,
6618125d	106	int regnum, void *buf);
193cb69f AC	107
193cb69f AC	108
d3b22ed5 AC	109	/* The register's ``offset''.
d3b22ed5 AC	110
ac2adee5	111	FIXME: cagney/2002-11-07: The frame_register() function, when
e600bd34 AC	112	specifying the real location of a register, does so using that
	113	registers offset in the register cache. That offset is then used
	114	by valops.c to determine the location of the register. The code
	115	should instead use the register's number and a location expression
	116	to describe a value spread across multiple registers or memory. */
d3b22ed5 AC	117
d3b22ed5 AC	118	extern int register_offset_hack (struct gdbarch *gdbarch, int regnum);
d3b22ed5 AC	119
d3b22ed5 AC	120
bb425013 AC	121	/* The type of a register. This function is slightly more efficient
bb425013 AC	122	then its gdbarch vector counterpart since it returns a precomputed
01e1877c	123	value stored in a table. */
bb425013 AC	124
	125	extern struct type register_type (struct gdbarch gdbarch, int regnum);
	126
	127
08a617da	128	/* Return the size of register REGNUM. All registers should have only
01e1877c	129	one size. */
08a617da AC	130
	131	extern int register_size (struct gdbarch *gdbarch, int regnum);
	132
	133
5602984a AC	134	/* Save/restore a register cache. The set of registers saved /
	135	restored into the DST regcache determined by the save_reggroup /
	136	restore_reggroup respectively. COOKED_READ returns zero iff the
	137	register's value can't be returned. */
	138
2d522557 AC	139	typedef int (regcache_cooked_read_ftype) (void *src, int regnum,
2d522557 AC	140	gdb_byte *buf);
5602984a AC	141
	142	extern void regcache_save (struct regcache *dst,
	143	regcache_cooked_read_ftype *cooked_read,
2d522557	144	void *cooked_read_context);
5602984a AC	145	extern void regcache_restore (struct regcache *dst,
5602984a AC	146	regcache_cooked_read_ftype *cooked_read,
2d522557	147	void *cooked_read_context);
2d28509a	148
37e71372 AC	149	/* Copy/duplicate the contents of a register cache. By default, the
	150	operation is pass-through. Writes to DST and reads from SRC will
	151	go through to the target.
	152
	153	The ``cpy'' functions can not have overlapping SRC and DST buffers.
3fadccb3 AC	154
3fadccb3 AC	155	``no passthrough'' versions do not go through to the target. They
37e71372	156	only transfer values already in the cache. */
3fadccb3	157
3fadccb3	158	extern struct regcache regcache_dup (struct regcache regcache);
3fadccb3 AC	159	extern struct regcache regcache_dup_no_passthrough (struct regcache regcache);
	160	extern void regcache_cpy (struct regcache dest, struct regcache src);
	161	extern void regcache_cpy_no_passthrough (struct regcache dest, struct regcache src);
	162
4e052eda AC	163	extern void registers_changed (void);
4e052eda AC	164
4e052eda	165	#endif /* REGCACHE_H */