/* Cache and manage the values of registers for GDB, the GNU debugger.
- Copyright (C) 1986-2014 Free Software Foundation, Inc.
+ Copyright (C) 1986-2018 Free Software Foundation, Inc.
This file is part of GDB.
#ifndef REGCACHE_H
#define REGCACHE_H
+#include "common-regcache.h"
+#include <forward_list>
+
struct regcache;
+struct regset;
struct gdbarch;
struct address_space;
struct gdbarch *,
struct address_space *);
-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. The read variants return the status of the register. */
-
-enum register_status 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 enum register_status
regcache_raw_read_signed (struct regcache *regcache,
int regnum, LONGEST *val);
-extern enum register_status
- 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 raw registers. These perform read, modify,
- write style operations. The read variant returns the status of the
- register. */
+/* Return the register's value in signed or throw if it's not
+ available. */
-extern enum register_status
- 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 of pseudo-registers. The read variants return a register
- status, as an indication of when a ``cooked'' register was
- constructed from valid, invalid or unavailable ``raw''
- registers. */
-
-/* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */
-enum register_status regcache_cooked_read (struct regcache *regcache,
- int rawnum, gdb_byte *buf);
-void regcache_cooked_write (struct regcache *regcache, int rawnum,
- const gdb_byte *buf);
-
-/* Read register REGNUM from REGCACHE and return a new value. This
- will call mark_value_bytes_unavailable as appropriate. */
-
-struct value *regcache_cooked_read_value (struct regcache *regcache,
- int regnum);
+extern LONGEST regcache_raw_get_signed (struct regcache *regcache,
+ int regnum);
/* Read a register as a signed/unsigned quantity. */
extern enum register_status
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. */
-
-enum register_status 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);
+/* For regcache_read_pc see common/common-regcache.h. */
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);
-
/* Mapping between register numbers and offsets in a buffer, for use
in the '*regset' functions below. In an array of
'regcache_map_entry' each element is interpreted like follows:
extern int register_size (struct gdbarch *gdbarch, int regnum);
+typedef gdb::function_view<register_status (int regnum, gdb_byte *buf)>
+ register_read_ftype;
-/* 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. */
+/* 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);
-typedef enum register_status (regcache_cooked_read_ftype) (void *src,
- int regnum,
- gdb_byte *buf);
+ DISABLE_COPY_AND_ASSIGN (reg_buffer);
-extern void regcache_save (struct regcache *dst,
- regcache_cooked_read_ftype *cooked_read,
- void *cooked_read_context);
+ /* Return regcache's architecture. */
+ gdbarch *arch () const;
-/* 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.
+ /* See common/common-regcache.h. */
+ enum register_status get_register_status (int regnum) const override;
- The ``cpy'' functions can not have overlapping SRC and DST buffers.
+ /* See common/common-regcache.h. */
+ void raw_collect (int regnum, void *buf) const override;
- ``no passthrough'' versions do not go through to the target. They
- only transfer values already in the cache. */
+ /* 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;
-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);
+ /* See common/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);
+
+ void invalidate (int regnum);
+
+ virtual ~reg_buffer () = default;
+
+ /* See common/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<gdb_byte[]> m_registers;
+ /* Register cache status. */
+ std::unique_ptr<register_status[]> 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<typename T, typename = RequireLongest<T>>
+ 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;
+
+ /* 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<typename T, typename = RequireLongest<T>>
+ enum register_status cooked_read (int regnum, T *val);
+
+ /* Partial transfer of a cooked register. */
+ enum register_status cooked_read_part (int regnum, int offset, int len,
+ gdb_byte *buf);
+
+ /* 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);
+
+protected:
+
+ /* 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);
+};
+
+/* Buffer of registers, can be read and written. */
+
+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<typename T, typename = RequireLongest<T>>
+ void raw_write (int regnum, T val);
+
+ /* Transfer of pseudo-registers. */
+ void cooked_write (int regnum, const gdb_byte *buf);
+
+ template<typename T, typename = RequireLongest<T>>
+ 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<regcache *> current_regcache;
+
+private:
+
+ void transfer_regset (const struct regset *regset,
+ struct regcache *out_regcache,
+ int regnum, const void *in_buf,
+ void *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);
+/* 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 */
projects / deliverable / binutils-gdb.git / blobdiff