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

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

   Copyright 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000,
   2001, 2002 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 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, void *buf);
void regcache_raw_write (struct regcache *regcache, int rawnum,
			 const void *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, void *buf);
void regcache_raw_write_part (struct regcache *regcache, int regnum,
			      int offset, int len, const void *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, void *buf);
void regcache_cooked_write (struct regcache *regcache, int rawnum,
			    const void *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, void *buf);
void regcache_cooked_write_part (struct regcache *regcache, int regnum,
				 int offset, int len, const void *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);

/* Similar.  The total number of bytes occupied by a regcache.  */

extern int deprecated_register_bytes (void );


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

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

/* 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 deprecated_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 char *deprecated_grub_regcache_for_registers (struct regcache *);
extern void deprecated_read_register_gen (int regnum, char *myaddr);
extern void deprecated_write_register_gen (int regnum, char *myaddr);
extern void deprecated_read_register_bytes (int regbyte, char *myaddr,
					    int len);
extern void deprecated_write_register_bytes (int regbyte, char *myaddr,
					     int len);

/* 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 AC	2
	3	Copyright 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000,
	4	2001, 2002 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
	20	Foundation, Inc., 59 Temple Place - Suite 330,
	21	Boston, MA 02111-1307, USA. */
	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
1aaa5f99 AC	42	void regcache_raw_read (struct regcache regcache, int rawnum, void buf);
	43	void regcache_raw_write (struct regcache *regcache, int rawnum,
	44	const void *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,
	58	int offset, int len, void *buf);
	59	void regcache_raw_write_part (struct regcache *regcache, int regnum,
	60	int offset, int len, const void *buf);
	61
3fadccb3	62	int regcache_valid_p (struct regcache *regcache, int regnum);
61a0eb5b	63
68365089 AC	64	/* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */
	65	void regcache_cooked_read (struct regcache regcache, int rawnum, void buf);
	66	void regcache_cooked_write (struct regcache *regcache, int rawnum,
	67	const void *buf);
	68
a378f419 AC	69	/* NOTE: cagney/2002-08-13: At present GDB has no reliable mechanism
	70	for indicating when a ``cooked'' register was constructed from
	71	invalid or unavailable ``raw'' registers. One fairly easy way of
	72	adding such a mechanism would be for the cooked functions to return
	73	a register valid indication. Given the possibility of such a
	74	change, the extract functions below use a reference parameter,
	75	rather than a function result. */
	76
	77	/* Read a register as a signed/unsigned quantity. */
	78	extern void regcache_cooked_read_signed (struct regcache *regcache,
	79	int regnum, LONGEST *val);
	80	extern void regcache_cooked_read_unsigned (struct regcache *regcache,
	81	int regnum, ULONGEST *val);
a66a9c23 AC	82	extern void regcache_cooked_write_signed (struct regcache *regcache,
	83	int regnum, LONGEST val);
	84	extern void regcache_cooked_write_unsigned (struct regcache *regcache,
	85	int regnum, ULONGEST val);
a378f419	86
06c0b04e AC	87	/* Partial transfer of a cooked register. These perform read, modify,
	88	write style operations. */
	89
	90	void regcache_cooked_read_part (struct regcache *regcache, int regnum,
	91	int offset, int len, void *buf);
	92	void regcache_cooked_write_part (struct regcache *regcache, int regnum,
	93	int offset, int len, const void *buf);
	94
193cb69f AC	95	/* Transfer a raw register [0..NUM_REGS) between the regcache and the
	96	target. These functions are called by the target in response to a
	97	target_fetch_registers() or target_store_registers(). */
	98
9a661b68 MK	99	extern void regcache_raw_supply (struct regcache *regcache,
	100	int regnum, const void *buf);
	101	extern void regcache_raw_collect (const struct regcache *regcache,
	102	int regnum, void *buf);
193cb69f AC	103
193cb69f AC	104
d3b22ed5 AC	105	/* The register's ``offset''.
d3b22ed5 AC	106
ac2adee5	107	FIXME: cagney/2002-11-07: The frame_register() function, when
e600bd34 AC	108	specifying the real location of a register, does so using that
	109	registers offset in the register cache. That offset is then used
	110	by valops.c to determine the location of the register. The code
	111	should instead use the register's number and a location expression
	112	to describe a value spread across multiple registers or memory. */
