Home | History | Annotate | Line # | Download | only in gdbserver 
      1 /* Register support routines for the remote server for GDB.
      2    Copyright (C) 2001-2024 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 GDBSERVER_REGCACHE_H
     20 #define GDBSERVER_REGCACHE_H
     21 
     22 #include "gdbsupport/common-regcache.h"
     23 
     24 struct thread_info;
     25 struct target_desc;
     26 
     27 /* The data for the register cache.  Note that we have one per
     28    inferior; this is primarily for simplicity, as the performance
     29    benefit is minimal.  */
     30 
     31 struct regcache : public reg_buffer_common
     32 {
     33   /* The regcache's target description.  */
     34   const struct target_desc *tdesc = nullptr;
     35 
     36   /* Whether the REGISTERS buffer's contents are valid.  If false, we
     37      haven't fetched the registers from the target yet.  Not that this
     38      register cache is _not_ pass-through, unlike GDB's.  Note that
     39      "valid" here is unrelated to whether the registers are available
     40      in a traceframe.  For that, check REGISTER_STATUS below.  */
     41   int registers_valid = 0;
     42   int registers_owned = 0;
     43   unsigned char *registers = nullptr;
     44 #ifndef IN_PROCESS_AGENT
     45   /* One of REG_UNAVAILABLE or REG_VALID.  */
     46   unsigned char *register_status = nullptr;
     47 #endif
     48 
     49   /* See gdbsupport/common-regcache.h.  */
     50   enum register_status get_register_status (int regnum) const override;
     51 
     52   /* See gdbsupport/common-regcache.h.  */
     53   void raw_supply (int regnum, gdb::array_view<const gdb_byte> src) override;
     54 
     55   /* See gdbsupport/common-regcache.h.  */
     56   void raw_collect (int regnum, gdb::array_view<gdb_byte> dst) const override;
     57 
     58   /* See gdbsupport/common-regcache.h.  */
     59   bool raw_compare (int regnum, const void *buf, int offset) const override;
     60 };
     61 
     62 struct regcache *init_register_cache (struct regcache *regcache,
     63 				      const struct target_desc *tdesc,
     64 				      unsigned char *regbuf);
     65 
     66 void regcache_cpy (struct regcache *dst, struct regcache *src);
     67 
     68 /* Create a new register cache for INFERIOR.  */
     69 
     70 struct regcache *new_register_cache (const struct target_desc *tdesc);
     71 
     72 struct regcache *get_thread_regcache (struct thread_info *thread, int fetch);
     73 
     74 /* Release all memory associated with the register cache for INFERIOR.  */
     75 
     76 void free_register_cache (struct regcache *regcache);
     77 
     78 /* Invalidate cached registers for one thread.  */
     79 
     80 void regcache_invalidate_thread (struct thread_info *);
     81 
     82 /* Invalidate cached registers for all threads of the given process.  */
     83 
     84 void regcache_invalidate_pid (int pid);
     85 
     86 /* Invalidate cached registers for all threads of the current
     87    process.  */
     88 
     89 void regcache_invalidate (void);
     90 
     91 /* Invalidate and release the register cache of all threads of the
     92    current process.  */
     93 
     94 void regcache_release (void);
     95 
     96 /* Convert all registers to a string in the currently specified remote
     97    format.  */
     98 
     99 void registers_to_string (struct regcache *regcache, char *buf);
    100 
    101 /* Convert a string to register values and fill our register cache.  */
    102 
    103 void registers_from_string (struct regcache *regcache, char *buf);
    104 
    105 /* For regcache_read_pc see gdbsupport/common-regcache.h.  */
    106 
    107 void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc);
    108 
    109 int register_cache_size (const struct target_desc *tdesc);
    110 
    111 int register_size (const struct target_desc *tdesc, int n);
    112 
    113 /* No throw version of find_regno.  If NAME is not a known register, return
    114    an empty value.  */
    115 std::optional<int> find_regno_no_throw (const struct target_desc *tdesc,
    116 					const char *name);
    117 
    118 int find_regno (const struct target_desc *tdesc, const char *name);
    119 
    120 void supply_register (struct regcache *regcache, int n, const void *buf);
    121 
    122 void supply_register_zeroed (struct regcache *regcache, int n);
    123 
    124 void supply_register_by_name (struct regcache *regcache,
    125 			      const char *name, const void *buf);
    126 
    127 void supply_register_by_name_zeroed (struct regcache *regcache,
    128 				     const char *name);
    129 
    130 void supply_regblock (struct regcache *regcache, const void *buf);
    131 
    132 void collect_register (struct regcache *regcache, int n, void *buf);
    133 
    134 void collect_register_as_string (struct regcache *regcache, int n, char *buf);
    135 
    136 void collect_register_by_name (struct regcache *regcache,
    137 			       const char *name, void *buf);
    138 
    139 /* Read a raw register as an unsigned integer.  Convenience wrapper
    140    around regcache_raw_get_unsigned that takes a register name instead
    141    of a register number.  */
    142 
    143 ULONGEST regcache_raw_get_unsigned_by_name (struct regcache *regcache,
    144 					    const char *name);
    145 
    146 #endif /* GDBSERVER_REGCACHE_H */
    147