xref: /dragonfly/contrib/gdb-7/gdb/regset.h (revision abf903a5)
1 /* Manage register sets.
2 
3    Copyright (C) 2003-2013 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 for the supported register notes in a core file.  */
27 struct core_regset_section
28 {
29   const char *sect_name;
30   int size;
31   const char *human_name;
32 };
33 
34 /* Data structure describing a register set.  */
35 
36 typedef void (supply_regset_ftype) (const struct regset *, struct regcache *,
37                                     int, const void *, size_t);
38 typedef void (collect_regset_ftype) (const struct regset *,
39                                      const struct regcache *,
40                                      int, void *, size_t);
41 
42 struct regset
43 {
44   /* Data pointer for private use by the methods below, presumably
45      providing some sort of description of the register set.  */
46   const void *descr;
47 
48   /* Function supplying values in a register set to a register cache.  */
49   supply_regset_ftype *supply_regset;
50 
51   /* Function collecting values in a register set from a register cache.  */
52   collect_regset_ftype *collect_regset;
53 
54   /* Architecture associated with the register set.  */
55   struct gdbarch *arch;
56 };
57 
58 /* Allocate a fresh 'struct regset' whose supply_regset function is
59    SUPPLY_REGSET, and whose collect_regset function is COLLECT_REGSET.
60    If the regset has no collect_regset function, pass NULL for
61    COLLECT_REGSET.
62 
63    The object returned is allocated on ARCH's obstack.  */
64 
65 extern struct regset *regset_alloc (struct gdbarch *arch,
66                                     supply_regset_ftype *supply_regset,
67                                     collect_regset_ftype *collect_regset);
68 
69 #endif /* regset.h */
70