Commit | Line | Data |
---|---|---|
4e052eda | 1 | /* Cache and manage the values of registers for GDB, the GNU debugger. |
3fadccb3 | 2 | |
6aba47ca DJ |
3 | Copyright (C) 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000, 2001, |
4 | 2002, 2007 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 | |
197e01b6 EZ |
20 | Foundation, Inc., 51 Franklin Street, Fifth Floor, |
21 | Boston, MA 02110-1301, USA. */ | |
4e052eda AC |
22 | |
23 | #ifndef REGCACHE_H | |
24 | #define REGCACHE_H | |
25 | ||
3fadccb3 AC |
26 | struct regcache; |
27 | struct gdbarch; | |
28 | ||
594f7785 UW |
29 | extern struct regcache *get_current_regcache (void); |
30 | extern struct regcache *get_thread_regcache (ptid_t ptid); | |
3fadccb3 AC |
31 | |
32 | void regcache_xfree (struct regcache *regcache); | |
36160dc4 | 33 | struct cleanup *make_cleanup_regcache_xfree (struct regcache *regcache); |
3fadccb3 AC |
34 | struct regcache *regcache_xmalloc (struct gdbarch *gdbarch); |
35 | ||
41d35cb0 MK |
36 | /* Return REGCACHE's architecture. */ |
37 | ||
38 | extern struct gdbarch *get_regcache_arch (const struct regcache *regcache); | |
39 | ||
61a0eb5b AC |
40 | /* Transfer a raw register [0..NUM_REGS) between core-gdb and the |
41 | regcache. */ | |
42 | ||
2d522557 | 43 | void regcache_raw_read (struct regcache *regcache, int rawnum, gdb_byte *buf); |
1aaa5f99 | 44 | void regcache_raw_write (struct regcache *regcache, int rawnum, |
2d522557 | 45 | const gdb_byte *buf); |
28fc6740 AC |
46 | extern void regcache_raw_read_signed (struct regcache *regcache, |
47 | int regnum, LONGEST *val); | |
48 | extern void regcache_raw_read_unsigned (struct regcache *regcache, | |
49 | int regnum, ULONGEST *val); | |
c00dcbe9 MK |
50 | extern void regcache_raw_write_signed (struct regcache *regcache, |
51 | int regnum, LONGEST val); | |
52 | extern void regcache_raw_write_unsigned (struct regcache *regcache, | |
53 | int regnum, ULONGEST val); | |
06c0b04e AC |
54 | |
55 | /* Partial transfer of a raw registers. These perform read, modify, | |
56 | write style operations. */ | |
57 | ||
58 | void regcache_raw_read_part (struct regcache *regcache, int regnum, | |
2d522557 | 59 | int offset, int len, gdb_byte *buf); |
06c0b04e | 60 | void regcache_raw_write_part (struct regcache *regcache, int regnum, |
2d522557 | 61 | int offset, int len, const gdb_byte *buf); |
06c0b04e | 62 | |
6ed7ea50 | 63 | int regcache_valid_p (const struct regcache *regcache, int regnum); |
61a0eb5b | 64 | |
9c5ea4d9 UW |
65 | void regcache_invalidate (struct regcache *regcache, int regnum); |
66 | ||
68365089 | 67 | /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */ |
2d522557 AC |
68 | void regcache_cooked_read (struct regcache *regcache, int rawnum, |
69 | gdb_byte *buf); | |
68365089 | 70 | void regcache_cooked_write (struct regcache *regcache, int rawnum, |
2d522557 | 71 | const gdb_byte *buf); |
68365089 | 72 | |
a378f419 AC |
73 | /* NOTE: cagney/2002-08-13: At present GDB has no reliable mechanism |
74 | for indicating when a ``cooked'' register was constructed from | |
75 | invalid or unavailable ``raw'' registers. One fairly easy way of | |
76 | adding such a mechanism would be for the cooked functions to return | |
77 | a register valid indication. Given the possibility of such a | |
78 | change, the extract functions below use a reference parameter, | |
79 | rather than a function result. */ | |
80 | ||
81 | /* Read a register as a signed/unsigned quantity. */ | |
82 | extern void regcache_cooked_read_signed (struct regcache *regcache, | |
83 | int regnum, LONGEST *val); | |
84 | extern void regcache_cooked_read_unsigned (struct regcache *regcache, | |
85 | int regnum, ULONGEST *val); | |
a66a9c23 AC |
86 | extern void regcache_cooked_write_signed (struct regcache *regcache, |
87 | int regnum, LONGEST val); | |
88 | extern void regcache_cooked_write_unsigned (struct regcache *regcache, | |
89 | int regnum, ULONGEST val); | |
a378f419 | 90 | |
06c0b04e AC |
91 | /* Partial transfer of a cooked register. These perform read, modify, |
92 | write style operations. */ | |
93 | ||
94 | void regcache_cooked_read_part (struct regcache *regcache, int regnum, | |
2d522557 | 95 | int offset, int len, gdb_byte *buf); |
06c0b04e | 96 | void regcache_cooked_write_part (struct regcache *regcache, int regnum, |
2d522557 | 97 | int offset, int len, const gdb_byte *buf); |
06c0b04e | 98 | |
193cb69f AC |
99 | /* Transfer a raw register [0..NUM_REGS) between the regcache and the |
100 | target. These functions are called by the target in response to a | |
101 | target_fetch_registers() or target_store_registers(). */ | |
102 | ||
9a661b68 | 103 | extern void regcache_raw_supply (struct regcache *regcache, |
6618125d | 104 | int regnum, const void *buf); |
9a661b68 | 105 | extern void regcache_raw_collect (const struct regcache *regcache, |
6618125d | 106 | int regnum, void *buf); |
193cb69f AC |
107 | |
108 | ||
d3b22ed5 AC |
109 | /* The register's ``offset''. |
110 | ||
ac2adee5 | 111 | FIXME: cagney/2002-11-07: The frame_register() function, when |
e600bd34 AC |
112 | specifying the real location of a register, does so using that |
113 | registers offset in the register cache. That offset is then used | |
114 | by valops.c to determine the location of the register. The code | |
115 | should instead use the register's number and a location expression | |
116 | to describe a value spread across multiple registers or memory. */ | |
d3b22ed5 AC |
117 | |
118 | extern int register_offset_hack (struct gdbarch *gdbarch, int regnum); | |
d3b22ed5 AC |
119 | |
120 | ||
bb425013 AC |
121 | /* The type of a register. This function is slightly more efficient |
122 | then its gdbarch vector counterpart since it returns a precomputed | |
01e1877c | 123 | value stored in a table. */ |
bb425013 AC |
124 | |
125 | extern struct type *register_type (struct gdbarch *gdbarch, int regnum); | |
126 | ||
127 | ||
08a617da | 128 | /* Return the size of register REGNUM. All registers should have only |
01e1877c | 129 | one size. */ |
08a617da AC |
130 | |
131 | extern int register_size (struct gdbarch *gdbarch, int regnum); | |
132 | ||
133 | ||
5602984a AC |
134 | /* Save/restore a register cache. The set of registers saved / |
135 | restored into the DST regcache determined by the save_reggroup / | |
136 | restore_reggroup respectively. COOKED_READ returns zero iff the | |
137 | register's value can't be returned. */ | |
138 | ||
2d522557 AC |
139 | typedef int (regcache_cooked_read_ftype) (void *src, int regnum, |
140 | gdb_byte *buf); | |
5602984a AC |
141 | |
142 | extern void regcache_save (struct regcache *dst, | |
143 | regcache_cooked_read_ftype *cooked_read, | |
2d522557 | 144 | void *cooked_read_context); |
5602984a AC |
145 | extern void regcache_restore (struct regcache *dst, |
146 | regcache_cooked_read_ftype *cooked_read, | |
2d522557 | 147 | void *cooked_read_context); |
2d28509a | 148 | |
37e71372 AC |
149 | /* Copy/duplicate the contents of a register cache. By default, the |
150 | operation is pass-through. Writes to DST and reads from SRC will | |
151 | go through to the target. | |
152 | ||
153 | The ``cpy'' functions can not have overlapping SRC and DST buffers. | |
3fadccb3 AC |
154 | |
155 | ``no passthrough'' versions do not go through to the target. They | |
37e71372 | 156 | only transfer values already in the cache. */ |
3fadccb3 | 157 | |
3fadccb3 | 158 | extern struct regcache *regcache_dup (struct regcache *regcache); |
3fadccb3 AC |
159 | extern struct regcache *regcache_dup_no_passthrough (struct regcache *regcache); |
160 | extern void regcache_cpy (struct regcache *dest, struct regcache *src); | |
161 | extern void regcache_cpy_no_passthrough (struct regcache *dest, struct regcache *src); | |
162 | ||
4e052eda AC |
163 | extern void registers_changed (void); |
164 | ||
4e052eda | 165 | #endif /* REGCACHE_H */ |