gdb/regcache.h

   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 /* Transfer a raw register [0..NUM_REGS) between core-gdb and the
  36    regcache. */
  37
  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);
  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
  46 /* Partial transfer of a raw registers.  These perform read, modify,
  47    write style operations.  */
  48
  49 void regcache_raw_read_part (struct regcache *regcache, int regnum,
  50                              int offset, int len, void *buf);
  51 void regcache_raw_write_part (struct regcache *regcache, int regnum,
  52                               int offset, int len, const void *buf);
  53
  54 int regcache_valid_p (struct regcache *regcache, int regnum);
  55
  56 /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS).  */
  57 void regcache_cooked_read (struct regcache *regcache, int rawnum, void *buf);
  58 void regcache_cooked_write (struct regcache *regcache, int rawnum,
  59                             const void *buf);
  60
  61 /* NOTE: cagney/2002-08-13: At present GDB has no reliable mechanism
  62    for indicating when a ``cooked'' register was constructed from
  63    invalid or unavailable ``raw'' registers.  One fairly easy way of
  64    adding such a mechanism would be for the cooked functions to return
  65    a register valid indication.  Given the possibility of such a
  66    change, the extract functions below use a reference parameter,
  67    rather than a function result.  */
  68
  69 /* Read a register as a signed/unsigned quantity.  */
  70 extern void regcache_cooked_read_signed (struct regcache *regcache,
  71                                          int regnum, LONGEST *val);
  72 extern void regcache_cooked_read_unsigned (struct regcache *regcache,
  73                                            int regnum, ULONGEST *val);
  74
  75 /* Partial transfer of a cooked register.  These perform read, modify,
  76    write style operations.  */
  77
  78 void regcache_cooked_read_part (struct regcache *regcache, int regnum,
  79                                 int offset, int len, void *buf);
  80 void regcache_cooked_write_part (struct regcache *regcache, int regnum,
  81                                  int offset, int len, const void *buf);
  82
  83 /* Transfer a raw register [0..NUM_REGS) between the regcache and the
  84    target.  These functions are called by the target in response to a
  85    target_fetch_registers() or target_store_registers().  */
  86
  87 extern void supply_register (int regnum, const void *val);
  88 extern void regcache_collect (int regnum, void *buf);
  89
  90
  91 /* The register's ``offset''.
  92
  93    NOTE: cagney/2002-08-17: The ``struct value'' and expression
  94    evaluator treat the register cache as a large liner buffer.
  95    Instead of reading/writing a register using its register number,
  96    the code read/writes registers by specifying their offset into the
  97    buffer and a number of bytes.  The code also assumes that these
  98    byte read/writes can cross register boundaries, adjacent registers
  99    treated as a contiguous set of bytes.
 100
 101    The below map that model onto the real register cache.  New code
 102    should go out of their way to avoid using these interfaces.
 103
 104    FIXME: cagney/2002-08-17: The ``struct value'' and expression
 105    evaluator should be fixed.  Instead of using the { offset, length }
 106    pair to describe a value within one or more registers, the code
 107    should use a chain of { regnum, offset, len } tripples.  */
 108
 109 extern int register_offset_hack (struct gdbarch *gdbarch, int regnum);
 110 extern void regcache_cooked_read_using_offset_hack (struct regcache *regcache,
 111                                                     int offset, int len,
 112                                                     void *buf);
 113 extern void regcache_cooked_write_using_offset_hack (struct regcache *regcache,
 114                                                      int offset, int len,
 115                                                      const void *buf);
 116
 117
 118 /* The type of a register.  This function is slightly more efficient
 119    then its gdbarch vector counterpart since it returns a precomputed
 120    value stored in a table.
 121
 122    NOTE: cagney/2002-08-17: The original macro was called
 123    REGISTER_VIRTUAL_TYPE.  This was because the register could have
 124    different raw and cooked (nee virtual) representations.  The
 125    CONVERTABLE methods being used to convert between the two
 126    representations.  Current code does not do this.  Instead, the
 127    first [0..NUM_REGS) registers are 1:1 raw:cooked, and the type
 128    exactly describes the register's representation.  Consequently, the
 129    ``virtual'' has been dropped.
 130
 131    FIXME: cagney/2002-08-17: A number of architectures, including the
 132    MIPS, are currently broken in this regard.  */
 133
 134 extern struct type *register_type (struct gdbarch *gdbarch, int regnum);
 135
 136
 137 /* Return the size of the largest register.  Used when allocating
 138    space for an aribtrary register value.  */
 139
 140 extern int max_register_size (struct gdbarch *gdbarch);
 141
 142
 143 /* DEPRECATED: Character array containing an image of the inferior
 144    programs' registers for the most recently referenced thread. */
 145
 146 extern char *registers;
 147
 148 /* DEPRECATED: Character array containing the current state of each
 149    register (unavailable<0, invalid=0, valid>0) for the most recently
 150    referenced thread. */
 151
 152 extern signed char *register_valid;
 153
 154 /* Copy/duplicate the contents of a register cache.  By default, the
 155    operation is pass-through.  Writes to DST and reads from SRC will
 156    go through to the target.
 157
 158    The ``cpy'' functions can not have overlapping SRC and DST buffers.
 159
 160    ``no passthrough'' versions do not go through to the target.  They
 161    only transfer values already in the cache.  */
 162
 163 extern struct regcache *regcache_dup (struct regcache *regcache);
 164 extern struct regcache *regcache_dup_no_passthrough (struct regcache *regcache);
 165 extern void regcache_cpy (struct regcache *dest, struct regcache *src);
 166 extern void regcache_cpy_no_passthrough (struct regcache *dest, struct regcache *src);
 167
 168 extern char *deprecated_grub_regcache_for_registers (struct regcache *);
 169 extern char *deprecated_grub_regcache_for_register_valid (struct regcache *);
 170
 171 extern int register_cached (int regnum);
 172
 173 extern void set_register_cached (int regnum, int state);
 174
 175 extern void register_changed (int regnum);
 176
 177 extern void registers_changed (void);
 178
 179 extern void registers_fetched (void);
 180
 181 extern void read_register_bytes (int regbyte, char *myaddr, int len);
 182
 183 extern void read_register_gen (int regnum, char *myaddr);
 184
 185 extern void write_register_gen (int regnum, char *myaddr);
 186
 187 extern void write_register_bytes (int regbyte, char *myaddr, int len);
 188
 189 /* Rename to read_unsigned_register()? */
 190 extern ULONGEST read_register (int regnum);
 191
 192 /* Rename to read_unsigned_register_pid()? */
 193 extern ULONGEST read_register_pid (int regnum, ptid_t ptid);
 194
 195 extern LONGEST read_signed_register (int regnum);
 196
 197 extern LONGEST read_signed_register_pid (int regnum, ptid_t ptid);
 198
 199 extern void write_register (int regnum, LONGEST val);
 200
 201 extern void write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid);
 202
 203 #endif /* REGCACHE_H */