/* 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 Free Software Foundation, Inc.
This file is part of GDB.
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. */
+ Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA. */
#ifndef REGCACHE_H
#define REGCACHE_H
-/* Transfer a raw register [0..NUM_REGS) between core-gdb and the
- regcache. */
+struct regcache;
+struct gdbarch;
-void regcache_read (int rawnum, char *buf);
-void regcache_write (int rawnum, char *buf);
+extern struct regcache *current_regcache;
-/* DEPRECATED: Character array containing an image of the inferior
- programs' registers for the most recently referenced thread. */
+void regcache_xfree (struct regcache *regcache);
+struct cleanup *make_cleanup_regcache_xfree (struct regcache *regcache);
+struct regcache *regcache_xmalloc (struct gdbarch *gdbarch);
-extern char *registers;
+/* Return REGCACHE's architecture. */
-/* DEPRECATED: Character array containing the current state of each
- register (unavailable<0, invalid=0, valid>0) for the most recently
- referenced thread. */
+extern struct gdbarch *get_regcache_arch (const struct regcache *regcache);
-extern signed char *register_valid;
+/* Transfer a raw register [0..NUM_REGS) between core-gdb and the
+ regcache. */
-extern int register_cached (int regnum);
+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);
-extern void set_register_cached (int regnum, int state);
+/* Partial transfer of a raw registers. These perform read, modify,
+ write style operations. */
-extern void register_changed (int regnum);
+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);
-/* DEPRECATED: Functional interface returning pointer into registers[]
- array. */
+int regcache_valid_p (struct regcache *regcache, int regnum);
-extern char *register_buffer (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);
+
+/* 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,
+ 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 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 void registers_changed (void);
+extern gdb_byte *deprecated_grub_regcache_for_registers (struct regcache *);
+extern void deprecated_read_register_gen (int regnum, gdb_byte *myaddr);
+extern void deprecated_write_register_gen (int regnum, gdb_byte *myaddr);
+extern void deprecated_read_register_bytes (int regbyte, gdb_byte *myaddr,
+ int len);
+extern void deprecated_write_register_bytes (int regbyte, gdb_byte *myaddr,
+ int len);
-extern void registers_fetched (void);
+/* NOTE: cagney/2002-11-05: This function has been superseeded by
+ regcache_raw_supply(). */
+extern void deprecated_registers_fetched (void);
-extern void read_register_bytes (int regbyte, char *myaddr, int len);
+extern int register_cached (int regnum);
-extern void read_register_gen (int regnum, char *myaddr);
+extern void set_register_cached (int regnum, int state);
-extern void write_register_gen (int regnum, char *myaddr);
+extern void registers_changed (void);
-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);
-extern void supply_register (int regnum, char *val);
-
#endif /* REGCACHE_H */
projects / deliverable / binutils-gdb.git / blobdiff