1 /* Cache and manage the values of registers for GDB, the GNU debugger.
3 Copyright (C) 1986-2018 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #include "common-regcache.h"
24 #include <forward_list>
31 extern struct regcache *get_current_regcache (void);
32 extern struct regcache *get_thread_regcache (ptid_t ptid);
33 extern struct regcache *get_thread_arch_regcache (ptid_t, struct gdbarch *);
34 extern struct regcache *get_thread_arch_aspace_regcache (ptid_t,
36 struct address_space *);
38 extern enum register_status
39 regcache_raw_read_signed (struct regcache *regcache,
40 int regnum, LONGEST *val);
42 extern void regcache_raw_write_signed (struct regcache *regcache,
43 int regnum, LONGEST val);
44 extern void regcache_raw_write_unsigned (struct regcache *regcache,
45 int regnum, ULONGEST val);
47 /* Return the register's value in signed or throw if it's not
50 extern LONGEST regcache_raw_get_signed (struct regcache *regcache,
53 /* Read a register as a signed/unsigned quantity. */
54 extern enum register_status
55 regcache_cooked_read_signed (struct regcache *regcache,
56 int regnum, LONGEST *val);
57 extern enum register_status
58 regcache_cooked_read_unsigned (struct regcache *regcache,
59 int regnum, ULONGEST *val);
60 extern void regcache_cooked_write_signed (struct regcache *regcache,
61 int regnum, LONGEST val);
62 extern void regcache_cooked_write_unsigned (struct regcache *regcache,
63 int regnum, ULONGEST val);
65 /* Special routines to read/write the PC. */
67 /* For regcache_read_pc see common/common-regcache.h. */
68 extern void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc);
70 /* Mapping between register numbers and offsets in a buffer, for use
71 in the '*regset' functions below. In an array of
72 'regcache_map_entry' each element is interpreted like follows:
74 - If 'regno' is a register number: Map register 'regno' to the
75 current offset (starting with 0) and increase the current offset
76 by 'size' (or the register's size, if 'size' is zero). Repeat
77 this with consecutive register numbers up to 'regno+count-1'.
79 - If 'regno' is REGCACHE_MAP_SKIP: Add 'count*size' to the current
82 - If count=0: End of the map. */
84 struct regcache_map_entry
91 /* Special value for the 'regno' field in the struct above. */
95 REGCACHE_MAP_SKIP = -1,
98 /* Transfer a set of registers (as described by REGSET) between
99 REGCACHE and BUF. If REGNUM == -1, transfer all registers
100 belonging to the regset, otherwise just the register numbered
101 REGNUM. The REGSET's 'regmap' field must point to an array of
102 'struct regcache_map_entry'.
104 These functions are suitable for the 'regset_supply' and
105 'regset_collect' fields in a regset structure. */
107 extern void regcache_supply_regset (const struct regset *regset,
108 struct regcache *regcache,
109 int regnum, const void *buf,
111 extern void regcache_collect_regset (const struct regset *regset,
112 const struct regcache *regcache,
113 int regnum, void *buf, size_t size);
116 /* The type of a register. This function is slightly more efficient
117 then its gdbarch vector counterpart since it returns a precomputed
118 value stored in a table. */
120 extern struct type *register_type (struct gdbarch *gdbarch, int regnum);
123 /* Return the size of register REGNUM. All registers should have only
126 extern int register_size (struct gdbarch *gdbarch, int regnum);
128 typedef enum register_status (regcache_cooked_read_ftype) (void *src,
132 /* A (register_number, register_value) pair. */
134 typedef struct cached_reg
140 /* Buffer of registers. */
145 reg_buffer (gdbarch *gdbarch, bool has_pseudo);
147 DISABLE_COPY_AND_ASSIGN (reg_buffer);
149 /* Return regcache's architecture. */
150 gdbarch *arch () const;
152 /* Get the availability status of the value of register REGNUM in this
154 enum register_status get_register_status (int regnum) const;
156 virtual ~reg_buffer ()
159 xfree (m_register_status);
162 /* Assert on the range of REGNUM. */
163 void assert_regnum (int regnum) const;
165 int num_raw_registers () const;
167 gdb_byte *register_buffer (int regnum) const;
169 /* Save a register cache. The set of registers saved into the
170 regcache determined by the save_reggroup. COOKED_READ returns
171 zero iff the register's value can't be returned. */
172 void save (regcache_cooked_read_ftype *cooked_read, void *src);
174 struct regcache_descr *m_descr;
177 /* The register buffers. */
178 gdb_byte *m_registers;
179 /* Register cache status. */
180 register_status *m_register_status;
182 friend class regcache;
183 friend class detached_regcache;
186 /* An abstract class which only has methods doing read. */
188 class readable_regcache : public reg_buffer
191 readable_regcache (gdbarch *gdbarch, bool has_pseudo)
192 : reg_buffer (gdbarch, has_pseudo)
195 /* Transfer a raw register [0..NUM_REGS) from core-gdb to this regcache,
196 return its value in *BUF and return its availability status. */
198 enum register_status raw_read (int regnum, gdb_byte *buf);
199 template<typename T, typename = RequireLongest<T>>
200 enum register_status raw_read (int regnum, T *val);
202 /* Partial transfer of raw registers. Return the status of the register. */
203 enum register_status raw_read_part (int regnum, int offset, int len,
206 /* Make certain that the register REGNUM is up-to-date. */
207 virtual void raw_update (int regnum) = 0;
209 /* Transfer a raw register [0..NUM_REGS+NUM_PSEUDO_REGS) from core-gdb to
210 this regcache, return its value in *BUF and return its availability status. */
211 enum register_status cooked_read (int regnum, gdb_byte *buf);
212 template<typename T, typename = RequireLongest<T>>
213 enum register_status cooked_read (int regnum, T *val);
215 /* Partial transfer of a cooked register. */
216 enum register_status cooked_read_part (int regnum, int offset, int len,
219 /* Read register REGNUM from the regcache and return a new value. This
220 will call mark_value_bytes_unavailable as appropriate. */
221 struct value *cooked_read_value (int regnum);
224 enum register_status read_part (int regnum, int offset, int len, void *in,
228 /* Buffer of registers, can be read and written. */
230 class detached_regcache : public readable_regcache
233 detached_regcache (gdbarch *gdbarch, bool has_pseudo)
234 : readable_regcache (gdbarch, has_pseudo)
237 /* Supply register REGNUM, whose contents are stored in BUF, to REGCACHE. */
238 void raw_supply (int regnum, const void *buf);
240 void raw_supply (int regnum, const reg_buffer &src)
242 raw_supply (regnum, src.register_buffer (regnum));
245 void raw_update (int regnum) override
248 void raw_supply_integer (int regnum, const gdb_byte *addr, int addr_len,
251 void raw_supply_zeroed (int regnum);
253 void invalidate (int regnum);
255 DISABLE_COPY_AND_ASSIGN (detached_regcache);
258 class readonly_detached_regcache;
260 /* The register cache for storing raw register values. */
262 class regcache : public detached_regcache
265 DISABLE_COPY_AND_ASSIGN (regcache);
267 /* Return REGCACHE's address space. */
268 const address_space *aspace () const
273 /* Restore 'this' regcache. The set of registers restored into
274 the regcache determined by the restore_reggroup.
275 Writes to regcache will go through to the target. SRC is a
276 read-only register cache. */
277 void restore (readonly_detached_regcache *src);
279 /* Update the value of raw register REGNUM (in the range [0..NUM_REGS)) and
280 transfer its value to core-gdb. */
282 void raw_write (int regnum, const gdb_byte *buf);
284 template<typename T, typename = RequireLongest<T>>
285 void raw_write (int regnum, T val);
287 /* Transfer of pseudo-registers. */
288 void cooked_write (int regnum, const gdb_byte *buf);
290 template<typename T, typename = RequireLongest<T>>
291 void cooked_write (int regnum, T val);
293 void raw_update (int regnum) override;
295 /* Collect register REGNUM from REGCACHE and store its contents in BUF. */
296 void raw_collect (int regnum, void *buf) const;
298 void raw_collect_integer (int regnum, gdb_byte *addr, int addr_len,
299 bool is_signed) const;
301 /* Partial transfer of raw registers. Perform read, modify, write style
303 void raw_write_part (int regnum, int offset, int len, const gdb_byte *buf);
305 /* Partial transfer of a cooked register. Perform read, modify, write style
307 void cooked_write_part (int regnum, int offset, int len,
308 const gdb_byte *buf);
310 void supply_regset (const struct regset *regset,
311 int regnum, const void *buf, size_t size);
314 void collect_regset (const struct regset *regset, int regnum,
315 void *buf, size_t size) const;
317 /* Return REGCACHE's ptid. */
321 gdb_assert (m_ptid != minus_one_ptid);
326 void set_ptid (const ptid_t ptid)
331 /* Dump the contents of a register from the register cache to the target
333 void debug_print_register (const char *func, int regno);
335 static void regcache_thread_ptid_changed (ptid_t old_ptid, ptid_t new_ptid);
337 regcache (gdbarch *gdbarch, const address_space *aspace_);
338 static std::forward_list<regcache *> current_regcache;
342 void transfer_regset (const struct regset *regset,
343 struct regcache *out_regcache,
344 int regnum, const void *in_buf,
345 void *out_buf, size_t size) const;
347 enum register_status write_part (int regnum, int offset, int len,
348 const void *out, bool is_raw);
351 /* The address space of this register cache (for registers where it
352 makes sense, like PC or SP). */
353 const address_space * const m_aspace;
355 /* If this is a read-write cache, which thread's registers is
359 friend struct regcache *
360 get_thread_arch_aspace_regcache (ptid_t ptid, struct gdbarch *gdbarch,
361 struct address_space *aspace);
364 registers_changed_ptid (ptid_t ptid);
367 class readonly_detached_regcache : public readable_regcache
370 readonly_detached_regcache (const regcache &src);
372 /* Create a readonly regcache by getting contents from COOKED_READ. */
374 readonly_detached_regcache (gdbarch *gdbarch,
375 regcache_cooked_read_ftype *cooked_read,
377 : readable_regcache (gdbarch, true)
379 save (cooked_read, src);
382 DISABLE_COPY_AND_ASSIGN (readonly_detached_regcache);
384 void raw_update (int regnum) override
388 extern void registers_changed (void);
389 extern void registers_changed_ptid (ptid_t);
391 /* An abstract base class for register dump. */
396 void dump (ui_file *file);
397 virtual ~register_dump () = default;
400 register_dump (gdbarch *arch)
404 /* Dump the register REGNUM contents. If REGNUM is -1, print the
406 virtual void dump_reg (ui_file *file, int regnum) = 0;
411 #endif /* REGCACHE_H */