Commit | Line | Data |
---|---|---|
4e052eda | 1 | /* Cache and manage the values of registers for GDB, the GNU debugger. |
3fadccb3 AC |
2 | |
3 | Copyright 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000, | |
4 | 2001, 2002 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 | |
10 | the Free Software Foundation; either version 2 of the License, or | |
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 | |
19 | along with this program; if not, write to the Free Software | |
20 | Foundation, Inc., 59 Temple Place - Suite 330, | |
21 | Boston, MA 02111-1307, USA. */ | |
22 | ||
23 | #ifndef REGCACHE_H | |
24 | #define REGCACHE_H | |
25 | ||
3fadccb3 AC |
26 | struct regcache; |
27 | struct gdbarch; | |
28 | ||
29 | extern struct regcache *current_regcache; | |
30 | ||
31 | void regcache_xfree (struct regcache *regcache); | |
36160dc4 | 32 | struct cleanup *make_cleanup_regcache_xfree (struct regcache *regcache); |
3fadccb3 AC |
33 | struct regcache *regcache_xmalloc (struct gdbarch *gdbarch); |
34 | ||
61a0eb5b AC |
35 | /* Transfer a raw register [0..NUM_REGS) between core-gdb and the |
36 | regcache. */ | |
37 | ||
1aaa5f99 AC |
38 | void regcache_raw_read (struct regcache *regcache, int rawnum, void *buf); |
39 | void regcache_raw_write (struct regcache *regcache, int rawnum, | |
40 | const void *buf); | |
28fc6740 AC |
41 | extern void regcache_raw_read_signed (struct regcache *regcache, |
42 | int regnum, LONGEST *val); | |
43 | extern void regcache_raw_read_unsigned (struct regcache *regcache, | |
44 | int regnum, ULONGEST *val); | |
c00dcbe9 MK |
45 | extern void regcache_raw_write_signed (struct regcache *regcache, |
46 | int regnum, LONGEST val); | |
47 | extern void regcache_raw_write_unsigned (struct regcache *regcache, | |
48 | int regnum, ULONGEST val); | |
06c0b04e AC |
49 | |
50 | /* Partial transfer of a raw registers. These perform read, modify, | |
51 | write style operations. */ | |
52 | ||
53 | void regcache_raw_read_part (struct regcache *regcache, int regnum, | |
54 | int offset, int len, void *buf); | |
55 | void regcache_raw_write_part (struct regcache *regcache, int regnum, | |
56 | int offset, int len, const void *buf); | |
57 | ||
3fadccb3 | 58 | int regcache_valid_p (struct regcache *regcache, int regnum); |
61a0eb5b | 59 | |
68365089 AC |
60 | /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */ |
61 | void regcache_cooked_read (struct regcache *regcache, int rawnum, void *buf); | |
62 | void regcache_cooked_write (struct regcache *regcache, int rawnum, | |
63 | const void *buf); | |
64 | ||
a378f419 AC |
65 | /* NOTE: cagney/2002-08-13: At present GDB has no reliable mechanism |
66 | for indicating when a ``cooked'' register was constructed from | |
67 | invalid or unavailable ``raw'' registers. One fairly easy way of | |
68 | adding such a mechanism would be for the cooked functions to return | |
69 | a register valid indication. Given the possibility of such a | |
70 | change, the extract functions below use a reference parameter, | |
71 | rather than a function result. */ | |
72 | ||
73 | /* Read a register as a signed/unsigned quantity. */ | |
74 | extern void regcache_cooked_read_signed (struct regcache *regcache, | |
75 | int regnum, LONGEST *val); | |
76 | extern void regcache_cooked_read_unsigned (struct regcache *regcache, | |
77 | int regnum, ULONGEST *val); | |
a66a9c23 AC |
78 | extern void regcache_cooked_write_signed (struct regcache *regcache, |
79 | int regnum, LONGEST val); | |
80 | extern void regcache_cooked_write_unsigned (struct regcache *regcache, | |
81 | int regnum, ULONGEST val); | |
a378f419 | 82 | |
06c0b04e AC |
83 | /* Partial transfer of a cooked register. These perform read, modify, |
84 | write style operations. */ | |
85 | ||
86 | void regcache_cooked_read_part (struct regcache *regcache, int regnum, | |
87 | int offset, int len, void *buf); | |
88 | void regcache_cooked_write_part (struct regcache *regcache, int regnum, | |
89 | int offset, int len, const void *buf); | |
90 | ||
193cb69f AC |
91 | /* Transfer a raw register [0..NUM_REGS) between the regcache and the |
92 | target. These functions are called by the target in response to a | |
93 | target_fetch_registers() or target_store_registers(). */ | |
94 | ||
1aaa5f99 | 95 | extern void supply_register (int regnum, const void *val); |
193cb69f | 96 | extern void regcache_collect (int regnum, void *buf); |
9a661b68 MK |
97 | extern void regcache_raw_supply (struct regcache *regcache, |
98 | int regnum, const void *buf); | |
99 | extern void regcache_raw_collect (const struct regcache *regcache, | |
100 | int regnum, void *buf); | |
193cb69f AC |
101 | |
102 | ||
d3b22ed5 AC |
103 | /* The register's ``offset''. |
104 | ||
ac2adee5 | 105 | FIXME: cagney/2002-11-07: The frame_register() function, when |
e600bd34 AC |
106 | specifying the real location of a register, does so using that |
107 | registers offset in the register cache. That offset is then used | |
108 | by valops.c to determine the location of the register. The code | |
109 | should instead use the register's number and a location expression | |
110 | to describe a value spread across multiple registers or memory. */ | |
d3b22ed5 AC |
111 | |
112 | extern int register_offset_hack (struct gdbarch *gdbarch, int regnum); | |
d3b22ed5 AC |
113 | |
114 | ||
bb425013 AC |
115 | /* The type of a register. This function is slightly more efficient |
116 | then its gdbarch vector counterpart since it returns a precomputed | |
117 | value stored in a table. | |
118 | ||
119 | NOTE: cagney/2002-08-17: The original macro was called | |
120 | REGISTER_VIRTUAL_TYPE. This was because the register could have | |
121 | different raw and cooked (nee virtual) representations. The | |
122 | CONVERTABLE methods being used to convert between the two | |
123 | representations. Current code does not do this. Instead, the | |
124 | first [0..NUM_REGS) registers are 1:1 raw:cooked, and the type | |
125 | exactly describes the register's representation. Consequently, the | |
126 | ``virtual'' has been dropped. | |
127 | ||
128 | FIXME: cagney/2002-08-17: A number of architectures, including the | |
129 | MIPS, are currently broken in this regard. */ | |
130 | ||
131 | extern struct type *register_type (struct gdbarch *gdbarch, int regnum); | |
132 | ||
133 | ||
08a617da AC |
134 | /* Return the size of register REGNUM. All registers should have only |
135 | one size. | |
136 | ||
137 | FIXME: cagney/2003-02-28: | |
138 | ||
139 | Unfortunatly, thanks to some legacy architectures, this doesn't | |
140 | hold. A register's cooked (nee virtual) and raw size can differ | |
141 | (see MIPS). Such architectures should be using different register | |
142 | numbers for the different sized views of identical registers. | |
143 | ||
144 | Anyway, the up-shot is that, until that mess is fixed, core code | |
145 | can end up being very confused - should the RAW or VIRTUAL size be | |
146 | used? As a rule of thumb, use REGISTER_VIRTUAL_SIZE in cooked | |
147 | code, but with the comment: | |
148 | ||
149 | OK: REGISTER_VIRTUAL_SIZE | |
150 | ||
151 | or just | |
152 | ||
153 | OK | |
154 | ||
155 | appended to the end of the line. */ | |
156 | ||
157 | extern int register_size (struct gdbarch *gdbarch, int regnum); | |
158 | ||
159 | ||
5602984a AC |
160 | /* Save/restore a register cache. The set of registers saved / |
161 | restored into the DST regcache determined by the save_reggroup / | |
162 | restore_reggroup respectively. COOKED_READ returns zero iff the | |
163 | register's value can't be returned. */ | |
164 | ||
165 | typedef int (regcache_cooked_read_ftype) (void *src, int regnum, void *buf); | |
166 | ||
167 | extern void regcache_save (struct regcache *dst, | |
168 | regcache_cooked_read_ftype *cooked_read, | |
169 | void *src); | |
170 | extern void regcache_restore (struct regcache *dst, | |
171 | regcache_cooked_read_ftype *cooked_read, | |
172 | void *src); | |
2d28509a | 173 | |
37e71372 AC |
174 | /* Copy/duplicate the contents of a register cache. By default, the |
175 | operation is pass-through. Writes to DST and reads from SRC will | |
176 | go through to the target. | |
177 | ||
178 | The ``cpy'' functions can not have overlapping SRC and DST buffers. | |
3fadccb3 AC |
179 | |
180 | ``no passthrough'' versions do not go through to the target. They | |
37e71372 | 181 | only transfer values already in the cache. */ |
3fadccb3 | 182 | |
3fadccb3 | 183 | extern struct regcache *regcache_dup (struct regcache *regcache); |
3fadccb3 AC |
184 | extern struct regcache *regcache_dup_no_passthrough (struct regcache *regcache); |
185 | extern void regcache_cpy (struct regcache *dest, struct regcache *src); | |
186 | extern void regcache_cpy_no_passthrough (struct regcache *dest, struct regcache *src); | |
187 | ||
192dbe33 AC |
188 | /* NOTE: cagney/2002-11-02: The below have been superseded by the |
189 | regcache_cooked_*() functions found above, and the frame_*() | |
190 | functions found in "frame.h". Take care though, often more than a | |
191 | simple substitution is required when updating the code. The | |
192 | change, as far as practical, should avoid adding references to | |
193 | global variables (e.g., current_regcache, current_frame, | |
6e7f8b9c AC |
194 | current_gdbarch or deprecated_selected_frame) and instead refer to |
195 | the FRAME or REGCACHE that has been passed into the containing | |
196 | function as parameters. Consequently, the change typically | |
197 | involves modifying the containing function so that it takes a FRAME | |
198 | or REGCACHE parameter. In the case of an architecture vector | |
199 | method, there should already be a non-deprecated variant that is | |
200 | parameterized with FRAME or REGCACHE. */ | |
192dbe33 | 201 | |
3fadccb3 | 202 | extern char *deprecated_grub_regcache_for_registers (struct regcache *); |
192dbe33 AC |
203 | extern void deprecated_read_register_gen (int regnum, char *myaddr); |
204 | extern void deprecated_write_register_gen (int regnum, char *myaddr); | |
73937e03 AC |
205 | extern void deprecated_read_register_bytes (int regbyte, char *myaddr, |
206 | int len); | |
207 | extern void deprecated_write_register_bytes (int regbyte, char *myaddr, | |
208 | int len); | |
3fadccb3 | 209 | |
8262ee23 AC |
210 | /* Character array containing the current state of each register |
211 | (unavailable<0, invalid=0, valid>0) for the most recently | |
212 | referenced thread. This global is often found in close proximity | |
213 | to code that is directly manipulating the deprecated_registers[] | |
214 | array. In such cases, it should be possible to replace the lot | |
215 | with a call to supply_register(). If you find yourself in dire | |
216 | straits, still needing access to the cache status bit, the | |
217 | regcache_valid_p() and set_register_cached() functions are | |
218 | available. */ | |
219 | extern signed char *deprecated_register_valid; | |
220 | ||
524d7c18 AC |
221 | /* Character array containing an image of the inferior programs' |
222 | registers for the most recently referenced thread. | |
223 | ||
224 | NOTE: cagney/2002-11-14: Target side code should be using | |
225 | supply_register() and/or regcache_collect() while architecture side | |
226 | code should use the more generic regcache methods. */ | |
227 | ||
228 | extern char *deprecated_registers; | |
229 | ||
2b9e5f3f AC |
230 | /* NOTE: cagney/2002-11-05: This function, and its co-conspirator |
231 | deprecated_registers[], have been superseeded by supply_register(). */ | |
232 | extern void deprecated_registers_fetched (void); | |
233 | ||
4e052eda AC |
234 | extern int register_cached (int regnum); |
235 | ||
236 | extern void set_register_cached (int regnum, int state); | |
237 | ||
4e052eda AC |
238 | extern void registers_changed (void); |
239 | ||
4e052eda | 240 | |
4e052eda AC |
241 | /* Rename to read_unsigned_register()? */ |
242 | extern ULONGEST read_register (int regnum); | |
243 | ||
244 | /* Rename to read_unsigned_register_pid()? */ | |
39f77062 | 245 | extern ULONGEST read_register_pid (int regnum, ptid_t ptid); |
4e052eda | 246 | |
4e052eda AC |
247 | extern void write_register (int regnum, LONGEST val); |
248 | ||
39f77062 | 249 | extern void write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid); |
4e052eda | 250 | |
4e052eda | 251 | #endif /* REGCACHE_H */ |