Commit | Line | Data |
---|---|---|
4e052eda | 1 | /* Cache and manage the values of registers for GDB, the GNU debugger. |
3fadccb3 | 2 | |
61baf725 | 3 | Copyright (C) 1986-2017 Free Software Foundation, Inc. |
4e052eda AC |
4 | |
5 | This file is part of GDB. | |
6 | ||
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 | |
a9762ec7 | 9 | the Free Software Foundation; either version 3 of the License, or |
4e052eda AC |
10 | (at your option) any later version. |
11 | ||
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. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
4e052eda AC |
19 | |
20 | #ifndef REGCACHE_H | |
21 | #define REGCACHE_H | |
22 | ||
361c8ade GB |
23 | #include "common-regcache.h" |
24 | ||
3fadccb3 | 25 | struct regcache; |
a01cbb49 | 26 | struct regset; |
3fadccb3 | 27 | struct gdbarch; |
6c95b8df | 28 | struct address_space; |
3fadccb3 | 29 | |
594f7785 UW |
30 | extern struct regcache *get_current_regcache (void); |
31 | extern struct regcache *get_thread_regcache (ptid_t ptid); | |
c2250ad1 | 32 | extern struct regcache *get_thread_arch_regcache (ptid_t, struct gdbarch *); |
e2d96639 YQ |
33 | extern struct regcache *get_thread_arch_aspace_regcache (ptid_t, |
34 | struct gdbarch *, | |
35 | struct address_space *); | |
3fadccb3 AC |
36 | |
37 | void regcache_xfree (struct regcache *regcache); | |
36160dc4 | 38 | struct cleanup *make_cleanup_regcache_xfree (struct regcache *regcache); |
d37346f0 DJ |
39 | struct regcache *regcache_xmalloc (struct gdbarch *gdbarch, |
40 | struct address_space *aspace); | |
3fadccb3 | 41 | |
41d35cb0 MK |
42 | /* Return REGCACHE's architecture. */ |
43 | ||
44 | extern struct gdbarch *get_regcache_arch (const struct regcache *regcache); | |
45 | ||
6c95b8df PA |
46 | /* Return REGCACHE's address space. */ |
47 | ||
3e43a32a | 48 | extern struct address_space *get_regcache_aspace (const struct regcache *); |
6c95b8df | 49 | |
ee99023e PA |
50 | enum register_status regcache_register_status (const struct regcache *regcache, |
51 | int regnum); | |
52 | ||
8e368124 AH |
53 | /* Make certain that the register REGNUM in REGCACHE is up-to-date. */ |
54 | ||
55 | void regcache_raw_update (struct regcache *regcache, int regnum); | |
56 | ||
61a0eb5b | 57 | /* Transfer a raw register [0..NUM_REGS) between core-gdb and the |
05d1431c | 58 | regcache. The read variants return the status of the register. */ |
61a0eb5b | 59 | |
05d1431c PA |
60 | enum register_status regcache_raw_read (struct regcache *regcache, |
61 | int rawnum, gdb_byte *buf); | |
1aaa5f99 | 62 | void regcache_raw_write (struct regcache *regcache, int rawnum, |
2d522557 | 63 | const gdb_byte *buf); |
05d1431c PA |
64 | extern enum register_status |
65 | regcache_raw_read_signed (struct regcache *regcache, | |
66 | int regnum, LONGEST *val); | |
d0e59a68 | 67 | |
c00dcbe9 MK |
68 | extern void regcache_raw_write_signed (struct regcache *regcache, |
69 | int regnum, LONGEST val); | |
70 | extern void regcache_raw_write_unsigned (struct regcache *regcache, | |
71 | int regnum, ULONGEST val); | |
06c0b04e | 72 | |
9fd15b2e YQ |
73 | /* Return the register's value in signed or throw if it's not |
74 | available. */ | |
75 | ||
76 | extern LONGEST regcache_raw_get_signed (struct regcache *regcache, | |
77 | int regnum); | |
78 | ||
20aa2c60 PA |
79 | /* Set a raw register's value in the regcache's buffer. Unlike |
80 | regcache_raw_write, this is not write-through. The intention is | |
81 | allowing to change the buffer contents of a read-only regcache | |
82 | allocated with regcache_xmalloc. */ | |
83 | ||
84 | extern void regcache_raw_set_cached_value | |
85 | (struct regcache *regcache, int regnum, const gdb_byte *buf); | |
86 | ||
05d1431c PA |
87 | /* Partial transfer of raw registers. These perform read, modify, |
88 | write style operations. The read variant returns the status of the | |
89 | register. */ | |
06c0b04e | 90 | |
05d1431c PA |
91 | extern enum register_status |
92 | regcache_raw_read_part (struct regcache *regcache, int regnum, | |
93 | int offset, int len, gdb_byte *buf); | |
06c0b04e | 94 | void regcache_raw_write_part (struct regcache *regcache, int regnum, |
2d522557 | 95 | int offset, int len, const gdb_byte *buf); |
06c0b04e | 96 | |
9c5ea4d9 UW |
97 | void regcache_invalidate (struct regcache *regcache, int regnum); |
98 | ||
05d1431c PA |
99 | /* Transfer of pseudo-registers. The read variants return a register |
100 | status, as an indication of when a ``cooked'' register was | |
101 | constructed from valid, invalid or unavailable ``raw'' | |
102 | registers. */ | |
103 | ||
68365089 | 104 | /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */ |
05d1431c PA |
105 | enum register_status regcache_cooked_read (struct regcache *regcache, |
106 | int rawnum, gdb_byte *buf); | |
68365089 | 107 | void regcache_cooked_write (struct regcache *regcache, int rawnum, |
2d522557 | 108 | const gdb_byte *buf); |
68365089 | 109 | |
3543a589 TT |
110 | /* Read register REGNUM from REGCACHE and return a new value. This |
111 | will call mark_value_bytes_unavailable as appropriate. */ | |
112 | ||
113 | struct value *regcache_cooked_read_value (struct regcache *regcache, | |
114 | int regnum); | |
115 | ||
a378f419 | 116 | /* Read a register as a signed/unsigned quantity. */ |
05d1431c PA |
117 | extern enum register_status |
118 | regcache_cooked_read_signed (struct regcache *regcache, | |
119 | int regnum, LONGEST *val); | |
120 | extern enum register_status | |
121 | regcache_cooked_read_unsigned (struct regcache *regcache, | |
122 | int regnum, ULONGEST *val); | |
a66a9c23 AC |
123 | extern void regcache_cooked_write_signed (struct regcache *regcache, |
124 | int regnum, LONGEST val); | |
125 | extern void regcache_cooked_write_unsigned (struct regcache *regcache, | |
126 | int regnum, ULONGEST val); | |
a378f419 | 127 | |
06c0b04e AC |
128 | /* Partial transfer of a cooked register. These perform read, modify, |
129 | write style operations. */ | |
130 | ||
05d1431c PA |
131 | enum register_status regcache_cooked_read_part (struct regcache *regcache, |
132 | int regnum, int offset, | |
133 | int len, gdb_byte *buf); | |
06c0b04e | 134 | void regcache_cooked_write_part (struct regcache *regcache, int regnum, |
2d522557 | 135 | int offset, int len, const gdb_byte *buf); |
06c0b04e | 136 | |
515630c5 UW |
137 | /* Special routines to read/write the PC. */ |
138 | ||
361c8ade | 139 | /* For regcache_read_pc see common/common-regcache.h. */ |
515630c5 UW |
140 | extern void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc); |
141 | ||
193cb69f AC |
142 | /* Transfer a raw register [0..NUM_REGS) between the regcache and the |
143 | target. These functions are called by the target in response to a | |
144 | target_fetch_registers() or target_store_registers(). */ | |
145 | ||
9a661b68 | 146 | extern void regcache_raw_supply (struct regcache *regcache, |
6618125d | 147 | int regnum, const void *buf); |
9a661b68 | 148 | extern void regcache_raw_collect (const struct regcache *regcache, |
6618125d | 149 | int regnum, void *buf); |
193cb69f | 150 | |
0b309272 AA |
151 | /* Mapping between register numbers and offsets in a buffer, for use |
152 | in the '*regset' functions below. In an array of | |
153 | 'regcache_map_entry' each element is interpreted like follows: | |
154 | ||
155 | - If 'regno' is a register number: Map register 'regno' to the | |
156 | current offset (starting with 0) and increase the current offset | |
157 | by 'size' (or the register's size, if 'size' is zero). Repeat | |
158 | this with consecutive register numbers up to 'regno+count-1'. | |
159 | ||
160 | - If 'regno' is REGCACHE_MAP_SKIP: Add 'count*size' to the current | |
161 | offset. | |
162 | ||
163 | - If count=0: End of the map. */ | |
164 | ||
165 | struct regcache_map_entry | |
166 | { | |
167 | int count; | |
168 | int regno; | |
169 | int size; | |
170 | }; | |
171 | ||
172 | /* Special value for the 'regno' field in the struct above. */ | |
173 | ||
174 | enum | |
175 | { | |
176 | REGCACHE_MAP_SKIP = -1, | |
177 | }; | |
178 | ||
179 | /* Transfer a set of registers (as described by REGSET) between | |
180 | REGCACHE and BUF. If REGNUM == -1, transfer all registers | |
181 | belonging to the regset, otherwise just the register numbered | |
182 | REGNUM. The REGSET's 'regmap' field must point to an array of | |
183 | 'struct regcache_map_entry'. | |
184 | ||
185 | These functions are suitable for the 'regset_supply' and | |
186 | 'regset_collect' fields in a regset structure. */ | |
187 | ||
188 | extern void regcache_supply_regset (const struct regset *regset, | |
189 | struct regcache *regcache, | |
190 | int regnum, const void *buf, | |
191 | size_t size); | |
192 | extern void regcache_collect_regset (const struct regset *regset, | |
193 | const struct regcache *regcache, | |
194 | int regnum, void *buf, size_t size); | |
195 | ||
193cb69f | 196 | |
bb425013 AC |
197 | /* The type of a register. This function is slightly more efficient |
198 | then its gdbarch vector counterpart since it returns a precomputed | |
01e1877c | 199 | value stored in a table. */ |
bb425013 AC |
200 | |
201 | extern struct type *register_type (struct gdbarch *gdbarch, int regnum); | |
202 | ||
203 | ||
08a617da | 204 | /* Return the size of register REGNUM. All registers should have only |
01e1877c | 205 | one size. */ |
08a617da AC |
206 | |
207 | extern int register_size (struct gdbarch *gdbarch, int regnum); | |
208 | ||
209 | ||
5602984a AC |
210 | /* Save/restore a register cache. The set of registers saved / |
211 | restored into the DST regcache determined by the save_reggroup / | |
212 | restore_reggroup respectively. COOKED_READ returns zero iff the | |
213 | register's value can't be returned. */ | |
214 | ||
05d1431c PA |
215 | typedef enum register_status (regcache_cooked_read_ftype) (void *src, |
216 | int regnum, | |
217 | gdb_byte *buf); | |
5602984a AC |
218 | |
219 | extern void regcache_save (struct regcache *dst, | |
220 | regcache_cooked_read_ftype *cooked_read, | |
2d522557 | 221 | void *cooked_read_context); |
2d28509a | 222 | |
37e71372 AC |
223 | /* Copy/duplicate the contents of a register cache. By default, the |
224 | operation is pass-through. Writes to DST and reads from SRC will | |
bd49952b | 225 | go through to the target. See also regcache_cpy_no_passthrough. |
37e71372 | 226 | |
bd49952b | 227 | regcache_cpy can not have overlapping SRC and DST buffers. */ |
3fadccb3 | 228 | |
3fadccb3 | 229 | extern struct regcache *regcache_dup (struct regcache *regcache); |
3fadccb3 | 230 | extern void regcache_cpy (struct regcache *dest, struct regcache *src); |
3fadccb3 | 231 | |
4e052eda | 232 | extern void registers_changed (void); |
e66408ed | 233 | extern void registers_changed_ptid (ptid_t); |
4e052eda | 234 | |
4e052eda | 235 | #endif /* REGCACHE_H */ |