[deliverable/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, 2008, 2009, 2010, 2011 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 3 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, see <http://www.gnu.org/licenses/>.  */

#ifndef REGCACHE_H
#define REGCACHE_H

struct regcache;
struct gdbarch;
struct address_space;

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

void regcache_xfree (struct regcache *regcache);
struct cleanup *make_cleanup_regcache_xfree (struct regcache *regcache);
struct regcache *regcache_xmalloc (struct gdbarch *gdbarch,
				   struct address_space *aspace);

/* Return REGCACHE's architecture.  */

extern struct gdbarch *get_regcache_arch (const struct regcache *regcache);

/* Return REGCACHE's address space.  */

extern struct address_space *get_regcache_aspace (const struct regcache *);

enum register_status
  {
    /* The register value is not in the cache, and we don't know yet
       whether it's available in the target (or traceframe).  */
    REG_UNKNOWN = 0,

    /* The register value is valid and cached.  */
    REG_VALID = 1,

    /* The register value is unavailable.  E.g., we're inspecting a
       traceframe, and this register wasn't collected.  Note that this
       is different a different "unavailable" from saying the register
       does not exist in the target's architecture --- in that case,
       the target should have given us a target description that does
       not include the register in the first place.  */
    REG_UNAVAILABLE = -1
  };

enum register_status regcache_register_status (const struct regcache *regcache,
					       int regnum);

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

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

/* Special routines to read/write the PC.  */

extern CORE_ADDR regcache_read_pc (struct regcache *regcache);
extern void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc);

