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 /* Transfer a raw register [0..NUM_REGS) between the regcache and the
71 target. These functions are called by the target in response to a
72 target_fetch_registers() or target_store_registers(). */
74 extern void regcache_raw_supply (struct regcache *regcache,
75 int regnum, const void *buf);
76 extern void regcache_raw_collect (const struct regcache *regcache,
77 int regnum, void *buf);
79 /* Mapping between register numbers and offsets in a buffer, for use
80 in the '*regset' functions below. In an array of
81 'regcache_map_entry' each element is interpreted like follows:
83 - If 'regno' is a register number: Map register 'regno' to the
84 current offset (starting with 0) and increase the current offset
85 by 'size' (or the register's size, if 'size' is zero). Repeat
86 this with consecutive register numbers up to 'regno+count-1'.
88 - If 'regno' is REGCACHE_MAP_SKIP: Add 'count*size' to the current
91 - If count=0: End of the map. */
93 struct regcache_map_entry
100 /* Special value for the 'regno' field in the struct above. */
104 REGCACHE_MAP_SKIP = -1,
107 /* Transfer a set of registers (as described by REGSET) between
108 REGCACHE and BUF. If REGNUM == -1, transfer all registers
109 belonging to the regset, otherwise just the register numbered
110 REGNUM. The REGSET's 'regmap' field must point to an array of
111 'struct regcache_map_entry'.
113 These functions are suitable for the 'regset_supply' and
114 'regset_collect' fields in a regset structure. */
116 extern void regcache_supply_regset (const struct regset *regset,
117 struct regcache *regcache,
118 int regnum, const void *buf,
120 extern void regcache_collect_regset (const struct regset *regset,
121 const struct regcache *regcache,
122 int regnum, void *buf, size_t size);
125 /* The type of a register. This function is slightly more efficient
126 then its gdbarch vector counterpart since it returns a precomputed
127 value stored in a table. */
129 extern struct type *register_type (struct gdbarch *gdbarch, int regnum);
132 /* Return the size of register REGNUM. All registers should have only
135 extern int register_size (struct gdbarch *gdbarch, int regnum);
137 typedef enum register_status (regcache_cooked_read_ftype) (void *src,
141 /* A (register_number, register_value) pair. */
143 typedef struct cached_reg
149 /* Buffer of registers. */
154 reg_buffer (gdbarch *gdbarch, bool has_pseudo);
156 DISABLE_COPY_AND_ASSIGN (reg_buffer);
158 /* Return regcache's architecture. */
159 gdbarch *arch () const;
161 /* Get the availability status of the value of register REGNUM in this
163 enum register_status get_register_status (int regnum) const;
165 virtual ~reg_buffer ()
168 xfree (m_register_status);
171 /* Assert on the range of REGNUM. */
172 void assert_regnum (int regnum) const;
174 int num_raw_registers () const;
176 gdb_byte *register_buffer (int regnum) const;
178 /* Save a register cache. The set of registers saved into the
179 regcache determined by the save_reggroup. COOKED_READ returns
180 zero iff the register's value can't be returned. */
181 void save (regcache_cooked_read_ftype *cooked_read, void *src);
183 struct regcache_descr *m_descr;
186 /* The register buffers. */
187 gdb_byte *m_registers;
188 /* Register cache status. */
189 signed char *m_register_status;
191 friend class regcache;
192 friend class detached_regcache;
195 /* An abstract class which only has methods doing read. */
197 class readable_regcache : public reg_buffer
200 readable_regcache (gdbarch *gdbarch, bool has_pseudo)
201 : reg_buffer (gdbarch, has_pseudo)
204 /* Transfer a raw register [0..NUM_REGS) from core-gdb to this regcache,
205 return its value in *BUF and return its availability status. */
207 enum register_status raw_read (int regnum, gdb_byte *buf);
208 template<typename T, typename = RequireLongest<T>>
209 enum register_status raw_read (int regnum, T *val);
211 /* Partial transfer of raw registers. Return the status of the register. */
212 enum register_status raw_read_part (int regnum, int offset, int len,
215 /* Make certain that the register REGNUM is up-to-date. */
216 virtual void raw_update (int regnum) = 0;
218 /* Transfer a raw register [0..NUM_REGS+NUM_PSEUDO_REGS) from core-gdb to
219 this regcache, return its value in *BUF and return its availability status. */
220 enum register_status cooked_read (int regnum, gdb_byte *buf);
221 template<typename T, typename = RequireLongest<T>>
222 enum register_status cooked_read (int regnum, T *val);
224 /* Partial transfer of a cooked register. */
225 enum register_status cooked_read_part (int regnum, int offset, int len,
228 /* Read register REGNUM from the regcache and return a new value. This
229 will call mark_value_bytes_unavailable as appropriate. */
230 struct value *cooked_read_value (int regnum);
233 enum register_status read_part (int regnum, int offset, int len, void *in,
237 /* Buffer of registers, can be read and written. */
239 class detached_regcache : public readable_regcache
242 detached_regcache (gdbarch *gdbarch, bool has_pseudo)
243 : readable_regcache (gdbarch, has_pseudo)
246 void raw_supply (int regnum, const void *buf);
248 void raw_supply (int regnum, const reg_buffer &src)
250 raw_supply (regnum, src.register_buffer (regnum));
253 void raw_update (int regnum) override
256 void raw_supply_integer (int regnum, const gdb_byte *addr, int addr_len,
259 void raw_supply_zeroed (int regnum);
261 void invalidate (int regnum);
263 DISABLE_COPY_AND_ASSIGN (detached_regcache);
266 class readonly_detached_regcache;
268 /* The register cache for storing raw register values. */
270 class regcache : public detached_regcache
273 DISABLE_COPY_AND_ASSIGN (regcache);
275 /* Return REGCACHE's address space. */
276 const address_space *aspace () const
281 /* Restore 'this' regcache. The set of registers restored into
282 the regcache determined by the restore_reggroup.
283 Writes to regcache will go through to the target. SRC is a
284 read-only register cache. */
285 void restore (readonly_detached_regcache *src);
287 /* Update the value of raw register REGNUM (in the range [0..NUM_REGS)) and
288 transfer its value to core-gdb. */
290 void raw_write (int regnum, const gdb_byte *buf);
292 template<typename T, typename = RequireLongest<T>>
293 void raw_write (int regnum, T val);
295 /* Transfer of pseudo-registers. */
296 void cooked_write (int regnum, const gdb_byte *buf);
298 template<typename T, typename = RequireLongest<T>>
299 void cooked_write (int regnum, T val);
301 void raw_update (int regnum) override;
303 void raw_collect (int regnum, void *buf) const;
305 void raw_collect_integer (int regnum, gdb_byte *addr, int addr_len,
306 bool is_signed) const;
308 /* Partial transfer of raw registers. Perform read, modify, write style
310 void raw_write_part (int regnum, int offset, int len, const gdb_byte *buf);
312 /* Partial transfer of a cooked register. Perform read, modify, write style
314 void cooked_write_part (int regnum, int offset, int len,
315 const gdb_byte *buf);
317 void supply_regset (const struct regset *regset,
318 int regnum, const void *buf, size_t size);
321 void collect_regset (const struct regset *regset, int regnum,
322 void *buf, size_t size) const;
324 /* Return REGCACHE's ptid. */
328 gdb_assert (m_ptid != minus_one_ptid);
333 void set_ptid (const ptid_t ptid)
338 /* Dump the contents of a register from the register cache to the target
340 void debug_print_register (const char *func, int regno);
342 static void regcache_thread_ptid_changed (ptid_t old_ptid, ptid_t new_ptid);
344 regcache (gdbarch *gdbarch, const address_space *aspace_);
345 static std::forward_list<regcache *> current_regcache;
349 void transfer_regset (const struct regset *regset,
350 struct regcache *out_regcache,
351 int regnum, const void *in_buf,
352 void *out_buf, size_t size) const;
354 enum register_status write_part (int regnum, int offset, int len,
355 const void *out, bool is_raw);
358 /* The address space of this register cache (for registers where it
359 makes sense, like PC or SP). */
360 const address_space * const m_aspace;
362 /* If this is a read-write cache, which thread's registers is
366 friend struct regcache *
367 get_thread_arch_aspace_regcache (ptid_t ptid, struct gdbarch *gdbarch,
368 struct address_space *aspace);
371 registers_changed_ptid (ptid_t ptid);
374 class readonly_detached_regcache : public readable_regcache
377 readonly_detached_regcache (const regcache &src);
379 /* Create a readonly regcache by getting contents from COOKED_READ. */
381 readonly_detached_regcache (gdbarch *gdbarch,
382 regcache_cooked_read_ftype *cooked_read,
384 : readable_regcache (gdbarch, true)
386 save (cooked_read, src);
389 DISABLE_COPY_AND_ASSIGN (readonly_detached_regcache);
391 void raw_update (int regnum) override
395 extern void registers_changed (void);
396 extern void registers_changed_ptid (ptid_t);
398 /* An abstract base class for register dump. */
403 void dump (ui_file *file);
404 virtual ~register_dump () = default;
407 register_dump (gdbarch *arch)
411 /* Dump the register REGNUM contents. If REGNUM is -1, print the
413 virtual void dump_reg (ui_file *file, int regnum) = 0;
418 #endif /* REGCACHE_H */