[deliverable/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);

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

/* 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 supply_register (int regnum, const void *val);
extern void regcache_collect (int regnum, void *buf);


/* The register's ``offset''.

   NOTE: cagney/2002-08-17: The ``struct value'' and expression
   evaluator treat the register cache as a large liner buffer.
   Instead of reading/writing a register using its register number,
   the code read/writes registers by specifying their offset into the
   buffer and a number of bytes.  The code also assumes that these
   byte read/writes can cross register boundaries, adjacent registers
   treated as a contiguous set of bytes.

   The below map that model onto the real register cache.  New code
   should go out of their way to avoid using these interfaces.

   FIXME: cagney/2002-08-17: The ``struct value'' and expression
   evaluator should be fixed.  Instead of using the { offset, length }
   pair to describe a value within one or more registers, the code
   should use a chain of { regnum, offset, len } tripples.  */

extern int register_offset_hack (struct gdbarch *gdbarch, int regnum);
extern void regcache_cooked_read_using_offset_hack (struct regcache *regcache,
						    int offset, int len,
						    void *buf);
extern void regcache_cooked_write_using_offset_hack (struct regcache *regcache,
						     int offset, int len,
						     const 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.

   NOTE: cagney/2002-08-17: The original macro was called
   REGISTER_VIRTUAL_TYPE.  This was because the register could have
   different raw and cooked (nee virtual) representations.  The
   CONVERTABLE methods being used to convert between the two
   representations.  Current code does not do this.  Instead, the
   first [0..NUM_REGS) registers are 1:1 raw:cooked, and the type
   exactly describes the register's representation.  Consequently, the
   ``virtual'' has been dropped.

   FIXME: cagney/2002-08-17: A number of architectures, including the
   MIPS, are currently broken in this regard.  */

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


/* Return the size of the largest register.  Used when allocating
   space for an aribtrary register value.  */

extern int max_register_size (struct gdbarch *gdbarch);


/* DEPRECATED: Character array containing an image of the inferior
   programs' registers for the most recently referenced thread. */

extern char *registers;

/* DEPRECATED: Character array containing the current state of each
   register (unavailable<0, invalid=0, valid>0) for the most recently
   referenced thread. */

extern signed char *register_valid;

/* 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 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 char *deprecated_grub_regcache_for_register_valid (struct regcache *);
extern void deprecated_read_register_gen (int regnum, char *myaddr);
extern void deprecated_write_register_gen (int regnum, char *myaddr);

extern int register_cached (int regnum);

extern void set_register_cached (int regnum, int state);

extern void register_changed (int regnum);

extern void registers_changed (void);

extern void registers_fetched (void);

extern void read_register_bytes (int regbyte, char *myaddr, int len);

extern void write_register_bytes (int regbyte, char *myaddr, int len);

/* 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 LONGEST read_signed_register (int regnum);

extern LONGEST read_signed_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
61a0eb5b AC	35	/* Transfer a raw register [0..NUM_REGS) between core-gdb and the
	36	regcache. */
	37
1aaa5f99 AC	38	void regcache_raw_read (struct regcache regcache, int rawnum, void buf);
	39	void regcache_raw_write (struct regcache *regcache, int rawnum,
	40	const void *buf);
28fc6740 AC	41	extern void regcache_raw_read_signed (struct regcache *regcache,
	42	int regnum, LONGEST *val);
	43	extern void regcache_raw_read_unsigned (struct regcache *regcache,
	44	int regnum, ULONGEST *val);
c00dcbe9 MK	45	extern void regcache_raw_write_signed (struct regcache *regcache,
	46	int regnum, LONGEST val);
	47	extern void regcache_raw_write_unsigned (struct regcache *regcache,
	48	int regnum, ULONGEST val);
06c0b04e AC	49
	50	/* Partial transfer of a raw registers. These perform read, modify,
	51	write style operations. */
	52
	53	void regcache_raw_read_part (struct regcache *regcache, int regnum,
	54	int offset, int len, void *buf);
	55	void regcache_raw_write_part (struct regcache *regcache, int regnum,
	56	int offset, int len, const void *buf);
	57
3fadccb3	58	int regcache_valid_p (struct regcache *regcache, int regnum);
61a0eb5b	59
68365089 AC	60	/* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */
	61	void regcache_cooked_read (struct regcache regcache, int rawnum, void buf);
	62	void regcache_cooked_write (struct regcache *regcache, int rawnum,
	63	const void *buf);
	64
a378f419 AC	65	/* NOTE: cagney/2002-08-13: At present GDB has no reliable mechanism
	66	for indicating when a ``cooked'' register was constructed from
	67	invalid or unavailable ``raw'' registers. One fairly easy way of
	68	adding such a mechanism would be for the cooked functions to return
	69	a register valid indication. Given the possibility of such a
	70	change, the extract functions below use a reference parameter,
	71	rather than a function result. */
	72
	73	/* Read a register as a signed/unsigned quantity. */
	74	extern void regcache_cooked_read_signed (struct regcache *regcache,
	75	int regnum, LONGEST *val);
	76	extern void regcache_cooked_read_unsigned (struct regcache *regcache,
	77	int regnum, ULONGEST *val);
	78
06c0b04e AC	79	/* Partial transfer of a cooked register. These perform read, modify,
	80	write style operations. */
	81
	82	void regcache_cooked_read_part (struct regcache *regcache, int regnum,
	83	int offset, int len, void *buf);
	84	void regcache_cooked_write_part (struct regcache *regcache, int regnum,
	85	int offset, int len, const void *buf);
	86
193cb69f AC	87	/* Transfer a raw register [0..NUM_REGS) between the regcache and the
	88	target. These functions are called by the target in response to a
	89	target_fetch_registers() or target_store_registers(). */
	90
1aaa5f99	91	extern void supply_register (int regnum, const void *val);
193cb69f AC	92	extern void regcache_collect (int regnum, void *buf);
	93
	94
d3b22ed5 AC	95	/* The register's ``offset''.
	96
	97	NOTE: cagney/2002-08-17: The ``struct value'' and expression
	98	evaluator treat the register cache as a large liner buffer.
	99	Instead of reading/writing a register using its register number,
	100	the code read/writes registers by specifying their offset into the
	101	buffer and a number of bytes. The code also assumes that these
	102	byte read/writes can cross register boundaries, adjacent registers
	103	treated as a contiguous set of bytes.
	104
	105	The below map that model onto the real register cache. New code
	106	should go out of their way to avoid using these interfaces.
	107
	108	FIXME: cagney/2002-08-17: The ``struct value'' and expression
	109	evaluator should be fixed. Instead of using the { offset, length }
	110	pair to describe a value within one or more registers, the code
	111	should use a chain of { regnum, offset, len } tripples. */
	112
	113	extern int register_offset_hack (struct gdbarch *gdbarch, int regnum);
	114	extern void regcache_cooked_read_using_offset_hack (struct regcache *regcache,
	115	int offset, int len,
	116	void *buf);
	117	extern void regcache_cooked_write_using_offset_hack (struct regcache *regcache,
	118	int offset, int len,
	119	const void *buf);
	120
	121
bb425013 AC	122	/* The type of a register. This function is slightly more efficient
	123	then its gdbarch vector counterpart since it returns a precomputed
	124	value stored in a table.
	125
	126	NOTE: cagney/2002-08-17: The original macro was called
	127	REGISTER_VIRTUAL_TYPE. This was because the register could have
	128	different raw and cooked (nee virtual) representations. The
	129	CONVERTABLE methods being used to convert between the two
	130	representations. Current code does not do this. Instead, the
	131	first [0..NUM_REGS) registers are 1:1 raw:cooked, and the type
	132	exactly describes the register's representation. Consequently, the
	133	``virtual'' has been dropped.
	134
	135	FIXME: cagney/2002-08-17: A number of architectures, including the
	136	MIPS, are currently broken in this regard. */
	137
	138	extern struct type register_type (struct gdbarch gdbarch, int regnum);
	139
	140
0ed04cce AC	141	/* Return the size of the largest register. Used when allocating
	142	space for an aribtrary register value. */
	143
	144	extern int max_register_size (struct gdbarch *gdbarch);
	145
	146
61a0eb5b AC	147	/* DEPRECATED: Character array containing an image of the inferior
61a0eb5b AC	148	programs' registers for the most recently referenced thread. */
4e052eda AC	149
	150	extern char *registers;
	151
61a0eb5b AC	152	/* DEPRECATED: Character array containing the current state of each
	153	register (unavailable<0, invalid=0, valid>0) for the most recently
	154	referenced thread. */
4e052eda AC	155
	156	extern signed char *register_valid;
	157
37e71372 AC	158	/* Copy/duplicate the contents of a register cache. By default, the
	159	operation is pass-through. Writes to DST and reads from SRC will
	160	go through to the target.
	161
	162	The ``cpy'' functions can not have overlapping SRC and DST buffers.
3fadccb3 AC	163
3fadccb3 AC	164	``no passthrough'' versions do not go through to the target. They
37e71372	165	only transfer values already in the cache. */
3fadccb3	166
3fadccb3	167	extern struct regcache regcache_dup (struct regcache regcache);
3fadccb3 AC	168	extern struct regcache regcache_dup_no_passthrough (struct regcache regcache);
	169	extern void regcache_cpy (struct regcache dest, struct regcache src);
	170	extern void regcache_cpy_no_passthrough (struct regcache dest, struct regcache src);
	171
192dbe33 AC	172	/* NOTE: cagney/2002-11-02: The below have been superseded by the
	173	regcache_cooked_() functions found above, and the frame_()
	174	functions found in "frame.h". Take care though, often more than a
	175	simple substitution is required when updating the code. The
	176	change, as far as practical, should avoid adding references to
	177	global variables (e.g., current_regcache, current_frame,
	178	current_gdbarch or selected_frame) and instead refer to the FRAME
	179	or REGCACHE that has been passed into the containing function as
	180	parameters. Consequently, the change typically involves modifying
	181	the containing function so that it takes a FRAME or REGCACHE
	182	parameter. In the case of an architecture vector method, there
	183	should already be a non-deprecated variant that is parameterized
	184	with FRAME or REGCACHE. */
	185
3fadccb3 AC	186	extern char deprecated_grub_regcache_for_registers (struct regcache );
3fadccb3 AC	187	extern char deprecated_grub_regcache_for_register_valid (struct regcache );
192dbe33 AC	188	extern void deprecated_read_register_gen (int regnum, char *myaddr);
192dbe33 AC	189	extern void deprecated_write_register_gen (int regnum, char *myaddr);
3fadccb3	190
4e052eda AC	191	extern int register_cached (int regnum);
	192
	193	extern void set_register_cached (int regnum, int state);
	194
	195	extern void register_changed (int regnum);
	196
4e052eda AC	197	extern void registers_changed (void);
	198
	199	extern void registers_fetched (void);
	200
	201	extern void read_register_bytes (int regbyte, char *myaddr, int len);
	202
4e052eda AC	203	extern void write_register_bytes (int regbyte, char *myaddr, int len);
	204
	205	/* Rename to read_unsigned_register()? */
	206	extern ULONGEST read_register (int regnum);
	207
	208	/* Rename to read_unsigned_register_pid()? */
39f77062	209	extern ULONGEST read_register_pid (int regnum, ptid_t ptid);
4e052eda AC	210
	211	extern LONGEST read_signed_register (int regnum);
	212
39f77062	213	extern LONGEST read_signed_register_pid (int regnum, ptid_t ptid);
4e052eda AC	214
	215	extern void write_register (int regnum, LONGEST val);
	216
39f77062	217	extern void write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid);
4e052eda	218
4e052eda	219	#endif /* REGCACHE_H */