/* 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 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 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);
extern void registers_changed_ptid (ptid_t);

#endif /* REGCACHE_H */
Commit	Line	Data
	1	/* Cache and manage the values of registers for GDB, the GNU debugger.
	2
	3	Copyright (C) 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000, 2001,
	4	2002, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
	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 3 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, see <http://www.gnu.org/licenses/>. */
	20
	21	#ifndef REGCACHE_H
	22	#define REGCACHE_H
	23
	24	struct regcache;
	25	struct gdbarch;
	26	struct address_space;
	27
	28	extern struct regcache *get_current_regcache (void);
	29	extern struct regcache *get_thread_regcache (ptid_t ptid);
	30	extern struct regcache get_thread_arch_regcache (ptid_t, struct gdbarch );
	31
	32	void regcache_xfree (struct regcache *regcache);
	33	struct cleanup make_cleanup_regcache_xfree (struct regcache regcache);
	34	struct regcache regcache_xmalloc (struct gdbarch gdbarch,
	35	struct address_space *aspace);
	36
	37	/* Return REGCACHE's architecture. */
	38
	39	extern struct gdbarch get_regcache_arch (const struct regcache regcache);
	40
	41	/* Return REGCACHE's address space. */
	42
	43	extern struct address_space get_regcache_aspace (const struct regcache );
	44
	45	enum register_status
	46	{
	47	/* The register value is not in the cache, and we don't know yet
	48	whether it's available in the target (or traceframe). */
	49	REG_UNKNOWN = 0,
	50
	51	/* The register value is valid and cached. */
	52	REG_VALID = 1,
	53
	54	/* The register value is unavailable. E.g., we're inspecting a
	55	traceframe, and this register wasn't collected. Note that this
	56	is different a different "unavailable" from saying the register
	57	does not exist in the target's architecture --- in that case,
	58	the target should have given us a target description that does
	59	not include the register in the first place. */
	60	REG_UNAVAILABLE = -1
	61	};
	62
	63	enum register_status regcache_register_status (const struct regcache *regcache,
	64	int regnum);
	65
	66	/* Transfer a raw register [0..NUM_REGS) between core-gdb and the
	67	regcache. */
	68
	69	void regcache_raw_read (struct regcache regcache, int rawnum, gdb_byte buf);
	70	void regcache_raw_write (struct regcache *regcache, int rawnum,
	71	const gdb_byte *buf);
	72	extern void regcache_raw_read_signed (struct regcache *regcache,
	73	int regnum, LONGEST *val);
	74	extern void regcache_raw_read_unsigned (struct regcache *regcache,
	75	int regnum, ULONGEST *val);
	76	extern void regcache_raw_write_signed (struct regcache *regcache,
	77	int regnum, LONGEST val);
	78	extern void regcache_raw_write_unsigned (struct regcache *regcache,
	79	int regnum, ULONGEST val);
	80
	81	/* Partial transfer of a raw registers. These perform read, modify,
	82	write style operations. */
	83
	84	void regcache_raw_read_part (struct regcache *regcache, int regnum,
	85	int offset, int len, gdb_byte *buf);
	86	void regcache_raw_write_part (struct regcache *regcache, int regnum,
	87	int offset, int len, const gdb_byte *buf);
	88
	89	void regcache_invalidate (struct regcache *regcache, int regnum);
	90
	91	/* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */
	92	void regcache_cooked_read (struct regcache *regcache, int rawnum,
	93	gdb_byte *buf);
	94	void regcache_cooked_write (struct regcache *regcache, int rawnum,
	95	const gdb_byte *buf);
	96
	97	/* NOTE: cagney/2002-08-13: At present GDB has no reliable mechanism
	98	for indicating when a ``cooked'' register was constructed from
	99	invalid or unavailable ``raw'' registers. One fairly easy way of
	100	adding such a mechanism would be for the cooked functions to return
	101	a register valid indication. Given the possibility of such a
	102	change, the extract functions below use a reference parameter,
	103	rather than a function result. */
	104
	105	/* Read a register as a signed/unsigned quantity. */
	106	extern void regcache_cooked_read_signed (struct regcache *regcache,
	107	int regnum, LONGEST *val);
	108	extern void regcache_cooked_read_unsigned (struct regcache *regcache,
	109	int regnum, ULONGEST *val);
	110	extern void regcache_cooked_write_signed (struct regcache *regcache,
	111	int regnum, LONGEST val);
	112	extern void regcache_cooked_write_unsigned (struct regcache *regcache,
	113	int regnum, ULONGEST val);
	114
	115	/* Partial transfer of a cooked register. These perform read, modify,
	116	write style operations. */
	117
	118	void regcache_cooked_read_part (struct regcache *regcache, int regnum,
	119	int offset, int len, gdb_byte *buf);
	120	void regcache_cooked_write_part (struct regcache *regcache, int regnum,
	121	int offset, int len, const gdb_byte *buf);
	122
	123	/* Special routines to read/write the PC. */
	124
	125	extern CORE_ADDR regcache_read_pc (struct regcache *regcache);
	126	extern void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc);
	127
	128	/* Transfer a raw register [0..NUM_REGS) between the regcache and the
	129	target. These functions are called by the target in response to a
	130	target_fetch_registers() or target_store_registers(). */
	131
	132	extern void regcache_raw_supply (struct regcache *regcache,
	133	int regnum, const void *buf);
	134	extern void regcache_raw_collect (const struct regcache *regcache,
	135	int regnum, void *buf);
	136
	137
	138	/* The type of a register. This function is slightly more efficient
	139	then its gdbarch vector counterpart since it returns a precomputed
	140	value stored in a table. */
	141
	142	extern struct type register_type (struct gdbarch gdbarch, int regnum);
	143
	144
	145	/* Return the size of register REGNUM. All registers should have only
	146	one size. */
	147
	148	extern int register_size (struct gdbarch *gdbarch, int regnum);
	149
	150
	151	/* Save/restore a register cache. The set of registers saved /
	152	restored into the DST regcache determined by the save_reggroup /
	153	restore_reggroup respectively. COOKED_READ returns zero iff the
	154	register's value can't be returned. */
	155
	156	typedef int (regcache_cooked_read_ftype) (void *src, int regnum,
	157	gdb_byte *buf);
	158
	159	extern void regcache_save (struct regcache *dst,
	160	regcache_cooked_read_ftype *cooked_read,
	161	void *cooked_read_context);
	162	extern void regcache_restore (struct regcache *dst,
	163	regcache_cooked_read_ftype *cooked_read,
	164	void *cooked_read_context);
	165
	166	/* Copy/duplicate the contents of a register cache. By default, the
	167	operation is pass-through. Writes to DST and reads from SRC will
	168	go through to the target.
	169
	170	The ``cpy'' functions can not have overlapping SRC and DST buffers.
	171
	172	``no passthrough'' versions do not go through to the target. They
	173	only transfer values already in the cache. */
	174
	175	extern struct regcache regcache_dup (struct regcache regcache);
	176	extern void regcache_cpy (struct regcache dest, struct regcache src);
	177	extern void regcache_cpy_no_passthrough (struct regcache *dest,
	178	struct regcache *src);
	179
	180	extern void registers_changed (void);
	181	extern void registers_changed_ptid (ptid_t);
	182
	183	#endif /* REGCACHE_H */