d3b22ed5 AC	113
d3b22ed5 AC	114	extern int register_offset_hack (struct gdbarch *gdbarch, int regnum);
d3b22ed5	115
f42accbe AC	116	/* Similar. The total number of bytes occupied by a regcache. */
	117
	118	extern int deprecated_register_bytes (void );
	119
d3b22ed5	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
	139	typedef int (regcache_cooked_read_ftype) (void src, int regnum, void buf);
	140
	141	extern void regcache_save (struct regcache *dst,
	142	regcache_cooked_read_ftype *cooked_read,
	143	void *src);
	144	extern void regcache_restore (struct regcache *dst,
	145	regcache_cooked_read_ftype *cooked_read,
	146	void *src);
2d28509a	147
37e71372 AC	148	/* Copy/duplicate the contents of a register cache. By default, the
	149	operation is pass-through. Writes to DST and reads from SRC will
	150	go through to the target.
	151
	152	The ``cpy'' functions can not have overlapping SRC and DST buffers.
3fadccb3 AC	153
3fadccb3 AC	154	``no passthrough'' versions do not go through to the target. They
37e71372	155	only transfer values already in the cache. */
3fadccb3	156
3fadccb3	157	extern struct regcache regcache_dup (struct regcache regcache);
3fadccb3 AC	158	extern struct regcache regcache_dup_no_passthrough (struct regcache regcache);
	159	extern void regcache_cpy (struct regcache dest, struct regcache src);
	160	extern void regcache_cpy_no_passthrough (struct regcache dest, struct regcache src);
	161
192dbe33 AC	162	/* NOTE: cagney/2002-11-02: The below have been superseded by the
	163	regcache_cooked_() functions found above, and the frame_()
	164	functions found in "frame.h". Take care though, often more than a
	165	simple substitution is required when updating the code. The
	166	change, as far as practical, should avoid adding references to
	167	global variables (e.g., current_regcache, current_frame,
6e7f8b9c AC	168	current_gdbarch or deprecated_selected_frame) and instead refer to
	169	the FRAME or REGCACHE that has been passed into the containing
	170	function as parameters. Consequently, the change typically
	171	involves modifying the containing function so that it takes a FRAME
	172	or REGCACHE parameter. In the case of an architecture vector
	173	method, there should already be a non-deprecated variant that is
	174	parameterized with FRAME or REGCACHE. */
192dbe33	175
3fadccb3	176	extern char deprecated_grub_regcache_for_registers (struct regcache );
192dbe33 AC	177	extern void deprecated_read_register_gen (int regnum, char *myaddr);
192dbe33 AC	178	extern void deprecated_write_register_gen (int regnum, char *myaddr);
73937e03 AC	179	extern void deprecated_read_register_bytes (int regbyte, char *myaddr,
	180	int len);
	181	extern void deprecated_write_register_bytes (int regbyte, char *myaddr,
	182	int len);
3fadccb3	183
8851ec7a	184	/* NOTE: cagney/2002-11-05: This function has been superseeded by
23a6d369	185	regcache_raw_supply(). */
2b9e5f3f AC	186	extern void deprecated_registers_fetched (void);
2b9e5f3f AC	187
4e052eda AC	188	extern int register_cached (int regnum);
	189
	190	extern void set_register_cached (int regnum, int state);
	191
4e052eda AC	192	extern void registers_changed (void);
4e052eda AC	193
4e052eda	194
4e052eda AC	195	/* Rename to read_unsigned_register()? */
	196	extern ULONGEST read_register (int regnum);
	197
	198	/* Rename to read_unsigned_register_pid()? */
39f77062	199	extern ULONGEST read_register_pid (int regnum, ptid_t ptid);
4e052eda	200
4e052eda AC	201	extern void write_register (int regnum, LONGEST val);
4e052eda AC	202
39f77062	203	extern void write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid);
4e052eda	204
4e052eda	205	#endif /* REGCACHE_H */