Commit | Line | Data |
---|---|---|
4e052eda | 1 | /* Cache and manage the values of registers for GDB, the GNU debugger. |
3fadccb3 | 2 | |
0b302171 JB |
3 | Copyright (C) 1986-1987, 1989, 1991, 1994-1996, 1998, 2000-2002, |
4 | 2007-2012 Free Software Foundation, Inc. | |
4e052eda AC |
5 | |
6 | This file is part of GDB. | |
7 | ||
8 | This program is free software; you can redistribute it and/or modify | |
9 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 10 | the Free Software Foundation; either version 3 of the License, or |
4e052eda AC |
11 | (at your option) any later version. |
12 | ||
13 | This program is distributed in the hope that it will be useful, | |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
17 | ||
18 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 19 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
4e052eda AC |
20 | |
21 | #ifndef REGCACHE_H | |
22 | #define REGCACHE_H | |
23 | ||
3fadccb3 AC |
24 | struct regcache; |
25 | struct gdbarch; | |
6c95b8df | 26 | struct address_space; |
3fadccb3 | 27 | |
594f7785 UW |
28 | extern struct regcache *get_current_regcache (void); |
29 | extern struct regcache *get_thread_regcache (ptid_t ptid); | |
c2250ad1 | 30 | extern struct regcache *get_thread_arch_regcache (ptid_t, struct gdbarch *); |
e2d96639 YQ |
31 | extern struct regcache *get_thread_arch_aspace_regcache (ptid_t, |
32 | struct gdbarch *, | |
33 | struct address_space *); | |
3fadccb3 AC |
34 | |
35 | void regcache_xfree (struct regcache *regcache); | |
36160dc4 | 36 | struct cleanup *make_cleanup_regcache_xfree (struct regcache *regcache); |
d37346f0 DJ |
37 | struct regcache *regcache_xmalloc (struct gdbarch *gdbarch, |
38 | struct address_space *aspace); | |
3fadccb3 | 39 | |
41d35cb0 MK |
40 | /* Return REGCACHE's architecture. */ |
41 | ||
42 | extern struct gdbarch *get_regcache_arch (const struct regcache *regcache); | |
43 | ||
6c95b8df PA |
44 | /* Return REGCACHE's address space. */ |
45 | ||
3e43a32a | 46 | extern struct address_space *get_regcache_aspace (const struct regcache *); |
6c95b8df | 47 | |
ee99023e PA |
48 | enum register_status |
49 | { | |
50 | /* The register value is not in the cache, and we don't know yet | |
51 | whether it's available in the target (or traceframe). */ | |
52 | REG_UNKNOWN = 0, | |
53 | ||
54 | /* The register value is valid and cached. */ | |
55 | REG_VALID = 1, | |
56 | ||
57 | /* The register value is unavailable. E.g., we're inspecting a | |
58 | traceframe, and this register wasn't collected. Note that this | |
59 | is different a different "unavailable" from saying the register | |
60 | does not exist in the target's architecture --- in that case, | |
61 | the target should have given us a target description that does | |
62 | not include the register in the first place. */ | |
63 | REG_UNAVAILABLE = -1 | |
64 | }; | |
65 | ||
66 | enum register_status regcache_register_status (const struct regcache *regcache, | |
67 | int regnum); | |
68 | ||
61a0eb5b | 69 | /* Transfer a raw register [0..NUM_REGS) between core-gdb and the |
05d1431c | 70 | regcache. The read variants return the status of the register. */ |
61a0eb5b | 71 | |
05d1431c PA |
72 | enum register_status regcache_raw_read (struct regcache *regcache, |
73 | int rawnum, gdb_byte *buf); | |
1aaa5f99 | 74 | void regcache_raw_write (struct regcache *regcache, int rawnum, |
2d522557 | 75 | const gdb_byte *buf); |
05d1431c PA |
76 | extern enum register_status |
77 | regcache_raw_read_signed (struct regcache *regcache, | |
78 | int regnum, LONGEST *val); | |
79 | extern enum register_status | |
80 | regcache_raw_read_unsigned (struct regcache *regcache, | |
81 | int regnum, ULONGEST *val); | |
c00dcbe9 MK |
82 | extern void regcache_raw_write_signed (struct regcache *regcache, |
83 | int regnum, LONGEST val); | |
84 | extern void regcache_raw_write_unsigned (struct regcache *regcache, | |
85 | int regnum, ULONGEST val); | |
06c0b04e | 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 | ||
139 | extern CORE_ADDR regcache_read_pc (struct regcache *regcache); | |
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 AC |
150 | |
151 | ||
bb425013 AC |
152 | /* The type of a register. This function is slightly more efficient |
153 | then its gdbarch vector counterpart since it returns a precomputed | |
01e1877c | 154 | value stored in a table. */ |
bb425013 AC |
155 | |
156 | extern struct type *register_type (struct gdbarch *gdbarch, int regnum); | |
157 | ||
158 | ||
08a617da | 159 | /* Return the size of register REGNUM. All registers should have only |
01e1877c | 160 | one size. */ |
08a617da AC |
161 | |
162 | extern int register_size (struct gdbarch *gdbarch, int regnum); | |
163 | ||
164 | ||
5602984a AC |
165 | /* Save/restore a register cache. The set of registers saved / |
166 | restored into the DST regcache determined by the save_reggroup / | |
167 | restore_reggroup respectively. COOKED_READ returns zero iff the | |
168 | register's value can't be returned. */ | |
169 | ||
05d1431c PA |
170 | typedef enum register_status (regcache_cooked_read_ftype) (void *src, |
171 | int regnum, | |
172 | gdb_byte *buf); | |
5602984a AC |
173 | |
174 | extern void regcache_save (struct regcache *dst, | |
175 | regcache_cooked_read_ftype *cooked_read, | |
2d522557 | 176 | void *cooked_read_context); |
2d28509a | 177 | |
37e71372 AC |
178 | /* Copy/duplicate the contents of a register cache. By default, the |
179 | operation is pass-through. Writes to DST and reads from SRC will | |
180 | go through to the target. | |
181 | ||
182 | The ``cpy'' functions can not have overlapping SRC and DST buffers. | |
3fadccb3 AC |
183 | |
184 | ``no passthrough'' versions do not go through to the target. They | |
37e71372 | 185 | only transfer values already in the cache. */ |
3fadccb3 | 186 | |
3fadccb3 | 187 | extern struct regcache *regcache_dup (struct regcache *regcache); |
3fadccb3 | 188 | extern void regcache_cpy (struct regcache *dest, struct regcache *src); |
3e43a32a MS |
189 | extern void regcache_cpy_no_passthrough (struct regcache *dest, |
190 | struct regcache *src); | |
3fadccb3 | 191 | |
4e052eda | 192 | extern void registers_changed (void); |
e66408ed | 193 | extern void registers_changed_ptid (ptid_t); |
4e052eda | 194 | |
4e052eda | 195 | #endif /* REGCACHE_H */ |