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); | |
ddaaf0fb SM |
41 | |
42 | /* Return REGCACHE's ptid. */ | |
43 | ||
44 | extern ptid_t regcache_get_ptid (const struct regcache *regcache); | |
3fadccb3 | 45 | |
41d35cb0 MK |
46 | /* Return REGCACHE's architecture. */ |
47 | ||
48 | extern struct gdbarch *get_regcache_arch (const struct regcache *regcache); | |
49 | ||
6c95b8df PA |
50 | /* Return REGCACHE's address space. */ |
51 | ||
3e43a32a | 52 | extern struct address_space *get_regcache_aspace (const struct regcache *); |
6c95b8df | 53 | |
ee99023e PA |
54 | enum register_status regcache_register_status (const struct regcache *regcache, |
55 | int regnum); | |
56 | ||
8e368124 AH |
57 | /* Make certain that the register REGNUM in REGCACHE is up-to-date. */ |
58 | ||
59 | void regcache_raw_update (struct regcache *regcache, int regnum); | |
60 | ||
61a0eb5b | 61 | /* Transfer a raw register [0..NUM_REGS) between core-gdb and the |
05d1431c | 62 | regcache. The read variants return the status of the register. */ |
61a0eb5b | 63 | |
05d1431c PA |
64 | enum register_status regcache_raw_read (struct regcache *regcache, |
65 | int rawnum, gdb_byte *buf); | |
1aaa5f99 | 66 | void regcache_raw_write (struct regcache *regcache, int rawnum, |
2d522557 | 67 | const gdb_byte *buf); |
05d1431c PA |
68 | extern enum register_status |
69 | regcache_raw_read_signed (struct regcache *regcache, | |
70 | int regnum, LONGEST *val); | |
d0e59a68 | 71 | |
c00dcbe9 MK |
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); | |
06c0b04e | 76 | |
9fd15b2e YQ |
77 | /* Return the register's value in signed or throw if it's not |
78 | available. */ | |
79 | ||
80 | extern LONGEST regcache_raw_get_signed (struct regcache *regcache, | |
81 | int regnum); | |
82 | ||
20aa2c60 PA |
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. */ | |
87 | ||
88 | extern void regcache_raw_set_cached_value | |
89 | (struct regcache *regcache, int regnum, const gdb_byte *buf); | |
90 | ||
05d1431c PA |
91 | /* Partial transfer of raw registers. These perform read, modify, |
92 | write style operations. The read variant returns the status of the | |
93 | register. */ | |
06c0b04e | 94 | |
05d1431c PA |
95 | extern enum register_status |
96 | regcache_raw_read_part (struct regcache *regcache, int regnum, | |
97 | int offset, int len, gdb_byte *buf); | |
06c0b04e | 98 | void regcache_raw_write_part (struct regcache *regcache, int regnum, |
2d522557 | 99 | int offset, int len, const gdb_byte *buf); |
06c0b04e | 100 | |
9c5ea4d9 UW |
101 | void regcache_invalidate (struct regcache *regcache, int regnum); |
102 | ||
05d1431c PA |
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'' | |
106 | registers. */ | |
107 | ||
68365089 | 108 | /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */ |
05d1431c PA |
109 | enum register_status regcache_cooked_read (struct regcache *regcache, |
110 | int rawnum, gdb_byte *buf); | |
68365089 | 111 | void regcache_cooked_write (struct regcache *regcache, int rawnum, |
2d522557 | 112 | const gdb_byte *buf); |
68365089 | 113 | |
3543a589 TT |
114 | /* Read register REGNUM from REGCACHE and return a new value. This |
115 | will call mark_value_bytes_unavailable as appropriate. */ | |
116 | ||
117 | struct value *regcache_cooked_read_value (struct regcache *regcache, | |
118 | int regnum); | |
119 | ||
a378f419 | 120 | /* Read a register as a signed/unsigned quantity. */ |
05d1431c PA |
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); | |
a66a9c23 AC |
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); | |
a378f419 | 131 | |
06c0b04e AC |
132 | /* Partial transfer of a cooked register. These perform read, modify, |
133 | write style operations. */ | |
134 | ||
05d1431c PA |
135 | enum register_status regcache_cooked_read_part (struct regcache *regcache, |
136 | int regnum, int offset, | |
137 | int len, gdb_byte *buf); | |
06c0b04e | 138 | void regcache_cooked_write_part (struct regcache *regcache, int regnum, |
2d522557 | 139 | int offset, int len, const gdb_byte *buf); |
06c0b04e | 140 | |
515630c5 UW |
141 | /* Special routines to read/write the PC. */ |
142 | ||
361c8ade | 143 | /* For regcache_read_pc see common/common-regcache.h. */ |
515630c5 UW |
144 | extern void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc); |
145 | ||
193cb69f AC |
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(). */ | |
149 | ||
9a661b68 | 150 | extern void regcache_raw_supply (struct regcache *regcache, |
6618125d | 151 | int regnum, const void *buf); |
9a661b68 | 152 | extern void regcache_raw_collect (const struct regcache *regcache, |
6618125d | 153 | int regnum, void *buf); |
193cb69f | 154 | |
0b309272 AA |
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: | |
158 | ||
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'. | |
163 | ||
164 | - If 'regno' is REGCACHE_MAP_SKIP: Add 'count*size' to the current | |
165 | offset. | |
166 | ||
167 | - If count=0: End of the map. */ | |
168 | ||
169 | struct regcache_map_entry | |
170 | { | |
171 | int count; | |
172 | int regno; | |
173 | int size; | |
174 | }; | |
175 | ||
176 | /* Special value for the 'regno' field in the struct above. */ | |
177 | ||
178 | enum | |
179 | { | |
180 | REGCACHE_MAP_SKIP = -1, | |
181 | }; | |
182 | ||
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'. | |
188 | ||
189 | These functions are suitable for the 'regset_supply' and | |
190 | 'regset_collect' fields in a regset structure. */ | |
191 | ||
192 | extern void regcache_supply_regset (const struct regset *regset, | |
193 | struct regcache *regcache, | |
194 | int regnum, const void *buf, | |
195 | size_t size); | |
196 | extern void regcache_collect_regset (const struct regset *regset, | |
197 | const struct regcache *regcache, | |
198 | int regnum, void *buf, size_t size); | |
199 | ||
193cb69f | 200 | |
bb425013 AC |
201 | /* The type of a register. This function is slightly more efficient |
202 | then its gdbarch vector counterpart since it returns a precomputed | |
01e1877c | 203 | value stored in a table. */ |
bb425013 AC |
204 | |
205 | extern struct type *register_type (struct gdbarch *gdbarch, int regnum); | |
206 | ||
207 | ||
08a617da | 208 | /* Return the size of register REGNUM. All registers should have only |
01e1877c | 209 | one size. */ |
08a617da AC |
210 | |
211 | extern int register_size (struct gdbarch *gdbarch, int regnum); | |
212 | ||
213 | ||
5602984a AC |
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. */ | |
218 | ||
05d1431c PA |
219 | typedef enum register_status (regcache_cooked_read_ftype) (void *src, |
220 | int regnum, | |
221 | gdb_byte *buf); | |
5602984a AC |
222 | |
223 | extern void regcache_save (struct regcache *dst, | |
224 | regcache_cooked_read_ftype *cooked_read, | |
2d522557 | 225 | void *cooked_read_context); |
2d28509a | 226 | |
37e71372 AC |
227 | /* Copy/duplicate the contents of a register cache. By default, the |
228 | operation is pass-through. Writes to DST and reads from SRC will | |
bd49952b | 229 | go through to the target. See also regcache_cpy_no_passthrough. |
37e71372 | 230 | |
bd49952b | 231 | regcache_cpy can not have overlapping SRC and DST buffers. */ |
3fadccb3 | 232 | |
3fadccb3 | 233 | extern struct regcache *regcache_dup (struct regcache *regcache); |
3fadccb3 | 234 | extern void regcache_cpy (struct regcache *dest, struct regcache *src); |
3fadccb3 | 235 | |
4e052eda | 236 | extern void registers_changed (void); |
e66408ed | 237 | extern void registers_changed_ptid (ptid_t); |
4e052eda | 238 | |
ed771251 AH |
239 | /* Dump the contents of a register from the register cache to the target |
240 | debug. */ | |
241 | extern void regcache_debug_print_register (const char *func, | |
242 | struct regcache *regcache, | |
243 | int regno); | |
244 | ||
4e052eda | 245 | #endif /* REGCACHE_H */ |