/* Cache and manage the values of registers for GDB, the GNU debugger.
- Copyright (C) 1986-2018 Free Software Foundation, Inc.
+ Copyright (C) 1986-2020 Free Software Foundation, Inc.
This file is part of GDB.
#ifndef REGCACHE_H
#define REGCACHE_H
-#include "common-regcache.h"
-#include <forward_list>
+#include "gdbsupport/common-regcache.h"
+#include "gdbsupport/function-view.h"
struct regcache;
struct regset;
struct gdbarch;
struct address_space;
+class thread_info;
+struct process_stratum_target;
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 *);
-extern struct regcache *get_thread_arch_aspace_regcache (ptid_t,
- struct gdbarch *,
- struct address_space *);
+extern struct regcache *get_thread_regcache (process_stratum_target *target,
+ ptid_t ptid);
+
+/* Get the regcache of THREAD. */
+extern struct regcache *get_thread_regcache (thread_info *thread);
+
+extern struct regcache *get_thread_arch_regcache
+ (process_stratum_target *targ, ptid_t, struct gdbarch *);
+extern struct regcache *get_thread_arch_aspace_regcache
+ (process_stratum_target *target, ptid_t,
+ struct gdbarch *, struct address_space *);
extern enum register_status
regcache_raw_read_signed (struct regcache *regcache,
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. */
-/* For regcache_read_pc see common/common-regcache.h. */
+/* For regcache_read_pc see gdbsupport/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:
+ 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.
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
extern int register_size (struct gdbarch *gdbarch, int regnum);
-typedef enum register_status (regcache_cooked_read_ftype) (void *src,
- int regnum,
- gdb_byte *buf);
+typedef gdb::function_view<register_status (int regnum, gdb_byte *buf)>
+ register_read_ftype;
/* A (register_number, register_value) pair. */
/* Buffer of registers. */
-class reg_buffer
+class reg_buffer : public reg_buffer_common
{
public:
reg_buffer (gdbarch *gdbarch, bool has_pseudo);
/* Return regcache's architecture. */
gdbarch *arch () const;
- /* Get the availability status of the value of register REGNUM in this
- buffer. */
- enum register_status get_register_status (int regnum) 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;
- virtual ~reg_buffer ()
+ void raw_supply (int regnum, const reg_buffer &src)
{
- xfree (m_registers);
- xfree (m_register_status);
+ 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;
/* 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 (regcache_cooked_read_ftype *cooked_read, void *src);
+ void save (register_read_ftype cooked_read);
struct regcache_descr *m_descr;
bool m_has_pseudo;
/* The register buffers. */
- gdb_byte *m_registers;
+ std::unique_ptr<gdb_byte[]> m_registers;
/* Register cache status. */
- signed char *m_register_status;
+ std::unique_ptr<register_status[]> m_register_status;
friend class regcache;
friend class detached_regcache;
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);
struct value *cooked_read_value (int regnum);
protected:
- enum register_status read_part (int regnum, int offset, int len, void *in,
- bool is_raw);
+
+ /* 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. */
: readable_regcache (gdbarch, has_pseudo)
{}
- void raw_supply (int regnum, const void *buf);
-
- void raw_supply (int regnum, const reg_buffer &src)
- {
- raw_supply (regnum, src.register_buffer (regnum));
- }
-
void raw_update (int regnum) override
{}
- void raw_supply_integer (int regnum, const gdb_byte *addr, int addr_len,
- bool is_signed);
-
- void raw_supply_zeroed (int regnum);
-
- void invalidate (int regnum);
-
DISABLE_COPY_AND_ASSIGN (detached_regcache);
};
void raw_update (int regnum) override;
- void raw_collect (int regnum, void *buf) const;
-
- void raw_collect_integer (int regnum, gdb_byte *addr, int addr_len,
- bool is_signed) const;
-
/* 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);
this->m_ptid = ptid;
}
+ process_stratum_target *target () const
+ {
+ return m_target;
+ }
+
/* 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;
+ regcache (process_stratum_target *target, gdbarch *gdbarch,
+ const address_space *aspace);
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 void *in_buf,
- void *out_buf, size_t size) const;
+ 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 void *out, bool is_raw);
-
+ const gdb_byte *in, bool is_raw);
/* The address space of this register cache (for registers where it
makes sense, like PC or SP). */
/* If this is a read-write cache, which thread's registers is
it connected to? */
+ process_stratum_target *m_target;
ptid_t m_ptid;
friend struct regcache *
- get_thread_arch_aspace_regcache (ptid_t ptid, struct gdbarch *gdbarch,
+ get_thread_arch_aspace_regcache (process_stratum_target *target, ptid_t ptid,
+ struct gdbarch *gdbarch,
struct address_space *aspace);
-
- friend void
- registers_changed_ptid (ptid_t ptid);
};
+using regcache_up = std::unique_ptr<regcache>;
+
class readonly_detached_regcache : public readable_regcache
{
public:
- readonly_detached_regcache (const regcache &src);
+ readonly_detached_regcache (regcache &src);
/* Create a readonly regcache by getting contents from COOKED_READ. */
- readonly_detached_regcache (gdbarch *gdbarch,
- regcache_cooked_read_ftype *cooked_read,
- void *src)
+ readonly_detached_regcache (gdbarch *gdbarch, register_read_ftype cooked_read)
: readable_regcache (gdbarch, true)
{
- save (cooked_read, src);
+ save (cooked_read);
}
DISABLE_COPY_AND_ASSIGN (readonly_detached_regcache);
};
extern void registers_changed (void);
-extern void registers_changed_ptid (ptid_t);
+extern void registers_changed_ptid (process_stratum_target *target,
+ ptid_t ptid);
+
+/* 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. */