[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 *current_regcache;

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

/* NOTE: cagney/2002-11-02: The below have been superseded by the
   regcache_cooked_*() functions found above, and the frame_*()
   functions found in "frame.h".  Take care though, often more than a
   simple substitution is required when updating the code.  The
   change, as far as practical, should avoid adding references to
   global variables (e.g., current_regcache, current_frame,
   current_gdbarch or the selected frame) and instead refer to
   the FRAME or REGCACHE that has been passed into the containing
   function as parameters.  Consequently, the change typically
   involves modifying the containing function so that it takes a FRAME
   or REGCACHE parameter.  In the case of an architecture vector
   method, there should already be a non-deprecated variant that is
   parameterized with FRAME or REGCACHE.  */

extern void deprecated_read_register_gen (int regnum, gdb_byte *myaddr);
extern void deprecated_write_register_gen (int regnum, gdb_byte *myaddr);

/* NOTE: cagney/2002-11-05: This function has been superseeded by
   regcache_raw_supply().  */
extern void deprecated_registers_fetched (void);

extern int register_cached (int regnum);

extern void set_register_cached (int regnum, int state);

extern void registers_changed (void);


/* Rename to read_unsigned_register()? */
extern ULONGEST read_register (int regnum);

/* Rename to read_unsigned_register_pid()? */
extern ULONGEST read_register_pid (int regnum, ptid_t ptid);

extern void write_register (int regnum, LONGEST val);

extern void write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid);

#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
	29	extern struct regcache *current_regcache;
	30
	31	void regcache_xfree (struct regcache *regcache);
36160dc4	32	struct cleanup make_cleanup_regcache_xfree (struct regcache regcache);
3fadccb3 AC	33	struct regcache regcache_xmalloc (struct gdbarch gdbarch);
3fadccb3 AC	34
41d35cb0 MK	35	/* Return REGCACHE's architecture. */
	36
	37	extern struct gdbarch get_regcache_arch (const struct regcache regcache);
	38
61a0eb5b AC	39	/* Transfer a raw register [0..NUM_REGS) between core-gdb and the
	40	regcache. */
	41
2d522557	42	void regcache_raw_read (struct regcache regcache, int rawnum, gdb_byte buf);
1aaa5f99	43	void regcache_raw_write (struct regcache *regcache, int rawnum,
2d522557	44	const gdb_byte *buf);
28fc6740 AC	45	extern void regcache_raw_read_signed (struct regcache *regcache,
	46	int regnum, LONGEST *val);
	47	extern void regcache_raw_read_unsigned (struct regcache *regcache,
	48	int regnum, ULONGEST *val);
c00dcbe9 MK	49	extern void regcache_raw_write_signed (struct regcache *regcache,
	50	int regnum, LONGEST val);
	51	extern void regcache_raw_write_unsigned (struct regcache *regcache,
	52	int regnum, ULONGEST val);
06c0b04e AC	53
	54	/* Partial transfer of a raw registers. These perform read, modify,
	55	write style operations. */
	56
	57	void regcache_raw_read_part (struct regcache *regcache, int regnum,
2d522557	58	int offset, int len, gdb_byte *buf);
06c0b04e	59	void regcache_raw_write_part (struct regcache *regcache, int regnum,
2d522557	60	int offset, int len, const gdb_byte *buf);
06c0b04e	61
3fadccb3	62	int regcache_valid_p (struct regcache *regcache, int regnum);
61a0eb5b	63
68365089	64	/* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */
2d522557 AC	65	void regcache_cooked_read (struct regcache *regcache, int rawnum,
2d522557 AC	66	gdb_byte *buf);
68365089	67	void regcache_cooked_write (struct regcache *regcache, int rawnum,
2d522557	68	const gdb_byte *buf);
68365089	69
a378f419 AC	70	/* NOTE: cagney/2002-08-13: At present GDB has no reliable mechanism
	71	for indicating when a ``cooked'' register was constructed from
	72	invalid or unavailable ``raw'' registers. One fairly easy way of
	73	adding such a mechanism would be for the cooked functions to return
	74	a register valid indication. Given the possibility of such a
	75	change, the extract functions below use a reference parameter,
	76	rather than a function result. */
	77
	78	/* Read a register as a signed/unsigned quantity. */
	79	extern void regcache_cooked_read_signed (struct regcache *regcache,
	80	int regnum, LONGEST *val);
	81	extern void regcache_cooked_read_unsigned (struct regcache *regcache,
	82	int regnum, ULONGEST *val);
