X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=gdb%2Fregcache.h;h=f7d4bc60f65133ff0c735b847f1b26cb15c31a62;hb=260bcd09bfb98ebc5d8f0eb564edca21872e9f7f;hp=a5f4fdb031640aebac1fb0ac8a04663f30ef4350;hpb=594f77850bb22a2cec4e8fc44c7ea735a6270eb2;p=deliverable%2Fbinutils-gdb.git
diff --git a/gdb/regcache.h b/gdb/regcache.h
index a5f4fdb031..f7d4bc60f6 100644
--- a/gdb/regcache.h
+++ b/gdb/regcache.h
@@ -1,13 +1,12 @@
/* 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 Free Software Foundation, Inc.
+ Copyright (C) 1986-2019 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,
@@ -16,106 +15,137 @@
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., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA. */
+ along with this program. If not, see . */
#ifndef REGCACHE_H
#define REGCACHE_H
+#include "gdbsupport/common-regcache.h"
+#include "gdbsupport/function-view.h"
+#include
+
struct regcache;
+struct regset;
struct gdbarch;
+struct address_space;
+class thread_info;
extern struct regcache *get_current_regcache (void);
extern struct regcache *get_thread_regcache (ptid_t ptid);
-void regcache_xfree (struct regcache *regcache);
-struct cleanup *make_cleanup_regcache_xfree (struct regcache *regcache);
-struct regcache *regcache_xmalloc (struct gdbarch *gdbarch);
-
-/* Return REGCACHE's architecture. */
+/* Get the regcache of THREAD. */
+extern struct regcache *get_thread_regcache (thread_info *thread);
-extern struct gdbarch *get_regcache_arch (const struct regcache *regcache);
+extern struct regcache *get_thread_arch_regcache (ptid_t, struct gdbarch *);
+extern struct regcache *get_thread_arch_aspace_regcache (ptid_t,
+ struct gdbarch *,
+ struct address_space *);
-/* Transfer a raw register [0..NUM_REGS) between core-gdb and the
- regcache. */
+extern enum register_status
+ regcache_raw_read_signed (struct regcache *regcache,
+ int regnum, LONGEST *val);
-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);
-
-int regcache_valid_p (const struct regcache *regcache, int regnum);
-
-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);
+/* Return the register's value in signed or throw if it's not
+ available. */
-/* 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 LONGEST regcache_raw_get_signed (struct regcache *regcache,
+ int regnum);
/* 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 enum register_status
+ regcache_cooked_read_signed (struct regcache *regcache,
+ int regnum, LONGEST *val);
+extern enum register_status
+ 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);
+/* Special routines to read/write the PC. */
+
+/* For regcache_read_pc see gdbsupport/common-regcache.h. */
+extern void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc);
+
+/* Mapping between register numbers and offsets in a buffer, for use
+ in the '*regset' functions below and with traditional frame caches.
+ In an array of 'regcache_map_entry' each element is interpreted
+ like follows:
+
+ - If 'regno' is a register number: Map register 'regno' to the
+ current offset (starting with 0) and increase the current offset
+ by 'size' (or the register's size, if 'size' is zero). Repeat
+ this with consecutive register numbers up to 'regno+count-1'.
+
+ For each described register, if 'size' is larger than the
+ register's size, the register's value is assumed to be stored in
+ the first N (where N is the register size) bytes at the current
+ offset. The remaining 'size' - N bytes are filled with zeroes by
+ 'regcache_collect_regset' and ignored by other consumers.
+
+ If 'size' is smaller than the register's size, only the first
+ 'size' bytes of a register's value are assumed to be stored at
+ the current offset. 'regcache_collect_regset' copies the first
+ 'size' bytes of a register's value to the output buffer.
+ 'regcache_supply_regset' copies the bytes from the input buffer
+ into the first 'size' bytes of the register's value leaving the
+ remaining bytes of the register's value unchanged. Frame caches
+ read the 'size' bytes from the stack frame and zero extend them
+ to generate the register's value.
+
+ - If 'regno' is REGCACHE_MAP_SKIP: Add 'count*size' to the current
+ offset.
+
+ - If count=0: End of the map. */
+
+struct regcache_map_entry
+{
+ int count;
+ int regno;
+ int size;
+};
+
+/* Special value for the 'regno' field in the struct above. */
+
+enum
+ {
+ REGCACHE_MAP_SKIP = -1,
+ };
+
+/* Calculate and return the total size of all the registers in a
+ regcache_map_entry. */
+
+static inline int
+regcache_map_entry_size (const struct regcache_map_entry *map)
+{
+ int size = 0;
+ for (int i = 0; map[i].count != 0; i++)
+ size += (map[i].count * map[i].size);
+ return size;
+}
+
+/* Transfer a set of registers (as described by REGSET) between
+ REGCACHE and BUF. If REGNUM == -1, transfer all registers
+ belonging to the regset, otherwise just the register numbered
+ REGNUM. The REGSET's 'regmap' field must point to an array of
+ 'struct regcache_map_entry'.
+
+ These functions are suitable for the 'regset_supply' and
+ 'regset_collect' fields in a regset structure. */
+
+extern void regcache_supply_regset (const struct regset *regset,
+ struct regcache *regcache,
+ int regnum, const void *buf,
+ size_t size);
+extern void regcache_collect_regset (const struct regset *regset,
+ const struct regcache *regcache,
+ int regnum, void *buf, size_t size);
/* The type of a register. This function is slightly more efficient
@@ -130,36 +160,321 @@ extern struct type *register_type (struct gdbarch *gdbarch, int regnum);
extern int register_size (struct gdbarch *gdbarch, int regnum);
+typedef gdb::function_view
+ register_read_ftype;
+
+/* A (register_number, register_value) pair. */
+
+typedef struct cached_reg
+{
+ int num;
+ gdb_byte *data;
+} cached_reg_t;
+
+/* Buffer of registers. */
+
+class reg_buffer : public reg_buffer_common
+{
+public:
+ reg_buffer (gdbarch *gdbarch, bool has_pseudo);
+
+ DISABLE_COPY_AND_ASSIGN (reg_buffer);
+
+ /* Return regcache's architecture. */
+ gdbarch *arch () const;
+
+ /* See gdbsupport/common-regcache.h. */
+ enum register_status get_register_status (int regnum) const override;
+
+ /* See gdbsupport/common-regcache.h. */
+ void raw_collect (int regnum, void *buf) const override;
+
+ /* Collect register REGNUM from REGCACHE. Store collected value as an integer
+ at address ADDR, in target endian, with length ADDR_LEN and sign IS_SIGNED.
+ If ADDR_LEN is greater than the register size, then the integer will be
+ sign or zero extended. If ADDR_LEN is smaller than the register size, then
+ the most significant bytes of the integer will be truncated. */
+ void raw_collect_integer (int regnum, gdb_byte *addr, int addr_len,
+ bool is_signed) const;
+
+ /* Collect register REGNUM from REGCACHE, starting at OFFSET in register,
+ reading only LEN. */
+ void raw_collect_part (int regnum, int offset, int len, gdb_byte *out) const;
+
+ /* See gdbsupport/common-regcache.h. */
+ void raw_supply (int regnum, const void *buf) override;
+
+ void raw_supply (int regnum, const reg_buffer &src)
+ {
+ raw_supply (regnum, src.register_buffer (regnum));
+ }
+
+ /* Supply register REGNUM to REGCACHE. Value to supply is an integer stored
+ at address ADDR, in target endian, with length ADDR_LEN and sign IS_SIGNED.
+ If the register size is greater than ADDR_LEN, then the integer will be
+ sign or zero extended. If the register size is smaller than the integer,
+ then the most significant bytes of the integer will be truncated. */
+ void raw_supply_integer (int regnum, const gdb_byte *addr, int addr_len,
+ bool is_signed);
+
+ /* Supply register REGNUM with zeroed value to REGCACHE. This is not the same
+ as calling raw_supply with NULL (which will set the state to
+ unavailable). */
+ void raw_supply_zeroed (int regnum);
+
+ /* Supply register REGNUM to REGCACHE, starting at OFFSET in register, writing
+ only LEN, without editing the rest of the register. */
+ void raw_supply_part (int regnum, int offset, int len, const gdb_byte *in);
+
+ void invalidate (int regnum);
+
+ virtual ~reg_buffer () = default;
+
+ /* See gdbsupport/common-regcache.h. */
+ bool raw_compare (int regnum, const void *buf, int offset) const override;
+
+protected:
+ /* Assert on the range of REGNUM. */
+ void assert_regnum (int regnum) const;
+
+ int num_raw_registers () const;
+
+ gdb_byte *register_buffer (int regnum) const;
+
+ /* Save a register cache. The set of registers saved into the
+ regcache determined by the save_reggroup. COOKED_READ returns
+ zero iff the register's value can't be returned. */
+ void save (register_read_ftype cooked_read);
+
+ struct regcache_descr *m_descr;
+
+ bool m_has_pseudo;
+ /* The register buffers. */
+ std::unique_ptr m_registers;
+ /* Register cache status. */
+ std::unique_ptr m_register_status;
+
+ friend class regcache;
+ friend class detached_regcache;
+};
+
+/* An abstract class which only has methods doing read. */
+
+class readable_regcache : public reg_buffer
+{
+public:
+ readable_regcache (gdbarch *gdbarch, bool has_pseudo)
+ : reg_buffer (gdbarch, has_pseudo)
+ {}
+
+ /* Transfer a raw register [0..NUM_REGS) from core-gdb to this regcache,
+ return its value in *BUF and return its availability status. */
+
+ enum register_status raw_read (int regnum, gdb_byte *buf);
+ template>
+ enum register_status raw_read (int regnum, T *val);
+
+ /* Partial transfer of raw registers. Return the status of the register. */
+ enum register_status raw_read_part (int regnum, int offset, int len,
+ gdb_byte *buf);
+
+ /* Make certain that the register REGNUM is up-to-date. */
+ virtual void raw_update (int regnum) = 0;
-/* 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. */
+ /* Transfer a raw register [0..NUM_REGS+NUM_PSEUDO_REGS) from core-gdb to
+ this regcache, return its value in *BUF and return its availability status. */
+ enum register_status cooked_read (int regnum, gdb_byte *buf);
+ template>
+ enum register_status cooked_read (int regnum, T *val);
-typedef int (regcache_cooked_read_ftype) (void *src, int regnum,
- gdb_byte *buf);
+ /* Partial transfer of a cooked register. */
+ enum register_status cooked_read_part (int regnum, int offset, int len,
+ 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);
+ /* Read register REGNUM from the regcache and return a new value. This
+ will call mark_value_bytes_unavailable as appropriate. */
+ struct value *cooked_read_value (int regnum);
-/* 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.
+protected:
- The ``cpy'' functions can not have overlapping SRC and DST buffers.
+ /* Perform a partial register transfer using a read, modify, write
+ operation. Will fail if register is currently invalid. */
+ enum register_status read_part (int regnum, int offset, int len,
+ gdb_byte *out, bool is_raw);
+};
- ``no passthrough'' versions do not go through to the target. They
- only transfer values already in the cache. */
+/* Buffer of registers, can be read and written. */
-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);
+class detached_regcache : public readable_regcache
+{
+public:
+ detached_regcache (gdbarch *gdbarch, bool has_pseudo)
+ : readable_regcache (gdbarch, has_pseudo)
+ {}
+
+ void raw_update (int regnum) override
+ {}
+
+ DISABLE_COPY_AND_ASSIGN (detached_regcache);
+};
+
+class readonly_detached_regcache;
+
+/* The register cache for storing raw register values. */
+
+class regcache : public detached_regcache
+{
+public:
+ DISABLE_COPY_AND_ASSIGN (regcache);
+
+ /* Return REGCACHE's address space. */
+ const address_space *aspace () const
+ {
+ return m_aspace;
+ }
+
+ /* Restore 'this' regcache. The set of registers restored into
+ the regcache determined by the restore_reggroup.
+ Writes to regcache will go through to the target. SRC is a
+ read-only register cache. */
+ void restore (readonly_detached_regcache *src);
+
+ /* Update the value of raw register REGNUM (in the range [0..NUM_REGS)) and
+ transfer its value to core-gdb. */
+
+ void raw_write (int regnum, const gdb_byte *buf);
+
+ template>
+ void raw_write (int regnum, T val);
+
+ /* Transfer of pseudo-registers. */
+ void cooked_write (int regnum, const gdb_byte *buf);
+
+ template>
+ void cooked_write (int regnum, T val);
+
+ void raw_update (int regnum) override;
+
+ /* Partial transfer of raw registers. Perform read, modify, write style
+ operations. */
+ void raw_write_part (int regnum, int offset, int len, const gdb_byte *buf);
+
+ /* Partial transfer of a cooked register. Perform read, modify, write style
+ operations. */
+ void cooked_write_part (int regnum, int offset, int len,
+ const gdb_byte *buf);
+
+ void supply_regset (const struct regset *regset,
+ int regnum, const void *buf, size_t size);
+
+
+ void collect_regset (const struct regset *regset, int regnum,
+ void *buf, size_t size) const;
+
+ /* Return REGCACHE's ptid. */
+
+ ptid_t ptid () const
+ {
+ gdb_assert (m_ptid != minus_one_ptid);
+
+ return m_ptid;
+ }
+
+ void set_ptid (const ptid_t ptid)
+ {
+ this->m_ptid = ptid;
+ }
+
+/* Dump the contents of a register from the register cache to the target
+ debug. */
+ void debug_print_register (const char *func, int regno);
+
+ static void regcache_thread_ptid_changed (ptid_t old_ptid, ptid_t new_ptid);
+protected:
+ regcache (gdbarch *gdbarch, const address_space *aspace_);
+
+ static std::forward_list current_regcache;
+
+private:
+
+ /* Helper function for transfer_regset. Copies across a single register. */
+ void transfer_regset_register (struct regcache *out_regcache, int regnum,
+ const gdb_byte *in_buf, gdb_byte *out_buf,
+ int slot_size, int offs) const;
+
+ /* Transfer a single or all registers belonging to a certain register
+ set to or from a buffer. This is the main worker function for
+ regcache_supply_regset and regcache_collect_regset. */
+ void transfer_regset (const struct regset *regset,
+ struct regcache *out_regcache,
+ int regnum, const gdb_byte *in_buf,
+ gdb_byte *out_buf, size_t size) const;
+
+ /* Perform a partial register transfer using a read, modify, write
+ operation. */
+ enum register_status write_part (int regnum, int offset, int len,
+ const gdb_byte *in, bool is_raw);
+
+ /* The address space of this register cache (for registers where it
+ makes sense, like PC or SP). */
+ const address_space * const m_aspace;
+
+ /* If this is a read-write cache, which thread's registers is
+ it connected to? */
+ ptid_t m_ptid;
+
+ friend struct regcache *
+ get_thread_arch_aspace_regcache (ptid_t ptid, struct gdbarch *gdbarch,
+ struct address_space *aspace);
+
+ friend void
+ registers_changed_ptid (ptid_t ptid);
+};
+
+class readonly_detached_regcache : public readable_regcache
+{
+public:
+ readonly_detached_regcache (regcache &src);
+
+ /* Create a readonly regcache by getting contents from COOKED_READ. */
+
+ readonly_detached_regcache (gdbarch *gdbarch, register_read_ftype cooked_read)
+ : readable_regcache (gdbarch, true)
+ {
+ save (cooked_read);
+ }
+
+ DISABLE_COPY_AND_ASSIGN (readonly_detached_regcache);
+
+ void raw_update (int regnum) override
+ {}
+};
extern void registers_changed (void);
+extern void registers_changed_ptid (ptid_t);
+
+/* Indicate that registers of THREAD may have changed, so invalidate
+ the cache. */
+extern void registers_changed_thread (thread_info *thread);
+
+/* An abstract base class for register dump. */
+
+class register_dump
+{
+public:
+ void dump (ui_file *file);
+ virtual ~register_dump () = default;
+
+protected:
+ register_dump (gdbarch *arch)
+ : m_gdbarch (arch)
+ {}
+
+ /* Dump the register REGNUM contents. If REGNUM is -1, print the
+ header. */
+ virtual void dump_reg (ui_file *file, int regnum) = 0;
+
+ gdbarch *m_gdbarch;
+};
#endif /* REGCACHE_H */