gdb/regset.h

   1 /* Manage register sets.
   2
   3    Copyright 2003 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 2 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, write to the Free Software
  19    Foundation, Inc., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.  */
  21
  22 #ifndef REGSET_H
  23 #define REGSET_H 1
  24
  25 struct gdbarch;
  26 struct regcache;
  27
  28 /* Data structure describing a register set.  */
  29 typedef void (supply_regset_ftype) (const struct regset *, struct regcache *,
  30                                     int, const void *, size_t);
  31 typedef void (collect_regset_ftype) (const struct regset *,
  32                                      const struct regcache *,
  33                                      int, const void *, size_t);
  34
  35 struct regset
  36 {
  37   /* Data pointer for private use by the methods below, presumably
  38      providing some sort of description of the register set.  */
  39   const void *descr;
  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
  48
  49 /* Allocate a fresh 'struct regset' whose descr is DESCR, whose
  50    supply_regset function is SUPPLY_REGSET, and whose collect_regset
  51    function is COLLECT_REGSET.  If the regset has no collect function,
  52    pass NULL for COLLECT_REGSET.
  53
  54    The object returned is allocated on ARCH's obstack.  */
  55 extern struct regset *regset_alloc (struct gdbarch *arch,
  56                                     const void *descr,
  57                                     supply_regset_ftype *supply_regset,
  58                                     collect_regset_ftype *collect_regset);
  59
  60
  61 #endif /* regset.h */