1 /* Cache and manage the values of registers for GDB, the GNU debugger.
3 Copyright (C) 1986-2017 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 void regcache_xfree (struct regcache
*regcache
);
39 struct cleanup
*make_cleanup_regcache_xfree (struct regcache
*regcache
);
40 struct regcache
*regcache_xmalloc (struct gdbarch
*gdbarch
,
41 struct address_space
*aspace
);
43 /* Return REGCACHE's ptid. */
45 extern ptid_t
regcache_get_ptid (const struct regcache
*regcache
);
47 /* Return REGCACHE's architecture. */
49 extern struct gdbarch
*get_regcache_arch (const struct regcache
*regcache
);
51 /* Return REGCACHE's address space. */
53 extern struct address_space
*get_regcache_aspace (const struct regcache
*);
55 enum register_status
regcache_register_status (const struct regcache
*regcache
,
58 /* Make certain that the register REGNUM in REGCACHE is up-to-date. */
60 void regcache_raw_update (struct regcache
*regcache
, int regnum
);
62 /* Transfer a raw register [0..NUM_REGS) between core-gdb and the
63 regcache. The read variants return the status of the register. */
65 enum register_status
regcache_raw_read (struct regcache
*regcache
,
66 int rawnum
, gdb_byte
*buf
);
67 void regcache_raw_write (struct regcache
*regcache
, int rawnum
,
69 extern enum register_status
70 regcache_raw_read_signed (struct regcache
*regcache
,
71 int regnum
, LONGEST
*val
);
73 extern void regcache_raw_write_signed (struct regcache
*regcache
,
74 int regnum
, LONGEST val
);
75 extern void regcache_raw_write_unsigned (struct regcache
*regcache
,
76 int regnum
, ULONGEST val
);
78 /* Return the register's value in signed or throw if it's not
81 extern LONGEST
regcache_raw_get_signed (struct regcache
*regcache
,
84 /* Set a raw register's value in the regcache's buffer. Unlike
85 regcache_raw_write, this is not write-through. The intention is
86 allowing to change the buffer contents of a read-only regcache
87 allocated with regcache_xmalloc. */
89 extern void regcache_raw_set_cached_value
90 (struct regcache
*regcache
, int regnum
, const gdb_byte
*buf
);
92 /* Partial transfer of raw registers. These perform read, modify,
93 write style operations. The read variant returns the status of the
96 extern enum register_status
97 regcache_raw_read_part (struct regcache
*regcache
, int regnum
,
98 int offset
, int len
, gdb_byte
*buf
);
99 void regcache_raw_write_part (struct regcache
*regcache
, int regnum
,
100 int offset
, int len
, const gdb_byte
*buf
);
102 void regcache_invalidate (struct regcache
*regcache
, int regnum
);
104 /* Transfer of pseudo-registers. The read variants return a register
105 status, as an indication of when a ``cooked'' register was
106 constructed from valid, invalid or unavailable ``raw''
109 /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */
110 enum register_status
regcache_cooked_read (struct regcache
*regcache
,
111 int rawnum
, gdb_byte
*buf
);
112 void regcache_cooked_write (struct regcache
*regcache
, int rawnum
,
113 const gdb_byte
*buf
);
115 /* Read register REGNUM from REGCACHE and return a new value. This
116 will call mark_value_bytes_unavailable as appropriate. */
118 struct value
*regcache_cooked_read_value (struct regcache
*regcache
,
121 /* Read a register as a signed/unsigned quantity. */
122 extern enum register_status
123 regcache_cooked_read_signed (struct regcache
*regcache
,
124 int regnum
, LONGEST
*val
);
125 extern enum register_status
126 regcache_cooked_read_unsigned (struct regcache
*regcache
,
127 int regnum
, ULONGEST
*val
);
128 extern void regcache_cooked_write_signed (struct regcache
*regcache
,
129 int regnum
, LONGEST val
);
130 extern void regcache_cooked_write_unsigned (struct regcache
*regcache
,
131 int regnum
, ULONGEST val
);
133 /* Partial transfer of a cooked register. These perform read, modify,
134 write style operations. */
136 enum register_status
regcache_cooked_read_part (struct regcache
*regcache
,
137 int regnum
, int offset
,
138 int len
, gdb_byte
*buf
);
139 void regcache_cooked_write_part (struct regcache
*regcache
, int regnum
,
140 int offset
, int len
, const gdb_byte
*buf
);
142 /* Special routines to read/write the PC. */
144 /* For regcache_read_pc see common/common-regcache.h. */
145 extern void regcache_write_pc (struct regcache
*regcache
, CORE_ADDR pc
);
147 /* Transfer a raw register [0..NUM_REGS) between the regcache and the
148 target. These functions are called by the target in response to a
149 target_fetch_registers() or target_store_registers(). */
151 extern void regcache_raw_supply (struct regcache
*regcache
,
152 int regnum
, const void *buf
);
153 extern void regcache_raw_collect (const struct regcache
*regcache
,
154 int regnum
, void *buf
);
156 /* Mapping between register numbers and offsets in a buffer, for use
157 in the '*regset' functions below. In an array of
158 'regcache_map_entry' each element is interpreted like follows:
160 - If 'regno' is a register number: Map register 'regno' to the
161 current offset (starting with 0) and increase the current offset
162 by 'size' (or the register's size, if 'size' is zero). Repeat
163 this with consecutive register numbers up to 'regno+count-1'.
165 - If 'regno' is REGCACHE_MAP_SKIP: Add 'count*size' to the current
168 - If count=0: End of the map. */
170 struct regcache_map_entry
177 /* Special value for the 'regno' field in the struct above. */
181 REGCACHE_MAP_SKIP
= -1,
184 /* Transfer a set of registers (as described by REGSET) between
185 REGCACHE and BUF. If REGNUM == -1, transfer all registers
186 belonging to the regset, otherwise just the register numbered
187 REGNUM. The REGSET's 'regmap' field must point to an array of
188 'struct regcache_map_entry'.
190 These functions are suitable for the 'regset_supply' and
191 'regset_collect' fields in a regset structure. */
193 extern void regcache_supply_regset (const struct regset
*regset
,
194 struct regcache
*regcache
,
195 int regnum
, const void *buf
,
197 extern void regcache_collect_regset (const struct regset
*regset
,
198 const struct regcache
*regcache
,
199 int regnum
, void *buf
, size_t size
);
202 /* The type of a register. This function is slightly more efficient
203 then its gdbarch vector counterpart since it returns a precomputed
204 value stored in a table. */
206 extern struct type
*register_type (struct gdbarch
*gdbarch
, int regnum
);
209 /* Return the size of register REGNUM. All registers should have only
212 extern int register_size (struct gdbarch
*gdbarch
, int regnum
);
215 /* Save/restore a register cache. The set of registers saved /
216 restored into the DST regcache determined by the save_reggroup /
217 restore_reggroup respectively. COOKED_READ returns zero iff the
218 register's value can't be returned. */
220 typedef enum register_status (regcache_cooked_read_ftype
) (void *src
,
224 extern void regcache_save (struct regcache
*dst
,
225 regcache_cooked_read_ftype
*cooked_read
,
226 void *cooked_read_context
);
228 enum regcache_dump_what
230 regcache_dump_none
, regcache_dump_raw
,
231 regcache_dump_cooked
, regcache_dump_groups
,
235 /* The register cache for storing raw register values. */
240 regcache (gdbarch
*gdbarch
, address_space
*aspace_
)
241 : regcache (gdbarch
, aspace_
, true)
244 struct readonly_t
{};
245 static constexpr readonly_t readonly
{};
247 /* Create a readonly regcache from a non-readonly regcache. */
248 regcache (readonly_t
, const regcache
&src
);
250 regcache (const regcache
&) = delete;
251 void operator= (const regcache
&) = delete;
253 /* class regcache is only extended in unit test, so only mark it
254 virtual when selftest is enabled. */
261 xfree (m_register_status
);
264 gdbarch
*arch () const;
266 address_space
*aspace () const
271 void save (regcache_cooked_read_ftype
*cooked_read
, void *src
);
273 enum register_status
cooked_read (int regnum
, gdb_byte
*buf
);
274 void cooked_write (int regnum
, const gdb_byte
*buf
);
276 enum register_status
raw_read (int regnum
, gdb_byte
*buf
);
278 /* class regcache is only extended in unit test, so only mark it
279 virtual when selftest is enabled. */
283 void raw_write (int regnum
, const gdb_byte
*buf
);
285 enum register_status
raw_read_signed (int regnum
, LONGEST
*val
);
287 void raw_write_signed (int regnum
, LONGEST val
);
289 enum register_status
raw_read_unsigned (int regnum
, ULONGEST
*val
);
291 void raw_write_unsigned (int regnum
, ULONGEST val
);
293 struct value
*cooked_read_value (int regnum
);
295 enum register_status
cooked_read_signed (int regnum
, LONGEST
*val
);
297 void cooked_write_signed (int regnum
, LONGEST val
);
299 enum register_status
cooked_read_unsigned (int regnum
, ULONGEST
*val
);
301 void cooked_write_unsigned (int regnum
, ULONGEST val
);
303 void raw_update (int regnum
);
305 void raw_collect (int regnum
, void *buf
) const;
307 void raw_collect_integer (int regnum
, gdb_byte
*addr
, int addr_len
,
308 bool is_signed
) const;
310 void raw_supply (int regnum
, const void *buf
);
312 void raw_supply_integer (int regnum
, const gdb_byte
*addr
, int addr_len
,
315 void raw_supply_zeroed (int regnum
);
317 enum register_status
get_register_status (int regnum
) const;
319 void raw_set_cached_value (int regnum
, const gdb_byte
*buf
);
321 void invalidate (int regnum
);
323 enum register_status
raw_read_part (int regnum
, int offset
, int len
,
326 void raw_write_part (int regnum
, int offset
, int len
, const gdb_byte
*buf
);
328 enum register_status
cooked_read_part (int regnum
, int offset
, int len
,
331 void cooked_write_part (int regnum
, int offset
, int len
,
332 const gdb_byte
*buf
);
334 void supply_regset (const struct regset
*regset
,
335 int regnum
, const void *buf
, size_t size
);
338 void collect_regset (const struct regset
*regset
, int regnum
,
339 void *buf
, size_t size
) const;
341 void dump (ui_file
*file
, enum regcache_dump_what what_to_dump
);
348 void set_ptid (const ptid_t ptid
)
353 /* Dump the contents of a register from the register cache to the target
355 void debug_print_register (const char *func
, int regno
);
357 static void regcache_thread_ptid_changed (ptid_t old_ptid
, ptid_t new_ptid
);
359 regcache (gdbarch
*gdbarch
, address_space
*aspace_
, bool readonly_p_
);
361 static std::forward_list
<regcache
*> current_regcache
;
364 gdb_byte
*register_buffer (int regnum
) const;
366 void restore (struct regcache
*src
);
368 void cpy_no_passthrough (struct regcache
*src
);
370 enum register_status
xfer_part (int regnum
, int offset
, int len
, void *in
,
372 decltype (regcache_raw_read
) read
,
373 decltype (regcache_raw_write
) write
);
375 void transfer_regset (const struct regset
*regset
,
376 struct regcache
*out_regcache
,
377 int regnum
, const void *in_buf
,
378 void *out_buf
, size_t size
) const;
380 struct regcache_descr
*m_descr
;
382 /* The address space of this register cache (for registers where it
383 makes sense, like PC or SP). */
384 struct address_space
*m_aspace
;
386 /* The register buffers. A read-only register cache can hold the
387 full [0 .. gdbarch_num_regs + gdbarch_num_pseudo_regs) while a read/write
388 register cache can only hold [0 .. gdbarch_num_regs). */
389 gdb_byte
*m_registers
;
390 /* Register cache status. */
391 signed char *m_register_status
;
392 /* Is this a read-only cache? A read-only cache is used for saving
393 the target's register state (e.g, across an inferior function
394 call or just before forcing a function return). A read-only
395 cache can only be updated via the methods regcache_dup() and
396 regcache_cpy(). The actual contents are determined by the
397 reggroup_save and reggroup_restore methods. */
399 /* If this is a read-write cache, which thread's registers is
403 friend struct regcache
*
404 get_thread_arch_aspace_regcache (ptid_t ptid
, struct gdbarch
*gdbarch
,
405 struct address_space
*aspace
);
408 registers_changed_ptid (ptid_t ptid
);
411 regcache_cpy (struct regcache
*dst
, struct regcache
*src
);
414 /* Copy/duplicate the contents of a register cache. By default, the
415 operation is pass-through. Writes to DST and reads from SRC will
416 go through to the target. See also regcache_cpy_no_passthrough.
418 regcache_cpy can not have overlapping SRC and DST buffers. */
420 extern struct regcache
*regcache_dup (struct regcache
*regcache
);
421 extern void regcache_cpy (struct regcache
*dest
, struct regcache
*src
);
423 extern void registers_changed (void);
424 extern void registers_changed_ptid (ptid_t
);
426 #endif /* REGCACHE_H */