gdb/regset.h

   1 /* Manage register sets.
   2
   3    Copyright (C) 2003, 2004, 2007, 2008 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   /* Data pointer for private use by the methods below, presumably
  37      providing some sort of description of the register set.  */
  38   const void *descr;
  39
  40   /* Function supplying values in a register set to a register cache.  */
  41   supply_regset_ftype *supply_regset;
  42
  43   /* Function collecting values in a register set from a register cache.  */
  44   collect_regset_ftype *collect_regset;
  45
  46   /* Architecture associated with the register set.  */
  47   struct gdbarch *arch;
  48 };
  49
  50 /* Allocate a fresh 'struct regset' whose supply_regset function is
  51    SUPPLY_REGSET, and whose collect_regset function is COLLECT_REGSET.
  52    If the regset has no collect_regset function, pass NULL for
  53    COLLECT_REGSET.
  54
  55    The object returned is allocated on ARCH's obstack.  */
  56
  57 extern struct regset *regset_alloc (struct gdbarch *arch,
  58                                     supply_regset_ftype *supply_regset,
  59                                     collect_regset_ftype *collect_regset);
  60
  61 #endif /* regset.h */