| 1 | /* Register support routines for the remote server for GDB. |
| 2 | Copyright (C) 2001-2015 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 | #include "common-regcache.h" |
| 23 | |
| 24 | struct thread_info; |
| 25 | struct target_desc; |
| 26 | |
| 27 | /* The register exists, it has a value, but we don't know what it is. |
| 28 | Used when inspecting traceframes. */ |
| 29 | #define REG_UNAVAILABLE 0 |
| 30 | |
| 31 | /* We know the register's value (and we have it cached). */ |
| 32 | #define REG_VALID 1 |
| 33 | |
| 34 | /* The data for the register cache. Note that we have one per |
| 35 | inferior; this is primarily for simplicity, as the performance |
| 36 | benefit is minimal. */ |
| 37 | |
| 38 | struct regcache |
| 39 | { |
| 40 | /* The regcache's target description. */ |
| 41 | const struct target_desc *tdesc; |
| 42 | |
| 43 | /* Whether the REGISTERS buffer's contents are valid. If false, we |
| 44 | haven't fetched the registers from the target yet. Not that this |
| 45 | register cache is _not_ pass-through, unlike GDB's. Note that |
| 46 | "valid" here is unrelated to whether the registers are available |
| 47 | in a traceframe. For that, check REGISTER_STATUS below. */ |
| 48 | int registers_valid; |
| 49 | int registers_owned; |
| 50 | unsigned char *registers; |
| 51 | #ifndef IN_PROCESS_AGENT |
| 52 | /* One of REG_UNAVAILBLE or REG_VALID. */ |
| 53 | unsigned char *register_status; |
| 54 | #endif |
| 55 | }; |
| 56 | |
| 57 | struct regcache *init_register_cache (struct regcache *regcache, |
| 58 | const struct target_desc *tdesc, |
| 59 | unsigned char *regbuf); |
| 60 | |
| 61 | void regcache_cpy (struct regcache *dst, struct regcache *src); |
| 62 | |
| 63 | /* Create a new register cache for INFERIOR. */ |
| 64 | |
| 65 | struct regcache *new_register_cache (const struct target_desc *tdesc); |
| 66 | |
| 67 | struct regcache *get_thread_regcache (struct thread_info *thread, int fetch); |
| 68 | |
| 69 | /* Release all memory associated with the register cache for INFERIOR. */ |
| 70 | |
| 71 | void free_register_cache (struct regcache *regcache); |
| 72 | |
| 73 | /* Invalidate cached registers for one thread. */ |
| 74 | |
| 75 | void regcache_invalidate_thread (struct thread_info *); |
| 76 | |
| 77 | /* Invalidate cached registers for all threads of the given process. */ |
| 78 | |
| 79 | void regcache_invalidate_pid (int pid); |
| 80 | |
| 81 | /* Invalidate cached registers for all threads of the current |
| 82 | process. */ |
| 83 | |
| 84 | void regcache_invalidate (void); |
| 85 | |
| 86 | /* Invalidate and release the register cache of all threads of the |
| 87 | current process. */ |
| 88 | |
| 89 | void regcache_release (void); |
| 90 | |
| 91 | /* Convert all registers to a string in the currently specified remote |
| 92 | format. */ |
| 93 | |
| 94 | void registers_to_string (struct regcache *regcache, char *buf); |
| 95 | |
| 96 | /* Convert a string to register values and fill our register cache. */ |
| 97 | |
| 98 | void registers_from_string (struct regcache *regcache, char *buf); |
| 99 | |
| 100 | /* For regcache_read_pc see common/common-regcache.h. */ |
| 101 | |
| 102 | void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc); |
| 103 | |
| 104 | /* Return a pointer to the description of register ``n''. */ |
| 105 | |
| 106 | struct reg *find_register_by_number (const struct target_desc *tdesc, int n); |
| 107 | |
| 108 | int register_cache_size (const struct target_desc *tdesc); |
| 109 | |
| 110 | int register_size (const struct target_desc *tdesc, int n); |
| 111 | |
| 112 | int find_regno (const struct target_desc *tdesc, const char *name); |
| 113 | |
| 114 | void supply_register (struct regcache *regcache, int n, const void *buf); |
| 115 | |
| 116 | void supply_register_zeroed (struct regcache *regcache, int n); |
| 117 | |
| 118 | void supply_register_by_name (struct regcache *regcache, |
| 119 | const char *name, const void *buf); |
| 120 | |
| 121 | void supply_regblock (struct regcache *regcache, const void *buf); |
| 122 | |
| 123 | void collect_register (struct regcache *regcache, int n, void *buf); |
| 124 | |
| 125 | void collect_register_as_string (struct regcache *regcache, int n, char *buf); |
| 126 | |
| 127 | void collect_register_by_name (struct regcache *regcache, |
| 128 | const char *name, void *buf); |
| 129 | |
| 130 | #endif /* REGCACHE_H */ |