a66a9c23 AC	83	extern void regcache_cooked_write_signed (struct regcache *regcache,
	84	int regnum, LONGEST val);
	85	extern void regcache_cooked_write_unsigned (struct regcache *regcache,
	86	int regnum, ULONGEST val);
a378f419	87
06c0b04e AC	88	/* Partial transfer of a cooked register. These perform read, modify,
	89	write style operations. */
	90
	91	void regcache_cooked_read_part (struct regcache *regcache, int regnum,
2d522557	92	int offset, int len, gdb_byte *buf);
06c0b04e	93	void regcache_cooked_write_part (struct regcache *regcache, int regnum,
2d522557	94	int offset, int len, const gdb_byte *buf);
06c0b04e	95
193cb69f AC	96	/* Transfer a raw register [0..NUM_REGS) between the regcache and the
	97	target. These functions are called by the target in response to a
	98	target_fetch_registers() or target_store_registers(). */
	99
9a661b68	100	extern void regcache_raw_supply (struct regcache *regcache,
6618125d	101	int regnum, const void *buf);
9a661b68	102	extern void regcache_raw_collect (const struct regcache *regcache,
6618125d	103	int regnum, void *buf);
193cb69f AC	104
193cb69f AC	105
d3b22ed5 AC	106	/* The register's ``offset''.
d3b22ed5 AC	107
ac2adee5	108	FIXME: cagney/2002-11-07: The frame_register() function, when
e600bd34 AC	109	specifying the real location of a register, does so using that
	110	registers offset in the register cache. That offset is then used
	111	by valops.c to determine the location of the register. The code
	112	should instead use the register's number and a location expression
	113	to describe a value spread across multiple registers or memory. */
d3b22ed5 AC	114
d3b22ed5 AC	115	extern int register_offset_hack (struct gdbarch *gdbarch, int regnum);
d3b22ed5 AC	116
d3b22ed5 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
192dbe33 AC	160	/* NOTE: cagney/2002-11-02: The below have been superseded by the
	161	regcache_cooked_() functions found above, and the frame_()
	162	functions found in "frame.h". Take care though, often more than a
	163	simple substitution is required when updating the code. The
	164	change, as far as practical, should avoid adding references to
	165	global variables (e.g., current_regcache, current_frame,
206415a3	166	current_gdbarch or the selected frame) and instead refer to
6e7f8b9c AC	167	the FRAME or REGCACHE that has been passed into the containing
	168	function as parameters. Consequently, the change typically
	169	involves modifying the containing function so that it takes a FRAME
	170	or REGCACHE parameter. In the case of an architecture vector
	171	method, there should already be a non-deprecated variant that is
	172	parameterized with FRAME or REGCACHE. */
192dbe33	173
2d522557 AC	174	extern void deprecated_read_register_gen (int regnum, gdb_byte *myaddr);
2d522557 AC	175	extern void deprecated_write_register_gen (int regnum, gdb_byte *myaddr);
3fadccb3	176
8851ec7a	177	/* NOTE: cagney/2002-11-05: This function has been superseeded by
23a6d369	178	regcache_raw_supply(). */
2b9e5f3f AC	179	extern void deprecated_registers_fetched (void);
2b9e5f3f AC	180
4e052eda AC	181	extern int register_cached (int regnum);
	182
	183	extern void set_register_cached (int regnum, int state);
	184
4e052eda AC	185	extern void registers_changed (void);
4e052eda AC	186
4e052eda	187
4e052eda AC	188	/* Rename to read_unsigned_register()? */
	189	extern ULONGEST read_register (int regnum);
	190
	191	/* Rename to read_unsigned_register_pid()? */
39f77062	192	extern ULONGEST read_register_pid (int regnum, ptid_t ptid);
4e052eda	193
4e052eda AC	194	extern void write_register (int regnum, LONGEST val);
4e052eda AC	195
39f77062	196	extern void write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid);
4e052eda	197
4e052eda	198	#endif /* REGCACHE_H */