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 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);
  49
  50 /* Partial transfer of a raw registers.  These perform read, modify,
  51    write style operations.  */
  52
  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);
  57
  58 int regcache_valid_p (struct regcache *regcache, int regnum);
  59
  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,
  63                             const void *buf);
  64
  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.  */
  72
  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);
  78
  79 /* Partial transfer of a cooked register.  These perform read, modify,
  80    write style operations.  */
  81
  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);
  86
  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().  */
  90
  91 extern void supply_register (int regnum, const void *val);
  92 extern void regcache_collect (int regnum, void *buf);
  93
  94
  95 /* The register's ``offset''.
  96
  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.
 104
 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.
 107
 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.  */
 112
 113 extern int register_offset_hack (struct gdbarch *gdbarch, int regnum);
 114 extern void regcache_cooked_read_using_offset_hack (struct regcache *regcache,
 115                                                     int offset, int len,
 116                                                     void *buf);
 117 extern void regcache_cooked_write_using_offset_hack (struct regcache *regcache,
 118                                                      int offset, int len,
 119                                                      const void *buf);
 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    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.
 134
 135    FIXME: cagney/2002-08-17: A number of architectures, including the
 136    MIPS, are currently broken in this regard.  */
 137
 138 extern struct type *register_type (struct gdbarch *gdbarch, int regnum);
 139
 140
 141 /* Return the size of the largest register.  Used when allocating
 142    space for an aribtrary register value.  */
 143
 144 extern int max_register_size (struct gdbarch *gdbarch);
 145
 146
 147 /* DEPRECATED: Character array containing an image of the inferior
 148    programs' registers for the most recently referenced thread. */
 149
 150 extern char *registers;
 151
 152 /* Copy/duplicate the contents of a register cache.  By default, the
 153    operation is pass-through.  Writes to DST and reads from SRC will
 154    go through to the target.
 155
 156    The ``cpy'' functions can not have overlapping SRC and DST buffers.
 157
 158    ``no passthrough'' versions do not go through to the target.  They
 159    only transfer values already in the cache.  */
 160
 161 extern struct regcache *regcache_dup (struct regcache *regcache);
 162 extern struct regcache *regcache_dup_no_passthrough (struct regcache *regcache);
 163 extern void regcache_cpy (struct regcache *dest, struct regcache *src);
 164 extern void regcache_cpy_no_passthrough (struct regcache *dest, struct regcache *src);
 165
 166 /* NOTE: cagney/2002-11-02: The below have been superseded by the
 167    regcache_cooked_*() functions found above, and the frame_*()
 168    functions found in "frame.h".  Take care though, often more than a
 169    simple substitution is required when updating the code.  The
 170    change, as far as practical, should avoid adding references to
 171    global variables (e.g., current_regcache, current_frame,
 172    current_gdbarch or selected_frame) and instead refer to the FRAME
 173    or REGCACHE that has been passed into the containing function as
 174    parameters.  Consequently, the change typically involves modifying
 175    the containing function so that it takes a FRAME or REGCACHE
 176    parameter.  In the case of an architecture vector method, there
 177    should already be a non-deprecated variant that is parameterized
 178    with FRAME or REGCACHE.  */
 179
 180 extern char *deprecated_grub_regcache_for_registers (struct regcache *);
 181 extern char *deprecated_grub_regcache_for_register_valid (struct regcache *);
 182 extern void deprecated_read_register_gen (int regnum, char *myaddr);
 183 extern void deprecated_write_register_gen (int regnum, char *myaddr);
 184
 185 /* Character array containing the current state of each register
 186    (unavailable<0, invalid=0, valid>0) for the most recently
 187    referenced thread.  This global is often found in close proximity
 188    to code that is directly manipulating the deprecated_registers[]
 189    array.  In such cases, it should be possible to replace the lot
 190    with a call to supply_register().  If you find yourself in dire
 191    straits, still needing access to the cache status bit, the
 192    regcache_valid_p() and set_register_cached() functions are
 193    available.  */
 194 extern signed char *deprecated_register_valid;
 195
 196 extern int register_cached (int regnum);
 197
 198 extern void set_register_cached (int regnum, int state);
 199
 200 extern void register_changed (int regnum);
 201
 202 extern void registers_changed (void);
 203
 204 extern void registers_fetched (void);
 205
 206 extern void read_register_bytes (int regbyte, char *myaddr, int len);
 207
 208 extern void write_register_bytes (int regbyte, char *myaddr, int len);
 209
 210 /* Rename to read_unsigned_register()? */
 211 extern ULONGEST read_register (int regnum);
 212
 213 /* Rename to read_unsigned_register_pid()? */
 214 extern ULONGEST read_register_pid (int regnum, ptid_t ptid);
 215
 216 extern LONGEST read_signed_register (int regnum);
 217
 218 extern LONGEST read_signed_register_pid (int regnum, ptid_t ptid);
 219
 220 extern void write_register (int regnum, LONGEST val);
 221
 222 extern void write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid);
 223
 224 #endif /* REGCACHE_H */