X-Git-Url: http://drtracing.org/?a=blobdiff_plain;f=gdb%2Fregcache.h;h=a9fb44bf8ab36f092668c545df9e2fc627e36d25;hb=b08b78e7d4bb56f395d3212eed6184ede236c760;hp=4ddcda381048bd41bfb1614251e2bcb46cfb0888;hpb=c00dcbe9654f01e87fe34825299296147a4646d7;p=deliverable%2Fbinutils-gdb.git diff --git a/gdb/regcache.h b/gdb/regcache.h index 4ddcda3810..a9fb44bf8a 100644 --- a/gdb/regcache.h +++ b/gdb/regcache.h @@ -1,13 +1,12 @@ /* Cache and manage the values of registers for GDB, the GNU debugger. - Copyright 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000, - 2001, 2002 Free Software Foundation, Inc. + Copyright (C) 1986-2015 Free Software Foundation, Inc. This file is part of GDB. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or + the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, @@ -16,192 +15,223 @@ GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, - Boston, MA 02111-1307, USA. */ + along with this program. If not, see . */ #ifndef REGCACHE_H #define REGCACHE_H +#include "common-regcache.h" + struct regcache; +struct regset; struct gdbarch; +struct address_space; -extern struct regcache *current_regcache; +extern struct regcache *get_current_regcache (void); +extern struct regcache *get_thread_regcache (ptid_t ptid); +extern struct regcache *get_thread_arch_regcache (ptid_t, struct gdbarch *); +extern struct regcache *get_thread_arch_aspace_regcache (ptid_t, + struct gdbarch *, + struct address_space *); void regcache_xfree (struct regcache *regcache); struct cleanup *make_cleanup_regcache_xfree (struct regcache *regcache); -struct regcache *regcache_xmalloc (struct gdbarch *gdbarch); +struct regcache *regcache_xmalloc (struct gdbarch *gdbarch, + struct address_space *aspace); + +/* Return REGCACHE's architecture. */ + +extern struct gdbarch *get_regcache_arch (const struct regcache *regcache); + +/* Return REGCACHE's address space. */ + +extern struct address_space *get_regcache_aspace (const struct regcache *); + +enum register_status + { + /* The register value is not in the cache, and we don't know yet + whether it's available in the target (or traceframe). */ + REG_UNKNOWN = 0, + + /* The register value is valid and cached. */ + REG_VALID = 1, + + /* The register value is unavailable. E.g., we're inspecting a + traceframe, and this register wasn't collected. Note that this + is different a different "unavailable" from saying the register + does not exist in the target's architecture --- in that case, + the target should have given us a target description that does + not include the register in the first place. */ + REG_UNAVAILABLE = -1 + }; + +enum register_status regcache_register_status (const struct regcache *regcache, + int regnum); /* Transfer a raw register [0..NUM_REGS) between core-gdb and the - regcache. */ + regcache. The read variants return the status of the register. */ -void regcache_raw_read (struct regcache *regcache, int rawnum, void *buf); +enum register_status regcache_raw_read (struct regcache *regcache, + int rawnum, gdb_byte *buf); void regcache_raw_write (struct regcache *regcache, int rawnum, - const void *buf); -extern void regcache_raw_read_signed (struct regcache *regcache, - int regnum, LONGEST *val); -extern void regcache_raw_read_unsigned (struct regcache *regcache, - int regnum, ULONGEST *val); + const gdb_byte *buf); +extern enum register_status + regcache_raw_read_signed (struct regcache *regcache, + int regnum, LONGEST *val); +extern enum register_status + regcache_raw_read_unsigned (struct regcache *regcache, + int regnum, ULONGEST *val); extern void regcache_raw_write_signed (struct regcache *regcache, int regnum, LONGEST val); extern void regcache_raw_write_unsigned (struct regcache *regcache, int regnum, ULONGEST val); -/* Partial transfer of a raw registers. These perform read, modify, - write style operations. */ +/* Partial transfer of raw registers. These perform read, modify, + write style operations. The read variant returns the status of the + register. */ -void regcache_raw_read_part (struct regcache *regcache, int regnum, - int offset, int len, void *buf); +extern enum register_status + regcache_raw_read_part (struct regcache *regcache, int regnum, + int offset, int len, gdb_byte *buf); void regcache_raw_write_part (struct regcache *regcache, int regnum, - int offset, int len, const void *buf); + int offset, int len, const gdb_byte *buf); + +void regcache_invalidate (struct regcache *regcache, int regnum); -int regcache_valid_p (struct regcache *regcache, int regnum); +/* Transfer of pseudo-registers. The read variants return a register + status, as an indication of when a ``cooked'' register was + constructed from valid, invalid or unavailable ``raw'' + registers. */ /* Transfer a cooked register [0..NUM_REGS+NUM_PSEUDO_REGS). */ -void regcache_cooked_read (struct regcache *regcache, int rawnum, void *buf); +enum register_status regcache_cooked_read (struct regcache *regcache, + int rawnum, gdb_byte *buf); void regcache_cooked_write (struct regcache *regcache, int rawnum, - const void *buf); + const gdb_byte *buf); + +/* Read register REGNUM from REGCACHE and return a new value. This + will call mark_value_bytes_unavailable as appropriate. */ -/* NOTE: cagney/2002-08-13: At present GDB has no reliable mechanism - for indicating when a ``cooked'' register was constructed from - invalid or unavailable ``raw'' registers. One fairly easy way of - adding such a mechanism would be for the cooked functions to return - a register valid indication. Given the possibility of such a - change, the extract functions below use a reference parameter, - rather than a function result. */ +struct value *regcache_cooked_read_value (struct regcache *regcache, + int regnum); /* Read a register as a signed/unsigned quantity. */ -extern void regcache_cooked_read_signed (struct regcache *regcache, - int regnum, LONGEST *val); -extern void regcache_cooked_read_unsigned (struct regcache *regcache, - int regnum, ULONGEST *val); +extern enum register_status + regcache_cooked_read_signed (struct regcache *regcache, + int regnum, LONGEST *val); +extern enum register_status + regcache_cooked_read_unsigned (struct regcache *regcache, + int regnum, ULONGEST *val); +extern void regcache_cooked_write_signed (struct regcache *regcache, + int regnum, LONGEST val); +extern void regcache_cooked_write_unsigned (struct regcache *regcache, + int regnum, ULONGEST val); /* Partial transfer of a cooked register. These perform read, modify, write style operations. */ -void regcache_cooked_read_part (struct regcache *regcache, int regnum, - int offset, int len, void *buf); +enum register_status regcache_cooked_read_part (struct regcache *regcache, + int regnum, int offset, + int len, gdb_byte *buf); void regcache_cooked_write_part (struct regcache *regcache, int regnum, - int offset, int len, const void *buf); + int offset, int len, const gdb_byte *buf); + +/* Special routines to read/write the PC. */ + +/* For regcache_read_pc see common/common-regcache.h. */ +extern void regcache_write_pc (struct regcache *regcache, CORE_ADDR pc); /* Transfer a raw register [0..NUM_REGS) between the regcache and the target. These functions are called by the target in response to a target_fetch_registers() or target_store_registers(). */ -extern void supply_register (int regnum, const void *val); -extern void regcache_collect (int regnum, void *buf); +extern void regcache_raw_supply (struct regcache *regcache, + int regnum, const void *buf); +extern void regcache_raw_collect (const struct regcache *regcache, + int regnum, void *buf); +/* Mapping between register numbers and offsets in a buffer, for use + in the '*regset' functions below. In an array of + 'regcache_map_entry' each element is interpreted like follows: -/* The register's ``offset''. + - If 'regno' is a register number: Map register 'regno' to the + current offset (starting with 0) and increase the current offset + by 'size' (or the register's size, if 'size' is zero). Repeat + this with consecutive register numbers up to 'regno+count-1'. - NOTE: cagney/2002-08-17: The ``struct value'' and expression - evaluator treat the register cache as a large liner buffer. - Instead of reading/writing a register using its register number, - the code read/writes registers by specifying their offset into the - buffer and a number of bytes. The code also assumes that these - byte read/writes can cross register boundaries, adjacent registers - treated as a contiguous set of bytes. + - If 'regno' is REGCACHE_MAP_SKIP: Add 'count*size' to the current + offset. - The below map that model onto the real register cache. New code - should go out of their way to avoid using these interfaces. + - If count=0: End of the map. */ - FIXME: cagney/2002-08-17: The ``struct value'' and expression - evaluator should be fixed. Instead of using the { offset, length } - pair to describe a value within one or more registers, the code - should use a chain of { regnum, offset, len } tripples. */ +struct regcache_map_entry +{ + int count; + int regno; + int size; +}; -extern int register_offset_hack (struct gdbarch *gdbarch, int regnum); -extern void regcache_cooked_read_using_offset_hack (struct regcache *regcache, - int offset, int len, - void *buf); -extern void regcache_cooked_write_using_offset_hack (struct regcache *regcache, - int offset, int len, - const void *buf); +/* Special value for the 'regno' field in the struct above. */ +enum + { + REGCACHE_MAP_SKIP = -1, + }; -/* The type of a register. This function is slightly more efficient - then its gdbarch vector counterpart since it returns a precomputed - value stored in a table. +/* Transfer a set of registers (as described by REGSET) between + REGCACHE and BUF. If REGNUM == -1, transfer all registers + belonging to the regset, otherwise just the register numbered + REGNUM. The REGSET's 'regmap' field must point to an array of + 'struct regcache_map_entry'. - NOTE: cagney/2002-08-17: The original macro was called - REGISTER_VIRTUAL_TYPE. This was because the register could have - different raw and cooked (nee virtual) representations. The - CONVERTABLE methods being used to convert between the two - representations. Current code does not do this. Instead, the - first [0..NUM_REGS) registers are 1:1 raw:cooked, and the type - exactly describes the register's representation. Consequently, the - ``virtual'' has been dropped. + These functions are suitable for the 'regset_supply' and + 'regset_collect' fields in a regset structure. */ - FIXME: cagney/2002-08-17: A number of architectures, including the - MIPS, are currently broken in this regard. */ +extern void regcache_supply_regset (const struct regset *regset, + struct regcache *regcache, + int regnum, const void *buf, + size_t size); +extern void regcache_collect_regset (const struct regset *regset, + const struct regcache *regcache, + int regnum, void *buf, size_t size); -extern struct type *register_type (struct gdbarch *gdbarch, int regnum); +/* The type of a register. This function is slightly more efficient + then its gdbarch vector counterpart since it returns a precomputed + value stored in a table. */ -/* Return the size of the largest register. Used when allocating - space for an aribtrary register value. */ +extern struct type *register_type (struct gdbarch *gdbarch, int regnum); -extern int max_register_size (struct gdbarch *gdbarch); +/* Return the size of register REGNUM. All registers should have only + one size. */ + +extern int register_size (struct gdbarch *gdbarch, int regnum); -/* DEPRECATED: Character array containing an image of the inferior - programs' registers for the most recently referenced thread. */ -extern char *registers; +/* Save/restore a register cache. The set of registers saved / + restored into the DST regcache determined by the save_reggroup / + restore_reggroup respectively. COOKED_READ returns zero iff the + register's value can't be returned. */ -/* DEPRECATED: Character array containing the current state of each - register (unavailable<0, invalid=0, valid>0) for the most recently - referenced thread. */ +typedef enum register_status (regcache_cooked_read_ftype) (void *src, + int regnum, + gdb_byte *buf); -extern signed char *register_valid; +extern void regcache_save (struct regcache *dst, + regcache_cooked_read_ftype *cooked_read, + void *cooked_read_context); /* Copy/duplicate the contents of a register cache. By default, the operation is pass-through. Writes to DST and reads from SRC will - go through to the target. - - The ``cpy'' functions can not have overlapping SRC and DST buffers. + go through to the target. See also regcache_cpy_no_passthrough. - ``no passthrough'' versions do not go through to the target. They - only transfer values already in the cache. */ + regcache_cpy can not have overlapping SRC and DST buffers. */ extern struct regcache *regcache_dup (struct regcache *regcache); -extern struct regcache *regcache_dup_no_passthrough (struct regcache *regcache); extern void regcache_cpy (struct regcache *dest, struct regcache *src); -extern void regcache_cpy_no_passthrough (struct regcache *dest, struct regcache *src); - -extern char *deprecated_grub_regcache_for_registers (struct regcache *); -extern char *deprecated_grub_regcache_for_register_valid (struct regcache *); - -extern int register_cached (int regnum); - -extern void set_register_cached (int regnum, int state); - -extern void register_changed (int regnum); extern void registers_changed (void); - -extern void registers_fetched (void); - -extern void read_register_bytes (int regbyte, char *myaddr, int len); - -extern void read_register_gen (int regnum, char *myaddr); - -extern void write_register_gen (int regnum, char *myaddr); - -extern void write_register_bytes (int regbyte, char *myaddr, int len); - -/* Rename to read_unsigned_register()? */ -extern ULONGEST read_register (int regnum); - -/* Rename to read_unsigned_register_pid()? */ -extern ULONGEST read_register_pid (int regnum, ptid_t ptid); - -extern LONGEST read_signed_register (int regnum); - -extern LONGEST read_signed_register_pid (int regnum, ptid_t ptid); - -extern void write_register (int regnum, LONGEST val); - -extern void write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid); +extern void registers_changed_ptid (ptid_t); #endif /* REGCACHE_H */