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 /* Transfer a raw register [0..NUM_REGS) between core-gdb and the
39 regcache. The read variants return the status of the register. */
41 enum register_status
regcache_raw_read (struct regcache
*regcache
,
42 int rawnum
, gdb_byte
*buf
);
43 void regcache_raw_write (struct regcache
*regcache
, int rawnum
,
45 extern enum register_status
46 regcache_raw_read_signed (struct regcache
*regcache
,
47 int regnum
, LONGEST
*val
);
49 extern void regcache_raw_write_signed (struct regcache
*regcache
,
50 int regnum
, LONGEST val
);
51 extern void regcache_raw_write_unsigned (struct regcache
*regcache
,
52 int regnum
, ULONGEST val
);
54 /* Return the register's value in signed or throw if it's not
57 extern LONGEST
regcache_raw_get_signed (struct regcache
*regcache
,
60 /* Partial transfer of raw registers. These perform read, modify,
61 write style operations. The read variant returns the status of the
64 extern enum register_status
65 regcache_raw_read_part (struct regcache
*regcache
, int regnum
,
66 int offset
, int len
, gdb_byte
*buf
);
67 void regcache_raw_write_part (struct regcache
*regcache
, int regnum
,
68 int offset
, int len
, const gdb_byte
*buf
);
70 void regcache_invalidate (struct regcache
*regcache
, int regnum
);
72 /* Transfer of pseudo-registers. The read variants return a register
73 status, as an indication of when a ``cooked'' register was
74 constructed from valid, invalid or unavailable ``raw''
77 /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */
78 enum register_status
regcache_cooked_read (struct regcache
*regcache
,
79 int rawnum
, gdb_byte
*buf
);
80 void regcache_cooked_write (struct regcache
*regcache
, int rawnum
,
83 /* Read register REGNUM from REGCACHE and return a new value. This
84 will call mark_value_bytes_unavailable as appropriate. */
86 struct value
*regcache_cooked_read_value (struct regcache
*regcache
,
89 /* Read a register as a signed/unsigned quantity. */
90 extern enum register_status
91 regcache_cooked_read_signed (struct regcache
*regcache
,
92 int regnum
, LONGEST
*val
);
93 extern enum register_status
94 regcache_cooked_read_unsigned (struct regcache
*regcache
,
95 int regnum
, ULONGEST
*val
);
96 extern void regcache_cooked_write_signed (struct regcache
*regcache
,
97 int regnum
, LONGEST val
);
98 extern void regcache_cooked_write_unsigned (struct regcache
*regcache
,
99 int regnum
, ULONGEST val
);
101 /* Partial transfer of a cooked register. These perform read, modify,
102 write style operations. */
104 enum register_status
regcache_cooked_read_part (struct regcache
*regcache
,
105 int regnum
, int offset
,
106 int len
, gdb_byte
*buf
);
107 void regcache_cooked_write_part (struct regcache
*regcache
, int regnum
,
108 int offset
, int len
, const gdb_byte
*buf
);
110 /* Special routines to read/write the PC. */
112 /* For regcache_read_pc see common/common-regcache.h. */
113 extern void regcache_write_pc (struct regcache
*regcache
, CORE_ADDR pc
);
115 /* Transfer a raw register [0..NUM_REGS) between the regcache and the
116 target. These functions are called by the target in response to a
117 target_fetch_registers() or target_store_registers(). */
119 extern void regcache_raw_supply (struct regcache
*regcache
,
120 int regnum
, const void *buf
);
121 extern void regcache_raw_collect (const struct regcache
*regcache
,
122 int regnum
, void *buf
);
124 /* Mapping between register numbers and offsets in a buffer, for use
125 in the '*regset' functions below. In an array of
126 'regcache_map_entry' each element is interpreted like follows:
128 - If 'regno' is a register number: Map register 'regno' to the
129 current offset (starting with 0) and increase the current offset
130 by 'size' (or the register's size, if 'size' is zero). Repeat
131 this with consecutive register numbers up to 'regno+count-1'.
133 - If 'regno' is REGCACHE_MAP_SKIP: Add 'count*size' to the current
136 - If count=0: End of the map. */
138 struct regcache_map_entry
145 /* Special value for the 'regno' field in the struct above. */
149 REGCACHE_MAP_SKIP
= -1,
152 /* Transfer a set of registers (as described by REGSET) between
153 REGCACHE and BUF. If REGNUM == -1, transfer all registers
154 belonging to the regset, otherwise just the register numbered
155 REGNUM. The REGSET's 'regmap' field must point to an array of
156 'struct regcache_map_entry'.
158 These functions are suitable for the 'regset_supply' and
159 'regset_collect' fields in a regset structure. */
161 extern void regcache_supply_regset (const struct regset
*regset
,
162 struct regcache
*regcache
,
163 int regnum
, const void *buf
,
165 extern void regcache_collect_regset (const struct regset
*regset
,
166 const struct regcache
*regcache
,
167 int regnum
, void *buf
, size_t size
);
170 /* The type of a register. This function is slightly more efficient
171 then its gdbarch vector counterpart since it returns a precomputed
172 value stored in a table. */
174 extern struct type
*register_type (struct gdbarch
*gdbarch
, int regnum
);
177 /* Return the size of register REGNUM. All registers should have only
180 extern int register_size (struct gdbarch
*gdbarch
, int regnum
);
182 typedef enum register_status (regcache_cooked_read_ftype
) (void *src
,
186 /* A (register_number, register_value) pair. */
188 typedef struct cached_reg
194 /* Buffer of registers. */
199 reg_buffer (gdbarch
*gdbarch
, bool has_pseudo
);
201 DISABLE_COPY_AND_ASSIGN (reg_buffer
);
203 /* Return regcache's architecture. */
204 gdbarch
*arch () const;
206 /* Get the availability status of the value of register REGNUM in this
208 enum register_status
get_register_status (int regnum
) const;
210 virtual ~reg_buffer ()
213 xfree (m_register_status
);
216 /* Assert on the range of REGNUM. */
217 void assert_regnum (int regnum
) const;
219 int num_raw_registers () const;
221 gdb_byte
*register_buffer (int regnum
) const;
223 /* Save a register cache. The set of registers saved into the
224 regcache determined by the save_reggroup. COOKED_READ returns
225 zero iff the register's value can't be returned. */
226 void save (regcache_cooked_read_ftype
*cooked_read
, void *src
);
228 struct regcache_descr
*m_descr
;
231 /* The register buffers. */
232 gdb_byte
*m_registers
;
233 /* Register cache status. */
234 signed char *m_register_status
;
236 friend class regcache
;
237 friend class detached_regcache
;
240 /* An abstract class which only has methods doing read. */
242 class readable_regcache
: public reg_buffer
245 readable_regcache (gdbarch
*gdbarch
, bool has_pseudo
)
246 : reg_buffer (gdbarch
, has_pseudo
)
249 enum register_status
raw_read (int regnum
, gdb_byte
*buf
);
250 template<typename T
, typename
= RequireLongest
<T
>>
251 enum register_status
raw_read (int regnum
, T
*val
);
253 enum register_status
raw_read_part (int regnum
, int offset
, int len
,
256 /* Make certain that the register REGNUM is up-to-date. */
257 virtual void raw_update (int regnum
) = 0;
259 enum register_status
cooked_read (int regnum
, gdb_byte
*buf
);
260 template<typename T
, typename
= RequireLongest
<T
>>
261 enum register_status
cooked_read (int regnum
, T
*val
);
263 enum register_status
cooked_read_part (int regnum
, int offset
, int len
,
266 struct value
*cooked_read_value (int regnum
);
269 enum register_status
read_part (int regnum
, int offset
, int len
, void *in
,
273 /* Buffer of registers, can be read and written. */
275 class detached_regcache
: public readable_regcache
278 detached_regcache (gdbarch
*gdbarch
, bool has_pseudo
)
279 : readable_regcache (gdbarch
, has_pseudo
)
282 void raw_supply (int regnum
, const void *buf
);
284 void raw_supply (int regnum
, const reg_buffer
&src
)
286 raw_supply (regnum
, src
.register_buffer (regnum
));
289 void raw_update (int regnum
) override
292 void raw_supply_integer (int regnum
, const gdb_byte
*addr
, int addr_len
,
295 void raw_supply_zeroed (int regnum
);
297 void invalidate (int regnum
);
299 DISABLE_COPY_AND_ASSIGN (detached_regcache
);
302 class readonly_detached_regcache
;
304 /* The register cache for storing raw register values. */
306 class regcache
: public detached_regcache
309 DISABLE_COPY_AND_ASSIGN (regcache
);
311 /* Return REGCACHE's address space. */
312 const address_space
*aspace () const
317 /* Restore 'this' regcache. The set of registers restored into
318 the regcache determined by the restore_reggroup.
319 Writes to regcache will go through to the target. SRC is a
320 read-only register cache. */
321 void restore (readonly_detached_regcache
*src
);
323 void cooked_write (int regnum
, const gdb_byte
*buf
);
325 void raw_write (int regnum
, const gdb_byte
*buf
);
327 template<typename T
, typename
= RequireLongest
<T
>>
328 void raw_write (int regnum
, T val
);
330 template<typename T
, typename
= RequireLongest
<T
>>
331 void cooked_write (int regnum
, T val
);
333 void raw_update (int regnum
) override
;
335 void raw_collect (int regnum
, void *buf
) const;
337 void raw_collect_integer (int regnum
, gdb_byte
*addr
, int addr_len
,
338 bool is_signed
) const;
340 void raw_write_part (int regnum
, int offset
, int len
, const gdb_byte
*buf
);
342 void cooked_write_part (int regnum
, int offset
, int len
,
343 const gdb_byte
*buf
);
345 void supply_regset (const struct regset
*regset
,
346 int regnum
, const void *buf
, size_t size
);
349 void collect_regset (const struct regset
*regset
, int regnum
,
350 void *buf
, size_t size
) const;
352 /* Return REGCACHE's ptid. */
356 gdb_assert (m_ptid
!= minus_one_ptid
);
361 void set_ptid (const ptid_t ptid
)
366 /* Dump the contents of a register from the register cache to the target
368 void debug_print_register (const char *func
, int regno
);
370 static void regcache_thread_ptid_changed (ptid_t old_ptid
, ptid_t new_ptid
);
372 regcache (gdbarch
*gdbarch
, const address_space
*aspace_
);
373 static std::forward_list
<regcache
*> current_regcache
;
377 void transfer_regset (const struct regset
*regset
,
378 struct regcache
*out_regcache
,
379 int regnum
, const void *in_buf
,
380 void *out_buf
, size_t size
) const;
382 enum register_status
write_part (int regnum
, int offset
, int len
,
383 const void *out
, bool is_raw
);
386 /* The address space of this register cache (for registers where it
387 makes sense, like PC or SP). */
388 const address_space
* const m_aspace
;
390 /* If this is a read-write cache, which thread's registers is
394 friend struct regcache
*
395 get_thread_arch_aspace_regcache (ptid_t ptid
, struct gdbarch
*gdbarch
,
396 struct address_space
*aspace
);
399 registers_changed_ptid (ptid_t ptid
);
402 class readonly_detached_regcache
: public readable_regcache
405 readonly_detached_regcache (const regcache
&src
);
407 /* Create a readonly regcache by getting contents from COOKED_READ. */
409 readonly_detached_regcache (gdbarch
*gdbarch
,
410 regcache_cooked_read_ftype
*cooked_read
,
412 : readable_regcache (gdbarch
, true)
414 save (cooked_read
, src
);
417 DISABLE_COPY_AND_ASSIGN (readonly_detached_regcache
);
419 void raw_update (int regnum
) override
423 extern void registers_changed (void);
424 extern void registers_changed_ptid (ptid_t
);
426 /* An abstract base class for register dump. */
431 void dump (ui_file
*file
);
432 virtual ~register_dump () = default;
435 register_dump (gdbarch
*arch
)
439 /* Dump the register REGNUM contents. If REGNUM is -1, print the
441 virtual void dump_reg (ui_file
*file
, int regnum
) = 0;
446 #endif /* REGCACHE_H */