1 /* Cache and manage the values of registers for GDB, the GNU debugger.
3 Copyright (C) 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000, 2001,
4 2002, 2004, 2007 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., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, 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 registers 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 /* Register cache status:
190 register_valid_p[REG] == 0 if REG value is not in the cache
191 > 0 if REG value is in the cache
192 < 0 if REG value is permanently unavailable */
193 signed char *register_valid_p;
194 /* Is this a read-only cache? A read-only cache is used for saving
195 the target's register state (e.g, across an inferior function
196 call or just before forcing a function return). A read-only
197 cache can only be updated via the methods regcache_dup() and
198 regcache_cpy(). The actual contents are determined by the
199 reggroup_save and reggroup_restore methods. */
204 regcache_xmalloc (struct gdbarch *gdbarch)
206 struct regcache_descr *descr;
207 struct regcache *regcache;
208 gdb_assert (gdbarch != NULL);
209 descr = regcache_descr (gdbarch);
210 regcache = XMALLOC (struct regcache);
211 regcache->descr = descr;
213 = XCALLOC (descr->sizeof_raw_registers, gdb_byte);
214 regcache->register_valid_p
215 = XCALLOC (descr->sizeof_raw_register_valid_p, gdb_byte);
216 regcache->readonly_p = 1;
221 regcache_xfree (struct regcache *regcache)
223 if (regcache == NULL)
225 xfree (regcache->registers);
226 xfree (regcache->register_valid_p);
231 do_regcache_xfree (void *data)
233 regcache_xfree (data);
237 make_cleanup_regcache_xfree (struct regcache *regcache)
239 return make_cleanup (do_regcache_xfree, regcache);
242 /* Return REGCACHE's architecture. */
245 get_regcache_arch (const struct regcache *regcache)
247 return regcache->descr->gdbarch;
250 /* Return a pointer to register REGNUM's buffer cache. */
253 register_buffer (const struct regcache *regcache, int regnum)
255 return regcache->registers + regcache->descr->register_offset[regnum];
259 regcache_save (struct regcache *dst, regcache_cooked_read_ftype *cooked_read,
262 struct gdbarch *gdbarch = dst->descr->gdbarch;
263 gdb_byte buf[MAX_REGISTER_SIZE];
265 /* The DST should be `read-only', if it wasn't then the save would
266 end up trying to write the register values back out to the
268 gdb_assert (dst->readonly_p);
269 /* Clear the dest. */
270 memset (dst->registers, 0, dst->descr->sizeof_cooked_registers);
271 memset (dst->register_valid_p, 0, dst->descr->sizeof_cooked_register_valid_p);
272 /* Copy over any registers (identified by their membership in the
273 save_reggroup) and mark them as valid. The full [0 .. NUM_REGS +
274 NUM_PSEUDO_REGS) range is checked since some architectures need
275 to save/restore `cooked' registers that live in memory. */
276 for (regnum = 0; regnum < dst->descr->nr_cooked_registers; regnum++)
278 if (gdbarch_register_reggroup_p (gdbarch, regnum, save_reggroup))
280 int valid = cooked_read (src, regnum, buf);
283 memcpy (register_buffer (dst, regnum), buf,
284 register_size (gdbarch, regnum));
285 dst->register_valid_p[regnum] = 1;
292 regcache_restore (struct regcache *dst,
293 regcache_cooked_read_ftype *cooked_read,
294 void *cooked_read_context)
296 struct gdbarch *gdbarch = dst->descr->gdbarch;
297 gdb_byte buf[MAX_REGISTER_SIZE];
299 /* The dst had better not be read-only. If it is, the `restore'
300 doesn't make much sense. */
301 gdb_assert (!dst->readonly_p);
302 /* Copy over any registers, being careful to only restore those that
303 were both saved and need to be restored. The full [0 .. NUM_REGS
304 + NUM_PSEUDO_REGS) range is checked since some architectures need
305 to save/restore `cooked' registers that live in memory. */
306 for (regnum = 0; regnum < dst->descr->nr_cooked_registers; regnum++)
308 if (gdbarch_register_reggroup_p (gdbarch, regnum, restore_reggroup))
310 int valid = cooked_read (cooked_read_context, regnum, buf);
312 regcache_cooked_write (dst, regnum, buf);
318 do_cooked_read (void *src, int regnum, gdb_byte *buf)
320 struct regcache *regcache = src;
321 if (!regcache->register_valid_p[regnum] && regcache->readonly_p)
322 /* Don't even think about fetching a register from a read-only
323 cache when the register isn't yet valid. There isn't a target
324 from which the register value can be fetched. */
326 regcache_cooked_read (regcache, regnum, buf);
332 regcache_cpy (struct regcache *dst, struct regcache *src)
336 gdb_assert (src != NULL && dst != NULL);
337 gdb_assert (src->descr->gdbarch == dst->descr->gdbarch);
338 gdb_assert (src != dst);
339 gdb_assert (src->readonly_p || dst->readonly_p);
340 if (!src->readonly_p)
341 regcache_save (dst, do_cooked_read, src);
342 else if (!dst->readonly_p)
343 regcache_restore (dst, do_cooked_read, src);
345 regcache_cpy_no_passthrough (dst, src);
349 regcache_cpy_no_passthrough (struct regcache *dst, struct regcache *src)
352 gdb_assert (src != NULL && dst != NULL);
353 gdb_assert (src->descr->gdbarch == dst->descr->gdbarch);
354 /* NOTE: cagney/2002-05-17: Don't let the caller do a no-passthrough
355 move of data into the current_regcache(). Doing this would be
356 silly - it would mean that valid_p would be completely invalid. */
357 gdb_assert (dst != current_regcache);
358 memcpy (dst->registers, src->registers, dst->descr->sizeof_raw_registers);
359 memcpy (dst->register_valid_p, src->register_valid_p,
360 dst->descr->sizeof_raw_register_valid_p);
364 regcache_dup (struct regcache *src)
366 struct regcache *newbuf;
367 gdb_assert (current_regcache != NULL);
368 newbuf = regcache_xmalloc (src->descr->gdbarch);
369 regcache_cpy (newbuf, src);
374 regcache_dup_no_passthrough (struct regcache *src)
376 struct regcache *newbuf;
377 gdb_assert (current_regcache != NULL);
378 newbuf = regcache_xmalloc (src->descr->gdbarch);
379 regcache_cpy_no_passthrough (newbuf, src);
384 regcache_valid_p (struct regcache *regcache, int regnum)
386 gdb_assert (regcache != NULL);
387 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
388 return regcache->register_valid_p[regnum];
392 deprecated_grub_regcache_for_registers (struct regcache *regcache)
394 return regcache->registers;
397 /* Global structure containing the current regcache. */
398 /* FIXME: cagney/2002-05-11: The two global arrays registers[] and
399 deprecated_register_valid[] currently point into this structure. */
400 struct regcache *current_regcache;
402 /* NOTE: this is a write-through cache. There is no "dirty" bit for
403 recording if the register values have been changed (eg. by the
404 user). Therefore all registers must be written back to the
405 target when appropriate. */
407 /* The thread/process associated with the current set of registers. */
409 static ptid_t registers_ptid;
417 Returns 0 if the value is not in the cache (needs fetch).
418 >0 if the value is in the cache.
419 <0 if the value is permanently unavailable (don't ask again). */
422 register_cached (int regnum)
424 return current_regcache->register_valid_p[regnum];
427 /* Record that REGNUM's value is cached if STATE is >0, uncached but
428 fetchable if STATE is 0, and uncached and unfetchable if STATE is <0. */
431 set_register_cached (int regnum, int state)
433 gdb_assert (regnum >= 0);
434 gdb_assert (regnum < current_regcache->descr->nr_raw_registers);
435 current_regcache->register_valid_p[regnum] = state;
438 /* Observer for the target_changed event. */
441 regcache_observer_target_changed (struct target_ops *target)
443 registers_changed ();
446 /* Low level examining and depositing of registers.
448 The caller is responsible for making sure that the inferior is
449 stopped before calling the fetching routines, or it will get
450 garbage. (a change from GDB version 3, in which the caller got the
451 value from the last stop). */
453 /* REGISTERS_CHANGED ()
455 Indicate that registers may have changed, so invalidate the cache. */
458 registers_changed (void)
462 registers_ptid = pid_to_ptid (-1);
464 /* Force cleanup of any alloca areas if using C alloca instead of
465 a builtin alloca. This particular call is used to clean up
466 areas allocated by low level target code which may build up
467 during lengthy interactions between gdb and the target before
468 gdb gives control to the user (ie watchpoints). */
471 for (i = 0; i < current_regcache->descr->nr_raw_registers; i++)
472 set_register_cached (i, 0);
474 if (deprecated_registers_changed_hook)
475 deprecated_registers_changed_hook ();
478 /* DEPRECATED_REGISTERS_FETCHED ()
480 Indicate that all registers have been fetched, so mark them all valid. */
482 /* FIXME: cagney/2001-12-04: This function is DEPRECATED. The target
483 code was blatting the registers[] array and then calling this.
484 Since targets should only be using regcache_raw_supply() the need for
485 this function/hack is eliminated. */
488 deprecated_registers_fetched (void)
492 for (i = 0; i < NUM_REGS; i++)
493 set_register_cached (i, 1);
494 /* Do not assume that the pseudo-regs have also been fetched.
495 Fetching all real regs NEVER accounts for pseudo-regs. */
499 regcache_raw_read (struct regcache *regcache, int regnum, gdb_byte *buf)
501 gdb_assert (regcache != NULL && buf != NULL);
502 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
503 /* Make certain that the register cache is up-to-date with respect
504 to the current thread. This switching shouldn't be necessary
505 only there is still only one target side register cache. Sigh!
506 On the bright side, at least there is a regcache object. */
507 if (!regcache->readonly_p)
509 gdb_assert (regcache == current_regcache);
510 if (! ptid_equal (registers_ptid, inferior_ptid))
512 registers_changed ();
513 registers_ptid = inferior_ptid;
515 if (!register_cached (regnum))
516 target_fetch_registers (regnum);
518 /* FIXME: cagney/2004-08-07: At present a number of targets
519 forget (or didn't know that they needed) to set this leading to
520 panics. Also is the problem that targets need to indicate
521 that a register is in one of the possible states: valid,
522 undefined, unknown. The last of which isn't yet
524 gdb_assert (register_cached (regnum));
527 /* Copy the value directly into the register cache. */
528 memcpy (buf, register_buffer (regcache, regnum),
529 regcache->descr->sizeof_register[regnum]);
533 regcache_raw_read_signed (struct regcache *regcache, int regnum, LONGEST *val)
536 gdb_assert (regcache != NULL);
537 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
538 buf = alloca (regcache->descr->sizeof_register[regnum]);
539 regcache_raw_read (regcache, regnum, buf);
540 (*val) = extract_signed_integer (buf,
541 regcache->descr->sizeof_register[regnum]);
545 regcache_raw_read_unsigned (struct regcache *regcache, int regnum,
549 gdb_assert (regcache != NULL);
550 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
551 buf = alloca (regcache->descr->sizeof_register[regnum]);
552 regcache_raw_read (regcache, regnum, buf);
553 (*val) = extract_unsigned_integer (buf,
554 regcache->descr->sizeof_register[regnum]);
558 regcache_raw_write_signed (struct regcache *regcache, int regnum, LONGEST val)
561 gdb_assert (regcache != NULL);
562 gdb_assert (regnum >=0 && regnum < regcache->descr->nr_raw_registers);
563 buf = alloca (regcache->descr->sizeof_register[regnum]);
564 store_signed_integer (buf, regcache->descr->sizeof_register[regnum], val);
565 regcache_raw_write (regcache, regnum, buf);
569 regcache_raw_write_unsigned (struct regcache *regcache, int regnum,
573 gdb_assert (regcache != NULL);
574 gdb_assert (regnum >=0 && regnum < regcache->descr->nr_raw_registers);
575 buf = alloca (regcache->descr->sizeof_register[regnum]);
576 store_unsigned_integer (buf, regcache->descr->sizeof_register[regnum], val);
577 regcache_raw_write (regcache, regnum, buf);
581 deprecated_read_register_gen (int regnum, gdb_byte *buf)
583 gdb_assert (current_regcache != NULL);
584 gdb_assert (current_regcache->descr->gdbarch == current_gdbarch);
585 regcache_cooked_read (current_regcache, regnum, buf);
589 regcache_cooked_read (struct regcache *regcache, int regnum, gdb_byte *buf)
591 gdb_assert (regnum >= 0);
592 gdb_assert (regnum < regcache->descr->nr_cooked_registers);
593 if (regnum < regcache->descr->nr_raw_registers)
594 regcache_raw_read (regcache, regnum, buf);
595 else if (regcache->readonly_p
596 && regnum < regcache->descr->nr_cooked_registers
597 && regcache->register_valid_p[regnum])
598 /* Read-only register cache, perhaps the cooked value was cached? */
599 memcpy (buf, register_buffer (regcache, regnum),
600 regcache->descr->sizeof_register[regnum]);
602 gdbarch_pseudo_register_read (regcache->descr->gdbarch, regcache,
607 regcache_cooked_read_signed (struct regcache *regcache, int regnum,
611 gdb_assert (regcache != NULL);
612 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_cooked_registers);
613 buf = alloca (regcache->descr->sizeof_register[regnum]);
614 regcache_cooked_read (regcache, regnum, buf);
615 (*val) = extract_signed_integer (buf,
616 regcache->descr->sizeof_register[regnum]);
620 regcache_cooked_read_unsigned (struct regcache *regcache, int regnum,
624 gdb_assert (regcache != NULL);
625 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_cooked_registers);
626 buf = alloca (regcache->descr->sizeof_register[regnum]);
627 regcache_cooked_read (regcache, regnum, buf);
628 (*val) = extract_unsigned_integer (buf,
629 regcache->descr->sizeof_register[regnum]);
633 regcache_cooked_write_signed (struct regcache *regcache, int regnum,
637 gdb_assert (regcache != NULL);
638 gdb_assert (regnum >=0 && regnum < regcache->descr->nr_cooked_registers);
639 buf = alloca (regcache->descr->sizeof_register[regnum]);
640 store_signed_integer (buf, regcache->descr->sizeof_register[regnum], val);
641 regcache_cooked_write (regcache, regnum, buf);
645 regcache_cooked_write_unsigned (struct regcache *regcache, int regnum,
649 gdb_assert (regcache != NULL);
650 gdb_assert (regnum >=0 && regnum < regcache->descr->nr_cooked_registers);
651 buf = alloca (regcache->descr->sizeof_register[regnum]);
652 store_unsigned_integer (buf, regcache->descr->sizeof_register[regnum], val);
653 regcache_cooked_write (regcache, regnum, buf);
657 regcache_raw_write (struct regcache *regcache, int regnum,
660 gdb_assert (regcache != NULL && buf != NULL);
661 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
662 gdb_assert (!regcache->readonly_p);
664 /* On the sparc, writing %g0 is a no-op, so we don't even want to
665 change the registers array if something writes to this register. */
666 if (CANNOT_STORE_REGISTER (regnum))
669 /* Make certain that the correct cache is selected. */
670 gdb_assert (regcache == current_regcache);
671 if (! ptid_equal (registers_ptid, inferior_ptid))
673 registers_changed ();
674 registers_ptid = inferior_ptid;
677 /* If we have a valid copy of the register, and new value == old
678 value, then don't bother doing the actual store. */
679 if (regcache_valid_p (regcache, regnum)
680 && (memcmp (register_buffer (regcache, regnum), buf,
681 regcache->descr->sizeof_register[regnum]) == 0))
684 target_prepare_to_store ();
685 memcpy (register_buffer (regcache, regnum), buf,
686 regcache->descr->sizeof_register[regnum]);
687 regcache->register_valid_p[regnum] = 1;
688 target_store_registers (regnum);
692 deprecated_write_register_gen (int regnum, gdb_byte *buf)
694 gdb_assert (current_regcache != NULL);
695 gdb_assert (current_regcache->descr->gdbarch == current_gdbarch);
696 regcache_cooked_write (current_regcache, regnum, buf);
700 regcache_cooked_write (struct regcache *regcache, int regnum,
703 gdb_assert (regnum >= 0);
704 gdb_assert (regnum < regcache->descr->nr_cooked_registers);
705 if (regnum < regcache->descr->nr_raw_registers)
706 regcache_raw_write (regcache, regnum, buf);
708 gdbarch_pseudo_register_write (regcache->descr->gdbarch, regcache,
712 /* Perform a partial register transfer using a read, modify, write
715 typedef void (regcache_read_ftype) (struct regcache *regcache, int regnum,
717 typedef void (regcache_write_ftype) (struct regcache *regcache, int regnum,
721 regcache_xfer_part (struct regcache *regcache, int regnum,
722 int offset, int len, void *in, const void *out,
723 void (*read) (struct regcache *regcache, int regnum,
725 void (*write) (struct regcache *regcache, int regnum,
726 const gdb_byte *buf))
728 struct regcache_descr *descr = regcache->descr;
729 gdb_byte reg[MAX_REGISTER_SIZE];
730 gdb_assert (offset >= 0 && offset <= descr->sizeof_register[regnum]);
731 gdb_assert (len >= 0 && offset + len <= descr->sizeof_register[regnum]);
732 /* Something to do? */
733 if (offset + len == 0)
735 /* Read (when needed) ... */
738 || offset + len < descr->sizeof_register[regnum])
740 gdb_assert (read != NULL);
741 read (regcache, regnum, reg);
745 memcpy (in, reg + offset, len);
747 memcpy (reg + offset, out, len);
748 /* ... write (when needed). */
751 gdb_assert (write != NULL);
752 write (regcache, regnum, reg);
757 regcache_raw_read_part (struct regcache *regcache, int regnum,
758 int offset, int len, gdb_byte *buf)
760 struct regcache_descr *descr = regcache->descr;
761 gdb_assert (regnum >= 0 && regnum < descr->nr_raw_registers);
762 regcache_xfer_part (regcache, regnum, offset, len, buf, NULL,
763 regcache_raw_read, regcache_raw_write);
767 regcache_raw_write_part (struct regcache *regcache, int regnum,
768 int offset, int len, const gdb_byte *buf)
770 struct regcache_descr *descr = regcache->descr;
771 gdb_assert (regnum >= 0 && regnum < descr->nr_raw_registers);
772 regcache_xfer_part (regcache, regnum, offset, len, NULL, buf,
773 regcache_raw_read, regcache_raw_write);
777 regcache_cooked_read_part (struct regcache *regcache, int regnum,
778 int offset, int len, gdb_byte *buf)
780 struct regcache_descr *descr = regcache->descr;
781 gdb_assert (regnum >= 0 && regnum < descr->nr_cooked_registers);
782 regcache_xfer_part (regcache, regnum, offset, len, buf, NULL,
783 regcache_cooked_read, regcache_cooked_write);
787 regcache_cooked_write_part (struct regcache *regcache, int regnum,
788 int offset, int len, const gdb_byte *buf)
790 struct regcache_descr *descr = regcache->descr;
791 gdb_assert (regnum >= 0 && regnum < descr->nr_cooked_registers);
792 regcache_xfer_part (regcache, regnum, offset, len, NULL, buf,
793 regcache_cooked_read, regcache_cooked_write);
796 /* Hack to keep code that view the register buffer as raw bytes
800 register_offset_hack (struct gdbarch *gdbarch, int regnum)
802 struct regcache_descr *descr = regcache_descr (gdbarch);
803 gdb_assert (regnum >= 0 && regnum < descr->nr_cooked_registers);
804 return descr->register_offset[regnum];
807 /* Return the contents of register REGNUM as an unsigned integer. */
810 read_register (int regnum)
812 gdb_byte *buf = alloca (register_size (current_gdbarch, regnum));
813 deprecated_read_register_gen (regnum, buf);
814 return (extract_unsigned_integer (buf, register_size (current_gdbarch, regnum)));
818 read_register_pid (int regnum, ptid_t ptid)
824 if (ptid_equal (ptid, inferior_ptid))
825 return read_register (regnum);
827 save_ptid = inferior_ptid;
829 inferior_ptid = ptid;
831 retval = read_register (regnum);
833 inferior_ptid = save_ptid;
838 /* Store VALUE into the raw contents of register number REGNUM. */
841 write_register (int regnum, LONGEST val)
845 size = register_size (current_gdbarch, regnum);
847 store_signed_integer (buf, size, (LONGEST) val);
848 deprecated_write_register_gen (regnum, buf);
852 write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid)
856 if (ptid_equal (ptid, inferior_ptid))
858 write_register (regnum, val);
862 save_ptid = inferior_ptid;
864 inferior_ptid = ptid;
866 write_register (regnum, val);
868 inferior_ptid = save_ptid;
871 /* Supply register REGNUM, whose contents are stored in BUF, to REGCACHE. */
874 regcache_raw_supply (struct regcache *regcache, int regnum, const void *buf)
879 gdb_assert (regcache != NULL);
880 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
881 gdb_assert (!regcache->readonly_p);
883 /* FIXME: kettenis/20030828: It shouldn't be necessary to handle
884 CURRENT_REGCACHE specially here. */
885 if (regcache == current_regcache
886 && !ptid_equal (registers_ptid, inferior_ptid))
888 registers_changed ();
889 registers_ptid = inferior_ptid;
892 regbuf = register_buffer (regcache, regnum);
893 size = regcache->descr->sizeof_register[regnum];
896 memcpy (regbuf, buf, size);
898 memset (regbuf, 0, size);
900 /* Mark the register as cached. */
901 regcache->register_valid_p[regnum] = 1;
904 /* Collect register REGNUM from REGCACHE and store its contents in BUF. */
907 regcache_raw_collect (const struct regcache *regcache, int regnum, void *buf)
912 gdb_assert (regcache != NULL && buf != NULL);
913 gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
915 regbuf = register_buffer (regcache, regnum);
916 size = regcache->descr->sizeof_register[regnum];
917 memcpy (buf, regbuf, size);
921 /* read_pc, write_pc, read_sp, etc. Special handling for registers
924 /* NOTE: cagney/2001-02-18: The functions read_pc_pid(), read_pc() and
925 read_sp(), will eventually be replaced by per-frame methods.
926 Instead of relying on the global INFERIOR_PTID, they will use the
927 contextual information provided by the FRAME. These functions do
928 not belong in the register cache. */
930 /* NOTE: cagney/2003-06-07: The functions generic_target_write_pc(),
931 write_pc_pid() and write_pc(), all need to be replaced by something
932 that does not rely on global state. But what? */
935 read_pc_pid (ptid_t ptid)
937 ptid_t saved_inferior_ptid;
940 /* In case ptid != inferior_ptid. */
941 saved_inferior_ptid = inferior_ptid;
942 inferior_ptid = ptid;
944 if (TARGET_READ_PC_P ())
945 pc_val = TARGET_READ_PC (ptid);
946 /* Else use per-frame method on get_current_frame. */
947 else if (PC_REGNUM >= 0)
949 CORE_ADDR raw_val = read_register_pid (PC_REGNUM, ptid);
950 pc_val = ADDR_BITS_REMOVE (raw_val);
953 internal_error (__FILE__, __LINE__, _("read_pc_pid: Unable to find PC"));
955 inferior_ptid = saved_inferior_ptid;
962 return read_pc_pid (inferior_ptid);
966 generic_target_write_pc (CORE_ADDR pc, ptid_t ptid)
969 write_register_pid (PC_REGNUM, pc, ptid);
971 internal_error (__FILE__, __LINE__,
972 _("generic_target_write_pc"));
976 write_pc_pid (CORE_ADDR pc, ptid_t ptid)
978 ptid_t saved_inferior_ptid;
980 /* In case ptid != inferior_ptid. */
981 saved_inferior_ptid = inferior_ptid;
982 inferior_ptid = ptid;
984 TARGET_WRITE_PC (pc, ptid);
986 inferior_ptid = saved_inferior_ptid;
990 write_pc (CORE_ADDR pc)
992 write_pc_pid (pc, inferior_ptid);
995 /* Cope with strage ways of getting to the stack and frame pointers */
1000 if (TARGET_READ_SP_P ())
1001 return TARGET_READ_SP ();
1002 else if (gdbarch_unwind_sp_p (current_gdbarch))
1003 return get_frame_sp (get_current_frame ());
1004 else if (SP_REGNUM >= 0)
1005 /* Try SP_REGNUM last: this makes all sorts of [wrong] assumptions
1006 about the architecture so put it at the end. */
1007 return read_register (SP_REGNUM);
1008 internal_error (__FILE__, __LINE__, _("read_sp: Unable to find SP"));
1012 reg_flush_command (char *command, int from_tty)
1014 /* Force-flush the register cache. */
1015 registers_changed ();
1017 printf_filtered (_("Register cache flushed.\n"));
1021 build_regcache (void)
1023 current_regcache = regcache_xmalloc (current_gdbarch);
1024 current_regcache->readonly_p = 0;
1028 dump_endian_bytes (struct ui_file *file, enum bfd_endian endian,
1029 const unsigned char *buf, long len)
1034 case BFD_ENDIAN_BIG:
1035 for (i = 0; i < len; i++)
1036 fprintf_unfiltered (file, "%02x", buf[i]);
1038 case BFD_ENDIAN_LITTLE:
1039 for (i = len - 1; i >= 0; i--)
1040 fprintf_unfiltered (file, "%02x", buf[i]);
1043 internal_error (__FILE__, __LINE__, _("Bad switch"));
1047 enum regcache_dump_what
1049 regcache_dump_none, regcache_dump_raw, regcache_dump_cooked, regcache_dump_groups
1053 regcache_dump (struct regcache *regcache, struct ui_file *file,
1054 enum regcache_dump_what what_to_dump)
1056 struct cleanup *cleanups = make_cleanup (null_cleanup, NULL);
1057 struct gdbarch *gdbarch = regcache->descr->gdbarch;
1059 int footnote_nr = 0;
1060 int footnote_register_size = 0;
1061 int footnote_register_offset = 0;
1062 int footnote_register_type_name_null = 0;
1063 long register_offset = 0;
1064 unsigned char buf[MAX_REGISTER_SIZE];
1067 fprintf_unfiltered (file, "nr_raw_registers %d\n",
1068 regcache->descr->nr_raw_registers);
1069 fprintf_unfiltered (file, "nr_cooked_registers %d\n",
1070 regcache->descr->nr_cooked_registers);
1071 fprintf_unfiltered (file, "sizeof_raw_registers %ld\n",
1072 regcache->descr->sizeof_raw_registers);
1073 fprintf_unfiltered (file, "sizeof_raw_register_valid_p %ld\n",
1074 regcache->descr->sizeof_raw_register_valid_p);
1075 fprintf_unfiltered (file, "NUM_REGS %d\n", NUM_REGS);
1076 fprintf_unfiltered (file, "NUM_PSEUDO_REGS %d\n", NUM_PSEUDO_REGS);
1079 gdb_assert (regcache->descr->nr_cooked_registers
1080 == (NUM_REGS + NUM_PSEUDO_REGS));
1082 for (regnum = -1; regnum < regcache->descr->nr_cooked_registers; regnum++)
1086 fprintf_unfiltered (file, " %-10s", "Name");
1089 const char *p = REGISTER_NAME (regnum);
1092 else if (p[0] == '\0')
1094 fprintf_unfiltered (file, " %-10s", p);
1099 fprintf_unfiltered (file, " %4s", "Nr");
1101 fprintf_unfiltered (file, " %4d", regnum);
1103 /* Relative number. */
1105 fprintf_unfiltered (file, " %4s", "Rel");
1106 else if (regnum < NUM_REGS)
1107 fprintf_unfiltered (file, " %4d", regnum);
1109 fprintf_unfiltered (file, " %4d", (regnum - NUM_REGS));
1113 fprintf_unfiltered (file, " %6s ", "Offset");
1116 fprintf_unfiltered (file, " %6ld",
1117 regcache->descr->register_offset[regnum]);
1118 if (register_offset != regcache->descr->register_offset[regnum]
1119 || register_offset != DEPRECATED_REGISTER_BYTE (regnum)
1121 && (regcache->descr->register_offset[regnum]
1122 != (regcache->descr->register_offset[regnum - 1]
1123 + regcache->descr->sizeof_register[regnum - 1])))
1126 if (!footnote_register_offset)
1127 footnote_register_offset = ++footnote_nr;
1128 fprintf_unfiltered (file, "*%d", footnote_register_offset);
1131 fprintf_unfiltered (file, " ");
1132 register_offset = (regcache->descr->register_offset[regnum]
1133 + regcache->descr->sizeof_register[regnum]);
1138 fprintf_unfiltered (file, " %5s ", "Size");
1140 fprintf_unfiltered (file, " %5ld",
1141 regcache->descr->sizeof_register[regnum]);
1150 static const char blt[] = "builtin_type";
1151 t = TYPE_NAME (register_type (regcache->descr->gdbarch, regnum));
1155 if (!footnote_register_type_name_null)
1156 footnote_register_type_name_null = ++footnote_nr;
1157 n = xstrprintf ("*%d", footnote_register_type_name_null);
1158 make_cleanup (xfree, n);
1161 /* Chop a leading builtin_type. */
1162 if (strncmp (t, blt, strlen (blt)) == 0)
1165 fprintf_unfiltered (file, " %-15s", t);
1168 /* Leading space always present. */
1169 fprintf_unfiltered (file, " ");
1172 if (what_to_dump == regcache_dump_raw)
1175 fprintf_unfiltered (file, "Raw value");
1176 else if (regnum >= regcache->descr->nr_raw_registers)
1177 fprintf_unfiltered (file, "<cooked>");
1178 else if (!regcache_valid_p (regcache, regnum))
1179 fprintf_unfiltered (file, "<invalid>");
1182 regcache_raw_read (regcache, regnum, buf);
1183 fprintf_unfiltered (file, "0x");
1184 dump_endian_bytes (file, TARGET_BYTE_ORDER, buf,
1185 regcache->descr->sizeof_register[regnum]);
1189 /* Value, cooked. */
1190 if (what_to_dump == regcache_dump_cooked)
1193 fprintf_unfiltered (file, "Cooked value");
1196 regcache_cooked_read (regcache, regnum, buf);
1197 fprintf_unfiltered (file, "0x");
1198 dump_endian_bytes (file, TARGET_BYTE_ORDER, buf,
1199 regcache->descr->sizeof_register[regnum]);
1203 /* Group members. */
1204 if (what_to_dump == regcache_dump_groups)
1207 fprintf_unfiltered (file, "Groups");
1210 const char *sep = "";
1211 struct reggroup *group;
1212 for (group = reggroup_next (gdbarch, NULL);
1214 group = reggroup_next (gdbarch, group))
1216 if (gdbarch_register_reggroup_p (gdbarch, regnum, group))
1218 fprintf_unfiltered (file, "%s%s", sep, reggroup_name (group));
1225 fprintf_unfiltered (file, "\n");
1228 if (footnote_register_size)
1229 fprintf_unfiltered (file, "*%d: Inconsistent register sizes.\n",
1230 footnote_register_size);
1231 if (footnote_register_offset)
1232 fprintf_unfiltered (file, "*%d: Inconsistent register offsets.\n",
1233 footnote_register_offset);
1234 if (footnote_register_type_name_null)
1235 fprintf_unfiltered (file,
1236 "*%d: Register type's name NULL.\n",
1237 footnote_register_type_name_null);
1238 do_cleanups (cleanups);
1242 regcache_print (char *args, enum regcache_dump_what what_to_dump)
1245 regcache_dump (current_regcache, gdb_stdout, what_to_dump);
1248 struct ui_file *file = gdb_fopen (args, "w");
1250 perror_with_name (_("maintenance print architecture"));
1251 regcache_dump (current_regcache, file, what_to_dump);
1252 ui_file_delete (file);
1257 maintenance_print_registers (char *args, int from_tty)
1259 regcache_print (args, regcache_dump_none);
1263 maintenance_print_raw_registers (char *args, int from_tty)
1265 regcache_print (args, regcache_dump_raw);
1269 maintenance_print_cooked_registers (char *args, int from_tty)
1271 regcache_print (args, regcache_dump_cooked);
1275 maintenance_print_register_groups (char *args, int from_tty)
1277 regcache_print (args, regcache_dump_groups);
1280 extern initialize_file_ftype _initialize_regcache; /* -Wmissing-prototype */
1283 _initialize_regcache (void)
1285 regcache_descr_handle = gdbarch_data_register_post_init (init_regcache_descr);
1286 DEPRECATED_REGISTER_GDBARCH_SWAP (current_regcache);
1287 deprecated_register_gdbarch_swap (NULL, 0, build_regcache);
1289 observer_attach_target_changed (regcache_observer_target_changed);
1291 add_com ("flushregs", class_maintenance, reg_flush_command,
1292 _("Force gdb to flush its register cache (maintainer command)"));
1294 /* Initialize the thread/process associated with the current set of
1295 registers. For now, -1 is special, and means `no current process'. */
1296 registers_ptid = pid_to_ptid (-1);
1298 add_cmd ("registers", class_maintenance, maintenance_print_registers, _("\
1299 Print the internal register configuration.\n\
1300 Takes an optional file parameter."), &maintenanceprintlist);
1301 add_cmd ("raw-registers", class_maintenance,
1302 maintenance_print_raw_registers, _("\
1303 Print the internal register configuration including raw values.\n\
1304 Takes an optional file parameter."), &maintenanceprintlist);
1305 add_cmd ("cooked-registers", class_maintenance,
1306 maintenance_print_cooked_registers, _("\
1307 Print the internal register configuration including cooked values.\n\
1308 Takes an optional file parameter."), &maintenanceprintlist);
1309 add_cmd ("register-groups", class_maintenance,
1310 maintenance_print_register_groups, _("\
1311 Print the internal register configuration including each register's group.\n\
1312 Takes an optional file parameter."),
1313 &maintenanceprintlist);