/* Cache and manage the values of registers for GDB, the GNU debugger.
- Copyright 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000, 2001
- Free Software Foundation, Inc.
+
+ Copyright (C) 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000, 2001,
+ 2002, 2007, 2008, 2009, 2010 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
+ 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,
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. */
+ 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 *regcache);
+
/* Transfer a raw register [0..NUM_REGS) between core-gdb and the
regcache. */
-void regcache_read (int rawnum, char *buf);
-void regcache_write (int rawnum, char *buf);
+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. */
-/* DEPRECATED: Character array containing an image of the inferior
- programs' registers for the most recently referenced thread. */
+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);
-extern char *registers;
+int regcache_valid_p (const struct regcache *regcache, int regnum);
-/* DEPRECATED: Character array containing the current state of each
- register (unavailable<0, invalid=0, valid>0) for the most recently
- referenced thread. */
+void regcache_invalidate (struct regcache *regcache, int regnum);
-extern signed char *register_valid;
+/* 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);
-extern int register_cached (int regnum);
+/* 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. */
-extern void set_register_cached (int regnum, int state);
+/* 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);
-extern void register_changed (int regnum);
+/* Partial transfer of a cooked register. These perform read, modify,
+ write style operations. */
-/* DEPRECATED: Functional interface returning pointer into registers[]
- array. */
+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);
-extern char *register_buffer (int regnum);
+/* Special routines to read/write the PC. */
-extern void registers_changed (void);
+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);
-extern void registers_fetched (void);
-extern void read_register_bytes (int regbyte, char *myaddr, int len);
+/* 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 void read_register_gen (int regnum, char *myaddr);
+extern struct type *register_type (struct gdbarch *gdbarch, int regnum);
-extern void write_register_gen (int regnum, char *myaddr);
-extern void write_register_bytes (int regbyte, char *myaddr, int len);
+/* Return the size of register REGNUM. All registers should have only
+ one size. */
+
+extern int register_size (struct gdbarch *gdbarch, int regnum);
-/* 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);
+/* 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. */
-extern LONGEST read_signed_register (int regnum);
+typedef int (regcache_cooked_read_ftype) (void *src, int regnum,
+ gdb_byte *buf);
-extern LONGEST read_signed_register_pid (int regnum, ptid_t ptid);
+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);
-extern void write_register (int regnum, LONGEST val);
+/* 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.
-extern void write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid);
+ The ``cpy'' functions can not have overlapping SRC and DST buffers.
-extern void supply_register (int regnum, char *val);
+ ``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 void registers_changed (void);
+extern void registers_changed_ptid (ptid_t);
#endif /* REGCACHE_H */