1 /* Cache and manage the values of registers for GDB, the GNU debugger.
3 Copyright 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000,
4 2001, 2002, 2004 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
29 #include "reggroups.h"
30 #include "gdb_assert.h"
31 #include "gdb_string.h"
32 #include "gdbcmd.h" /* For maintenanceprintlist. */
38 * Here is the actual register cache.
41 /* Per-architecture object describing the layout of a register cache.
42 Computed once when the architecture is created */
44 struct gdbarch_data *regcache_descr_handle;
48 /* The architecture this descriptor belongs to. */
49 struct gdbarch *gdbarch;
51 /* The raw register cache. Each raw (or hard) register is supplied
52 by the target interface. The raw cache should not contain
53 redundant information - if the PC is constructed from two
54 registers then those regigisters and not the PC lives in the raw
57 long sizeof_raw_registers;
58 long sizeof_raw_register_valid_p;
60 /* The cooked register space. Each cooked register in the range
61 [0..NR_RAW_REGISTERS) is direct-mapped onto the corresponding raw
62 register. The remaining [NR_RAW_REGISTERS
63 .. NR_COOKED_REGISTERS) (a.k.a. pseudo registers) are mapped onto
64 both raw registers and memory by the architecture methods
65 gdbarch_pseudo_register_read and gdbarch_pseudo_register_write. */
66 int nr_cooked_registers;
67 long sizeof_cooked_registers;
68 long sizeof_cooked_register_valid_p;
70 /* Offset and size (in 8 bit bytes), of reach register in the
71 register cache. All registers (including those in the range
72 [NR_RAW_REGISTERS .. NR_COOKED_REGISTERS) are given an offset.
73 Assigning all registers an offset makes it possible to keep
74 legacy code, such as that found in read_register_bytes() and
75 write_register_bytes() working. */
76 long *register_offset;
77 long *sizeof_register;
79 /* Cached table containing the type of each register. */
80 struct type **register_type;
84 init_regcache_descr (struct gdbarch *gdbarch)
87 struct regcache_descr *descr;
88 gdb_assert (gdbarch != NULL);
90 /* Create an initial, zero filled, table. */
91 descr = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct regcache_descr);
92 descr->gdbarch = gdbarch;
94 /* Total size of the register space. The raw registers are mapped
95 directly onto the raw register cache while the pseudo's are
96 either mapped onto raw-registers or memory. */
97 descr->nr_cooked_registers = NUM_REGS + NUM_PSEUDO_REGS;
98 descr->sizeof_cooked_register_valid_p = NUM_REGS + NUM_PSEUDO_REGS;
100 /* Fill in a table of register types. */
102 = GDBARCH_OBSTACK_CALLOC (gdbarch, descr->nr_cooked_registers, struct type *);
103 for (i = 0; i < descr->nr_cooked_registers; i++)
104 descr->register_type[i] = gdbarch_register_type (gdbarch, i);
106 /* Construct a strictly RAW register cache. Don't allow pseudo's
107 into the register cache. */
108 descr->nr_raw_registers = NUM_REGS;
110 /* FIXME: cagney/2002-08-13: Overallocate the register_valid_p
111 array. This pretects GDB from erant code that accesses elements
112 of the global register_valid_p[] array in the range [NUM_REGS
113 .. NUM_REGS + NUM_PSEUDO_REGS). */
114 descr->sizeof_raw_register_valid_p = descr->sizeof_cooked_register_valid_p;
116 /* Lay out the register cache.
118 NOTE: cagney/2002-05-22: Only register_type() is used when
119 constructing the register cache. It is assumed that the
120 register's raw size, virtual size and type length are all the
125 descr->sizeof_register
126 = GDBARCH_OBSTACK_CALLOC (gdbarch, descr->nr_cooked_registers, long);
127 descr->register_offset
128 = GDBARCH_OBSTACK_CALLOC (gdbarch, descr->nr_cooked_registers, long);
129 for (i = 0; i < descr->nr_cooked_registers; i++)
131 descr->sizeof_register[i] = TYPE_LENGTH (descr->register_type[i]);
132 descr->register_offset[i] = offset;
133 offset += descr->sizeof_register[i];
134 gdb_assert (MAX_REGISTER_SIZE >= descr->sizeof_register[i]);
136 /* Set the real size of the register cache buffer. */
137 descr->sizeof_cooked_registers = offset;
140 /* FIXME: cagney/2002-05-22: Should only need to allocate space for
141 the raw registers. Unfortunately some code still accesses the
142 register array directly using the global registers[]. Until that
143 code has been purged, play safe and over allocating the register
145 descr->sizeof_raw_registers = descr->sizeof_cooked_registers;
150 static struct regcache_descr *
151 regcache_descr (struct gdbarch *gdbarch)
153 return gdbarch_data (gdbarch, regcache_descr_handle);
156 /* Utility functions returning useful register attributes stored in
157 the regcache descr. */
160 register_type (struct gdbarch *gdbarch, int regnum)
162 struct regcache_descr *descr = regcache_descr (gdbarch);
163 gdb_assert (regnum >= 0 && regnum < descr->nr_cooked_registers);
164 return descr->register_type[regnum];
167 /* Utility functions returning useful register attributes stored in
168 the regcache descr. */
171 register_size (struct gdbarch *gdbarch, int regnum)
173 struct regcache_descr *descr = regcache_descr (gdbarch);
175 gdb_assert (regnum >= 0 && regnum < (NUM_REGS + NUM_PSEUDO_REGS));
176 size = descr->sizeof_register[regnum];
180 /* The register cache for storing raw register values. */
184 struct regcache_descr *descr;
185 /* The register buffers. A read-only register cache can hold the
186 full [0 .. NUM_REGS + NUM_PSEUDO_REGS) while a read/write
187 register cache can only hold [0 .. NUM_REGS). */
189 char *register_valid_p;
190 /* Is this a read-only cache? A read-only cache is used for saving
191 the target's register state (e.g, across an inferior function
192 call or just before forcing a function return). A read-only
193 cache can only be updated via the methods regcache_dup() and
194 regcache_cpy(). The actual contents are determined by the
195 reggroup_save and reggroup_restore methods. */
200 regcache_xmalloc (struct gdbarch *gdbarch)
202 struct regcache_descr *descr;
203 struct regcache *regcache;
204 gdb_assert (gdbarch != NULL);
205 descr = regcache_descr (gdbarch);
206 regcache = XMALLOC (struct regcache);
207 regcache->descr = descr;
209 = XCALLOC (descr->sizeof_raw_registers, char);
210 regcache->register_valid_p
211 = XCALLOC (descr->sizeof_raw_register_valid_p, char);
212 regcache->readonly_p = 1;
217 regcache_xfree (struct regcache *regcache)
219 if (regcache == NULL)
221 xfree (regcache->registers);
222 xfree (regcache->register_valid_p);
227 do_regcache_xfree (void *data)
229 regcache_xfree (data);
233 make_cleanup_regcache_xfree (struct regcache *regcache)
235 return make_cleanup (do_regcache_xfree, regcache);
238 /* Return REGCACHE's architecture. */
241 get_regcache_arch (const struct regcache *regcache)
243 return regcache->descr->gdbarch;
246 /* Return a pointer to register REGNUM's buffer cache. */
249 register_buffer (const struct regcache *regcache, int regnum)
251 return regcache->registers + regcache->descr->register_offset[regnum];
255 regcache_save (struct regcache *dst, regcache_cooked_read_ftype *cooked_read,
258 struct gdbarch *gdbarch = dst->descr->gdbarch;
259 char buf[MAX_REGISTER_SIZE];
261 /* The DST should be `read-only', if it wasn't then the save would
262 end up trying to write the register values back out to the
264 gdb_assert (dst->readonly_p);
265 /* Clear the dest. */
266 memset (dst->registers, 0, dst->descr->sizeof_cooked_registers);
267 memset (dst->register_valid_p, 0, dst->descr->sizeof_cooked_register_valid_p);
268 /* Copy over any registers (identified by their membership in the
269 save_reggroup) and mark them as valid. The full [0 .. NUM_REGS +
270 NUM_PSEUDO_REGS) range is checked since some architectures need
271 to save/restore `cooked' registers that live in memory. */
272 for (regnum = 0; regnum < dst->descr->nr_cooked_registers; regnum++)
274 if (gdbarch_register_reggroup_p (gdbarch, regnum, save_reggroup))
276 int valid = cooked_read (src, regnum, buf);
279 memcpy (register_buffer (dst, regnum), buf,
280 register_size (gdbarch, regnum));
281 dst->register_valid_p[regnum] = 1;
288 regcache_restore (struct regcache *dst,
289 regcache_cooked_read_ftype *cooked_read,
292 struct gdbarch *gdbarch = dst->descr->gdbarch;
293 char buf[MAX_REGISTER_SIZE];
295 /* The dst had better not be read-only. If it is, the `restore'
296 doesn't make much sense. */
297 gdb_assert (!dst->readonly_p);
298 /* Copy over any registers, being careful to only restore those that
299 were both saved and need to be restored. The full [0 .. NUM_REGS
300 + NUM_PSEUDO_REGS) range is checked since some architectures need
301 to save/restore `cooked' registers that live in memory. */
302 for (regnum = 0; regnum < dst->descr->nr_cooked_registers; regnum++)
304 if (gdbarch_register_reggroup_p (gdbarch, regnum, restore_reggroup))
306 int valid = cooked_read (src, regnum, buf);
308 regcache_cooked_write (dst, regnum, buf);
314 do_cooked_read (void *src, int regnum, void *buf)
316 struct regcache *regcache = src;
317 if (!regcache->register_valid_p[regnum] && regcache->readonly_p)
318 /* Don't even think about fetching a register from a read-only
319 cache when the register isn't yet valid. There isn't a target
320 from which the register value can be fetched. */
322 regcache_cooked_read (regcache, regnum, buf);
328 regcache_cpy (struct regcache *dst, struct regcache *src)
332 gdb_assert (src != NULL && dst != NULL);
333 gdb_assert (src->descr->gdbarch == dst->descr->gdbarch);
334 gdb_assert (src != dst);
335 gdb_assert (src->readonly_p || dst->readonly_p);
336 if (!src->readonly_p)
337 regcache_save (dst, do_cooked_read, src);
338 else if (!dst->readonly_p)
339 regcache_restore (dst, do_cooked_read, src);
341 regcache_cpy_no_passthrough (dst, src);
345 regcache_cpy_no_passthrough (struct regcache *dst, struct regcache *src)
348 gdb_assert (src != NULL && dst != NULL);
349 gdb_assert (src->descr->gdbarch == dst->descr->gdbarch);
350 /* NOTE: cagney/2002-05-17: Don't let the caller do a no-passthrough
351 move of data into the current_regcache(). Doing this would be
352 silly - it would mean that valid_p would be completely invalid. */
353 gdb_assert (dst != current_regcache);
354 memcpy (dst->registers, src->registers, dst->descr->sizeof_raw_registers);
355 memcpy (dst->register_valid_p, src->register_valid_p,
356 dst->descr->sizeof_raw_register_valid_p);
360 regcache_dup (struct regcache *src)
362 struct regcache *newbuf;
363 gdb_assert (current_regcache != NULL);
364 newbuf = regcache_xmalloc (src->descr->gdbarch);
365 regcache_cpy (newbuf, src);
370 regcache_dup_no_passthrough (struct regcache *src)
372 struct regcache *newbuf;
373 gdb_assert (current_regcache != NULL);
374 newbuf = regcache_xmalloc (src->descr->gdbarch);
375 regcache_cpy_no_passthrough (newbuf, src);
380 regcache_valid_p (struct regcache *regcache, int regnum)
382 gdb_assert (regcache != NULL);
383 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
384 return regcache->register_valid_p[regnum];
388 deprecated_grub_regcache_for_registers (struct regcache *regcache)
390 return regcache->registers;
393 /* Global structure containing the current regcache. */
394 /* FIXME: cagney/2002-05-11: The two global arrays registers[] and
395 deprecated_register_valid[] currently point into this structure. */
396 struct regcache *current_regcache;
398 /* NOTE: this is a write-through cache. There is no "dirty" bit for
399 recording if the register values have been changed (eg. by the
400 user). Therefore all registers must be written back to the
401 target when appropriate. */
403 /* The thread/process associated with the current set of registers. */
405 static ptid_t registers_ptid;
413 Returns 0 if the value is not in the cache (needs fetch).
414 >0 if the value is in the cache.
415 <0 if the value is permanently unavailable (don't ask again). */
418 register_cached (int regnum)
420 return current_regcache->register_valid_p[regnum];
423 /* Record that REGNUM's value is cached if STATE is >0, uncached but
424 fetchable if STATE is 0, and uncached and unfetchable if STATE is <0. */
427 set_register_cached (int regnum, int state)
429 gdb_assert (regnum >= 0);
430 gdb_assert (regnum < current_regcache->descr->nr_raw_registers);
431 current_regcache->register_valid_p[regnum] = state;
434 /* Observer for the target_changed event. */
437 regcache_observer_target_changed (struct target_ops *target)
439 registers_changed ();
442 /* Low level examining and depositing of registers.
444 The caller is responsible for making sure that the inferior is
445 stopped before calling the fetching routines, or it will get
446 garbage. (a change from GDB version 3, in which the caller got the
447 value from the last stop). */
449 /* REGISTERS_CHANGED ()
451 Indicate that registers may have changed, so invalidate the cache. */
454 registers_changed (void)
458 registers_ptid = pid_to_ptid (-1);
460 /* Force cleanup of any alloca areas if using C alloca instead of
461 a builtin alloca. This particular call is used to clean up
462 areas allocated by low level target code which may build up
463 during lengthy interactions between gdb and the target before
464 gdb gives control to the user (ie watchpoints). */
467 for (i = 0; i < current_regcache->descr->nr_raw_registers; i++)
468 set_register_cached (i, 0);
470 if (deprecated_registers_changed_hook)
471 deprecated_registers_changed_hook ();
474 /* DEPRECATED_REGISTERS_FETCHED ()
476 Indicate that all registers have been fetched, so mark them all valid. */
478 /* FIXME: cagney/2001-12-04: This function is DEPRECATED. The target
479 code was blatting the registers[] array and then calling this.
480 Since targets should only be using regcache_raw_supply() the need for
481 this function/hack is eliminated. */
484 deprecated_registers_fetched (void)
488 for (i = 0; i < NUM_REGS; i++)
489 set_register_cached (i, 1);
490 /* Do not assume that the pseudo-regs have also been fetched.
491 Fetching all real regs NEVER accounts for pseudo-regs. */
494 /* deprecated_read_register_bytes and deprecated_write_register_bytes
495 are generally a *BAD* idea. They are inefficient because they need
496 to check for partial updates, which can only be done by scanning
497 through all of the registers and seeing if the bytes that are being
498 read/written fall inside of an invalid register. [The main reason
499 this is necessary is that register sizes can vary, so a simple
500 index won't suffice.] It is far better to call read_register_gen
501 and write_register_gen if you want to get at the raw register
502 contents, as it only takes a regnum as an argument, and therefore
503 can't do a partial register update.
505 Prior to the recent fixes to check for partial updates, both read
506 and deprecated_write_register_bytes always checked to see if any
507 registers were stale, and then called target_fetch_registers (-1)
508 to update the whole set. This caused really slowed things down for
511 /* Copy INLEN bytes of consecutive data from registers
512 starting with the INREGBYTE'th byte of register data
513 into memory at MYADDR. */
516 deprecated_read_register_bytes (int in_start, char *in_buf, int in_len)
518 int in_end = in_start + in_len;
520 char reg_buf[MAX_REGISTER_SIZE];
522 /* See if we are trying to read bytes from out-of-date registers. If so,
523 update just those registers. */
525 for (regnum = 0; regnum < NUM_REGS + NUM_PSEUDO_REGS; regnum++)
534 reg_start = DEPRECATED_REGISTER_BYTE (regnum);
535 reg_len = register_size (current_gdbarch, regnum);
536 reg_end = reg_start + reg_len;
538 if (reg_end <= in_start || in_end <= reg_start)
539 /* The range the user wants to read doesn't overlap with regnum. */
542 if (REGISTER_NAME (regnum) != NULL && *REGISTER_NAME (regnum) != '\0')
543 /* Force the cache to fetch the entire register. */
544 deprecated_read_register_gen (regnum, reg_buf);
546 /* Legacy note: This function, for some reason, allows a NULL
547 input buffer. If the buffer is NULL, the registers are still
548 fetched, just the final transfer is skipped. */
552 /* start = max (reg_start, in_start) */
553 if (reg_start > in_start)
558 /* end = min (reg_end, in_end) */
559 if (reg_end < in_end)
564 /* Transfer just the bytes common to both IN_BUF and REG_BUF */
565 for (byte = start; byte < end; byte++)
567 in_buf[byte - in_start] = reg_buf[byte - reg_start];
573 regcache_raw_read (struct regcache *regcache, int regnum, void *buf)
575 gdb_assert (regcache != NULL && buf != NULL);
576 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
577 /* Make certain that the register cache is up-to-date with respect
578 to the current thread. This switching shouldn't be necessary
579 only there is still only one target side register cache. Sigh!
580 On the bright side, at least there is a regcache object. */
581 if (!regcache->readonly_p)
583 gdb_assert (regcache == current_regcache);
584 if (! ptid_equal (registers_ptid, inferior_ptid))
586 registers_changed ();
587 registers_ptid = inferior_ptid;
589 if (!register_cached (regnum))
590 target_fetch_registers (regnum);
592 /* FIXME: cagney/2004-08-07: At present a number of targets
593 forget (or didn't know that they needed) to set this leading to
594 panics. Also is the problem that targets need to indicate
595 that a register is in one of the possible states: valid,
596 undefined, unknown. The last of which isn't yet
598 gdb_assert (register_cached (regnum));
601 /* Copy the value directly into the register cache. */
602 memcpy (buf, register_buffer (regcache, regnum),
603 regcache->descr->sizeof_register[regnum]);
607 regcache_raw_read_signed (struct regcache *regcache, int regnum, LONGEST *val)
610 gdb_assert (regcache != NULL);
611 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
612 buf = alloca (regcache->descr->sizeof_register[regnum]);
613 regcache_raw_read (regcache, regnum, buf);
614 (*val) = extract_signed_integer (buf,
615 regcache->descr->sizeof_register[regnum]);
619 regcache_raw_read_unsigned (struct regcache *regcache, int regnum,
623 gdb_assert (regcache != NULL);
624 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
625 buf = alloca (regcache->descr->sizeof_register[regnum]);
626 regcache_raw_read (regcache, regnum, buf);
627 (*val) = extract_unsigned_integer (buf,
628 regcache->descr->sizeof_register[regnum]);
632 regcache_raw_write_signed (struct regcache *regcache, int regnum, LONGEST val)
635 gdb_assert (regcache != NULL);
636 gdb_assert (regnum >=0 && regnum < regcache->descr->nr_raw_registers);
637 buf = alloca (regcache->descr->sizeof_register[regnum]);
638 store_signed_integer (buf, regcache->descr->sizeof_register[regnum], val);
639 regcache_raw_write (regcache, regnum, buf);
643 regcache_raw_write_unsigned (struct regcache *regcache, int regnum,
647 gdb_assert (regcache != NULL);
648 gdb_assert (regnum >=0 && regnum < regcache->descr->nr_raw_registers);
649 buf = alloca (regcache->descr->sizeof_register[regnum]);
650 store_unsigned_integer (buf, regcache->descr->sizeof_register[regnum], val);
651 regcache_raw_write (regcache, regnum, buf);
655 deprecated_read_register_gen (int regnum, char *buf)
657 gdb_assert (current_regcache != NULL);
658 gdb_assert (current_regcache->descr->gdbarch == current_gdbarch);
659 regcache_cooked_read (current_regcache, regnum, buf);
663 regcache_cooked_read (struct regcache *regcache, int regnum, void *buf)
665 gdb_assert (regnum >= 0);
666 gdb_assert (regnum < regcache->descr->nr_cooked_registers);
667 if (regnum < regcache->descr->nr_raw_registers)
668 regcache_raw_read (regcache, regnum, buf);
669 else if (regcache->readonly_p
670 && regnum < regcache->descr->nr_cooked_registers
671 && regcache->register_valid_p[regnum])
672 /* Read-only register cache, perhaps the cooked value was cached? */
673 memcpy (buf, register_buffer (regcache, regnum),
674 regcache->descr->sizeof_register[regnum]);
676 gdbarch_pseudo_register_read (regcache->descr->gdbarch, regcache,
681 regcache_cooked_read_signed (struct regcache *regcache, int regnum,
685 gdb_assert (regcache != NULL);
686 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_cooked_registers);
687 buf = alloca (regcache->descr->sizeof_register[regnum]);
688 regcache_cooked_read (regcache, regnum, buf);
689 (*val) = extract_signed_integer (buf,
690 regcache->descr->sizeof_register[regnum]);
694 regcache_cooked_read_unsigned (struct regcache *regcache, int regnum,
698 gdb_assert (regcache != NULL);
699 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_cooked_registers);
700 buf = alloca (regcache->descr->sizeof_register[regnum]);
701 regcache_cooked_read (regcache, regnum, buf);
702 (*val) = extract_unsigned_integer (buf,
703 regcache->descr->sizeof_register[regnum]);
707 regcache_cooked_write_signed (struct regcache *regcache, int regnum,
711 gdb_assert (regcache != NULL);
712 gdb_assert (regnum >=0 && regnum < regcache->descr->nr_cooked_registers);
713 buf = alloca (regcache->descr->sizeof_register[regnum]);
714 store_signed_integer (buf, regcache->descr->sizeof_register[regnum], val);
715 regcache_cooked_write (regcache, regnum, buf);
719 regcache_cooked_write_unsigned (struct regcache *regcache, int regnum,
723 gdb_assert (regcache != NULL);
724 gdb_assert (regnum >=0 && regnum < regcache->descr->nr_cooked_registers);
725 buf = alloca (regcache->descr->sizeof_register[regnum]);
726 store_unsigned_integer (buf, regcache->descr->sizeof_register[regnum], val);
727 regcache_cooked_write (regcache, regnum, buf);
731 regcache_raw_write (struct regcache *regcache, int regnum, const void *buf)
733 gdb_assert (regcache != NULL && buf != NULL);
734 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
735 gdb_assert (!regcache->readonly_p);
737 /* On the sparc, writing %g0 is a no-op, so we don't even want to
738 change the registers array if something writes to this register. */
739 if (CANNOT_STORE_REGISTER (regnum))
742 /* Make certain that the correct cache is selected. */
743 gdb_assert (regcache == current_regcache);
744 if (! ptid_equal (registers_ptid, inferior_ptid))
746 registers_changed ();
747 registers_ptid = inferior_ptid;
750 /* If we have a valid copy of the register, and new value == old
751 value, then don't bother doing the actual store. */
752 if (regcache_valid_p (regcache, regnum)
753 && (memcmp (register_buffer (regcache, regnum), buf,
754 regcache->descr->sizeof_register[regnum]) == 0))
757 target_prepare_to_store ();
758 memcpy (register_buffer (regcache, regnum), buf,
759 regcache->descr->sizeof_register[regnum]);
760 regcache->register_valid_p[regnum] = 1;
761 target_store_registers (regnum);
765 deprecated_write_register_gen (int regnum, char *buf)
767 gdb_assert (current_regcache != NULL);
768 gdb_assert (current_regcache->descr->gdbarch == current_gdbarch);
769 regcache_cooked_write (current_regcache, regnum, buf);
773 regcache_cooked_write (struct regcache *regcache, int regnum, const void *buf)
775 gdb_assert (regnum >= 0);
776 gdb_assert (regnum < regcache->descr->nr_cooked_registers);
777 if (regnum < regcache->descr->nr_raw_registers)
778 regcache_raw_write (regcache, regnum, buf);
780 gdbarch_pseudo_register_write (regcache->descr->gdbarch, regcache,
784 /* Copy INLEN bytes of consecutive data from memory at MYADDR
785 into registers starting with the MYREGSTART'th byte of register data. */
788 deprecated_write_register_bytes (int myregstart, char *myaddr, int inlen)
790 int myregend = myregstart + inlen;
793 target_prepare_to_store ();
795 /* Scan through the registers updating any that are covered by the
796 range myregstart<=>myregend using write_register_gen, which does
797 nice things like handling threads, and avoiding updates when the
798 new and old contents are the same. */
800 for (regnum = 0; regnum < NUM_REGS + NUM_PSEUDO_REGS; regnum++)
802 int regstart, regend;
804 regstart = DEPRECATED_REGISTER_BYTE (regnum);
805 regend = regstart + register_size (current_gdbarch, regnum);
807 /* Is this register completely outside the range the user is writing? */
808 if (myregend <= regstart || regend <= myregstart)
811 /* Is this register completely within the range the user is writing? */
812 else if (myregstart <= regstart && regend <= myregend)
813 deprecated_write_register_gen (regnum, myaddr + (regstart - myregstart));
815 /* The register partially overlaps the range being written. */
818 char regbuf[MAX_REGISTER_SIZE];
819 /* What's the overlap between this register's bytes and
820 those the caller wants to write? */
821 int overlapstart = max (regstart, myregstart);
822 int overlapend = min (regend, myregend);
824 /* We may be doing a partial update of an invalid register.
825 Update it from the target before scribbling on it. */
826 deprecated_read_register_gen (regnum, regbuf);
828 target_store_registers (regnum);
833 /* Perform a partial register transfer using a read, modify, write
836 typedef void (regcache_read_ftype) (struct regcache *regcache, int regnum,
838 typedef void (regcache_write_ftype) (struct regcache *regcache, int regnum,
842 regcache_xfer_part (struct regcache *regcache, int regnum,
843 int offset, int len, void *in, const void *out,
844 regcache_read_ftype *read, regcache_write_ftype *write)
846 struct regcache_descr *descr = regcache->descr;
847 bfd_byte reg[MAX_REGISTER_SIZE];
848 gdb_assert (offset >= 0 && offset <= descr->sizeof_register[regnum]);
849 gdb_assert (len >= 0 && offset + len <= descr->sizeof_register[regnum]);
850 /* Something to do? */
851 if (offset + len == 0)
853 /* Read (when needed) ... */
856 || offset + len < descr->sizeof_register[regnum])
858 gdb_assert (read != NULL);
859 read (regcache, regnum, reg);
863 memcpy (in, reg + offset, len);
865 memcpy (reg + offset, out, len);
866 /* ... write (when needed). */
869 gdb_assert (write != NULL);
870 write (regcache, regnum, reg);
875 regcache_raw_read_part (struct regcache *regcache, int regnum,
876 int offset, int len, void *buf)
878 struct regcache_descr *descr = regcache->descr;
879 gdb_assert (regnum >= 0 && regnum < descr->nr_raw_registers);
880 regcache_xfer_part (regcache, regnum, offset, len, buf, NULL,
881 regcache_raw_read, regcache_raw_write);
885 regcache_raw_write_part (struct regcache *regcache, int regnum,
886 int offset, int len, const void *buf)
888 struct regcache_descr *descr = regcache->descr;
889 gdb_assert (regnum >= 0 && regnum < descr->nr_raw_registers);
890 regcache_xfer_part (regcache, regnum, offset, len, NULL, buf,
891 regcache_raw_read, regcache_raw_write);
895 regcache_cooked_read_part (struct regcache *regcache, int regnum,
896 int offset, int len, void *buf)
898 struct regcache_descr *descr = regcache->descr;
899 gdb_assert (regnum >= 0 && regnum < descr->nr_cooked_registers);
900 regcache_xfer_part (regcache, regnum, offset, len, buf, NULL,
901 regcache_cooked_read, regcache_cooked_write);
905 regcache_cooked_write_part (struct regcache *regcache, int regnum,
906 int offset, int len, const void *buf)
908 struct regcache_descr *descr = regcache->descr;
909 gdb_assert (regnum >= 0 && regnum < descr->nr_cooked_registers);
910 regcache_xfer_part (regcache, regnum, offset, len, NULL, buf,
911 regcache_cooked_read, regcache_cooked_write);
914 /* Hack to keep code that view the register buffer as raw bytes
918 register_offset_hack (struct gdbarch *gdbarch, int regnum)
920 struct regcache_descr *descr = regcache_descr (gdbarch);
921 gdb_assert (regnum >= 0 && regnum < descr->nr_cooked_registers);
922 return descr->register_offset[regnum];
925 /* Hack to keep code using register_bytes working. */
928 deprecated_register_bytes (void)
930 return current_regcache->descr->sizeof_raw_registers;
933 /* Return the contents of register REGNUM as an unsigned integer. */
936 read_register (int regnum)
938 char *buf = alloca (register_size (current_gdbarch, regnum));
939 deprecated_read_register_gen (regnum, buf);
940 return (extract_unsigned_integer (buf, register_size (current_gdbarch, regnum)));
944 read_register_pid (int regnum, ptid_t ptid)
950 if (ptid_equal (ptid, inferior_ptid))
951 return read_register (regnum);
953 save_ptid = inferior_ptid;
955 inferior_ptid = ptid;
957 retval = read_register (regnum);
959 inferior_ptid = save_ptid;
964 /* Store VALUE into the raw contents of register number REGNUM. */
967 write_register (int regnum, LONGEST val)
971 size = register_size (current_gdbarch, regnum);
973 store_signed_integer (buf, size, (LONGEST) val);
974 deprecated_write_register_gen (regnum, buf);
978 write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid)
982 if (ptid_equal (ptid, inferior_ptid))
984 write_register (regnum, val);
988 save_ptid = inferior_ptid;
990 inferior_ptid = ptid;
992 write_register (regnum, val);
994 inferior_ptid = save_ptid;
997 /* Supply register REGNUM, whose contents are stored in BUF, to REGCACHE. */
1000 regcache_raw_supply (struct regcache *regcache, int regnum, const void *buf)
1005 gdb_assert (regcache != NULL);
1006 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
1007 gdb_assert (!regcache->readonly_p);
1009 /* FIXME: kettenis/20030828: It shouldn't be necessary to handle
1010 CURRENT_REGCACHE specially here. */
1011 if (regcache == current_regcache
1012 && !ptid_equal (registers_ptid, inferior_ptid))
1014 registers_changed ();
1015 registers_ptid = inferior_ptid;
1018 regbuf = register_buffer (regcache, regnum);
1019 size = regcache->descr->sizeof_register[regnum];
1022 memcpy (regbuf, buf, size);
1024 memset (regbuf, 0, size);
1026 /* Mark the register as cached. */
1027 regcache->register_valid_p[regnum] = 1;
1030 /* Collect register REGNUM from REGCACHE and store its contents in BUF. */
1033 regcache_raw_collect (const struct regcache *regcache, int regnum, void *buf)
1038 gdb_assert (regcache != NULL && buf != NULL);
1039 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
1041 regbuf = register_buffer (regcache, regnum);
1042 size = regcache->descr->sizeof_register[regnum];
1043 memcpy (buf, regbuf, size);
1047 /* read_pc, write_pc, read_sp, etc. Special handling for registers
1050 /* NOTE: cagney/2001-02-18: The functions read_pc_pid(), read_pc() and
1051 read_sp(), will eventually be replaced by per-frame methods.
1052 Instead of relying on the global INFERIOR_PTID, they will use the
1053 contextual information provided by the FRAME. These functions do
1054 not belong in the register cache. */
1056 /* NOTE: cagney/2003-06-07: The functions generic_target_write_pc(),
1057 write_pc_pid() and write_pc(), all need to be replaced by something
1058 that does not rely on global state. But what? */
1061 read_pc_pid (ptid_t ptid)
1063 ptid_t saved_inferior_ptid;
1066 /* In case ptid != inferior_ptid. */
1067 saved_inferior_ptid = inferior_ptid;
1068 inferior_ptid = ptid;
1070 if (TARGET_READ_PC_P ())
1071 pc_val = TARGET_READ_PC (ptid);
1072 /* Else use per-frame method on get_current_frame. */
1073 else if (PC_REGNUM >= 0)
1075 CORE_ADDR raw_val = read_register_pid (PC_REGNUM, ptid);
1076 pc_val = ADDR_BITS_REMOVE (raw_val);
1079 internal_error (__FILE__, __LINE__, _("read_pc_pid: Unable to find PC"));
1081 inferior_ptid = saved_inferior_ptid;
1088 return read_pc_pid (inferior_ptid);
1092 generic_target_write_pc (CORE_ADDR pc, ptid_t ptid)
1095 write_register_pid (PC_REGNUM, pc, ptid);
1097 internal_error (__FILE__, __LINE__,
1098 _("generic_target_write_pc"));
1102 write_pc_pid (CORE_ADDR pc, ptid_t ptid)
1104 ptid_t saved_inferior_ptid;
1106 /* In case ptid != inferior_ptid. */
1107 saved_inferior_ptid = inferior_ptid;
1108 inferior_ptid = ptid;
1110 TARGET_WRITE_PC (pc, ptid);
1112 inferior_ptid = saved_inferior_ptid;
1116 write_pc (CORE_ADDR pc)
1118 write_pc_pid (pc, inferior_ptid);
1121 /* Cope with strage ways of getting to the stack and frame pointers */
1126 if (TARGET_READ_SP_P ())
1127 return TARGET_READ_SP ();
1128 else if (gdbarch_unwind_sp_p (current_gdbarch))
1129 return get_frame_sp (get_current_frame ());
1130 else if (SP_REGNUM >= 0)
1131 /* Try SP_REGNUM last: this makes all sorts of [wrong] assumptions
1132 about the architecture so put it at the end. */
1133 return read_register (SP_REGNUM);
1134 internal_error (__FILE__, __LINE__, _("read_sp: Unable to find SP"));
1138 reg_flush_command (char *command, int from_tty)
1140 /* Force-flush the register cache. */
1141 registers_changed ();
1143 printf_filtered (_("Register cache flushed.\n"));
1147 build_regcache (void)
1149 current_regcache = regcache_xmalloc (current_gdbarch);
1150 current_regcache->readonly_p = 0;
1154 dump_endian_bytes (struct ui_file *file, enum bfd_endian endian,
1155 const unsigned char *buf, long len)
1160 case BFD_ENDIAN_BIG:
1161 for (i = 0; i < len; i++)
1162 fprintf_unfiltered (file, "%02x", buf[i]);
1164 case BFD_ENDIAN_LITTLE:
1165 for (i = len - 1; i >= 0; i--)
1166 fprintf_unfiltered (file, "%02x", buf[i]);
1169 internal_error (__FILE__, __LINE__, _("Bad switch"));
1173 enum regcache_dump_what
1175 regcache_dump_none, regcache_dump_raw, regcache_dump_cooked, regcache_dump_groups
1179 regcache_dump (struct regcache *regcache, struct ui_file *file,
1180 enum regcache_dump_what what_to_dump)
1182 struct cleanup *cleanups = make_cleanup (null_cleanup, NULL);
1183 struct gdbarch *gdbarch = regcache->descr->gdbarch;
1185 int footnote_nr = 0;
1186 int footnote_register_size = 0;
1187 int footnote_register_offset = 0;
1188 int footnote_register_type_name_null = 0;
1189 long register_offset = 0;
1190 unsigned char buf[MAX_REGISTER_SIZE];
1193 fprintf_unfiltered (file, "nr_raw_registers %d\n",
1194 regcache->descr->nr_raw_registers);
1195 fprintf_unfiltered (file, "nr_cooked_registers %d\n",
1196 regcache->descr->nr_cooked_registers);
1197 fprintf_unfiltered (file, "sizeof_raw_registers %ld\n",
1198 regcache->descr->sizeof_raw_registers);
1199 fprintf_unfiltered (file, "sizeof_raw_register_valid_p %ld\n",
1200 regcache->descr->sizeof_raw_register_valid_p);
1201 fprintf_unfiltered (file, "NUM_REGS %d\n", NUM_REGS);
1202 fprintf_unfiltered (file, "NUM_PSEUDO_REGS %d\n", NUM_PSEUDO_REGS);
1205 gdb_assert (regcache->descr->nr_cooked_registers
1206 == (NUM_REGS + NUM_PSEUDO_REGS));
1208 for (regnum = -1; regnum < regcache->descr->nr_cooked_registers; regnum++)
1212 fprintf_unfiltered (file, " %-10s", "Name");
1215 const char *p = REGISTER_NAME (regnum);
1218 else if (p[0] == '\0')
1220 fprintf_unfiltered (file, " %-10s", p);
1225 fprintf_unfiltered (file, " %4s", "Nr");
1227 fprintf_unfiltered (file, " %4d", regnum);
1229 /* Relative number. */
1231 fprintf_unfiltered (file, " %4s", "Rel");
1232 else if (regnum < NUM_REGS)
1233 fprintf_unfiltered (file, " %4d", regnum);
1235 fprintf_unfiltered (file, " %4d", (regnum - NUM_REGS));
1239 fprintf_unfiltered (file, " %6s ", "Offset");
1242 fprintf_unfiltered (file, " %6ld",
1243 regcache->descr->register_offset[regnum]);
1244 if (register_offset != regcache->descr->register_offset[regnum]
1245 || register_offset != DEPRECATED_REGISTER_BYTE (regnum)
1247 && (regcache->descr->register_offset[regnum]
1248 != (regcache->descr->register_offset[regnum - 1]
1249 + regcache->descr->sizeof_register[regnum - 1])))
1252 if (!footnote_register_offset)
1253 footnote_register_offset = ++footnote_nr;
1254 fprintf_unfiltered (file, "*%d", footnote_register_offset);
1257 fprintf_unfiltered (file, " ");
1258 register_offset = (regcache->descr->register_offset[regnum]
1259 + regcache->descr->sizeof_register[regnum]);
1264 fprintf_unfiltered (file, " %5s ", "Size");
1266 fprintf_unfiltered (file, " %5ld",
1267 regcache->descr->sizeof_register[regnum]);
1276 static const char blt[] = "builtin_type";
1277 t = TYPE_NAME (register_type (regcache->descr->gdbarch, regnum));
1281 if (!footnote_register_type_name_null)
1282 footnote_register_type_name_null = ++footnote_nr;
1283 n = xstrprintf ("*%d", footnote_register_type_name_null);
1284 make_cleanup (xfree, n);
1287 /* Chop a leading builtin_type. */
1288 if (strncmp (t, blt, strlen (blt)) == 0)
1291 fprintf_unfiltered (file, " %-15s", t);
1294 /* Leading space always present. */
1295 fprintf_unfiltered (file, " ");
1298 if (what_to_dump == regcache_dump_raw)
1301 fprintf_unfiltered (file, "Raw value");
1302 else if (regnum >= regcache->descr->nr_raw_registers)
1303 fprintf_unfiltered (file, "<cooked>");
1304 else if (!regcache_valid_p (regcache, regnum))
1305 fprintf_unfiltered (file, "<invalid>");
1308 regcache_raw_read (regcache, regnum, buf);
1309 fprintf_unfiltered (file, "0x");
1310 dump_endian_bytes (file, TARGET_BYTE_ORDER, buf,
1311 regcache->descr->sizeof_register[regnum]);
1315 /* Value, cooked. */
1316 if (what_to_dump == regcache_dump_cooked)
1319 fprintf_unfiltered (file, "Cooked value");
1322 regcache_cooked_read (regcache, regnum, buf);
1323 fprintf_unfiltered (file, "0x");
1324 dump_endian_bytes (file, TARGET_BYTE_ORDER, buf,
1325 regcache->descr->sizeof_register[regnum]);
1329 /* Group members. */
1330 if (what_to_dump == regcache_dump_groups)
1333 fprintf_unfiltered (file, "Groups");
1336 const char *sep = "";
1337 struct reggroup *group;
1338 for (group = reggroup_next (gdbarch, NULL);
1340 group = reggroup_next (gdbarch, group))
1342 if (gdbarch_register_reggroup_p (gdbarch, regnum, group))
1344 fprintf_unfiltered (file, "%s%s", sep, reggroup_name (group));
1351 fprintf_unfiltered (file, "\n");
1354 if (footnote_register_size)
1355 fprintf_unfiltered (file, "*%d: Inconsistent register sizes.\n",
1356 footnote_register_size);
1357 if (footnote_register_offset)
1358 fprintf_unfiltered (file, "*%d: Inconsistent register offsets.\n",
1359 footnote_register_offset);
1360 if (footnote_register_type_name_null)
1361 fprintf_unfiltered (file,
1362 "*%d: Register type's name NULL.\n",
1363 footnote_register_type_name_null);
1364 do_cleanups (cleanups);
1368 regcache_print (char *args, enum regcache_dump_what what_to_dump)
1371 regcache_dump (current_regcache, gdb_stdout, what_to_dump);
1374 struct ui_file *file = gdb_fopen (args, "w");
1376 perror_with_name (_("maintenance print architecture"));
1377 regcache_dump (current_regcache, file, what_to_dump);
1378 ui_file_delete (file);
1383 maintenance_print_registers (char *args, int from_tty)
1385 regcache_print (args, regcache_dump_none);
1389 maintenance_print_raw_registers (char *args, int from_tty)
1391 regcache_print (args, regcache_dump_raw);
1395 maintenance_print_cooked_registers (char *args, int from_tty)
1397 regcache_print (args, regcache_dump_cooked);
1401 maintenance_print_register_groups (char *args, int from_tty)
1403 regcache_print (args, regcache_dump_groups);
1406 extern initialize_file_ftype _initialize_regcache; /* -Wmissing-prototype */
1409 _initialize_regcache (void)
1411 regcache_descr_handle = gdbarch_data_register_post_init (init_regcache_descr);
1412 DEPRECATED_REGISTER_GDBARCH_SWAP (current_regcache);
1413 deprecated_register_gdbarch_swap (NULL, 0, build_regcache);
1415 observer_attach_target_changed (regcache_observer_target_changed);
1417 add_com ("flushregs", class_maintenance, reg_flush_command,
1418 _("Force gdb to flush its register cache (maintainer command)"));
1420 /* Initialize the thread/process associated with the current set of
1421 registers. For now, -1 is special, and means `no current process'. */
1422 registers_ptid = pid_to_ptid (-1);
1424 add_cmd ("registers", class_maintenance, maintenance_print_registers, _("\
1425 Print the internal register configuration.\n\
1426 Takes an optional file parameter."), &maintenanceprintlist);
1427 add_cmd ("raw-registers", class_maintenance,
1428 maintenance_print_raw_registers, _("\
1429 Print the internal register configuration including raw values.\n\
1430 Takes an optional file parameter."), &maintenanceprintlist);
1431 add_cmd ("cooked-registers", class_maintenance,
1432 maintenance_print_cooked_registers, _("\
1433 Print the internal register configuration including cooked values.\n\
1434 Takes an optional file parameter."), &maintenanceprintlist);
1435 add_cmd ("register-groups", class_maintenance,
1436 maintenance_print_register_groups, _("\
1437 Print the internal register configuration including each register's group.\n\
1438 Takes an optional file parameter."),
1439 &maintenanceprintlist);