1 /* Cache and manage the values of registers for GDB, the GNU debugger.
3 Copyright 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000,
4 2001, 2002 Free Software Foundation, Inc.
6 This file is part of GDB.
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.
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.
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. */
29 extern struct regcache
*current_regcache
;
31 void regcache_xfree (struct regcache
*regcache
);
32 struct cleanup
*make_cleanup_regcache_xfree (struct regcache
*regcache
);
33 struct regcache
*regcache_xmalloc (struct gdbarch
*gdbarch
);
35 /* Return REGCACHE's architecture. */
37 extern struct gdbarch
*get_regcache_arch (const struct regcache
*regcache
);
39 /* Transfer a raw register [0..NUM_REGS) between core-gdb and the
42 void regcache_raw_read (struct regcache
*regcache
, int rawnum
, void *buf
);
43 void regcache_raw_write (struct regcache
*regcache
, int rawnum
,
45 extern void regcache_raw_read_signed (struct regcache
*regcache
,
46 int regnum
, LONGEST
*val
);
47 extern void regcache_raw_read_unsigned (struct regcache
*regcache
,
48 int regnum
, ULONGEST
*val
);
49 extern void regcache_raw_write_signed (struct regcache
*regcache
,
50 int regnum
, LONGEST val
);
51 extern void regcache_raw_write_unsigned (struct regcache
*regcache
,
52 int regnum
, ULONGEST val
);
54 /* Partial transfer of a raw registers. These perform read, modify,
55 write style operations. */
57 void regcache_raw_read_part (struct regcache
*regcache
, int regnum
,
58 int offset
, int len
, void *buf
);
59 void regcache_raw_write_part (struct regcache
*regcache
, int regnum
,
60 int offset
, int len
, const void *buf
);
62 int regcache_valid_p (struct regcache
*regcache
, int regnum
);
64 /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */
65 void regcache_cooked_read (struct regcache
*regcache
, int rawnum
, void *buf
);
66 void regcache_cooked_write (struct regcache
*regcache
, int rawnum
,
69 /* NOTE: cagney/2002-08-13: At present GDB has no reliable mechanism
70 for indicating when a ``cooked'' register was constructed from
71 invalid or unavailable ``raw'' registers. One fairly easy way of
72 adding such a mechanism would be for the cooked functions to return
73 a register valid indication. Given the possibility of such a
74 change, the extract functions below use a reference parameter,
75 rather than a function result. */
77 /* Read a register as a signed/unsigned quantity. */
78 extern void regcache_cooked_read_signed (struct regcache
*regcache
,
79 int regnum
, LONGEST
*val
);
80 extern void regcache_cooked_read_unsigned (struct regcache
*regcache
,
81 int regnum
, ULONGEST
*val
);
82 extern void regcache_cooked_write_signed (struct regcache
*regcache
,
83 int regnum
, LONGEST val
);
84 extern void regcache_cooked_write_unsigned (struct regcache
*regcache
,
85 int regnum
, ULONGEST val
);
87 /* Partial transfer of a cooked register. These perform read, modify,
88 write style operations. */
90 void regcache_cooked_read_part (struct regcache
*regcache
, int regnum
,
91 int offset
, int len
, void *buf
);
92 void regcache_cooked_write_part (struct regcache
*regcache
, int regnum
,
93 int offset
, int len
, const void *buf
);
95 /* Transfer a raw register [0..NUM_REGS) between the regcache and the
96 target. These functions are called by the target in response to a
97 target_fetch_registers() or target_store_registers(). */
99 extern void regcache_raw_supply (struct regcache
*regcache
,
100 int regnum
, const void *buf
);
101 extern void regcache_raw_collect (const struct regcache
*regcache
,
102 int regnum
, void *buf
);
105 /* The register's ``offset''.
107 FIXME: cagney/2002-11-07: The frame_register() function, when
108 specifying the real location of a register, does so using that
109 registers offset in the register cache. That offset is then used
110 by valops.c to determine the location of the register. The code
111 should instead use the register's number and a location expression
112 to describe a value spread across multiple registers or memory. */
114 extern int register_offset_hack (struct gdbarch
*gdbarch
, int regnum
);
117 /* The type of a register. This function is slightly more efficient
118 then its gdbarch vector counterpart since it returns a precomputed
119 value stored in a table. */
121 extern struct type
*register_type (struct gdbarch
*gdbarch
, int regnum
);
124 /* Return the size of register REGNUM. All registers should have only
127 extern int register_size (struct gdbarch
*gdbarch
, int regnum
);
130 /* Save/restore a register cache. The set of registers saved /
131 restored into the DST regcache determined by the save_reggroup /
132 restore_reggroup respectively. COOKED_READ returns zero iff the
133 register's value can't be returned. */
135 typedef int (regcache_cooked_read_ftype
) (void *src
, int regnum
, void *buf
);
137 extern void regcache_save (struct regcache
*dst
,
138 regcache_cooked_read_ftype
*cooked_read
,
140 extern void regcache_restore (struct regcache
*dst
,
141 regcache_cooked_read_ftype
*cooked_read
,
144 /* Copy/duplicate the contents of a register cache. By default, the
145 operation is pass-through. Writes to DST and reads from SRC will
146 go through to the target.
148 The ``cpy'' functions can not have overlapping SRC and DST buffers.
150 ``no passthrough'' versions do not go through to the target. They
151 only transfer values already in the cache. */
153 extern struct regcache
*regcache_dup (struct regcache
*regcache
);
154 extern struct regcache
*regcache_dup_no_passthrough (struct regcache
*regcache
);
155 extern void regcache_cpy (struct regcache
*dest
, struct regcache
*src
);
156 extern void regcache_cpy_no_passthrough (struct regcache
*dest
, struct regcache
*src
);
158 /* NOTE: cagney/2002-11-02: The below have been superseded by the
159 regcache_cooked_*() functions found above, and the frame_*()
160 functions found in "frame.h". Take care though, often more than a
161 simple substitution is required when updating the code. The
162 change, as far as practical, should avoid adding references to
163 global variables (e.g., current_regcache, current_frame,
164 current_gdbarch or deprecated_selected_frame) and instead refer to
165 the FRAME or REGCACHE that has been passed into the containing
166 function as parameters. Consequently, the change typically
167 involves modifying the containing function so that it takes a FRAME
168 or REGCACHE parameter. In the case of an architecture vector
169 method, there should already be a non-deprecated variant that is
170 parameterized with FRAME or REGCACHE. */
172 extern char *deprecated_grub_regcache_for_registers (struct regcache
*);
173 extern void deprecated_read_register_gen (int regnum
, char *myaddr
);
174 extern void deprecated_write_register_gen (int regnum
, char *myaddr
);
175 extern void deprecated_read_register_bytes (int regbyte
, char *myaddr
,
177 extern void deprecated_write_register_bytes (int regbyte
, char *myaddr
,
180 /* Character array containing the current state of each register
181 (unavailable<0, invalid=0, valid>0) for the most recently
182 referenced thread. This global is often found in close proximity
183 to code that is directly manipulating the deprecated_registers[]
184 array. In such cases, it should be possible to replace the lot
185 with a call to regcache_raw_supply(). If you find yourself in dire
186 straits, still needing access to the cache status bit, the
187 regcache_valid_p() and set_register_cached() functions are
189 extern signed char *deprecated_register_valid
;
191 /* Character array containing an image of the inferior programs'
192 registers for the most recently referenced thread.
194 NOTE: cagney/2002-11-14: Target side code should be using
195 regcache_raw_supply() and/or regcache_collect() while architecture
196 side code should use the more generic regcache methods. */
198 extern char *deprecated_registers
;
200 /* NOTE: cagney/2002-11-05: This function, and its co-conspirator
201 deprecated_registers[], have been superseeded by
202 regcache_raw_supply(). */
203 extern void deprecated_registers_fetched (void);
205 extern int register_cached (int regnum
);
207 extern void set_register_cached (int regnum
, int state
);
209 extern void registers_changed (void);
212 /* Rename to read_unsigned_register()? */
213 extern ULONGEST
read_register (int regnum
);
215 /* Rename to read_unsigned_register_pid()? */
216 extern ULONGEST
read_register_pid (int regnum
, ptid_t ptid
);
218 extern void write_register (int regnum
, LONGEST val
);
220 extern void write_register_pid (int regnum
, CORE_ADDR val
, ptid_t ptid
);
222 #endif /* REGCACHE_H */