gdb/regcache.h

   1 /* Cache and manage the values of registers for GDB, the GNU debugger.
   2
   3    Copyright (C) 1986-2016 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef REGCACHE_H
  21 #define REGCACHE_H
  22
  23 #include "common-regcache.h"
  24
  25 struct regcache;
  26 struct regset;
  27 struct gdbarch;
  28 struct address_space;
  29
  30 extern struct regcache *get_current_regcache (void);
  31 extern struct regcache *get_thread_regcache (ptid_t ptid);
  32 extern struct regcache *get_thread_arch_regcache (ptid_t, struct gdbarch *);
  33 extern struct regcache *get_thread_arch_aspace_regcache (ptid_t,
  34                                                          struct gdbarch *,
  35                                                          struct address_space *);
  36
  37 void regcache_xfree (struct regcache *regcache);
  38 struct cleanup *make_cleanup_regcache_xfree (struct regcache *regcache);
  39 struct regcache *regcache_xmalloc (struct gdbarch *gdbarch,
  40                                    struct address_space *aspace);
  41
  42 /* Return REGCACHE's architecture.  */
  43
  44 extern struct gdbarch *get_regcache_arch (const struct regcache *regcache);
  45
  46 /* Return REGCACHE's address space.  */
  47
  48 extern struct address_space *get_regcache_aspace (const struct regcache *);
  49
  50 enum register_status regcache_register_status (const struct regcache *regcache,
  51                                                int regnum);
  52
  53 /* Transfer a raw register [0..NUM_REGS) between core-gdb and the
  54    regcache.  The read variants return the status of the register.  */
  55
  56 enum register_status regcache_raw_read (struct regcache *regcache,
  57                                         int rawnum, gdb_byte *buf);
  58 void regcache_raw_write (struct regcache *regcache, int rawnum,
  59                          const gdb_byte *buf);
  60 extern enum register_status
  61   regcache_raw_read_signed (struct regcache *regcache,
  62                             int regnum, LONGEST *val);
  63
  64 extern void regcache_raw_write_signed (struct regcache *regcache,
  65                                        int regnum, LONGEST val);
  66 extern void regcache_raw_write_unsigned (struct regcache *regcache,
  67                                          int regnum, ULONGEST val);
  68
  69 /* Set a raw register's value in the regcache's buffer.  Unlike
  70    regcache_raw_write, this is not write-through.  The intention is
  71    allowing to change the buffer contents of a read-only regcache
  72    allocated with regcache_xmalloc.  */
  73
  74 extern void regcache_raw_set_cached_value
  75   (struct regcache *regcache, int regnum, const gdb_byte *buf);
  76
  77 /* Partial transfer of raw registers.  These perform read, modify,
  78    write style operations.  The read variant returns the status of the
  79    register.  */
  80
  81 extern enum register_status
  82   regcache_raw_read_part (struct regcache *regcache, int regnum,
  83                           int offset, int len, gdb_byte *buf);
  84 void regcache_raw_write_part (struct regcache *regcache, int regnum,
  85                               int offset, int len, const gdb_byte *buf);
  86
  87 void regcache_invalidate (struct regcache *regcache, int regnum);
  88
  89 /* Transfer of pseudo-registers.  The read variants return a register
  90    status, as an indication of when a ``cooked'' register was
  91    constructed from valid, invalid or unavailable ``raw''
  92    registers.  */
  93
  94 /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS).  */
  95 enum register_status regcache_cooked_read (struct regcache *regcache,
  96                                            int rawnum, gdb_byte *buf);
  97 void regcache_cooked_write (struct regcache *regcache, int rawnum,
  98                             const gdb_byte *buf);
  99
 100 /* Read register REGNUM from REGCACHE and return a new value.  This
 101    will call mark_value_bytes_unavailable as appropriate.  */
 102
 103 struct value *regcache_cooked_read_value (struct regcache *regcache,
 104                                           int regnum);
 105
 106 /* Read a register as a signed/unsigned quantity.  */
 107 extern enum register_status
 108   regcache_cooked_read_signed (struct regcache *regcache,
 109                                int regnum, LONGEST *val);
 110 extern enum register_status
 111   regcache_cooked_read_unsigned (struct regcache *regcache,
 112                                  int regnum, ULONGEST *val);
 113 extern void regcache_cooked_write_signed (struct regcache *regcache,
 114                                           int regnum, LONGEST val);
 115 extern void regcache_cooked_write_unsigned (struct regcache *regcache,
 116                                             int regnum, ULONGEST val);
 117
 118 /* Partial transfer of a cooked register.  These perform read, modify,
 119    write style operations.  */
 120
 121 enum register_status regcache_cooked_read_part (struct regcache *regcache,
 122                                                 int regnum, int offset,
 123                                                 int len, gdb_byte *buf);
 124 void regcache_cooked_write_part (struct regcache *regcache, int regnum,
 125                                  int offset, int len, const gdb_byte *buf);
 126
 127 /* Special routines to read/write the PC.  */
 128
 129 /* For regcache_read_pc see common/common-regcache.h.  */
 130 extern void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc);
 131
 132 /* Transfer a raw register [0..NUM_REGS) between the regcache and the
 133    target.  These functions are called by the target in response to a
 134    target_fetch_registers() or target_store_registers().  */
 135
 136 extern void regcache_raw_supply (struct regcache *regcache,
 137                                  int regnum, const void *buf);
 138 extern void regcache_raw_collect (const struct regcache *regcache,
 139                                   int regnum, void *buf);
 140
 141 /* Mapping between register numbers and offsets in a buffer, for use
 142    in the '*regset' functions below.  In an array of
 143    'regcache_map_entry' each element is interpreted like follows:
 144
 145    - If 'regno' is a register number: Map register 'regno' to the
 146      current offset (starting with 0) and increase the current offset
 147      by 'size' (or the register's size, if 'size' is zero).  Repeat
 148      this with consecutive register numbers up to 'regno+count-1'.
 149
 150    - If 'regno' is REGCACHE_MAP_SKIP: Add 'count*size' to the current
 151      offset.
 152
 153    - If count=0: End of the map.  */
 154
 155 struct regcache_map_entry
 156 {
 157   int count;
 158   int regno;
 159   int size;
 160 };
 161
 162 /* Special value for the 'regno' field in the struct above.  */
 163
 164 enum
 165   {
 166     REGCACHE_MAP_SKIP = -1,
 167   };
 168
 169 /* Transfer a set of registers (as described by REGSET) between
 170    REGCACHE and BUF.  If REGNUM == -1, transfer all registers
 171    belonging to the regset, otherwise just the register numbered
 172    REGNUM.  The REGSET's 'regmap' field must point to an array of
 173    'struct regcache_map_entry'.
 174
 175    These functions are suitable for the 'regset_supply' and
 176    'regset_collect' fields in a regset structure.  */
 177
 178 extern void regcache_supply_regset (const struct regset *regset,
 179                                     struct regcache *regcache,
 180                                     int regnum, const void *buf,
 181                                     size_t size);
 182 extern void regcache_collect_regset (const struct regset *regset,
 183                                      const struct regcache *regcache,
 184                                      int regnum, void *buf, size_t size);
 185
 186
 187 /* The type of a register.  This function is slightly more efficient
 188    then its gdbarch vector counterpart since it returns a precomputed
 189    value stored in a table.  */
 190
 191 extern struct type *register_type (struct gdbarch *gdbarch, int regnum);
 192
 193
 194 /* Return the size of register REGNUM.  All registers should have only
 195    one size.  */
 196
 197 extern int register_size (struct gdbarch *gdbarch, int regnum);
 198
 199
 200 /* Save/restore a register cache.  The set of registers saved /
 201    restored into the DST regcache determined by the save_reggroup /
 202    restore_reggroup respectively.  COOKED_READ returns zero iff the
 203    register's value can't be returned.  */
 204
 205 typedef enum register_status (regcache_cooked_read_ftype) (void *src,
 206                                                            int regnum,
 207                                                            gdb_byte *buf);
 208
 209 extern void regcache_save (struct regcache *dst,
 210                            regcache_cooked_read_ftype *cooked_read,
 211                            void *cooked_read_context);
 212
 213 /* Copy/duplicate the contents of a register cache.  By default, the
 214    operation is pass-through.  Writes to DST and reads from SRC will
 215    go through to the target.  See also regcache_cpy_no_passthrough.
 216
 217    regcache_cpy can not have overlapping SRC and DST buffers.  */
 218
 219 extern struct regcache *regcache_dup (struct regcache *regcache);
 220 extern void regcache_cpy (struct regcache *dest, struct regcache *src);
 221
 222 extern void registers_changed (void);
 223 extern void registers_changed_ptid (ptid_t);
 224
 225 #endif /* REGCACHE_H */