1 /* Cache and manage the values of registers for GDB, the GNU debugger. 2 3 Copyright 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000, 4 2001, 2002 Free Software Foundation, Inc. 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 26 struct regcache; 27 struct gdbarch; 28 29 extern struct regcache *current_regcache; 30 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); 34 35 /* Return REGCACHE's architecture. */ 36 37 extern struct gdbarch *get_regcache_arch (const struct regcache *regcache); 38 39 /* Transfer a raw register [0..NUM_REGS) between core-gdb and the 40 regcache. */ 41 42 void regcache_raw_read (struct regcache *regcache, int rawnum, gdb_byte *buf); 43 void regcache_raw_write (struct regcache *regcache, int rawnum, 44 const gdb_byte *buf); 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); 53 54 /* Partial transfer of a raw registers. These perform read, modify, 55 write style operations. */ 56 57 void regcache_raw_read_part (struct regcache *regcache, int regnum, 58 int offset, int len, gdb_byte *buf); 59 void regcache_raw_write_part (struct regcache *regcache, int regnum, 60 int offset, int len, const gdb_byte *buf); 61 62 int regcache_valid_p (struct regcache *regcache, int regnum); 63 64 /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */ 65 void regcache_cooked_read (struct regcache *regcache, int rawnum, 66 gdb_byte *buf); 67 void regcache_cooked_write (struct regcache *regcache, int rawnum, 68 const gdb_byte *buf); 69 70 /* NOTE: cagney/2002-08-13: At present GDB has no reliable mechanism 71 for indicating when a ``cooked'' register was constructed from 72 invalid or unavailable ``raw'' registers. One fairly easy way of 73 adding such a mechanism would be for the cooked functions to return 74 a register valid indication. Given the possibility of such a 75 change, the extract functions below use a reference parameter, 76 rather than a function result. */ 77 78 /* Read a register as a signed/unsigned quantity. */ 79 extern void regcache_cooked_read_signed (struct regcache *regcache, 80 int regnum, LONGEST *val); 81 extern void regcache_cooked_read_unsigned (struct regcache *regcache, 82 int regnum, ULONGEST *val); 83 extern void regcache_cooked_write_signed (struct regcache *regcache, 84 int regnum, LONGEST val); 85 extern void regcache_cooked_write_unsigned (struct regcache *regcache, 86 int regnum, ULONGEST val); 87 88 /* Partial transfer of a cooked register. These perform read, modify, 89 write style operations. */ 90 91 void regcache_cooked_read_part (struct regcache *regcache, int regnum, 92 int offset, int len, gdb_byte *buf); 93 void regcache_cooked_write_part (struct regcache *regcache, int regnum, 94 int offset, int len, const gdb_byte *buf); 95 96 /* Transfer a raw register [0..NUM_REGS) between the regcache and the 97 target. These functions are called by the target in response to a 98 target_fetch_registers() or target_store_registers(). */ 99 100 extern void regcache_raw_supply (struct regcache *regcache, 101 int regnum, const void *buf); 102 extern void regcache_raw_collect (const struct regcache *regcache, 103 int regnum, void *buf); 104 105 106 /* The register's ``offset''. 107 108 FIXME: cagney/2002-11-07: The frame_register() function, when 109 specifying the real location of a register, does so using that 110 registers offset in the register cache. That offset is then used 111 by valops.c to determine the location of the register. The code 112 should instead use the register's number and a location expression 113 to describe a value spread across multiple registers or memory. */ 114 115 extern int register_offset_hack (struct gdbarch *gdbarch, int regnum); 116 117 /* Similar. The total number of bytes occupied by a regcache. */ 118 119 extern int deprecated_register_bytes (void ); 120 121 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. */ 125 126 extern struct type *register_type (struct gdbarch *gdbarch, int regnum); 127 128 129 /* Return the size of register REGNUM. All registers should have only 130 one size. */ 131 132 extern int register_size (struct gdbarch *gdbarch, int regnum); 133 134 135 /* Save/restore a register cache. The set of registers saved / 136 restored into the DST regcache determined by the save_reggroup / 137 restore_reggroup respectively. COOKED_READ returns zero iff the 138 register's value can't be returned. */ 139 140 typedef int (regcache_cooked_read_ftype) (void *src, int regnum, 141 gdb_byte *buf); 142 143 extern void regcache_save (struct regcache *dst, 144 regcache_cooked_read_ftype *cooked_read, 145 void *cooked_read_context); 146 extern void regcache_restore (struct regcache *dst, 147 regcache_cooked_read_ftype *cooked_read, 148 void *cooked_read_context); 149 150 /* Copy/duplicate the contents of a register cache. By default, the 151 operation is pass-through. Writes to DST and reads from SRC will 152 go through to the target. 153 154 The ``cpy'' functions can not have overlapping SRC and DST buffers. 155 156 ``no passthrough'' versions do not go through to the target. They 157 only transfer values already in the cache. */ 158 159 extern struct regcache *regcache_dup (struct regcache *regcache); 160 extern struct regcache *regcache_dup_no_passthrough (struct regcache *regcache); 161 extern void regcache_cpy (struct regcache *dest, struct regcache *src); 162 extern void regcache_cpy_no_passthrough (struct regcache *dest, struct regcache *src); 163 164 /* NOTE: cagney/2002-11-02: The below have been superseded by the 165 regcache_cooked_*() functions found above, and the frame_*() 166 functions found in "frame.h". Take care though, often more than a 167 simple substitution is required when updating the code. The 168 change, as far as practical, should avoid adding references to 169 global variables (e.g., current_regcache, current_frame, 170 current_gdbarch or deprecated_selected_frame) and instead refer to 171 the FRAME or REGCACHE that has been passed into the containing 172 function as parameters. Consequently, the change typically 173 involves modifying the containing function so that it takes a FRAME 174 or REGCACHE parameter. In the case of an architecture vector 175 method, there should already be a non-deprecated variant that is 176 parameterized with FRAME or REGCACHE. */ 177 178 extern gdb_byte *deprecated_grub_regcache_for_registers (struct regcache *); 179 extern void deprecated_read_register_gen (int regnum, gdb_byte *myaddr); 180 extern void deprecated_write_register_gen (int regnum, gdb_byte *myaddr); 181 extern void deprecated_read_register_bytes (int regbyte, gdb_byte *myaddr, 182 int len); 183 extern void deprecated_write_register_bytes (int regbyte, gdb_byte *myaddr, 184 int len); 185 186 /* NOTE: cagney/2002-11-05: This function has been superseeded by 187 regcache_raw_supply(). */ 188 extern void deprecated_registers_fetched (void); 189 190 extern int register_cached (int regnum); 191 192 extern void set_register_cached (int regnum, int state); 193 194 extern void registers_changed (void); 195 196 197 /* Rename to read_unsigned_register()? */ 198 extern ULONGEST read_register (int regnum); 199 200 /* Rename to read_unsigned_register_pid()? */ 201 extern ULONGEST read_register_pid (int regnum, ptid_t ptid); 202 203 extern void write_register (int regnum, LONGEST val); 204 205 extern void write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid); 206 207 #endif /* REGCACHE_H */ 208