Commit | Line | Data |
---|---|---|
4e052eda | 1 | /* Cache and manage the values of registers for GDB, the GNU debugger. |
3fadccb3 | 2 | |
e2882c85 | 3 | Copyright (C) 1986-2018 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 | 23 | #include "common-regcache.h" |
e521e87e | 24 | #include <forward_list> |
361c8ade | 25 | |
3fadccb3 | 26 | struct regcache; |
a01cbb49 | 27 | struct regset; |
3fadccb3 | 28 | struct gdbarch; |
6c95b8df | 29 | struct address_space; |
3fadccb3 | 30 | |
594f7785 UW |
31 | extern struct regcache *get_current_regcache (void); |
32 | extern struct regcache *get_thread_regcache (ptid_t ptid); | |
c2250ad1 | 33 | extern struct regcache *get_thread_arch_regcache (ptid_t, struct gdbarch *); |
e2d96639 YQ |
34 | extern struct regcache *get_thread_arch_aspace_regcache (ptid_t, |
35 | struct gdbarch *, | |
36 | struct address_space *); | |
3fadccb3 | 37 | |
05d1431c PA |
38 | extern enum register_status |
39 | regcache_raw_read_signed (struct regcache *regcache, | |
40 | int regnum, LONGEST *val); | |
d0e59a68 | 41 | |
c00dcbe9 MK |
42 | extern void regcache_raw_write_signed (struct regcache *regcache, |
43 | int regnum, LONGEST val); | |
44 | extern void regcache_raw_write_unsigned (struct regcache *regcache, | |
45 | int regnum, ULONGEST val); | |
06c0b04e | 46 | |
9fd15b2e YQ |
47 | /* Return the register's value in signed or throw if it's not |
48 | available. */ | |
49 | ||
50 | extern LONGEST regcache_raw_get_signed (struct regcache *regcache, | |
51 | int regnum); | |
52 | ||
a378f419 | 53 | /* Read a register as a signed/unsigned quantity. */ |
05d1431c PA |
54 | extern enum register_status |
55 | regcache_cooked_read_signed (struct regcache *regcache, | |
56 | int regnum, LONGEST *val); | |
57 | extern enum register_status | |
58 | regcache_cooked_read_unsigned (struct regcache *regcache, | |
59 | int regnum, ULONGEST *val); | |
a66a9c23 AC |
60 | extern void regcache_cooked_write_signed (struct regcache *regcache, |
61 | int regnum, LONGEST val); | |
62 | extern void regcache_cooked_write_unsigned (struct regcache *regcache, | |
63 | int regnum, ULONGEST val); | |
a378f419 | 64 | |
515630c5 UW |
65 | /* Special routines to read/write the PC. */ |
66 | ||
361c8ade | 67 | /* For regcache_read_pc see common/common-regcache.h. */ |
515630c5 UW |
68 | extern void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc); |
69 | ||
0b309272 AA |
70 | /* Mapping between register numbers and offsets in a buffer, for use |
71 | in the '*regset' functions below. In an array of | |
72 | 'regcache_map_entry' each element is interpreted like follows: | |
73 | ||
74 | - If 'regno' is a register number: Map register 'regno' to the | |
75 | current offset (starting with 0) and increase the current offset | |
76 | by 'size' (or the register's size, if 'size' is zero). Repeat | |
77 | this with consecutive register numbers up to 'regno+count-1'. | |
78 | ||
79 | - If 'regno' is REGCACHE_MAP_SKIP: Add 'count*size' to the current | |
80 | offset. | |
81 | ||
82 | - If count=0: End of the map. */ | |
83 | ||
84 | struct regcache_map_entry | |
85 | { | |
86 | int count; | |
87 | int regno; | |
88 | int size; | |
89 | }; | |
90 | ||
91 | /* Special value for the 'regno' field in the struct above. */ | |
92 | ||
93 | enum | |
94 | { | |
95 | REGCACHE_MAP_SKIP = -1, | |
96 | }; | |
97 | ||
98 | /* Transfer a set of registers (as described by REGSET) between | |
99 | REGCACHE and BUF. If REGNUM == -1, transfer all registers | |
100 | belonging to the regset, otherwise just the register numbered | |
101 | REGNUM. The REGSET's 'regmap' field must point to an array of | |
102 | 'struct regcache_map_entry'. | |
103 | ||
104 | These functions are suitable for the 'regset_supply' and | |
105 | 'regset_collect' fields in a regset structure. */ | |
106 | ||
107 | extern void regcache_supply_regset (const struct regset *regset, | |
108 | struct regcache *regcache, | |
109 | int regnum, const void *buf, | |
110 | size_t size); | |
111 | extern void regcache_collect_regset (const struct regset *regset, | |
112 | const struct regcache *regcache, | |
113 | int regnum, void *buf, size_t size); | |
114 | ||
193cb69f | 115 | |
bb425013 AC |
116 | /* The type of a register. This function is slightly more efficient |
117 | then its gdbarch vector counterpart since it returns a precomputed | |
01e1877c | 118 | value stored in a table. */ |
bb425013 AC |
119 | |
120 | extern struct type *register_type (struct gdbarch *gdbarch, int regnum); | |
121 | ||
122 | ||
08a617da | 123 | /* Return the size of register REGNUM. All registers should have only |
01e1877c | 124 | one size. */ |
08a617da AC |
125 | |
126 | extern int register_size (struct gdbarch *gdbarch, int regnum); | |
127 | ||
05d1431c PA |
128 | typedef enum register_status (regcache_cooked_read_ftype) (void *src, |
129 | int regnum, | |
130 | gdb_byte *buf); | |
5602984a | 131 | |
4fa847d7 AH |
132 | /* A (register_number, register_value) pair. */ |
133 | ||
134 | typedef struct cached_reg | |
135 | { | |
136 | int num; | |
137 | gdb_byte *data; | |
138 | } cached_reg_t; | |
139 | ||
31716595 YQ |
140 | /* Buffer of registers. */ |
141 | ||
9c861883 | 142 | class reg_buffer : public reg_buffer_common |
31716595 YQ |
143 | { |
144 | public: | |
145 | reg_buffer (gdbarch *gdbarch, bool has_pseudo); | |
146 | ||
147 | DISABLE_COPY_AND_ASSIGN (reg_buffer); | |
148 | ||
149 | /* Return regcache's architecture. */ | |
150 | gdbarch *arch () const; | |
151 | ||
9c861883 AH |
152 | /* See common/common-regcache.h. */ |
153 | enum register_status get_register_status (int regnum) const override; | |
154 | ||
155 | /* See common/common-regcache.h. */ | |
156 | void raw_collect (int regnum, void *buf) const override; | |
157 | ||
158 | /* Collect register REGNUM from REGCACHE. Store collected value as an integer | |
159 | at address ADDR, in target endian, with length ADDR_LEN and sign IS_SIGNED. | |
160 | If ADDR_LEN is greater than the register size, then the integer will be | |
161 | sign or zero extended. If ADDR_LEN is smaller than the register size, then | |
162 | the most significant bytes of the integer will be truncated. */ | |
163 | void raw_collect_integer (int regnum, gdb_byte *addr, int addr_len, | |
164 | bool is_signed) const; | |
165 | ||
166 | /* See common/common-regcache.h. */ | |
167 | void raw_supply (int regnum, const void *buf) override; | |
168 | ||
169 | void raw_supply (int regnum, const reg_buffer &src) | |
170 | { | |
171 | raw_supply (regnum, src.register_buffer (regnum)); | |
172 | } | |
173 | ||
174 | /* Supply register REGNUM to REGCACHE. Value to supply is an integer stored | |
175 | at address ADDR, in target endian, with length ADDR_LEN and sign IS_SIGNED. | |
176 | If the register size is greater than ADDR_LEN, then the integer will be | |
177 | sign or zero extended. If the register size is smaller than the integer, | |
178 | then the most significant bytes of the integer will be truncated. */ | |
179 | void raw_supply_integer (int regnum, const gdb_byte *addr, int addr_len, | |
180 | bool is_signed); | |
181 | ||
182 | /* Supply register REGNUM with zeroed value to REGCACHE. This is not the same | |
183 | as calling raw_supply with NULL (which will set the state to | |
184 | unavailable). */ | |
185 | void raw_supply_zeroed (int regnum); | |
186 | ||
187 | void invalidate (int regnum); | |
c8ec2f33 | 188 | |
835dcf92 SM |
189 | virtual ~reg_buffer () = default; |
190 | ||
f868386e AH |
191 | /* See common/common-regcache.h. */ |
192 | bool raw_compare (int regnum, const void *buf, int offset) const override; | |
193 | ||
31716595 YQ |
194 | protected: |
195 | /* Assert on the range of REGNUM. */ | |
196 | void assert_regnum (int regnum) const; | |
197 | ||
198 | int num_raw_registers () const; | |
199 | ||
200 | gdb_byte *register_buffer (int regnum) const; | |
201 | ||
daf6667d YQ |
202 | /* Save a register cache. The set of registers saved into the |
203 | regcache determined by the save_reggroup. COOKED_READ returns | |
204 | zero iff the register's value can't be returned. */ | |
205 | void save (regcache_cooked_read_ftype *cooked_read, void *src); | |
206 | ||
31716595 YQ |
207 | struct regcache_descr *m_descr; |
208 | ||
209 | bool m_has_pseudo; | |
210 | /* The register buffers. */ | |
835dcf92 | 211 | std::unique_ptr<gdb_byte[]> m_registers; |
31716595 | 212 | /* Register cache status. */ |
835dcf92 | 213 | std::unique_ptr<register_status[]> m_register_status; |
daf6667d YQ |
214 | |
215 | friend class regcache; | |
c8ec2f33 | 216 | friend class detached_regcache; |
31716595 YQ |
217 | }; |
218 | ||
849d0ba8 YQ |
219 | /* An abstract class which only has methods doing read. */ |
220 | ||
221 | class readable_regcache : public reg_buffer | |
222 | { | |
223 | public: | |
224 | readable_regcache (gdbarch *gdbarch, bool has_pseudo) | |
225 | : reg_buffer (gdbarch, has_pseudo) | |
226 | {} | |
227 | ||
0b883586 SM |
228 | /* Transfer a raw register [0..NUM_REGS) from core-gdb to this regcache, |
229 | return its value in *BUF and return its availability status. */ | |
230 | ||
849d0ba8 YQ |
231 | enum register_status raw_read (int regnum, gdb_byte *buf); |
232 | template<typename T, typename = RequireLongest<T>> | |
233 | enum register_status raw_read (int regnum, T *val); | |
234 | ||
502fe83e | 235 | /* Partial transfer of raw registers. Return the status of the register. */ |
849d0ba8 YQ |
236 | enum register_status raw_read_part (int regnum, int offset, int len, |
237 | gdb_byte *buf); | |
238 | ||
0b47d985 | 239 | /* Make certain that the register REGNUM is up-to-date. */ |
849d0ba8 YQ |
240 | virtual void raw_update (int regnum) = 0; |
241 | ||
dca08e1f SM |
242 | /* Transfer a raw register [0..NUM_REGS+NUM_PSEUDO_REGS) from core-gdb to |
243 | this regcache, return its value in *BUF and return its availability status. */ | |
849d0ba8 YQ |
244 | enum register_status cooked_read (int regnum, gdb_byte *buf); |
245 | template<typename T, typename = RequireLongest<T>> | |
246 | enum register_status cooked_read (int regnum, T *val); | |
247 | ||
73bb0000 | 248 | /* Partial transfer of a cooked register. */ |
849d0ba8 YQ |
249 | enum register_status cooked_read_part (int regnum, int offset, int len, |
250 | gdb_byte *buf); | |
251 | ||
46a45e9d SM |
252 | /* Read register REGNUM from the regcache and return a new value. This |
253 | will call mark_value_bytes_unavailable as appropriate. */ | |
849d0ba8 YQ |
254 | struct value *cooked_read_value (int regnum); |
255 | ||
256 | protected: | |
257 | enum register_status read_part (int regnum, int offset, int len, void *in, | |
258 | bool is_raw); | |
259 | }; | |
260 | ||
c8ec2f33 YQ |
261 | /* Buffer of registers, can be read and written. */ |
262 | ||
263 | class detached_regcache : public readable_regcache | |
264 | { | |
265 | public: | |
266 | detached_regcache (gdbarch *gdbarch, bool has_pseudo) | |
267 | : readable_regcache (gdbarch, has_pseudo) | |
268 | {} | |
269 | ||
c8ec2f33 YQ |
270 | void raw_update (int regnum) override |
271 | {} | |
272 | ||
273 | DISABLE_COPY_AND_ASSIGN (detached_regcache); | |
274 | }; | |
275 | ||
daf6667d YQ |
276 | class readonly_detached_regcache; |
277 | ||
ef79d9a3 YQ |
278 | /* The register cache for storing raw register values. */ |
279 | ||
c8ec2f33 | 280 | class regcache : public detached_regcache |
ef79d9a3 YQ |
281 | { |
282 | public: | |
d6541620 | 283 | DISABLE_COPY_AND_ASSIGN (regcache); |
deb1fa3e | 284 | |
a01bda52 | 285 | /* Return REGCACHE's address space. */ |
8b86c959 | 286 | const address_space *aspace () const |
ef79d9a3 YQ |
287 | { |
288 | return m_aspace; | |
289 | } | |
290 | ||
daf6667d YQ |
291 | /* Restore 'this' regcache. The set of registers restored into |
292 | the regcache determined by the restore_reggroup. | |
293 | Writes to regcache will go through to the target. SRC is a | |
fc5b8736 | 294 | read-only register cache. */ |
daf6667d | 295 | void restore (readonly_detached_regcache *src); |
fc5b8736 | 296 | |
10eaee5f SM |
297 | /* Update the value of raw register REGNUM (in the range [0..NUM_REGS)) and |
298 | transfer its value to core-gdb. */ | |
299 | ||
ef79d9a3 YQ |
300 | void raw_write (int regnum, const gdb_byte *buf); |
301 | ||
6f98355c YQ |
302 | template<typename T, typename = RequireLongest<T>> |
303 | void raw_write (int regnum, T val); | |
ef79d9a3 | 304 | |
b66f5587 SM |
305 | /* Transfer of pseudo-registers. */ |
306 | void cooked_write (int regnum, const gdb_byte *buf); | |
307 | ||
6f98355c YQ |
308 | template<typename T, typename = RequireLongest<T>> |
309 | void cooked_write (int regnum, T val); | |
ef79d9a3 | 310 | |
849d0ba8 | 311 | void raw_update (int regnum) override; |
ef79d9a3 | 312 | |
4f0420fd SM |
313 | /* Partial transfer of raw registers. Perform read, modify, write style |
314 | operations. */ | |
ef79d9a3 YQ |
315 | void raw_write_part (int regnum, int offset, int len, const gdb_byte *buf); |
316 | ||
e4c4a59b SM |
317 | /* Partial transfer of a cooked register. Perform read, modify, write style |
318 | operations. */ | |
ef79d9a3 YQ |
319 | void cooked_write_part (int regnum, int offset, int len, |
320 | const gdb_byte *buf); | |
321 | ||
322 | void supply_regset (const struct regset *regset, | |
323 | int regnum, const void *buf, size_t size); | |
324 | ||
325 | ||
326 | void collect_regset (const struct regset *regset, int regnum, | |
327 | void *buf, size_t size) const; | |
328 | ||
222312d3 SM |
329 | /* Return REGCACHE's ptid. */ |
330 | ||
ef79d9a3 YQ |
331 | ptid_t ptid () const |
332 | { | |
222312d3 SM |
333 | gdb_assert (m_ptid != minus_one_ptid); |
334 | ||
ef79d9a3 YQ |
335 | return m_ptid; |
336 | } | |
337 | ||
338 | void set_ptid (const ptid_t ptid) | |
339 | { | |
340 | this->m_ptid = ptid; | |
341 | } | |
342 | ||
343 | /* Dump the contents of a register from the register cache to the target | |
344 | debug. */ | |
345 | void debug_print_register (const char *func, int regno); | |
346 | ||
e521e87e YQ |
347 | static void regcache_thread_ptid_changed (ptid_t old_ptid, ptid_t new_ptid); |
348 | protected: | |
796bb026 | 349 | regcache (gdbarch *gdbarch, const address_space *aspace_); |
e521e87e YQ |
350 | static std::forward_list<regcache *> current_regcache; |
351 | ||
352 | private: | |
ef79d9a3 | 353 | |
ef79d9a3 YQ |
354 | void transfer_regset (const struct regset *regset, |
355 | struct regcache *out_regcache, | |
356 | int regnum, const void *in_buf, | |
357 | void *out_buf, size_t size) const; | |
358 | ||
849d0ba8 YQ |
359 | enum register_status write_part (int regnum, int offset, int len, |
360 | const void *out, bool is_raw); | |
361 | ||
362 | ||
ef79d9a3 YQ |
363 | /* The address space of this register cache (for registers where it |
364 | makes sense, like PC or SP). */ | |
8b86c959 | 365 | const address_space * const m_aspace; |
ef79d9a3 | 366 | |
ef79d9a3 YQ |
367 | /* If this is a read-write cache, which thread's registers is |
368 | it connected to? */ | |
369 | ptid_t m_ptid; | |
370 | ||
371 | friend struct regcache * | |
372 | get_thread_arch_aspace_regcache (ptid_t ptid, struct gdbarch *gdbarch, | |
373 | struct address_space *aspace); | |
374 | ||
e521e87e YQ |
375 | friend void |
376 | registers_changed_ptid (ptid_t ptid); | |
ef79d9a3 YQ |
377 | }; |
378 | ||
daf6667d YQ |
379 | class readonly_detached_regcache : public readable_regcache |
380 | { | |
381 | public: | |
382 | readonly_detached_regcache (const regcache &src); | |
383 | ||
384 | /* Create a readonly regcache by getting contents from COOKED_READ. */ | |
385 | ||
386 | readonly_detached_regcache (gdbarch *gdbarch, | |
387 | regcache_cooked_read_ftype *cooked_read, | |
388 | void *src) | |
389 | : readable_regcache (gdbarch, true) | |
390 | { | |
391 | save (cooked_read, src); | |
392 | } | |
393 | ||
394 | DISABLE_COPY_AND_ASSIGN (readonly_detached_regcache); | |
395 | ||
396 | void raw_update (int regnum) override | |
397 | {} | |
398 | }; | |
cfb7e58b | 399 | |
4e052eda | 400 | extern void registers_changed (void); |
e66408ed | 401 | extern void registers_changed_ptid (ptid_t); |
4e052eda | 402 | |
4c74fe6b YQ |
403 | /* An abstract base class for register dump. */ |
404 | ||
405 | class register_dump | |
406 | { | |
407 | public: | |
408 | void dump (ui_file *file); | |
409 | virtual ~register_dump () = default; | |
410 | ||
411 | protected: | |
412 | register_dump (gdbarch *arch) | |
413 | : m_gdbarch (arch) | |
414 | {} | |
415 | ||
416 | /* Dump the register REGNUM contents. If REGNUM is -1, print the | |
417 | header. */ | |
418 | virtual void dump_reg (ui_file *file, int regnum) = 0; | |
419 | ||
420 | gdbarch *m_gdbarch; | |
421 | }; | |
422 | ||
4e052eda | 423 | #endif /* REGCACHE_H */ |