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 /* Return REGCACHE's ptid. */
40 extern ptid_t
regcache_get_ptid (const struct regcache
*regcache
);
42 /* Return REGCACHE's address space. */
44 extern struct address_space
*get_regcache_aspace (const struct regcache
*);
46 enum register_status
regcache_register_status (const struct regcache
*regcache
,
49 /* Make certain that the register REGNUM in REGCACHE is up-to-date. */
51 void regcache_raw_update (struct regcache
*regcache
, int regnum
);
53 /* Transfer a raw register [0..NUM_REGS) between core-gdb and the
54 regcache. The read variants return the status of the register. */
56 enum register_status
regcache_raw_read (struct regcache
*regcache
,
57 int rawnum
, gdb_byte
*buf
);
58 void regcache_raw_write (struct regcache
*regcache
, int rawnum
,
60 extern enum register_status
61 regcache_raw_read_signed (struct regcache
*regcache
,
62 int regnum
, LONGEST
*val
);
64 extern void regcache_raw_write_signed (struct regcache
*regcache
,
65 int regnum
, LONGEST val
);
66 extern void regcache_raw_write_unsigned (struct regcache
*regcache
,
67 int regnum
, ULONGEST val
);
69 /* Return the register's value in signed or throw if it's not
72 extern LONGEST
regcache_raw_get_signed (struct regcache
*regcache
,
75 /* Set a raw register's value in the regcache's buffer. Unlike
76 regcache_raw_write, this is not write-through. The intention is
77 allowing to change the buffer contents of a read-only regcache
78 allocated with new. */
80 extern void regcache_raw_set_cached_value
81 (struct regcache
*regcache
, int regnum
, const gdb_byte
*buf
);
83 /* Partial transfer of raw registers. These perform read, modify,
84 write style operations. The read variant returns the status of the
87 extern enum register_status
88 regcache_raw_read_part (struct regcache
*regcache
, int regnum
,
89 int offset
, int len
, gdb_byte
*buf
);
90 void regcache_raw_write_part (struct regcache
*regcache
, int regnum
,
91 int offset
, int len
, const gdb_byte
*buf
);
93 void regcache_invalidate (struct regcache
*regcache
, int regnum
);
95 /* Transfer of pseudo-registers. The read variants return a register
96 status, as an indication of when a ``cooked'' register was
97 constructed from valid, invalid or unavailable ``raw''
100 /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */
101 enum register_status
regcache_cooked_read (struct regcache
*regcache
,
102 int rawnum
, gdb_byte
*buf
);
103 void regcache_cooked_write (struct regcache
*regcache
, int rawnum
,
104 const gdb_byte
*buf
);
106 /* Read register REGNUM from REGCACHE and return a new value. This
107 will call mark_value_bytes_unavailable as appropriate. */
109 struct value
*regcache_cooked_read_value (struct regcache
*regcache
,
112 /* Read a register as a signed/unsigned quantity. */
113 extern enum register_status
114 regcache_cooked_read_signed (struct regcache
*regcache
,
115 int regnum
, LONGEST
*val
);
116 extern enum register_status
117 regcache_cooked_read_unsigned (struct regcache
*regcache
,
118 int regnum
, ULONGEST
*val
);
119 extern void regcache_cooked_write_signed (struct regcache
*regcache
,
120 int regnum
, LONGEST val
);
121 extern void regcache_cooked_write_unsigned (struct regcache
*regcache
,
122 int regnum
, ULONGEST val
);
124 /* Partial transfer of a cooked register. These perform read, modify,
125 write style operations. */
127 enum register_status
regcache_cooked_read_part (struct regcache
*regcache
,
128 int regnum
, int offset
,
129 int len
, gdb_byte
*buf
);
130 void regcache_cooked_write_part (struct regcache
*regcache
, int regnum
,
131 int offset
, int len
, const gdb_byte
*buf
);
133 /* Special routines to read/write the PC. */
135 /* For regcache_read_pc see common/common-regcache.h. */
136 extern void regcache_write_pc (struct regcache
*regcache
, CORE_ADDR pc
);
138 /* Transfer a raw register [0..NUM_REGS) between the regcache and the
139 target. These functions are called by the target in response to a
140 target_fetch_registers() or target_store_registers(). */
142 extern void regcache_raw_supply (struct regcache
*regcache
,
143 int regnum
, const void *buf
);
144 extern void regcache_raw_collect (const struct regcache
*regcache
,
145 int regnum
, void *buf
);
147 /* Mapping between register numbers and offsets in a buffer, for use
148 in the '*regset' functions below. In an array of
149 'regcache_map_entry' each element is interpreted like follows:
151 - If 'regno' is a register number: Map register 'regno' to the
152 current offset (starting with 0) and increase the current offset
153 by 'size' (or the register's size, if 'size' is zero). Repeat
154 this with consecutive register numbers up to 'regno+count-1'.
156 - If 'regno' is REGCACHE_MAP_SKIP: Add 'count*size' to the current
159 - If count=0: End of the map. */
161 struct regcache_map_entry
168 /* Special value for the 'regno' field in the struct above. */
172 REGCACHE_MAP_SKIP
= -1,
175 /* Transfer a set of registers (as described by REGSET) between
176 REGCACHE and BUF. If REGNUM == -1, transfer all registers
177 belonging to the regset, otherwise just the register numbered
178 REGNUM. The REGSET's 'regmap' field must point to an array of
179 'struct regcache_map_entry'.
181 These functions are suitable for the 'regset_supply' and
182 'regset_collect' fields in a regset structure. */
184 extern void regcache_supply_regset (const struct regset
*regset
,
185 struct regcache
*regcache
,
186 int regnum
, const void *buf
,
188 extern void regcache_collect_regset (const struct regset
*regset
,
189 const struct regcache
*regcache
,
190 int regnum
, void *buf
, size_t size
);
193 /* The type of a register. This function is slightly more efficient
194 then its gdbarch vector counterpart since it returns a precomputed
195 value stored in a table. */
197 extern struct type
*register_type (struct gdbarch
*gdbarch
, int regnum
);
200 /* Return the size of register REGNUM. All registers should have only
203 extern int register_size (struct gdbarch
*gdbarch
, int regnum
);
206 /* Save/restore a register cache. The set of registers saved /
207 restored into the DST regcache determined by the save_reggroup /
208 restore_reggroup respectively. COOKED_READ returns zero iff the
209 register's value can't be returned. */
211 typedef enum register_status (regcache_cooked_read_ftype
) (void *src
,
215 extern void regcache_save (struct regcache
*dst
,
216 regcache_cooked_read_ftype
*cooked_read
,
217 void *cooked_read_context
);
219 enum regcache_dump_what
221 regcache_dump_none
, regcache_dump_raw
,
222 regcache_dump_cooked
, regcache_dump_groups
,
226 /* A (register_number, register_value) pair. */
228 typedef struct cached_reg
234 /* The register cache for storing raw register values. */
239 regcache (gdbarch
*gdbarch
, address_space
*aspace_
)
240 : regcache (gdbarch
, aspace_
, true)
243 struct readonly_t
{};
244 static constexpr readonly_t readonly
{};
246 /* Create a readonly regcache from a non-readonly regcache. */
247 regcache (readonly_t
, const regcache
&src
);
249 DISABLE_COPY_AND_ASSIGN (regcache
);
254 xfree (m_register_status
);
257 /* Return regcache's architecture. */
258 gdbarch
*arch () const;
260 address_space
*aspace () const
265 void save (regcache_cooked_read_ftype
*cooked_read
, void *src
);
267 enum register_status
cooked_read (int regnum
, gdb_byte
*buf
);
268 void cooked_write (int regnum
, const gdb_byte
*buf
);
270 enum register_status
raw_read (int regnum
, gdb_byte
*buf
);
272 void raw_write (int regnum
, const gdb_byte
*buf
);
274 template<typename T
, typename
= RequireLongest
<T
>>
275 enum register_status
raw_read (int regnum
, T
*val
);
277 template<typename T
, typename
= RequireLongest
<T
>>
278 void raw_write (int regnum
, T val
);
280 struct value
*cooked_read_value (int regnum
);
282 template<typename T
, typename
= RequireLongest
<T
>>
283 enum register_status
cooked_read (int regnum
, T
*val
);
285 template<typename T
, typename
= RequireLongest
<T
>>
286 void cooked_write (int regnum
, T val
);
288 void raw_update (int regnum
);
290 void raw_collect (int regnum
, void *buf
) const;
292 void raw_collect_integer (int regnum
, gdb_byte
*addr
, int addr_len
,
293 bool is_signed
) const;
295 void raw_supply (int regnum
, const void *buf
);
297 void raw_supply_integer (int regnum
, const gdb_byte
*addr
, int addr_len
,
300 void raw_supply_zeroed (int regnum
);
302 enum register_status
get_register_status (int regnum
) const;
304 void raw_set_cached_value (int regnum
, const gdb_byte
*buf
);
306 void invalidate (int regnum
);
308 enum register_status
raw_read_part (int regnum
, int offset
, int len
,
311 void raw_write_part (int regnum
, int offset
, int len
, const gdb_byte
*buf
);
313 enum register_status
cooked_read_part (int regnum
, int offset
, int len
,
316 void cooked_write_part (int regnum
, int offset
, int len
,
317 const gdb_byte
*buf
);
319 void supply_regset (const struct regset
*regset
,
320 int regnum
, const void *buf
, size_t size
);
323 void collect_regset (const struct regset
*regset
, int regnum
,
324 void *buf
, size_t size
) const;
326 void dump (ui_file
*file
, enum regcache_dump_what what_to_dump
);
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
, address_space
*aspace_
, bool readonly_p_
);
346 static std::forward_list
<regcache
*> current_regcache
;
349 gdb_byte
*register_buffer (int regnum
) const;
351 void restore (struct regcache
*src
);
353 enum register_status
xfer_part (int regnum
, int offset
, int len
, void *in
,
354 const void *out
, bool is_raw
);
356 void transfer_regset (const struct regset
*regset
,
357 struct regcache
*out_regcache
,
358 int regnum
, const void *in_buf
,
359 void *out_buf
, size_t size
) const;
361 struct regcache_descr
*m_descr
;
363 /* The address space of this register cache (for registers where it
364 makes sense, like PC or SP). */
365 struct address_space
*m_aspace
;
367 /* The register buffers. A read-only register cache can hold the
368 full [0 .. gdbarch_num_regs + gdbarch_num_pseudo_regs) while a read/write
369 register cache can only hold [0 .. gdbarch_num_regs). */
370 gdb_byte
*m_registers
;
371 /* Register cache status. */
372 signed char *m_register_status
;
373 /* Is this a read-only cache? A read-only cache is used for saving
374 the target's register state (e.g, across an inferior function
375 call or just before forcing a function return). A read-only
376 cache can only be updated via the methods regcache_dup() and
377 regcache_cpy(). The actual contents are determined by the
378 reggroup_save and reggroup_restore methods. */
380 /* If this is a read-write cache, which thread's registers is
384 friend struct regcache
*
385 get_thread_arch_aspace_regcache (ptid_t ptid
, struct gdbarch
*gdbarch
,
386 struct address_space
*aspace
);
389 registers_changed_ptid (ptid_t ptid
);
392 regcache_cpy (struct regcache
*dst
, struct regcache
*src
);
395 /* Duplicate the contents of a register cache to a read-only register
396 cache. The operation is pass-through. */
397 extern struct regcache
*regcache_dup (struct regcache
*regcache
);
399 /* Writes to DEST will go through to the target. SRC is a read-only
401 extern void regcache_cpy (struct regcache
*dest
, struct regcache
*src
);
403 extern void registers_changed (void);
404 extern void registers_changed_ptid (ptid_t
);
406 #endif /* REGCACHE_H */