9f5a3daed8eb07174cc7228da168f0dce2a4cc26
[external/binutils.git] / gdb / regset.h
1 /* Manage register sets.
2
3    Copyright (C) 2003-2019 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 REGSET_H
21 #define REGSET_H 1
22
23 struct gdbarch;
24 struct regcache;
25
26 /* Data structure describing a register set.  */
27
28 typedef void (supply_regset_ftype) (const struct regset *, struct regcache *,
29                                     int, const void *, size_t);
30 typedef void (collect_regset_ftype) (const struct regset *, 
31                                      const struct regcache *,
32                                      int, void *, size_t);
33
34 struct regset
35 {
36   /* Pointer to a "register map", for private use by the methods
37      below.  Typically describes how the regset's registers are
38      arranged in the buffer collected to or supplied from.  */
39   const void *regmap;
40
41   /* Function supplying values in a register set to a register cache.  */
42   supply_regset_ftype *supply_regset;
43
44   /* Function collecting values in a register set from a register cache.  */
45   collect_regset_ftype *collect_regset;
46
47   unsigned flags;
48 };
49
50 /* Values for a regset's 'flags' field.  */
51
52 #define REGSET_VARIABLE_SIZE 1  /* Accept a larger regset section size
53                                    in a core file without warning.  */
54
55 #endif /* regset.h */