gdb/regcache.h

   1 /* Cache and manage the values of registers for GDB, the GNU debugger.
   2
   3    Copyright (C) 1986-2015 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
  51   {
  52     /* The register value is not in the cache, and we don't know yet
  53        whether it's available in the target (or traceframe).  */
  54     REG_UNKNOWN = 0,
  55
  56     /* The register value is valid and cached.  */
  57     REG_VALID = 1,
  58
  59     /* The register value is unavailable.  E.g., we're inspecting a
  60        traceframe, and this register wasn't collected.  Note that this
  61        is different a different "unavailable" from saying the register
  62        does not exist in the target's architecture --- in that case,
  63        the target should have given us a target description that does
  64        not include the register in the first place.  */
  65     REG_UNAVAILABLE = -1
  66   };
  67
  68 enum register_status regcache_register_status (const struct regcache *regcache,
  69                                                int regnum);
  70
  71 /* Transfer a raw register [0..NUM_REGS) between core-gdb and the
  72    regcache.  The read variants return the status of the register.  */
  73
  74 enum register_status regcache_raw_read (struct regcache *regcache,
  75                                         int rawnum, gdb_byte *buf);
  76 void regcache_raw_write (struct regcache *regcache, int rawnum,
  77                          const gdb_byte *buf);
  78 extern enum register_status
  79   regcache_raw_read_signed (struct regcache *regcache,
  80                             int regnum, LONGEST *val);
  81 extern enum register_status
  82   regcache_raw_read_unsigned (struct regcache *regcache,
  83                               int regnum, ULONGEST *val);
  84
  85 ULONGEST regcache_raw_get_unsigned (struct regcache *regcache,
  86                                     int regnum);
  87
  88 extern void regcache_raw_write_signed (struct regcache *regcache,
  89                                        int regnum, LONGEST val);
  90 extern void regcache_raw_write_unsigned (struct regcache *regcache,
  91                                          int regnum, ULONGEST val);
  92
  93 /* Partial transfer of raw registers.  These perform read, modify,
  94    write style operations.  The read variant returns the status of the
  95    register.  */
  96
  97 extern enum register_status
  98   regcache_raw_read_part (struct regcache *regcache, int regnum,
  99                           int offset, int len, gdb_byte *buf);
 100 void regcache_raw_write_part (struct regcache *regcache, int regnum,
 101                               int offset, int len, const gdb_byte *buf);
 102
 103 void regcache_invalidate (struct regcache *regcache, int regnum);
 104
 105 /* Transfer of pseudo-registers.  The read variants return a register
 106    status, as an indication of when a ``cooked'' register was
 107    constructed from valid, invalid or unavailable ``raw''
 108    registers.  */
 109
 110 /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS).  */
 111 enum register_status regcache_cooked_read (struct regcache *regcache,
 112                                            int rawnum, gdb_byte *buf);
 113 void regcache_cooked_write (struct regcache *regcache, int rawnum,
 114                             const gdb_byte *buf);
 115
 116 /* Read register REGNUM from REGCACHE and return a new value.  This
 117    will call mark_value_bytes_unavailable as appropriate.  */
 118
 119 struct value *regcache_cooked_read_value (struct regcache *regcache,
 120                                           int regnum);
 121
 122 /* Read a register as a signed/unsigned quantity.  */
 123 extern enum register_status
 124   regcache_cooked_read_signed (struct regcache *regcache,
 125                                int regnum, LONGEST *val);
 126 extern enum register_status
 127   regcache_cooked_read_unsigned (struct regcache *regcache,
 128                                  int regnum, ULONGEST *val);
 129 extern void regcache_cooked_write_signed (struct regcache *regcache,
 130                                           int regnum, LONGEST val);
 131 extern void regcache_cooked_write_unsigned (struct regcache *regcache,
 132                                             int regnum, ULONGEST val);
 133
 134 /* Partial transfer of a cooked register.  These perform read, modify,
 135    write style operations.  */
 136
 137 enum register_status regcache_cooked_read_part (struct regcache *regcache,
 138                                                 int regnum, int offset,
 139                                                 int len, gdb_byte *buf);
 140 void regcache_cooked_write_part (struct regcache *regcache, int regnum,
 141                                  int offset, int len, const gdb_byte *buf);
 142
 143 /* Special routines to read/write the PC.  */
 144
 145 /* For regcache_read_pc see common/common-regcache.h.  */
 146 extern void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc);
 147
 148 /* Transfer a raw register [0..NUM_REGS) between the regcache and the
 149    target.  These functions are called by the target in response to a
 150    target_fetch_registers() or target_store_registers().  */
 151
 152 extern void regcache_raw_supply (struct regcache *regcache,
 153                                  int regnum, const void *buf);
 154 extern void regcache_raw_collect (const struct regcache *regcache,
 155                                   int regnum, void *buf);
 156
 157 /* Mapping between register numbers and offsets in a buffer, for use
 158    in the '*regset' functions below.  In an array of
 159    'regcache_map_entry' each element is interpreted like follows:
 160
 161    - If 'regno' is a register number: Map register 'regno' to the
 162      current offset (starting with 0) and increase the current offset
 163      by 'size' (or the register's size, if 'size' is zero).  Repeat
 164      this with consecutive register numbers up to 'regno+count-1'.
 165
 166    - If 'regno' is REGCACHE_MAP_SKIP: Add 'count*size' to the current
 167      offset.
 168
 169    - If count=0: End of the map.  */
 170
 171 struct regcache_map_entry
 172 {
 173   int count;
 174   int regno;
 175   int size;
 176 };
 177
 178 /* Special value for the 'regno' field in the struct above.  */
 179
 180 enum
 181   {
 182     REGCACHE_MAP_SKIP = -1,
 183   };
 184
 185 /* Transfer a set of registers (as described by REGSET) between
 186    REGCACHE and BUF.  If REGNUM == -1, transfer all registers
 187    belonging to the regset, otherwise just the register numbered
 188    REGNUM.  The REGSET's 'regmap' field must point to an array of
 189    'struct regcache_map_entry'.
 190
 191    These functions are suitable for the 'regset_supply' and
 192    'regset_collect' fields in a regset structure.  */
 193
 194 extern void regcache_supply_regset (const struct regset *regset,
 195                                     struct regcache *regcache,
 196                                     int regnum, const void *buf,
 197                                     size_t size);
 198 extern void regcache_collect_regset (const struct regset *regset,
 199                                      const struct regcache *regcache,
 200                                      int regnum, void *buf, size_t size);
 201
 202
 203 /* The type of a register.  This function is slightly more efficient
 204    then its gdbarch vector counterpart since it returns a precomputed
 205    value stored in a table.  */
 206
 207 extern struct type *register_type (struct gdbarch *gdbarch, int regnum);
 208
 209
 210 /* Return the size of register REGNUM.  All registers should have only
 211    one size.  */
 212
 213 extern int register_size (struct gdbarch *gdbarch, int regnum);
 214
 215
 216 /* Save/restore a register cache.  The set of registers saved /
 217    restored into the DST regcache determined by the save_reggroup /
 218    restore_reggroup respectively.  COOKED_READ returns zero iff the
 219    register's value can't be returned.  */
 220
 221 typedef enum register_status (regcache_cooked_read_ftype) (void *src,
 222                                                            int regnum,
 223                                                            gdb_byte *buf);
 224
 225 extern void regcache_save (struct regcache *dst,
 226                            regcache_cooked_read_ftype *cooked_read,
 227                            void *cooked_read_context);
 228
 229 /* Copy/duplicate the contents of a register cache.  By default, the
 230    operation is pass-through.  Writes to DST and reads from SRC will
 231    go through to the target.  See also regcache_cpy_no_passthrough.
 232
 233    regcache_cpy can not have overlapping SRC and DST buffers.  */
 234
 235 extern struct regcache *regcache_dup (struct regcache *regcache);
 236 extern void regcache_cpy (struct regcache *dest, struct regcache *src);
 237
 238 extern void registers_changed (void);
 239 extern void registers_changed_ptid (ptid_t);
 240
 241 #endif /* REGCACHE_H */