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"
30 extern struct regcache *get_current_regcache (void);
31 extern struct regcache *get_thread_regcache (ptid_t ptid);
32 extern struct regcache *get_thread_arch_regcache (ptid_t, struct gdbarch *);
33 extern struct regcache *get_thread_arch_aspace_regcache (ptid_t,
35 struct address_space *);
37 void regcache_xfree (struct regcache *regcache);
38 struct cleanup *make_cleanup_regcache_xfree (struct regcache *regcache);
39 struct regcache *regcache_xmalloc (struct gdbarch *gdbarch,
40 struct address_space *aspace);
42 /* Return REGCACHE's ptid. */
44 extern ptid_t regcache_get_ptid (const struct regcache *regcache);
46 /* Return REGCACHE's architecture. */
48 extern struct gdbarch *get_regcache_arch (const struct regcache *regcache);
50 /* Return REGCACHE's address space. */
52 extern struct address_space *get_regcache_aspace (const struct regcache *);
54 enum register_status regcache_register_status (const struct regcache *regcache,
57 /* Make certain that the register REGNUM in REGCACHE is up-to-date. */
59 void regcache_raw_update (struct regcache *regcache, int regnum);
61 /* Transfer a raw register [0..NUM_REGS) between core-gdb and the
62 regcache. The read variants return the status of the register. */
64 enum register_status regcache_raw_read (struct regcache *regcache,
65 int rawnum, gdb_byte *buf);
66 void regcache_raw_write (struct regcache *regcache, int rawnum,
68 extern enum register_status
69 regcache_raw_read_signed (struct regcache *regcache,
70 int regnum, LONGEST *val);
72 extern void regcache_raw_write_signed (struct regcache *regcache,
73 int regnum, LONGEST val);
74 extern void regcache_raw_write_unsigned (struct regcache *regcache,
75 int regnum, ULONGEST val);
77 /* Return the register's value in signed or throw if it's not
80 extern LONGEST regcache_raw_get_signed (struct regcache *regcache,
83 /* Set a raw register's value in the regcache's buffer. Unlike
84 regcache_raw_write, this is not write-through. The intention is
85 allowing to change the buffer contents of a read-only regcache
86 allocated with regcache_xmalloc. */
88 extern void regcache_raw_set_cached_value
89 (struct regcache *regcache, int regnum, const gdb_byte *buf);
91 /* Partial transfer of raw registers. These perform read, modify,
92 write style operations. The read variant returns the status of the
95 extern enum register_status
96 regcache_raw_read_part (struct regcache *regcache, int regnum,
97 int offset, int len, gdb_byte *buf);
98 void regcache_raw_write_part (struct regcache *regcache, int regnum,
99 int offset, int len, const gdb_byte *buf);
101 void regcache_invalidate (struct regcache *regcache, int regnum);
103 /* Transfer of pseudo-registers. The read variants return a register
104 status, as an indication of when a ``cooked'' register was
105 constructed from valid, invalid or unavailable ``raw''
108 /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */
109 enum register_status regcache_cooked_read (struct regcache *regcache,
110 int rawnum, gdb_byte *buf);
111 void regcache_cooked_write (struct regcache *regcache, int rawnum,
112 const gdb_byte *buf);
114 /* Read register REGNUM from REGCACHE and return a new value. This
115 will call mark_value_bytes_unavailable as appropriate. */
117 struct value *regcache_cooked_read_value (struct regcache *regcache,
120 /* Read a register as a signed/unsigned quantity. */
121 extern enum register_status
122 regcache_cooked_read_signed (struct regcache *regcache,
123 int regnum, LONGEST *val);
124 extern enum register_status
125 regcache_cooked_read_unsigned (struct regcache *regcache,
126 int regnum, ULONGEST *val);
127 extern void regcache_cooked_write_signed (struct regcache *regcache,
128 int regnum, LONGEST val);
129 extern void regcache_cooked_write_unsigned (struct regcache *regcache,
130 int regnum, ULONGEST val);
132 /* Partial transfer of a cooked register. These perform read, modify,
133 write style operations. */
135 enum register_status regcache_cooked_read_part (struct regcache *regcache,
136 int regnum, int offset,
137 int len, gdb_byte *buf);
138 void regcache_cooked_write_part (struct regcache *regcache, int regnum,
139 int offset, int len, const gdb_byte *buf);
141 /* Special routines to read/write the PC. */
143 /* For regcache_read_pc see common/common-regcache.h. */
144 extern void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc);
146 /* Transfer a raw register [0..NUM_REGS) between the regcache and the
147 target. These functions are called by the target in response to a
148 target_fetch_registers() or target_store_registers(). */
150 extern void regcache_raw_supply (struct regcache *regcache,
151 int regnum, const void *buf);
152 extern void regcache_raw_collect (const struct regcache *regcache,
153 int regnum, void *buf);
155 /* Mapping between register numbers and offsets in a buffer, for use
156 in the '*regset' functions below. In an array of
157 'regcache_map_entry' each element is interpreted like follows:
159 - If 'regno' is a register number: Map register 'regno' to the
160 current offset (starting with 0) and increase the current offset
161 by 'size' (or the register's size, if 'size' is zero). Repeat
162 this with consecutive register numbers up to 'regno+count-1'.
164 - If 'regno' is REGCACHE_MAP_SKIP: Add 'count*size' to the current
167 - If count=0: End of the map. */
169 struct regcache_map_entry
176 /* Special value for the 'regno' field in the struct above. */
180 REGCACHE_MAP_SKIP = -1,
183 /* Transfer a set of registers (as described by REGSET) between
184 REGCACHE and BUF. If REGNUM == -1, transfer all registers
185 belonging to the regset, otherwise just the register numbered
186 REGNUM. The REGSET's 'regmap' field must point to an array of
187 'struct regcache_map_entry'.
189 These functions are suitable for the 'regset_supply' and
190 'regset_collect' fields in a regset structure. */
192 extern void regcache_supply_regset (const struct regset *regset,
193 struct regcache *regcache,
194 int regnum, const void *buf,
196 extern void regcache_collect_regset (const struct regset *regset,
197 const struct regcache *regcache,
198 int regnum, void *buf, size_t size);
201 /* The type of a register. This function is slightly more efficient
202 then its gdbarch vector counterpart since it returns a precomputed
203 value stored in a table. */
205 extern struct type *register_type (struct gdbarch *gdbarch, int regnum);
208 /* Return the size of register REGNUM. All registers should have only
211 extern int register_size (struct gdbarch *gdbarch, int regnum);
214 /* Save/restore a register cache. The set of registers saved /
215 restored into the DST regcache determined by the save_reggroup /
216 restore_reggroup respectively. COOKED_READ returns zero iff the
217 register's value can't be returned. */
219 typedef enum register_status (regcache_cooked_read_ftype) (void *src,
223 extern void regcache_save (struct regcache *dst,
224 regcache_cooked_read_ftype *cooked_read,
225 void *cooked_read_context);
227 enum regcache_dump_what
229 regcache_dump_none, regcache_dump_raw,
230 regcache_dump_cooked, regcache_dump_groups,
234 /* The register cache for storing raw register values. */
239 regcache (gdbarch *gdbarch, address_space *aspace_)
240 : regcache (gdbarch, aspace_, true)
246 xfree (m_register_status);
249 gdbarch *arch () const;
251 address_space *aspace () const
256 void save (regcache_cooked_read_ftype *cooked_read, void *src);
258 enum register_status cooked_read (int regnum, gdb_byte *buf);
259 void cooked_write (int regnum, const gdb_byte *buf);
261 enum register_status raw_read (int regnum, gdb_byte *buf);
262 void raw_write (int regnum, const gdb_byte *buf);
264 enum register_status raw_read_signed (int regnum, LONGEST *val);
266 void raw_write_signed (int regnum, LONGEST val);
268 enum register_status raw_read_unsigned (int regnum, ULONGEST *val);
270 void raw_write_unsigned (int regnum, ULONGEST val);
272 struct value *cooked_read_value (int regnum);
274 enum register_status cooked_read_signed (int regnum, LONGEST *val);
276 void cooked_write_signed (int regnum, LONGEST val);
278 enum register_status cooked_read_unsigned (int regnum, ULONGEST *val);
280 void cooked_write_unsigned (int regnum, ULONGEST val);
282 void raw_update (int regnum);
284 void raw_collect (int regnum, void *buf) const;
286 void raw_supply (int regnum, const void *buf);
288 enum register_status get_register_status (int regnum) const;
290 void raw_set_cached_value (int regnum, const gdb_byte *buf);
292 void invalidate (int regnum);
294 enum register_status raw_read_part (int regnum, int offset, int len,
297 void raw_write_part (int regnum, int offset, int len, const gdb_byte *buf);
299 enum register_status cooked_read_part (int regnum, int offset, int len,
302 void cooked_write_part (int regnum, int offset, int len,
303 const gdb_byte *buf);
305 void supply_regset (const struct regset *regset,
306 int regnum, const void *buf, size_t size);
309 void collect_regset (const struct regset *regset, int regnum,
310 void *buf, size_t size) const;
312 void dump (ui_file *file, enum regcache_dump_what what_to_dump);
319 void set_ptid (const ptid_t ptid)
324 /* Dump the contents of a register from the register cache to the target
326 void debug_print_register (const char *func, int regno);
329 regcache (gdbarch *gdbarch, address_space *aspace_, bool readonly_p_);
331 gdb_byte *register_buffer (int regnum) const;
333 void restore (struct regcache *src);
335 void cpy_no_passthrough (struct regcache *src);
337 enum register_status xfer_part (int regnum, int offset, int len, void *in,
339 decltype (regcache_raw_read) read,
340 decltype (regcache_raw_write) write);
342 void transfer_regset (const struct regset *regset,
343 struct regcache *out_regcache,
344 int regnum, const void *in_buf,
345 void *out_buf, size_t size) const;
347 struct regcache_descr *m_descr;
349 /* The address space of this register cache (for registers where it
350 makes sense, like PC or SP). */
351 struct address_space *m_aspace;
353 /* The register buffers. A read-only register cache can hold the
354 full [0 .. gdbarch_num_regs + gdbarch_num_pseudo_regs) while a read/write
355 register cache can only hold [0 .. gdbarch_num_regs). */
356 gdb_byte *m_registers;
357 /* Register cache status. */
358 signed char *m_register_status;
359 /* Is this a read-only cache? A read-only cache is used for saving
360 the target's register state (e.g, across an inferior function
361 call or just before forcing a function return). A read-only
362 cache can only be updated via the methods regcache_dup() and
363 regcache_cpy(). The actual contents are determined by the
364 reggroup_save and reggroup_restore methods. */
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 regcache_cpy (struct regcache *dst, struct regcache *src);
378 /* Copy/duplicate the contents of a register cache. By default, the
379 operation is pass-through. Writes to DST and reads from SRC will
380 go through to the target. See also regcache_cpy_no_passthrough.
382 regcache_cpy can not have overlapping SRC and DST buffers. */
384 extern struct regcache *regcache_dup (struct regcache *regcache);
385 extern void regcache_cpy (struct regcache *dest, struct regcache *src);
387 extern void registers_changed (void);
388 extern void registers_changed_ptid (ptid_t);
390 #endif /* REGCACHE_H */