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

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

extern char *deprecated_grub_regcache_for_registers (struct regcache *);
extern char *deprecated_grub_regcache_for_register_valid (struct regcache *);

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 read_register_gen (int regnum, char *myaddr);

extern void write_register_gen (int regnum, char *myaddr);

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