GDBserver
regcache.h
Go to the documentation of this file.
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. */
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 
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 
72 
73 /* Invalidate cached registers for one thread. */
74 
76 
77 /* Invalidate cached registers for all threads of the current
78  process. */
79 
80 void regcache_invalidate (void);
81 
82 /* Invalidate and release the register cache of all threads of the
83  current process. */
84 
85 void regcache_release (void);
86 
87 /* Convert all registers to a string in the currently specified remote
88  format. */
89 
90 void registers_to_string (struct regcache *regcache, char *buf);
91 
92 /* Convert a string to register values and fill our register cache. */
93 
94 void registers_from_string (struct regcache *regcache, char *buf);
95 
96 /* For regcache_read_pc see common/common-regcache.h. */
97 
98 void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc);
99 
100 /* Return a pointer to the description of register ``n''. */
101 
102 struct reg *find_register_by_number (const struct target_desc *tdesc, int n);
103 
104 int register_cache_size (const struct target_desc *tdesc);
105 
106 int register_size (const struct target_desc *tdesc, int n);
107 
108 int find_regno (const struct target_desc *tdesc, const char *name);
109 
110 void supply_register (struct regcache *regcache, int n, const void *buf);
111 
112 void supply_register_zeroed (struct regcache *regcache, int n);
113 
115  const char *name, const void *buf);
116 
117 void supply_regblock (struct regcache *regcache, const void *buf);
118 
119 void collect_register (struct regcache *regcache, int n, void *buf);
120 
121 void collect_register_as_string (struct regcache *regcache, int n, char *buf);
122 
124  const char *name, void *buf);
125 
126 #endif /* REGCACHE_H */
const struct target_desc * tdesc
Definition: regcache.h:41
void registers_to_string(struct regcache *regcache, char *buf)
Definition: regcache.c:204
int registers_valid
Definition: regcache.h:48
bfd_vma CORE_ADDR
Definition: common-types.h:41
void regcache_invalidate_thread(struct thread_info *)
Definition: regcache.c:75
const char * name
Definition: tracepoint.c:178
void supply_regblock(struct regcache *regcache, const void *buf)
Definition: regcache.c:370
int registers_owned
Definition: regcache.h:49
struct reg * find_register_by_number(const struct target_desc *tdesc, int n)
Definition: regcache.c:269
unsigned char * registers
Definition: regcache.h:50
unsigned char * register_status
Definition: regcache.h:53
void free_register_cache(struct regcache *regcache)
Definition: regcache.c:171
void collect_register(struct regcache *regcache, int n, void *buf)
Definition: regcache.c:414
void regcache_write_pc(struct regcache *regcache, CORE_ADDR pc)
Definition: regcache.c:453
int register_size(const struct target_desc *tdesc, int n)
Definition: regcache.c:314
void collect_register_as_string(struct regcache *regcache, int n, char *buf)
Definition: regcache.c:423
int find_regno(const struct target_desc *tdesc, const char *name)
Definition: regcache.c:257
void supply_register_zeroed(struct regcache *regcache, int n)
Definition: regcache.c:355
struct regcache * get_thread_regcache(struct thread_info *thread, int fetch)
Definition: regcache.c:27
void regcache_invalidate(void)
Definition: regcache.c:111
void regcache_cpy(struct regcache *dst, struct regcache *src)
Definition: regcache.c:185
void regcache_release(void)
Definition: regcache.c:300
void registers_from_string(struct regcache *regcache, char *buf)
Definition: regcache.c:228
struct regcache * new_register_cache(const struct target_desc *tdesc)
Definition: regcache.c:160
void collect_register_by_name(struct regcache *regcache, const char *name, void *buf)
Definition: regcache.c:430
void supply_register(struct regcache *regcache, int n, const void *buf)
Definition: regcache.c:330
void supply_register_by_name(struct regcache *regcache, const char *name, const void *buf)
Definition: regcache.c:405
struct regcache * init_register_cache(struct regcache *regcache, const struct target_desc *tdesc, unsigned char *regbuf)
Definition: regcache.c:122
int register_cache_size(const struct target_desc *tdesc)
Definition: regcache.c:308