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 /* Transfer a raw register [0..NUM_REGS) between core-gdb and the
38 void regcache_raw_read (struct regcache *regcache, int rawnum, void *buf);
39 void regcache_raw_write (struct regcache *regcache, int rawnum,
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);
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);
50 /* Partial transfer of a raw registers. These perform read, modify,
51 write style operations. */
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);
58 int regcache_valid_p (struct regcache *regcache, int regnum);
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,
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. */
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);
79 /* Partial transfer of a cooked register. These perform read, modify,
80 write style operations. */
82 void regcache_cooked_read_part (struct regcache *regcache, int regnum,
83 int offset, int len, void *buf);
84 void regcache_cooked_write_part (struct regcache *regcache, int regnum,
85 int offset, int len, const void *buf);
87 /* Transfer a raw register [0..NUM_REGS) between the regcache and the
88 target. These functions are called by the target in response to a
89 target_fetch_registers() or target_store_registers(). */
91 extern void supply_register (int regnum, const void *val);
92 extern void regcache_collect (int regnum, void *buf);
95 /* The register's ``offset''.
97 NOTE: cagney/2002-08-17: The ``struct value'' and expression
98 evaluator treat the register cache as a large liner buffer.
99 Instead of reading/writing a register using its register number,
100 the code read/writes registers by specifying their offset into the
101 buffer and a number of bytes. The code also assumes that these
102 byte read/writes can cross register boundaries, adjacent registers
103 treated as a contiguous set of bytes.
105 The below map that model onto the real register cache. New code
106 should go out of their way to avoid using these interfaces.
108 FIXME: cagney/2002-08-17: The ``struct value'' and expression
109 evaluator should be fixed. Instead of using the { offset, length }
110 pair to describe a value within one or more registers, the code
111 should use a chain of { regnum, offset, len } tripples. */
113 extern int register_offset_hack (struct gdbarch *gdbarch, int regnum);
114 extern void regcache_cooked_read_using_offset_hack (struct regcache *regcache,
117 extern void regcache_cooked_write_using_offset_hack (struct regcache *regcache,
122 /* The type of a register. This function is slightly more efficient
123 then its gdbarch vector counterpart since it returns a precomputed
124 value stored in a table.
126 NOTE: cagney/2002-08-17: The original macro was called
127 REGISTER_VIRTUAL_TYPE. This was because the register could have
128 different raw and cooked (nee virtual) representations. The
129 CONVERTABLE methods being used to convert between the two
130 representations. Current code does not do this. Instead, the
131 first [0..NUM_REGS) registers are 1:1 raw:cooked, and the type
132 exactly describes the register's representation. Consequently, the
133 ``virtual'' has been dropped.
135 FIXME: cagney/2002-08-17: A number of architectures, including the
136 MIPS, are currently broken in this regard. */
138 extern struct type *register_type (struct gdbarch *gdbarch, int regnum);
141 /* Return the size of the largest register. Used when allocating
142 space for an aribtrary register value. */
144 extern int max_register_size (struct gdbarch *gdbarch);
147 /* DEPRECATED: Character array containing an image of the inferior
148 programs' registers for the most recently referenced thread. */
150 extern char *registers;
152 /* DEPRECATED: Character array containing the current state of each
153 register (unavailable<0, invalid=0, valid>0) for the most recently
154 referenced thread. */
156 extern signed char *register_valid;
158 /* Copy/duplicate the contents of a register cache. By default, the
159 operation is pass-through. Writes to DST and reads from SRC will
160 go through to the target.
162 The ``cpy'' functions can not have overlapping SRC and DST buffers.
164 ``no passthrough'' versions do not go through to the target. They
165 only transfer values already in the cache. */
167 extern struct regcache *regcache_dup (struct regcache *regcache);
168 extern struct regcache *regcache_dup_no_passthrough (struct regcache *regcache);
169 extern void regcache_cpy (struct regcache *dest, struct regcache *src);
170 extern void regcache_cpy_no_passthrough (struct regcache *dest, struct regcache *src);
172 extern char *deprecated_grub_regcache_for_registers (struct regcache *);
173 extern char *deprecated_grub_regcache_for_register_valid (struct regcache *);
175 extern int register_cached (int regnum);
177 extern void set_register_cached (int regnum, int state);
179 extern void register_changed (int regnum);
181 extern void registers_changed (void);
183 extern void registers_fetched (void);
185 extern void read_register_bytes (int regbyte, char *myaddr, int len);
187 extern void deprecated_read_register_gen (int regnum, char *myaddr);
189 extern void deprecated_write_register_gen (int regnum, char *myaddr);
191 extern void write_register_bytes (int regbyte, char *myaddr, int len);
193 /* Rename to read_unsigned_register()? */
194 extern ULONGEST read_register (int regnum);
196 /* Rename to read_unsigned_register_pid()? */
197 extern ULONGEST read_register_pid (int regnum, ptid_t ptid);
199 extern LONGEST read_signed_register (int regnum);
201 extern LONGEST read_signed_register_pid (int regnum, ptid_t ptid);
203 extern void write_register (int regnum, LONGEST val);
205 extern void write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid);
207 #endif /* REGCACHE_H */