gdb/gdbserver/regcache.h

   1 /* Register support routines for the remote server for GDB.
   2    Copyright (C) 2001-2013 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef REGCACHE_H
  20 #define REGCACHE_H
  21
  22 struct inferior_list_entry;
  23 struct thread_info;
  24 struct target_desc;
  25
  26 /* The register exists, it has a value, but we don't know what it is.
  27    Used when inspecting traceframes.  */
  28 #define REG_UNAVAILABLE 0
  29
  30 /* We know the register's value (and we have it cached).  */
  31 #define REG_VALID 1
  32
  33 /* The data for the register cache.  Note that we have one per
  34    inferior; this is primarily for simplicity, as the performance
  35    benefit is minimal.  */
  36
  37 struct regcache
  38 {
  39   /* The regcache's target description.  */
  40   const struct target_desc *tdesc;
  41
  42   /* Whether the REGISTERS buffer's contents are valid.  If false, we
  43      haven't fetched the registers from the target yet.  Not that this
  44      register cache is _not_ pass-through, unlike GDB's.  Note that
  45      "valid" here is unrelated to whether the registers are available
  46      in a traceframe.  For that, check REGISTER_STATUS below.  */
  47   int registers_valid;
  48   int registers_owned;
  49   unsigned char *registers;
  50 #ifndef IN_PROCESS_AGENT
  51   /* One of REG_UNAVAILBLE or REG_VALID.  */
  52   unsigned char *register_status;
  53 #endif
  54 };
  55
  56 struct regcache *init_register_cache (struct regcache *regcache,
  57                                       const struct target_desc *tdesc,
  58                                       unsigned char *regbuf);
  59
  60 void regcache_cpy (struct regcache *dst, struct regcache *src);
  61
  62 /* Create a new register cache for INFERIOR.  */
  63
  64 struct regcache *new_register_cache (const struct target_desc *tdesc);
  65
  66 struct regcache *get_thread_regcache (struct thread_info *thread, int fetch);
  67
  68 /* Release all memory associated with the register cache for INFERIOR.  */
  69
  70 void free_register_cache (struct regcache *regcache);
  71
  72 /* Invalidate cached registers for one thread.  */
  73
  74 void regcache_invalidate_thread (struct thread_info *);
  75
  76 /* Invalidate cached registers for all threads of the current
  77    process.  */
  78
  79 void regcache_invalidate (void);
  80
  81 /* Invalidate and release the register cache of all threads of the
  82    current process.  */
  83
  84 void regcache_release (void);
  85
  86 /* Convert all registers to a string in the currently specified remote
  87    format.  */
  88
  89 void registers_to_string (struct regcache *regcache, char *buf);
  90
  91 /* Convert a string to register values and fill our register cache.  */
  92
  93 void registers_from_string (struct regcache *regcache, char *buf);
  94
  95 CORE_ADDR regcache_read_pc (struct regcache *regcache);
  96
  97 void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc);
  98
  99 /* Return a pointer to the description of register ``n''.  */
 100
 101 struct reg *find_register_by_number (const struct target_desc *tdesc, int n);
 102
 103 int register_cache_size (const struct target_desc *tdesc);
 104
 105 int register_size (const struct target_desc *tdesc, int n);
 106
 107 int find_regno (const struct target_desc *tdesc, const char *name);
 108
 109 void supply_register (struct regcache *regcache, int n, const void *buf);
 110
 111 void supply_register_zeroed (struct regcache *regcache, int n);
 112
 113 void supply_register_by_name (struct regcache *regcache,
 114                               const char *name, const void *buf);
 115
 116 void supply_regblock (struct regcache *regcache, const void *buf);
 117
 118 void collect_register (struct regcache *regcache, int n, void *buf);
 119
 120 void collect_register_as_string (struct regcache *regcache, int n, char *buf);
 121
 122 void collect_register_by_name (struct regcache *regcache,
 123                                const char *name, void *buf);
 124
 125 #endif /* REGCACHE_H */