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 gdb::function_view
<register_status (int regnum
, gdb_byte
*buf
)>
131 /* A (register_number, register_value) pair. */
133 typedef struct cached_reg
139 /* Buffer of registers. */
141 class reg_buffer
: public reg_buffer_common
144 reg_buffer (gdbarch
*gdbarch
, bool has_pseudo
);
146 DISABLE_COPY_AND_ASSIGN (reg_buffer
);
148 /* Return regcache's architecture. */
149 gdbarch
*arch () const;
151 /* See common/common-regcache.h. */
152 enum register_status
get_register_status (int regnum
) const override
;
154 /* See common/common-regcache.h. */
155 void raw_collect (int regnum
, void *buf
) const override
;
157 /* Collect register REGNUM from REGCACHE. Store collected value as an integer
158 at address ADDR, in target endian, with length ADDR_LEN and sign IS_SIGNED.
159 If ADDR_LEN is greater than the register size, then the integer will be
160 sign or zero extended. If ADDR_LEN is smaller than the register size, then
161 the most significant bytes of the integer will be truncated. */
162 void raw_collect_integer (int regnum
, gdb_byte
*addr
, int addr_len
,
163 bool is_signed
) const;
165 /* See common/common-regcache.h. */
166 void raw_supply (int regnum
, const void *buf
) override
;
168 void raw_supply (int regnum
, const reg_buffer
&src
)
170 raw_supply (regnum
, src
.register_buffer (regnum
));
173 /* Supply register REGNUM to REGCACHE. Value to supply is an integer stored
174 at address ADDR, in target endian, with length ADDR_LEN and sign IS_SIGNED.
175 If the register size is greater than ADDR_LEN, then the integer will be
176 sign or zero extended. If the register size is smaller than the integer,
177 then the most significant bytes of the integer will be truncated. */
178 void raw_supply_integer (int regnum
, const gdb_byte
*addr
, int addr_len
,
181 /* Supply register REGNUM with zeroed value to REGCACHE. This is not the same
182 as calling raw_supply with NULL (which will set the state to
184 void raw_supply_zeroed (int regnum
);
186 void invalidate (int regnum
);
188 virtual ~reg_buffer () = default;
190 /* See common/common-regcache.h. */
191 bool raw_compare (int regnum
, const void *buf
, int offset
) const override
;
194 /* Assert on the range of REGNUM. */
195 void assert_regnum (int regnum
) const;
197 int num_raw_registers () const;
199 gdb_byte
*register_buffer (int regnum
) const;
201 /* Save a register cache. The set of registers saved into the
202 regcache determined by the save_reggroup. COOKED_READ returns
203 zero iff the register's value can't be returned. */
204 void save (register_read_ftype cooked_read
);
206 struct regcache_descr
*m_descr
;
209 /* The register buffers. */
210 std::unique_ptr
<gdb_byte
[]> m_registers
;
211 /* Register cache status. */
212 std::unique_ptr
<register_status
[]> m_register_status
;
214 friend class regcache
;
215 friend class detached_regcache
;
218 /* An abstract class which only has methods doing read. */
220 class readable_regcache
: public reg_buffer
223 readable_regcache (gdbarch
*gdbarch
, bool has_pseudo
)
224 : reg_buffer (gdbarch
, has_pseudo
)
227 /* Transfer a raw register [0..NUM_REGS) from core-gdb to this regcache,
228 return its value in *BUF and return its availability status. */
230 enum register_status
raw_read (int regnum
, gdb_byte
*buf
);
231 template<typename T
, typename
= RequireLongest
<T
>>
232 enum register_status
raw_read (int regnum
, T
*val
);
234 /* Partial transfer of raw registers. Return the status of the register. */
235 enum register_status
raw_read_part (int regnum
, int offset
, int len
,
238 /* Make certain that the register REGNUM is up-to-date. */
239 virtual void raw_update (int regnum
) = 0;
241 /* Transfer a raw register [0..NUM_REGS+NUM_PSEUDO_REGS) from core-gdb to
242 this regcache, return its value in *BUF and return its availability status. */
243 enum register_status
cooked_read (int regnum
, gdb_byte
*buf
);
244 template<typename T
, typename
= RequireLongest
<T
>>
245 enum register_status
cooked_read (int regnum
, T
*val
);
247 /* Partial transfer of a cooked register. */
248 enum register_status
cooked_read_part (int regnum
, int offset
, int len
,
251 /* Read register REGNUM from the regcache and return a new value. This
252 will call mark_value_bytes_unavailable as appropriate. */
253 struct value
*cooked_read_value (int regnum
);
256 enum register_status
read_part (int regnum
, int offset
, int len
, void *in
,
260 /* Buffer of registers, can be read and written. */
262 class detached_regcache
: public readable_regcache
265 detached_regcache (gdbarch
*gdbarch
, bool has_pseudo
)
266 : readable_regcache (gdbarch
, has_pseudo
)
269 void raw_update (int regnum
) override
272 DISABLE_COPY_AND_ASSIGN (detached_regcache
);
275 class readonly_detached_regcache
;
277 /* The register cache for storing raw register values. */
279 class regcache
: public detached_regcache
282 DISABLE_COPY_AND_ASSIGN (regcache
);
284 /* Return REGCACHE's address space. */
285 const address_space
*aspace () const
290 /* Restore 'this' regcache. The set of registers restored into
291 the regcache determined by the restore_reggroup.
292 Writes to regcache will go through to the target. SRC is a
293 read-only register cache. */
294 void restore (readonly_detached_regcache
*src
);
296 /* Update the value of raw register REGNUM (in the range [0..NUM_REGS)) and
297 transfer its value to core-gdb. */
299 void raw_write (int regnum
, const gdb_byte
*buf
);
301 template<typename T
, typename
= RequireLongest
<T
>>
302 void raw_write (int regnum
, T val
);
304 /* Transfer of pseudo-registers. */
305 void cooked_write (int regnum
, const gdb_byte
*buf
);
307 template<typename T
, typename
= RequireLongest
<T
>>
308 void cooked_write (int regnum
, T val
);
310 void raw_update (int regnum
) override
;
312 /* Partial transfer of raw registers. Perform read, modify, write style
314 void raw_write_part (int regnum
, int offset
, int len
, const gdb_byte
*buf
);
316 /* Partial transfer of a cooked register. Perform read, modify, write style
318 void cooked_write_part (int regnum
, int offset
, int len
,
319 const gdb_byte
*buf
);
321 void supply_regset (const struct regset
*regset
,
322 int regnum
, const void *buf
, size_t size
);
325 void collect_regset (const struct regset
*regset
, int regnum
,
326 void *buf
, size_t size
) const;
328 /* Return REGCACHE's ptid. */
332 gdb_assert (m_ptid
!= minus_one_ptid
);
337 void set_ptid (const ptid_t ptid
)
342 /* Dump the contents of a register from the register cache to the target
344 void debug_print_register (const char *func
, int regno
);
346 static void regcache_thread_ptid_changed (ptid_t old_ptid
, ptid_t new_ptid
);
348 regcache (gdbarch
*gdbarch
, const address_space
*aspace_
);
349 static std::forward_list
<regcache
*> current_regcache
;
353 void transfer_regset (const struct regset
*regset
,
354 struct regcache
*out_regcache
,
355 int regnum
, const void *in_buf
,
356 void *out_buf
, size_t size
) const;
358 enum register_status
write_part (int regnum
, int offset
, int len
,
359 const void *out
, bool is_raw
);
362 /* The address space of this register cache (for registers where it
363 makes sense, like PC or SP). */
364 const address_space
* const m_aspace
;
366 /* If this is a read-write cache, which thread's registers is
370 friend struct regcache
*
371 get_thread_arch_aspace_regcache (ptid_t ptid
, struct gdbarch
*gdbarch
,
372 struct address_space
*aspace
);
375 registers_changed_ptid (ptid_t ptid
);
378 class readonly_detached_regcache
: public readable_regcache
381 readonly_detached_regcache (regcache
&src
);
383 /* Create a readonly regcache by getting contents from COOKED_READ. */
385 readonly_detached_regcache (gdbarch
*gdbarch
, register_read_ftype cooked_read
)
386 : readable_regcache (gdbarch
, true)
391 DISABLE_COPY_AND_ASSIGN (readonly_detached_regcache
);
393 void raw_update (int regnum
) override
397 extern void registers_changed (void);
398 extern void registers_changed_ptid (ptid_t
);
400 /* An abstract base class for register dump. */
405 void dump (ui_file
*file
);
406 virtual ~register_dump () = default;
409 register_dump (gdbarch
*arch
)
413 /* Dump the register REGNUM contents. If REGNUM is -1, print the
415 virtual void dump_reg (ui_file
*file
, int regnum
) = 0;
420 #endif /* REGCACHE_H */