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    FIXME: cagney/2002-11-07: The get_saved_register() function, when
  98    specifying the real location of a register, does so using that
  99    registers offset in the register cache.  That offset is then used
 100    by valops.c to determine the location of the register.  The code
 101    should instead use the register's number and a location expression
 102    to describe a value spread across multiple registers or memory.  */
 103
 104 extern int register_offset_hack (struct gdbarch *gdbarch, int regnum);
 105
 106
 107 /* The type of a register.  This function is slightly more efficient
 108    then its gdbarch vector counterpart since it returns a precomputed
 109    value stored in a table.
 110
 111    NOTE: cagney/2002-08-17: The original macro was called
 112    REGISTER_VIRTUAL_TYPE.  This was because the register could have
 113    different raw and cooked (nee virtual) representations.  The
 114    CONVERTABLE methods being used to convert between the two
 115    representations.  Current code does not do this.  Instead, the
 116    first [0..NUM_REGS) registers are 1:1 raw:cooked, and the type
 117    exactly describes the register's representation.  Consequently, the
 118    ``virtual'' has been dropped.
 119
 120    FIXME: cagney/2002-08-17: A number of architectures, including the
 121    MIPS, are currently broken in this regard.  */
 122
 123 extern struct type *register_type (struct gdbarch *gdbarch, int regnum);
 124
 125
 126 /* Return the size of the largest register.  Used when allocating
 127    space for an aribtrary register value.  */
 128
 129 extern int max_register_size (struct gdbarch *gdbarch);
 130
 131
 132 /* DEPRECATED: Character array containing an image of the inferior
 133    programs' registers for the most recently referenced thread. */
 134
 135 extern char *registers;
 136
 137 /* Copy/duplicate the contents of a register cache.  By default, the
 138    operation is pass-through.  Writes to DST and reads from SRC will
 139    go through to the target.
 140
 141    The ``cpy'' functions can not have overlapping SRC and DST buffers.
 142
 143    ``no passthrough'' versions do not go through to the target.  They
 144    only transfer values already in the cache.  */
 145
 146 extern struct regcache *regcache_dup (struct regcache *regcache);
 147 extern struct regcache *regcache_dup_no_passthrough (struct regcache *regcache);
 148 extern void regcache_cpy (struct regcache *dest, struct regcache *src);
 149 extern void regcache_cpy_no_passthrough (struct regcache *dest, struct regcache *src);
 150
 151 /* NOTE: cagney/2002-11-02: The below have been superseded by the
 152    regcache_cooked_*() functions found above, and the frame_*()
 153    functions found in "frame.h".  Take care though, often more than a
 154    simple substitution is required when updating the code.  The
 155    change, as far as practical, should avoid adding references to
 156    global variables (e.g., current_regcache, current_frame,
 157    current_gdbarch or selected_frame) and instead refer to the FRAME
 158    or REGCACHE that has been passed into the containing function as
 159    parameters.  Consequently, the change typically involves modifying
 160    the containing function so that it takes a FRAME or REGCACHE
 161    parameter.  In the case of an architecture vector method, there
 162    should already be a non-deprecated variant that is parameterized
 163    with FRAME or REGCACHE.  */
 164
 165 extern char *deprecated_grub_regcache_for_registers (struct regcache *);
 166 extern char *deprecated_grub_regcache_for_register_valid (struct regcache *);
 167 extern void deprecated_read_register_gen (int regnum, char *myaddr);
 168 extern void deprecated_write_register_gen (int regnum, char *myaddr);
 169
 170 /* Character array containing the current state of each register
 171    (unavailable<0, invalid=0, valid>0) for the most recently
 172    referenced thread.  This global is often found in close proximity
 173    to code that is directly manipulating the deprecated_registers[]
 174    array.  In such cases, it should be possible to replace the lot
 175    with a call to supply_register().  If you find yourself in dire
 176    straits, still needing access to the cache status bit, the
 177    regcache_valid_p() and set_register_cached() functions are
 178    available.  */
 179 extern signed char *deprecated_register_valid;
 180
 181 /* NOTE: cagney/2002-11-05: This function, and its co-conspirator
 182    deprecated_registers[], have been superseeded by supply_register().  */
 183 extern void deprecated_registers_fetched (void);
 184
 185 extern int register_cached (int regnum);
 186
 187 extern void set_register_cached (int regnum, int state);
 188
 189 extern void registers_changed (void);
 190
 191
 192 extern void read_register_bytes (int regbyte, char *myaddr, int len);
 193
 194 extern void write_register_bytes (int regbyte, char *myaddr, int len);
 195
 196 /* Rename to read_unsigned_register()? */
 197 extern ULONGEST read_register (int regnum);
 198
 199 /* Rename to read_unsigned_register_pid()? */
 200 extern ULONGEST read_register_pid (int regnum, ptid_t ptid);
 201
 202 extern LONGEST read_signed_register (int regnum);
 203
 204 extern LONGEST read_signed_register_pid (int regnum, ptid_t ptid);
 205
 206 extern void write_register (int regnum, LONGEST val);
 207
 208 extern void write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid);
 209
 210 #endif /* REGCACHE_H */