1 /* Cache and manage the values of registers for GDB, the GNU debugger.
3 Copyright (C) 1986-2018 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 #include "reggroups.h"
31 #include <forward_list>
36 * Here is the actual register cache.
39 /* Per-architecture object describing the layout of a register cache.
40 Computed once when the architecture is created. */
42 struct gdbarch_data *regcache_descr_handle;
46 /* The architecture this descriptor belongs to. */
47 struct gdbarch *gdbarch;
49 /* The raw register cache. Each raw (or hard) register is supplied
50 by the target interface. The raw cache should not contain
51 redundant information - if the PC is constructed from two
52 registers then those registers and not the PC lives in the raw
54 long sizeof_raw_registers;
56 /* The cooked register space. Each cooked register in the range
57 [0..NR_RAW_REGISTERS) is direct-mapped onto the corresponding raw
58 register. The remaining [NR_RAW_REGISTERS
59 .. NR_COOKED_REGISTERS) (a.k.a. pseudo registers) are mapped onto
60 both raw registers and memory by the architecture methods
61 gdbarch_pseudo_register_read and gdbarch_pseudo_register_write. */
62 int nr_cooked_registers;
63 long sizeof_cooked_registers;
65 /* Offset and size (in 8 bit bytes), of each register in the
66 register cache. All registers (including those in the range
67 [NR_RAW_REGISTERS .. NR_COOKED_REGISTERS) are given an
69 long *register_offset;
70 long *sizeof_register;
72 /* Cached table containing the type of each register. */
73 struct type **register_type;
77 init_regcache_descr (struct gdbarch *gdbarch)
80 struct regcache_descr *descr;
81 gdb_assert (gdbarch != NULL);
83 /* Create an initial, zero filled, table. */
84 descr = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct regcache_descr);
85 descr->gdbarch = gdbarch;
87 /* Total size of the register space. The raw registers are mapped
88 directly onto the raw register cache while the pseudo's are
89 either mapped onto raw-registers or memory. */
90 descr->nr_cooked_registers = gdbarch_num_regs (gdbarch)
91 + gdbarch_num_pseudo_regs (gdbarch);
93 /* Fill in a table of register types. */
95 = GDBARCH_OBSTACK_CALLOC (gdbarch, descr->nr_cooked_registers,
97 for (i = 0; i < descr->nr_cooked_registers; i++)
98 descr->register_type[i] = gdbarch_register_type (gdbarch, i);
100 /* Construct a strictly RAW register cache. Don't allow pseudo's
101 into the register cache. */
103 /* Lay out the register cache.
105 NOTE: cagney/2002-05-22: Only register_type() is used when
106 constructing the register cache. It is assumed that the
107 register's raw size, virtual size and type length are all the
113 descr->sizeof_register
114 = GDBARCH_OBSTACK_CALLOC (gdbarch, descr->nr_cooked_registers, long);
115 descr->register_offset
116 = GDBARCH_OBSTACK_CALLOC (gdbarch, descr->nr_cooked_registers, long);
117 for (i = 0; i < gdbarch_num_regs (gdbarch); i++)
119 descr->sizeof_register[i] = TYPE_LENGTH (descr->register_type[i]);
120 descr->register_offset[i] = offset;
121 offset += descr->sizeof_register[i];
122 gdb_assert (MAX_REGISTER_SIZE >= descr->sizeof_register[i]);
124 /* Set the real size of the raw register cache buffer. */
125 descr->sizeof_raw_registers = offset;
127 for (; i < descr->nr_cooked_registers; i++)
129 descr->sizeof_register[i] = TYPE_LENGTH (descr->register_type[i]);
130 descr->register_offset[i] = offset;
131 offset += descr->sizeof_register[i];
132 gdb_assert (MAX_REGISTER_SIZE >= descr->sizeof_register[i]);
134 /* Set the real size of the readonly register cache buffer. */
135 descr->sizeof_cooked_registers = offset;
141 static struct regcache_descr *
142 regcache_descr (struct gdbarch *gdbarch)
144 return (struct regcache_descr *) gdbarch_data (gdbarch,
145 regcache_descr_handle);
148 /* Utility functions returning useful register attributes stored in
149 the regcache descr. */
152 register_type (struct gdbarch *gdbarch, int regnum)
154 struct regcache_descr *descr = regcache_descr (gdbarch);
156 gdb_assert (regnum >= 0 && regnum < descr->nr_cooked_registers);
157 return descr->register_type[regnum];
160 /* Utility functions returning useful register attributes stored in
161 the regcache descr. */
164 register_size (struct gdbarch *gdbarch, int regnum)
166 struct regcache_descr *descr = regcache_descr (gdbarch);
169 gdb_assert (regnum >= 0
170 && regnum < (gdbarch_num_regs (gdbarch)
171 + gdbarch_num_pseudo_regs (gdbarch)));
172 size = descr->sizeof_register[regnum];
176 /* See common/common-regcache.h. */
179 regcache_register_size (const struct regcache *regcache, int n)
181 return register_size (regcache->arch (), n);
184 reg_buffer::reg_buffer (gdbarch *gdbarch, bool has_pseudo)
185 : m_has_pseudo (has_pseudo)
187 gdb_assert (gdbarch != NULL);
188 m_descr = regcache_descr (gdbarch);
192 m_registers = XCNEWVEC (gdb_byte, m_descr->sizeof_cooked_registers);
193 m_register_status = XCNEWVEC (signed char,
194 m_descr->nr_cooked_registers);
198 m_registers = XCNEWVEC (gdb_byte, m_descr->sizeof_raw_registers);
199 m_register_status = XCNEWVEC (signed char, gdbarch_num_regs (gdbarch));
203 regcache::regcache (gdbarch *gdbarch, const address_space *aspace_,
205 /* The register buffers. A read-only register cache can hold the
206 full [0 .. gdbarch_num_regs + gdbarch_num_pseudo_regs) while a
207 read/write register cache can only hold [0 .. gdbarch_num_regs). */
208 : detached_regcache (gdbarch, readonly_p_),
209 m_aspace (aspace_), m_readonly_p (readonly_p_)
211 m_ptid = minus_one_ptid;
214 static enum register_status
215 do_cooked_read (void *src, int regnum, gdb_byte *buf)
217 struct regcache *regcache = (struct regcache *) src;
219 return regcache_cooked_read (regcache, regnum, buf);
222 regcache::regcache (readonly_t, const regcache &src)
223 : regcache (src.arch (), nullptr, true)
225 gdb_assert (!src.m_readonly_p);
226 save (do_cooked_read, (void *) &src);
229 readonly_detached_regcache::readonly_detached_regcache (const regcache &src)
230 : readonly_detached_regcache (src.arch (), do_cooked_read, (void *) &src)
235 reg_buffer::arch () const
237 return m_descr->gdbarch;
240 /* See regcache.h. */
243 regcache_get_ptid (const struct regcache *regcache)
245 gdb_assert (!ptid_equal (regcache->ptid (), minus_one_ptid));
247 return regcache->ptid ();
250 /* Cleanup class for invalidating a register. */
252 class regcache_invalidator
256 regcache_invalidator (struct regcache *regcache, int regnum)
257 : m_regcache (regcache),
262 ~regcache_invalidator ()
264 if (m_regcache != nullptr)
265 regcache_invalidate (m_regcache, m_regnum);
268 DISABLE_COPY_AND_ASSIGN (regcache_invalidator);
272 m_regcache = nullptr;
277 struct regcache *m_regcache;
281 /* Return a pointer to register REGNUM's buffer cache. */
284 reg_buffer::register_buffer (int regnum) const
286 return m_registers + m_descr->register_offset[regnum];
290 reg_buffer::save (regcache_cooked_read_ftype *cooked_read,
293 struct gdbarch *gdbarch = m_descr->gdbarch;
296 /* It should have pseudo registers. */
297 gdb_assert (m_has_pseudo);
298 /* Clear the dest. */
299 memset (m_registers, 0, m_descr->sizeof_cooked_registers);
300 memset (m_register_status, 0, m_descr->nr_cooked_registers);
301 /* Copy over any registers (identified by their membership in the
302 save_reggroup) and mark them as valid. The full [0 .. gdbarch_num_regs +
303 gdbarch_num_pseudo_regs) range is checked since some architectures need
304 to save/restore `cooked' registers that live in memory. */
305 for (regnum = 0; regnum < m_descr->nr_cooked_registers; regnum++)
307 if (gdbarch_register_reggroup_p (gdbarch, regnum, save_reggroup))
309 gdb_byte *dst_buf = register_buffer (regnum);
310 enum register_status status = cooked_read (src, regnum, dst_buf);
312 gdb_assert (status != REG_UNKNOWN);
314 if (status != REG_VALID)
315 memset (dst_buf, 0, register_size (gdbarch, regnum));
317 m_register_status[regnum] = status;
323 regcache::restore (readonly_detached_regcache *src)
325 struct gdbarch *gdbarch = m_descr->gdbarch;
328 gdb_assert (src != NULL);
329 gdb_assert (!m_readonly_p);
330 gdb_assert (src->m_has_pseudo);
332 gdb_assert (gdbarch == src->arch ());
334 /* Copy over any registers, being careful to only restore those that
335 were both saved and need to be restored. The full [0 .. gdbarch_num_regs
336 + gdbarch_num_pseudo_regs) range is checked since some architectures need
337 to save/restore `cooked' registers that live in memory. */
338 for (regnum = 0; regnum < m_descr->nr_cooked_registers; regnum++)
340 if (gdbarch_register_reggroup_p (gdbarch, regnum, restore_reggroup))
342 if (src->m_register_status[regnum] == REG_VALID)
343 cooked_write (regnum, src->register_buffer (regnum));
349 regcache_register_status (const struct regcache *regcache, int regnum)
351 gdb_assert (regcache != NULL);
352 return regcache->get_register_status (regnum);
356 reg_buffer::get_register_status (int regnum) const
358 assert_regnum (regnum);
360 return (enum register_status) m_register_status[regnum];
364 regcache_invalidate (struct regcache *regcache, int regnum)
366 gdb_assert (regcache != NULL);
367 regcache->invalidate (regnum);
371 regcache::invalidate (int regnum)
373 gdb_assert (!m_readonly_p);
374 assert_regnum (regnum);
375 m_register_status[regnum] = REG_UNKNOWN;
379 reg_buffer::assert_regnum (int regnum) const
381 gdb_assert (regnum >= 0);
383 gdb_assert (regnum < m_descr->nr_cooked_registers);
385 gdb_assert (regnum < gdbarch_num_regs (arch ()));
388 /* Global structure containing the current regcache. */
390 /* NOTE: this is a write-through cache. There is no "dirty" bit for
391 recording if the register values have been changed (eg. by the
392 user). Therefore all registers must be written back to the
393 target when appropriate. */
394 std::forward_list<regcache *> regcache::current_regcache;
397 get_thread_arch_aspace_regcache (ptid_t ptid, struct gdbarch *gdbarch,
398 struct address_space *aspace)
400 for (const auto ®cache : regcache::current_regcache)
401 if (ptid_equal (regcache->ptid (), ptid) && regcache->arch () == gdbarch)
404 regcache *new_regcache = new regcache (gdbarch, aspace, false);
406 regcache::current_regcache.push_front (new_regcache);
407 new_regcache->set_ptid (ptid);
413 get_thread_arch_regcache (ptid_t ptid, struct gdbarch *gdbarch)
415 address_space *aspace = target_thread_address_space (ptid);
417 return get_thread_arch_aspace_regcache (ptid, gdbarch, aspace);
420 static ptid_t current_thread_ptid;
421 static struct gdbarch *current_thread_arch;
424 get_thread_regcache (ptid_t ptid)
426 if (!current_thread_arch || !ptid_equal (current_thread_ptid, ptid))
428 current_thread_ptid = ptid;
429 current_thread_arch = target_thread_architecture (ptid);
432 return get_thread_arch_regcache (ptid, current_thread_arch);
436 get_current_regcache (void)
438 return get_thread_regcache (inferior_ptid);
441 /* See common/common-regcache.h. */
444 get_thread_regcache_for_ptid (ptid_t ptid)
446 return get_thread_regcache (ptid);
449 /* Observer for the target_changed event. */
452 regcache_observer_target_changed (struct target_ops *target)
454 registers_changed ();
457 /* Update global variables old ptids to hold NEW_PTID if they were
460 regcache::regcache_thread_ptid_changed (ptid_t old_ptid, ptid_t new_ptid)
462 for (auto ®cache : regcache::current_regcache)
464 if (ptid_equal (regcache->ptid (), old_ptid))
465 regcache->set_ptid (new_ptid);
469 /* Low level examining and depositing of registers.
471 The caller is responsible for making sure that the inferior is
472 stopped before calling the fetching routines, or it will get
473 garbage. (a change from GDB version 3, in which the caller got the
474 value from the last stop). */
476 /* REGISTERS_CHANGED ()
478 Indicate that registers may have changed, so invalidate the cache. */
481 registers_changed_ptid (ptid_t ptid)
483 for (auto oit = regcache::current_regcache.before_begin (),
484 it = std::next (oit);
485 it != regcache::current_regcache.end ();
488 if (ptid_match ((*it)->ptid (), ptid))
491 it = regcache::current_regcache.erase_after (oit);
497 if (ptid_match (current_thread_ptid, ptid))
499 current_thread_ptid = null_ptid;
500 current_thread_arch = NULL;
503 if (ptid_match (inferior_ptid, ptid))
505 /* We just deleted the regcache of the current thread. Need to
506 forget about any frames we have cached, too. */
507 reinit_frame_cache ();
512 registers_changed (void)
514 registers_changed_ptid (minus_one_ptid);
516 /* Force cleanup of any alloca areas if using C alloca instead of
517 a builtin alloca. This particular call is used to clean up
518 areas allocated by low level target code which may build up
519 during lengthy interactions between gdb and the target before
520 gdb gives control to the user (ie watchpoints). */
525 regcache_raw_update (struct regcache *regcache, int regnum)
527 gdb_assert (regcache != NULL);
529 regcache->raw_update (regnum);
533 regcache::raw_update (int regnum)
535 assert_regnum (regnum);
537 /* Make certain that the register cache is up-to-date with respect
538 to the current thread. This switching shouldn't be necessary
539 only there is still only one target side register cache. Sigh!
540 On the bright side, at least there is a regcache object. */
542 if (!m_readonly_p && get_register_status (regnum) == REG_UNKNOWN)
544 target_fetch_registers (this, regnum);
546 /* A number of targets can't access the whole set of raw
547 registers (because the debug API provides no means to get at
549 if (m_register_status[regnum] == REG_UNKNOWN)
550 m_register_status[regnum] = REG_UNAVAILABLE;
555 regcache_raw_read (struct regcache *regcache, int regnum, gdb_byte *buf)
557 return regcache->raw_read (regnum, buf);
561 readable_regcache::raw_read (int regnum, gdb_byte *buf)
563 gdb_assert (buf != NULL);
566 if (m_register_status[regnum] != REG_VALID)
567 memset (buf, 0, m_descr->sizeof_register[regnum]);
569 memcpy (buf, register_buffer (regnum),
570 m_descr->sizeof_register[regnum]);
572 return (enum register_status) m_register_status[regnum];
576 regcache_raw_read_signed (struct regcache *regcache, int regnum, LONGEST *val)
578 gdb_assert (regcache != NULL);
579 return regcache->raw_read (regnum, val);
582 template<typename T, typename>
584 readable_regcache::raw_read (int regnum, T *val)
587 enum register_status status;
589 assert_regnum (regnum);
590 buf = (gdb_byte *) alloca (m_descr->sizeof_register[regnum]);
591 status = raw_read (regnum, buf);
592 if (status == REG_VALID)
593 *val = extract_integer<T> (buf,
594 m_descr->sizeof_register[regnum],
595 gdbarch_byte_order (m_descr->gdbarch));
602 regcache_raw_read_unsigned (struct regcache *regcache, int regnum,
605 gdb_assert (regcache != NULL);
606 return regcache->raw_read (regnum, val);
610 regcache_raw_write_signed (struct regcache *regcache, int regnum, LONGEST val)
612 gdb_assert (regcache != NULL);
613 regcache->raw_write (regnum, val);
616 template<typename T, typename>
618 regcache::raw_write (int regnum, T val)
622 assert_regnum (regnum);
623 buf = (gdb_byte *) alloca (m_descr->sizeof_register[regnum]);
624 store_integer (buf, m_descr->sizeof_register[regnum],
625 gdbarch_byte_order (m_descr->gdbarch), val);
626 raw_write (regnum, buf);
630 regcache_raw_write_unsigned (struct regcache *regcache, int regnum,
633 gdb_assert (regcache != NULL);
634 regcache->raw_write (regnum, val);
638 regcache_raw_get_signed (struct regcache *regcache, int regnum)
641 enum register_status status;
643 status = regcache_raw_read_signed (regcache, regnum, &value);
644 if (status == REG_UNAVAILABLE)
645 throw_error (NOT_AVAILABLE_ERROR,
646 _("Register %d is not available"), regnum);
651 regcache_cooked_read (struct regcache *regcache, int regnum, gdb_byte *buf)
653 return regcache->cooked_read (regnum, buf);
657 readable_regcache::cooked_read (int regnum, gdb_byte *buf)
659 gdb_assert (regnum >= 0);
660 gdb_assert (regnum < m_descr->nr_cooked_registers);
661 if (regnum < num_raw_registers ())
662 return raw_read (regnum, buf);
663 else if (m_has_pseudo
664 && m_register_status[regnum] != REG_UNKNOWN)
666 if (m_register_status[regnum] == REG_VALID)
667 memcpy (buf, register_buffer (regnum),
668 m_descr->sizeof_register[regnum]);
670 memset (buf, 0, m_descr->sizeof_register[regnum]);
672 return (enum register_status) m_register_status[regnum];
674 else if (gdbarch_pseudo_register_read_value_p (m_descr->gdbarch))
676 struct value *mark, *computed;
677 enum register_status result = REG_VALID;
679 mark = value_mark ();
681 computed = gdbarch_pseudo_register_read_value (m_descr->gdbarch,
683 if (value_entirely_available (computed))
684 memcpy (buf, value_contents_raw (computed),
685 m_descr->sizeof_register[regnum]);
688 memset (buf, 0, m_descr->sizeof_register[regnum]);
689 result = REG_UNAVAILABLE;
692 value_free_to_mark (mark);
697 return gdbarch_pseudo_register_read (m_descr->gdbarch, this,
702 regcache_cooked_read_value (struct regcache *regcache, int regnum)
704 return regcache->cooked_read_value (regnum);
708 readable_regcache::cooked_read_value (int regnum)
710 gdb_assert (regnum >= 0);
711 gdb_assert (regnum < m_descr->nr_cooked_registers);
713 if (regnum < num_raw_registers ()
714 || (m_has_pseudo && m_register_status[regnum] != REG_UNKNOWN)
715 || !gdbarch_pseudo_register_read_value_p (m_descr->gdbarch))
717 struct value *result;
719 result = allocate_value (register_type (m_descr->gdbarch, regnum));
720 VALUE_LVAL (result) = lval_register;
721 VALUE_REGNUM (result) = regnum;
723 /* It is more efficient in general to do this delegation in this
724 direction than in the other one, even though the value-based
726 if (cooked_read (regnum,
727 value_contents_raw (result)) == REG_UNAVAILABLE)
728 mark_value_bytes_unavailable (result, 0,
729 TYPE_LENGTH (value_type (result)));
734 return gdbarch_pseudo_register_read_value (m_descr->gdbarch,
739 regcache_cooked_read_signed (struct regcache *regcache, int regnum,
742 gdb_assert (regcache != NULL);
743 return regcache->cooked_read (regnum, val);
746 template<typename T, typename>
748 readable_regcache::cooked_read (int regnum, T *val)
750 enum register_status status;
753 gdb_assert (regnum >= 0 && regnum < m_descr->nr_cooked_registers);
754 buf = (gdb_byte *) alloca (m_descr->sizeof_register[regnum]);
755 status = cooked_read (regnum, buf);
756 if (status == REG_VALID)
757 *val = extract_integer<T> (buf, m_descr->sizeof_register[regnum],
758 gdbarch_byte_order (m_descr->gdbarch));
765 regcache_cooked_read_unsigned (struct regcache *regcache, int regnum,
768 gdb_assert (regcache != NULL);
769 return regcache->cooked_read (regnum, val);
773 regcache_cooked_write_signed (struct regcache *regcache, int regnum,
776 gdb_assert (regcache != NULL);
777 regcache->cooked_write (regnum, val);
780 template<typename T, typename>
782 regcache::cooked_write (int regnum, T val)
786 gdb_assert (regnum >=0 && regnum < m_descr->nr_cooked_registers);
787 buf = (gdb_byte *) alloca (m_descr->sizeof_register[regnum]);
788 store_integer (buf, m_descr->sizeof_register[regnum],
789 gdbarch_byte_order (m_descr->gdbarch), val);
790 cooked_write (regnum, buf);
794 regcache_cooked_write_unsigned (struct regcache *regcache, int regnum,
797 gdb_assert (regcache != NULL);
798 regcache->cooked_write (regnum, val);
802 regcache_raw_write (struct regcache *regcache, int regnum,
805 gdb_assert (regcache != NULL && buf != NULL);
806 regcache->raw_write (regnum, buf);
810 regcache::raw_write (int regnum, const gdb_byte *buf)
813 gdb_assert (buf != NULL);
814 assert_regnum (regnum);
815 gdb_assert (!m_readonly_p);
817 /* On the sparc, writing %g0 is a no-op, so we don't even want to
818 change the registers array if something writes to this register. */
819 if (gdbarch_cannot_store_register (arch (), regnum))
822 /* If we have a valid copy of the register, and new value == old
823 value, then don't bother doing the actual store. */
824 if (get_register_status (regnum) == REG_VALID
825 && (memcmp (register_buffer (regnum), buf,
826 m_descr->sizeof_register[regnum]) == 0))
829 target_prepare_to_store (this);
830 raw_supply (regnum, buf);
832 /* Invalidate the register after it is written, in case of a
834 regcache_invalidator invalidator (this, regnum);
836 target_store_registers (this, regnum);
838 /* The target did not throw an error so we can discard invalidating
840 invalidator.release ();
844 regcache_cooked_write (struct regcache *regcache, int regnum,
847 regcache->cooked_write (regnum, buf);
851 regcache::cooked_write (int regnum, const gdb_byte *buf)
853 gdb_assert (regnum >= 0);
854 gdb_assert (regnum < m_descr->nr_cooked_registers);
855 if (regnum < num_raw_registers ())
856 raw_write (regnum, buf);
858 gdbarch_pseudo_register_write (m_descr->gdbarch, this,
862 /* Perform a partial register transfer using a read, modify, write
865 typedef void (regcache_read_ftype) (struct regcache *regcache, int regnum,
867 typedef void (regcache_write_ftype) (struct regcache *regcache, int regnum,
871 readable_regcache::read_part (int regnum, int offset, int len, void *in,
874 struct gdbarch *gdbarch = arch ();
875 gdb_byte *reg = (gdb_byte *) alloca (register_size (gdbarch, regnum));
877 gdb_assert (in != NULL);
878 gdb_assert (offset >= 0 && offset <= m_descr->sizeof_register[regnum]);
879 gdb_assert (len >= 0 && offset + len <= m_descr->sizeof_register[regnum]);
880 /* Something to do? */
881 if (offset + len == 0)
883 /* Read (when needed) ... */
884 enum register_status status;
887 status = raw_read (regnum, reg);
889 status = cooked_read (regnum, reg);
890 if (status != REG_VALID)
894 memcpy (in, reg + offset, len);
900 regcache::write_part (int regnum, int offset, int len,
901 const void *out, bool is_raw)
903 struct gdbarch *gdbarch = arch ();
904 gdb_byte *reg = (gdb_byte *) alloca (register_size (gdbarch, regnum));
906 gdb_assert (out != NULL);
907 gdb_assert (offset >= 0 && offset <= m_descr->sizeof_register[regnum]);
908 gdb_assert (len >= 0 && offset + len <= m_descr->sizeof_register[regnum]);
909 /* Something to do? */
910 if (offset + len == 0)
912 /* Read (when needed) ... */
914 || offset + len < m_descr->sizeof_register[regnum])
916 enum register_status status;
919 status = raw_read (regnum, reg);
921 status = cooked_read (regnum, reg);
922 if (status != REG_VALID)
926 memcpy (reg + offset, out, len);
927 /* ... write (when needed). */
929 raw_write (regnum, reg);
931 cooked_write (regnum, reg);
937 regcache_raw_read_part (struct regcache *regcache, int regnum,
938 int offset, int len, gdb_byte *buf)
940 return regcache->raw_read_part (regnum, offset, len, buf);
944 readable_regcache::raw_read_part (int regnum, int offset, int len, gdb_byte *buf)
946 assert_regnum (regnum);
947 return read_part (regnum, offset, len, buf, true);
951 regcache_raw_write_part (struct regcache *regcache, int regnum,
952 int offset, int len, const gdb_byte *buf)
954 regcache->raw_write_part (regnum, offset, len, buf);
958 regcache::raw_write_part (int regnum, int offset, int len,
961 assert_regnum (regnum);
962 write_part (regnum, offset, len, buf, true);
966 regcache_cooked_read_part (struct regcache *regcache, int regnum,
967 int offset, int len, gdb_byte *buf)
969 return regcache->cooked_read_part (regnum, offset, len, buf);
974 readable_regcache::cooked_read_part (int regnum, int offset, int len,
977 gdb_assert (regnum >= 0 && regnum < m_descr->nr_cooked_registers);
978 return read_part (regnum, offset, len, buf, false);
982 regcache_cooked_write_part (struct regcache *regcache, int regnum,
983 int offset, int len, const gdb_byte *buf)
985 regcache->cooked_write_part (regnum, offset, len, buf);
989 regcache::cooked_write_part (int regnum, int offset, int len,
992 gdb_assert (regnum >= 0 && regnum < m_descr->nr_cooked_registers);
993 write_part (regnum, offset, len, buf, false);
996 /* Supply register REGNUM, whose contents are stored in BUF, to REGCACHE. */
999 regcache_raw_supply (struct regcache *regcache, int regnum, const void *buf)
1001 gdb_assert (regcache != NULL);
1002 regcache->raw_supply (regnum, buf);
1006 detached_regcache::raw_supply (int regnum, const void *buf)
1011 assert_regnum (regnum);
1013 regbuf = register_buffer (regnum);
1014 size = m_descr->sizeof_register[regnum];
1018 memcpy (regbuf, buf, size);
1019 m_register_status[regnum] = REG_VALID;
1023 /* This memset not strictly necessary, but better than garbage
1024 in case the register value manages to escape somewhere (due
1025 to a bug, no less). */
1026 memset (regbuf, 0, size);
1027 m_register_status[regnum] = REG_UNAVAILABLE;
1031 /* Supply register REGNUM to REGCACHE. Value to supply is an integer stored at
1032 address ADDR, in target endian, with length ADDR_LEN and sign IS_SIGNED. If
1033 the register size is greater than ADDR_LEN, then the integer will be sign or
1034 zero extended. If the register size is smaller than the integer, then the
1035 most significant bytes of the integer will be truncated. */
1038 regcache::raw_supply_integer (int regnum, const gdb_byte *addr, int addr_len,
1041 enum bfd_endian byte_order = gdbarch_byte_order (m_descr->gdbarch);
1045 assert_regnum (regnum);
1046 gdb_assert (!m_readonly_p);
1048 regbuf = register_buffer (regnum);
1049 regsize = m_descr->sizeof_register[regnum];
1051 copy_integer_to_size (regbuf, regsize, addr, addr_len, is_signed,
1053 m_register_status[regnum] = REG_VALID;
1056 /* Supply register REGNUM with zeroed value to REGCACHE. This is not the same
1057 as calling raw_supply with NULL (which will set the state to
1061 regcache::raw_supply_zeroed (int regnum)
1066 assert_regnum (regnum);
1067 gdb_assert (!m_readonly_p);
1069 regbuf = register_buffer (regnum);
1070 size = m_descr->sizeof_register[regnum];
1072 memset (regbuf, 0, size);
1073 m_register_status[regnum] = REG_VALID;
1076 /* Collect register REGNUM from REGCACHE and store its contents in BUF. */
1079 regcache_raw_collect (const struct regcache *regcache, int regnum, void *buf)
1081 gdb_assert (regcache != NULL && buf != NULL);
1082 regcache->raw_collect (regnum, buf);
1086 regcache::raw_collect (int regnum, void *buf) const
1091 gdb_assert (buf != NULL);
1092 assert_regnum (regnum);
1094 regbuf = register_buffer (regnum);
1095 size = m_descr->sizeof_register[regnum];
1096 memcpy (buf, regbuf, size);
1099 /* Transfer a single or all registers belonging to a certain register
1100 set to or from a buffer. This is the main worker function for
1101 regcache_supply_regset and regcache_collect_regset. */
1103 /* Collect register REGNUM from REGCACHE. Store collected value as an integer
1104 at address ADDR, in target endian, with length ADDR_LEN and sign IS_SIGNED.
1105 If ADDR_LEN is greater than the register size, then the integer will be sign
1106 or zero extended. If ADDR_LEN is smaller than the register size, then the
1107 most significant bytes of the integer will be truncated. */
1110 regcache::raw_collect_integer (int regnum, gdb_byte *addr, int addr_len,
1111 bool is_signed) const
1113 enum bfd_endian byte_order = gdbarch_byte_order (m_descr->gdbarch);
1114 const gdb_byte *regbuf;
1117 assert_regnum (regnum);
1119 regbuf = register_buffer (regnum);
1120 regsize = m_descr->sizeof_register[regnum];
1122 copy_integer_to_size (addr, addr_len, regbuf, regsize, is_signed,
1127 regcache::transfer_regset (const struct regset *regset,
1128 struct regcache *out_regcache,
1129 int regnum, const void *in_buf,
1130 void *out_buf, size_t size) const
1132 const struct regcache_map_entry *map;
1133 int offs = 0, count;
1135 for (map = (const struct regcache_map_entry *) regset->regmap;
1136 (count = map->count) != 0;
1139 int regno = map->regno;
1140 int slot_size = map->size;
1142 if (slot_size == 0 && regno != REGCACHE_MAP_SKIP)
1143 slot_size = m_descr->sizeof_register[regno];
1145 if (regno == REGCACHE_MAP_SKIP
1147 && (regnum < regno || regnum >= regno + count)))
1148 offs += count * slot_size;
1150 else if (regnum == -1)
1151 for (; count--; regno++, offs += slot_size)
1153 if (offs + slot_size > size)
1157 raw_collect (regno, (gdb_byte *) out_buf + offs);
1159 out_regcache->raw_supply (regno, in_buf
1160 ? (const gdb_byte *) in_buf + offs
1165 /* Transfer a single register and return. */
1166 offs += (regnum - regno) * slot_size;
1167 if (offs + slot_size > size)
1171 raw_collect (regnum, (gdb_byte *) out_buf + offs);
1173 out_regcache->raw_supply (regnum, in_buf
1174 ? (const gdb_byte *) in_buf + offs
1181 /* Supply register REGNUM from BUF to REGCACHE, using the register map
1182 in REGSET. If REGNUM is -1, do this for all registers in REGSET.
1183 If BUF is NULL, set the register(s) to "unavailable" status. */
1186 regcache_supply_regset (const struct regset *regset,
1187 struct regcache *regcache,
1188 int regnum, const void *buf, size_t size)
1190 regcache->supply_regset (regset, regnum, buf, size);
1194 regcache::supply_regset (const struct regset *regset,
1195 int regnum, const void *buf, size_t size)
1197 transfer_regset (regset, this, regnum, buf, NULL, size);
1200 /* Collect register REGNUM from REGCACHE to BUF, using the register
1201 map in REGSET. If REGNUM is -1, do this for all registers in
1205 regcache_collect_regset (const struct regset *regset,
1206 const struct regcache *regcache,
1207 int regnum, void *buf, size_t size)
1209 regcache->collect_regset (regset, regnum, buf, size);
1213 regcache::collect_regset (const struct regset *regset,
1214 int regnum, void *buf, size_t size) const
1216 transfer_regset (regset, NULL, regnum, NULL, buf, size);
1220 /* Special handling for register PC. */
1223 regcache_read_pc (struct regcache *regcache)
1225 struct gdbarch *gdbarch = regcache->arch ();
1229 if (gdbarch_read_pc_p (gdbarch))
1230 pc_val = gdbarch_read_pc (gdbarch, regcache);
1231 /* Else use per-frame method on get_current_frame. */
1232 else if (gdbarch_pc_regnum (gdbarch) >= 0)
1236 if (regcache_cooked_read_unsigned (regcache,
1237 gdbarch_pc_regnum (gdbarch),
1238 &raw_val) == REG_UNAVAILABLE)
1239 throw_error (NOT_AVAILABLE_ERROR, _("PC register is not available"));
1241 pc_val = gdbarch_addr_bits_remove (gdbarch, raw_val);
1244 internal_error (__FILE__, __LINE__,
1245 _("regcache_read_pc: Unable to find PC"));
1250 regcache_write_pc (struct regcache *regcache, CORE_ADDR pc)
1252 struct gdbarch *gdbarch = regcache->arch ();
1254 if (gdbarch_write_pc_p (gdbarch))
1255 gdbarch_write_pc (gdbarch, regcache, pc);
1256 else if (gdbarch_pc_regnum (gdbarch) >= 0)
1257 regcache_cooked_write_unsigned (regcache,
1258 gdbarch_pc_regnum (gdbarch), pc);
1260 internal_error (__FILE__, __LINE__,
1261 _("regcache_write_pc: Unable to update PC"));
1263 /* Writing the PC (for instance, from "load") invalidates the
1265 reinit_frame_cache ();
1269 reg_buffer::num_raw_registers () const
1271 return gdbarch_num_regs (arch ());
1275 regcache::debug_print_register (const char *func, int regno)
1277 struct gdbarch *gdbarch = arch ();
1279 fprintf_unfiltered (gdb_stdlog, "%s ", func);
1280 if (regno >= 0 && regno < gdbarch_num_regs (gdbarch)
1281 && gdbarch_register_name (gdbarch, regno) != NULL
1282 && gdbarch_register_name (gdbarch, regno)[0] != '\0')
1283 fprintf_unfiltered (gdb_stdlog, "(%s)",
1284 gdbarch_register_name (gdbarch, regno));
1286 fprintf_unfiltered (gdb_stdlog, "(%d)", regno);
1287 if (regno >= 0 && regno < gdbarch_num_regs (gdbarch))
1289 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1290 int size = register_size (gdbarch, regno);
1291 gdb_byte *buf = register_buffer (regno);
1293 fprintf_unfiltered (gdb_stdlog, " = ");
1294 for (int i = 0; i < size; i++)
1296 fprintf_unfiltered (gdb_stdlog, "%02x", buf[i]);
1298 if (size <= sizeof (LONGEST))
1300 ULONGEST val = extract_unsigned_integer (buf, size, byte_order);
1302 fprintf_unfiltered (gdb_stdlog, " %s %s",
1303 core_addr_to_string_nz (val), plongest (val));
1306 fprintf_unfiltered (gdb_stdlog, "\n");
1310 reg_flush_command (const char *command, int from_tty)
1312 /* Force-flush the register cache. */
1313 registers_changed ();
1315 printf_filtered (_("Register cache flushed.\n"));
1318 /* An abstract base class for register dump. */
1323 void dump (ui_file *file)
1325 auto descr = regcache_descr (m_gdbarch);
1327 int footnote_nr = 0;
1328 int footnote_register_offset = 0;
1329 int footnote_register_type_name_null = 0;
1330 long register_offset = 0;
1332 gdb_assert (descr->nr_cooked_registers
1333 == (gdbarch_num_regs (m_gdbarch)
1334 + gdbarch_num_pseudo_regs (m_gdbarch)));
1336 for (regnum = -1; regnum < descr->nr_cooked_registers; regnum++)
1340 fprintf_unfiltered (file, " %-10s", "Name");
1343 const char *p = gdbarch_register_name (m_gdbarch, regnum);
1347 else if (p[0] == '\0')
1349 fprintf_unfiltered (file, " %-10s", p);
1354 fprintf_unfiltered (file, " %4s", "Nr");
1356 fprintf_unfiltered (file, " %4d", regnum);
1358 /* Relative number. */
1360 fprintf_unfiltered (file, " %4s", "Rel");
1361 else if (regnum < gdbarch_num_regs (m_gdbarch))
1362 fprintf_unfiltered (file, " %4d", regnum);
1364 fprintf_unfiltered (file, " %4d",
1365 (regnum - gdbarch_num_regs (m_gdbarch)));
1369 fprintf_unfiltered (file, " %6s ", "Offset");
1372 fprintf_unfiltered (file, " %6ld",
1373 descr->register_offset[regnum]);
1374 if (register_offset != descr->register_offset[regnum]
1376 && (descr->register_offset[regnum]
1377 != (descr->register_offset[regnum - 1]
1378 + descr->sizeof_register[regnum - 1])))
1381 if (!footnote_register_offset)
1382 footnote_register_offset = ++footnote_nr;
1383 fprintf_unfiltered (file, "*%d", footnote_register_offset);
1386 fprintf_unfiltered (file, " ");
1387 register_offset = (descr->register_offset[regnum]
1388 + descr->sizeof_register[regnum]);
1393 fprintf_unfiltered (file, " %5s ", "Size");
1395 fprintf_unfiltered (file, " %5ld", descr->sizeof_register[regnum]);
1400 std::string name_holder;
1406 static const char blt[] = "builtin_type";
1408 t = TYPE_NAME (register_type (m_gdbarch, regnum));
1411 if (!footnote_register_type_name_null)
1412 footnote_register_type_name_null = ++footnote_nr;
1413 name_holder = string_printf ("*%d",
1414 footnote_register_type_name_null);
1415 t = name_holder.c_str ();
1417 /* Chop a leading builtin_type. */
1418 if (startswith (t, blt))
1421 fprintf_unfiltered (file, " %-15s", t);
1424 /* Leading space always present. */
1425 fprintf_unfiltered (file, " ");
1427 dump_reg (file, regnum);
1429 fprintf_unfiltered (file, "\n");
1432 if (footnote_register_offset)
1433 fprintf_unfiltered (file, "*%d: Inconsistent register offsets.\n",
1434 footnote_register_offset);
1435 if (footnote_register_type_name_null)
1436 fprintf_unfiltered (file,
1437 "*%d: Register type's name NULL.\n",
1438 footnote_register_type_name_null);
1441 virtual ~register_dump () {};
1444 register_dump (gdbarch *arch)
1448 /* Dump the register REGNUM contents. If REGNUM is -1, print the
1450 virtual void dump_reg (ui_file *file, int regnum) = 0;
1455 /* Dump registers from regcache, used for dump raw registers and
1456 cooked registers. */
1458 class register_dump_regcache : public register_dump
1461 register_dump_regcache (regcache *regcache, bool dump_pseudo)
1462 : register_dump (regcache->arch ()), m_regcache (regcache),
1463 m_dump_pseudo (dump_pseudo)
1468 void dump_reg (ui_file *file, int regnum) override
1473 fprintf_unfiltered (file, "Cooked value");
1475 fprintf_unfiltered (file, "Raw value");
1479 if (regnum < gdbarch_num_regs (m_gdbarch) || m_dump_pseudo)
1481 auto size = register_size (m_gdbarch, regnum);
1486 gdb::def_vector<gdb_byte> buf (size);
1487 auto status = m_regcache->cooked_read (regnum, buf.data ());
1489 if (status == REG_UNKNOWN)
1490 fprintf_unfiltered (file, "<invalid>");
1491 else if (status == REG_UNAVAILABLE)
1492 fprintf_unfiltered (file, "<unavailable>");
1495 print_hex_chars (file, buf.data (), size,
1496 gdbarch_byte_order (m_gdbarch), true);
1501 /* Just print "<cooked>" for pseudo register when
1502 regcache_dump_raw. */
1503 fprintf_unfiltered (file, "<cooked>");
1509 regcache *m_regcache;
1511 /* Dump pseudo registers or not. */
1512 const bool m_dump_pseudo;
1515 /* For "maint print registers". */
1517 class register_dump_none : public register_dump
1520 register_dump_none (gdbarch *arch)
1521 : register_dump (arch)
1525 void dump_reg (ui_file *file, int regnum) override
1529 /* For "maint print remote-registers". */
1531 class register_dump_remote : public register_dump
1534 register_dump_remote (gdbarch *arch)
1535 : register_dump (arch)
1539 void dump_reg (ui_file *file, int regnum) override
1543 fprintf_unfiltered (file, "Rmt Nr g/G Offset");
1545 else if (regnum < gdbarch_num_regs (m_gdbarch))
1549 if (remote_register_number_and_offset (m_gdbarch, regnum,
1551 fprintf_unfiltered (file, "%7d %11d", pnum, poffset);
1556 /* For "maint print register-groups". */
1558 class register_dump_groups : public register_dump
1561 register_dump_groups (gdbarch *arch)
1562 : register_dump (arch)
1566 void dump_reg (ui_file *file, int regnum) override
1569 fprintf_unfiltered (file, "Groups");
1572 const char *sep = "";
1573 struct reggroup *group;
1575 for (group = reggroup_next (m_gdbarch, NULL);
1577 group = reggroup_next (m_gdbarch, group))
1579 if (gdbarch_register_reggroup_p (m_gdbarch, regnum, group))
1581 fprintf_unfiltered (file,
1582 "%s%s", sep, reggroup_name (group));
1590 enum regcache_dump_what
1592 regcache_dump_none, regcache_dump_raw,
1593 regcache_dump_cooked, regcache_dump_groups,
1594 regcache_dump_remote
1598 regcache_print (const char *args, enum regcache_dump_what what_to_dump)
1600 /* Where to send output. */
1608 if (!file.open (args, "w"))
1609 perror_with_name (_("maintenance print architecture"));
1613 std::unique_ptr<register_dump> dump;
1614 std::unique_ptr<regcache> regs;
1617 if (target_has_registers)
1618 gdbarch = get_current_regcache ()->arch ();
1620 gdbarch = target_gdbarch ();
1622 switch (what_to_dump)
1624 case regcache_dump_none:
1625 dump.reset (new register_dump_none (gdbarch));
1627 case regcache_dump_remote:
1628 dump.reset (new register_dump_remote (gdbarch));
1630 case regcache_dump_groups:
1631 dump.reset (new register_dump_groups (gdbarch));
1633 case regcache_dump_raw:
1634 case regcache_dump_cooked:
1638 if (target_has_registers)
1639 reg = get_current_regcache ();
1642 /* For the benefit of "maint print registers" & co when
1643 debugging an executable, allow dumping a regcache even when
1644 there is no thread selected / no registers. */
1645 reg = new regcache (target_gdbarch ());
1649 auto dump_pseudo = (what_to_dump == regcache_dump_cooked);
1651 dump.reset (new register_dump_regcache (reg, dump_pseudo));
1660 maintenance_print_registers (const char *args, int from_tty)
1662 regcache_print (args, regcache_dump_none);
1666 maintenance_print_raw_registers (const char *args, int from_tty)
1668 regcache_print (args, regcache_dump_raw);
1672 maintenance_print_cooked_registers (const char *args, int from_tty)
1674 regcache_print (args, regcache_dump_cooked);
1678 maintenance_print_register_groups (const char *args, int from_tty)
1680 regcache_print (args, regcache_dump_groups);
1684 maintenance_print_remote_registers (const char *args, int from_tty)
1686 regcache_print (args, regcache_dump_remote);
1690 #include "selftest.h"
1691 #include "selftest-arch.h"
1692 #include "gdbthread.h"
1693 #include "target-float.h"
1695 namespace selftests {
1697 class regcache_access : public regcache
1701 /* Return the number of elements in current_regcache. */
1704 current_regcache_size ()
1706 return std::distance (regcache::current_regcache.begin (),
1707 regcache::current_regcache.end ());
1712 current_regcache_test (void)
1714 /* It is empty at the start. */
1715 SELF_CHECK (regcache_access::current_regcache_size () == 0);
1717 ptid_t ptid1 (1), ptid2 (2), ptid3 (3);
1719 /* Get regcache from ptid1, a new regcache is added to
1720 current_regcache. */
1721 regcache *regcache = get_thread_arch_aspace_regcache (ptid1,
1725 SELF_CHECK (regcache != NULL);
1726 SELF_CHECK (regcache->ptid () == ptid1);
1727 SELF_CHECK (regcache_access::current_regcache_size () == 1);
1729 /* Get regcache from ptid2, a new regcache is added to
1730 current_regcache. */
1731 regcache = get_thread_arch_aspace_regcache (ptid2,
1734 SELF_CHECK (regcache != NULL);
1735 SELF_CHECK (regcache->ptid () == ptid2);
1736 SELF_CHECK (regcache_access::current_regcache_size () == 2);
1738 /* Get regcache from ptid3, a new regcache is added to
1739 current_regcache. */
1740 regcache = get_thread_arch_aspace_regcache (ptid3,
1743 SELF_CHECK (regcache != NULL);
1744 SELF_CHECK (regcache->ptid () == ptid3);
1745 SELF_CHECK (regcache_access::current_regcache_size () == 3);
1747 /* Get regcache from ptid2 again, nothing is added to
1748 current_regcache. */
1749 regcache = get_thread_arch_aspace_regcache (ptid2,
1752 SELF_CHECK (regcache != NULL);
1753 SELF_CHECK (regcache->ptid () == ptid2);
1754 SELF_CHECK (regcache_access::current_regcache_size () == 3);
1756 /* Mark ptid2 is changed, so regcache of ptid2 should be removed from
1757 current_regcache. */
1758 registers_changed_ptid (ptid2);
1759 SELF_CHECK (regcache_access::current_regcache_size () == 2);
1762 static void test_target_fetch_registers (target_ops *self, regcache *regs,
1764 static void test_target_store_registers (target_ops *self, regcache *regs,
1766 static enum target_xfer_status
1767 test_target_xfer_partial (struct target_ops *ops,
1768 enum target_object object,
1769 const char *annex, gdb_byte *readbuf,
1770 const gdb_byte *writebuf,
1771 ULONGEST offset, ULONGEST len,
1772 ULONGEST *xfered_len);
1774 class target_ops_no_register : public test_target_ops
1777 target_ops_no_register ()
1778 : test_target_ops {}
1780 to_fetch_registers = test_target_fetch_registers;
1781 to_store_registers = test_target_store_registers;
1782 to_xfer_partial = test_target_xfer_partial;
1789 fetch_registers_called = 0;
1790 store_registers_called = 0;
1791 xfer_partial_called = 0;
1794 unsigned int fetch_registers_called = 0;
1795 unsigned int store_registers_called = 0;
1796 unsigned int xfer_partial_called = 0;
1800 test_target_fetch_registers (target_ops *self, regcache *regs, int regno)
1802 auto ops = static_cast<target_ops_no_register *> (self->to_data);
1804 /* Mark register available. */
1805 regs->raw_supply_zeroed (regno);
1806 ops->fetch_registers_called++;
1810 test_target_store_registers (target_ops *self, regcache *regs, int regno)
1812 auto ops = static_cast<target_ops_no_register *> (self->to_data);
1814 ops->store_registers_called++;
1817 static enum target_xfer_status
1818 test_target_xfer_partial (struct target_ops *self, enum target_object object,
1819 const char *annex, gdb_byte *readbuf,
1820 const gdb_byte *writebuf,
1821 ULONGEST offset, ULONGEST len, ULONGEST *xfered_len)
1823 auto ops = static_cast<target_ops_no_register *> (self->to_data);
1825 ops->xfer_partial_called++;
1828 return TARGET_XFER_OK;
1831 class readwrite_regcache : public regcache
1834 readwrite_regcache (struct gdbarch *gdbarch)
1835 : regcache (gdbarch, nullptr, false)
1839 /* Test regcache::cooked_read gets registers from raw registers and
1840 memory instead of target to_{fetch,store}_registers. */
1843 cooked_read_test (struct gdbarch *gdbarch)
1845 /* Error out if debugging something, because we're going to push the
1846 test target, which would pop any existing target. */
1847 if (current_target.to_stratum >= process_stratum)
1848 error (_("target already pushed"));
1850 /* Create a mock environment. An inferior with a thread, with a
1851 process_stratum target pushed. */
1853 target_ops_no_register mock_target;
1854 ptid_t mock_ptid (1, 1);
1855 inferior mock_inferior (mock_ptid.pid ());
1856 address_space mock_aspace {};
1857 mock_inferior.gdbarch = gdbarch;
1858 mock_inferior.aspace = &mock_aspace;
1859 thread_info mock_thread (&mock_inferior, mock_ptid);
1861 scoped_restore restore_thread_list
1862 = make_scoped_restore (&thread_list, &mock_thread);
1864 /* Add the mock inferior to the inferior list so that look ups by
1865 target+ptid can find it. */
1866 scoped_restore restore_inferior_list
1867 = make_scoped_restore (&inferior_list);
1868 inferior_list = &mock_inferior;
1870 /* Switch to the mock inferior. */
1871 scoped_restore_current_inferior restore_current_inferior;
1872 set_current_inferior (&mock_inferior);
1874 /* Push the process_stratum target so we can mock accessing
1876 push_target (&mock_target);
1878 /* Pop it again on exit (return/exception). */
1883 pop_all_targets_at_and_above (process_stratum);
1887 /* Switch to the mock thread. */
1888 scoped_restore restore_inferior_ptid
1889 = make_scoped_restore (&inferior_ptid, mock_ptid);
1891 /* Test that read one raw register from regcache_no_target will go
1892 to the target layer. */
1895 /* Find a raw register which size isn't zero. */
1896 for (regnum = 0; regnum < gdbarch_num_regs (gdbarch); regnum++)
1898 if (register_size (gdbarch, regnum) != 0)
1902 readwrite_regcache readwrite (gdbarch);
1903 gdb::def_vector<gdb_byte> buf (register_size (gdbarch, regnum));
1905 readwrite.raw_read (regnum, buf.data ());
1907 /* raw_read calls target_fetch_registers. */
1908 SELF_CHECK (mock_target.fetch_registers_called > 0);
1909 mock_target.reset ();
1911 /* Mark all raw registers valid, so the following raw registers
1912 accesses won't go to target. */
1913 for (auto i = 0; i < gdbarch_num_regs (gdbarch); i++)
1914 readwrite.raw_update (i);
1916 mock_target.reset ();
1917 /* Then, read all raw and pseudo registers, and don't expect calling
1918 to_{fetch,store}_registers. */
1919 for (int regnum = 0;
1920 regnum < gdbarch_num_regs (gdbarch) + gdbarch_num_pseudo_regs (gdbarch);
1923 if (register_size (gdbarch, regnum) == 0)
1926 gdb::def_vector<gdb_byte> buf (register_size (gdbarch, regnum));
1928 SELF_CHECK (REG_VALID == readwrite.cooked_read (regnum, buf.data ()));
1930 SELF_CHECK (mock_target.fetch_registers_called == 0);
1931 SELF_CHECK (mock_target.store_registers_called == 0);
1933 /* Some SPU pseudo registers are got via TARGET_OBJECT_SPU. */
1934 if (gdbarch_bfd_arch_info (gdbarch)->arch != bfd_arch_spu)
1935 SELF_CHECK (mock_target.xfer_partial_called == 0);
1937 mock_target.reset ();
1940 regcache readonly (regcache::readonly, readwrite);
1942 /* GDB may go to target layer to fetch all registers and memory for
1943 readonly regcache. */
1944 mock_target.reset ();
1946 for (int regnum = 0;
1947 regnum < gdbarch_num_regs (gdbarch) + gdbarch_num_pseudo_regs (gdbarch);
1950 if (register_size (gdbarch, regnum) == 0)
1953 gdb::def_vector<gdb_byte> buf (register_size (gdbarch, regnum));
1954 enum register_status status = readonly.cooked_read (regnum,
1957 if (regnum < gdbarch_num_regs (gdbarch))
1959 auto bfd_arch = gdbarch_bfd_arch_info (gdbarch)->arch;
1961 if (bfd_arch == bfd_arch_frv || bfd_arch == bfd_arch_h8300
1962 || bfd_arch == bfd_arch_m32c || bfd_arch == bfd_arch_sh
1963 || bfd_arch == bfd_arch_alpha || bfd_arch == bfd_arch_v850
1964 || bfd_arch == bfd_arch_msp430 || bfd_arch == bfd_arch_mep
1965 || bfd_arch == bfd_arch_mips || bfd_arch == bfd_arch_v850_rh850
1966 || bfd_arch == bfd_arch_tic6x || bfd_arch == bfd_arch_mn10300
1967 || bfd_arch == bfd_arch_rl78 || bfd_arch == bfd_arch_score)
1969 /* Raw registers. If raw registers are not in save_reggroup,
1970 their status are unknown. */
1971 if (gdbarch_register_reggroup_p (gdbarch, regnum, save_reggroup))
1972 SELF_CHECK (status == REG_VALID);
1974 SELF_CHECK (status == REG_UNKNOWN);
1977 SELF_CHECK (status == REG_VALID);
1981 if (gdbarch_register_reggroup_p (gdbarch, regnum, save_reggroup))
1982 SELF_CHECK (status == REG_VALID);
1985 /* If pseudo registers are not in save_reggroup, some of
1986 them can be computed from saved raw registers, but some
1987 of them are unknown. */
1988 auto bfd_arch = gdbarch_bfd_arch_info (gdbarch)->arch;
1990 if (bfd_arch == bfd_arch_frv
1991 || bfd_arch == bfd_arch_m32c
1992 || bfd_arch == bfd_arch_mep
1993 || bfd_arch == bfd_arch_sh)
1994 SELF_CHECK (status == REG_VALID || status == REG_UNKNOWN);
1995 else if (bfd_arch == bfd_arch_mips
1996 || bfd_arch == bfd_arch_h8300)
1997 SELF_CHECK (status == REG_UNKNOWN);
1999 SELF_CHECK (status == REG_VALID);
2003 SELF_CHECK (mock_target.fetch_registers_called == 0);
2004 SELF_CHECK (mock_target.store_registers_called == 0);
2005 SELF_CHECK (mock_target.xfer_partial_called == 0);
2007 mock_target.reset ();
2011 /* Test regcache::cooked_write by writing some expected contents to
2012 registers, and checking that contents read from registers and the
2013 expected contents are the same. */
2016 cooked_write_test (struct gdbarch *gdbarch)
2018 /* Error out if debugging something, because we're going to push the
2019 test target, which would pop any existing target. */
2020 if (current_target.to_stratum >= process_stratum)
2021 error (_("target already pushed"));
2023 /* Create a mock environment. A process_stratum target pushed. */
2025 target_ops_no_register mock_target;
2027 /* Push the process_stratum target so we can mock accessing
2029 push_target (&mock_target);
2031 /* Pop it again on exit (return/exception). */
2036 pop_all_targets_at_and_above (process_stratum);
2040 readwrite_regcache readwrite (gdbarch);
2042 const int num_regs = (gdbarch_num_regs (gdbarch)
2043 + gdbarch_num_pseudo_regs (gdbarch));
2045 for (auto regnum = 0; regnum < num_regs; regnum++)
2047 if (register_size (gdbarch, regnum) == 0
2048 || gdbarch_cannot_store_register (gdbarch, regnum))
2051 auto bfd_arch = gdbarch_bfd_arch_info (gdbarch)->arch;
2053 if ((bfd_arch == bfd_arch_sparc
2054 /* SPARC64_CWP_REGNUM, SPARC64_PSTATE_REGNUM,
2055 SPARC64_ASI_REGNUM and SPARC64_CCR_REGNUM are hard to test. */
2056 && gdbarch_ptr_bit (gdbarch) == 64
2057 && (regnum >= gdbarch_num_regs (gdbarch)
2058 && regnum <= gdbarch_num_regs (gdbarch) + 4))
2059 || (bfd_arch == bfd_arch_sh
2060 /* FPSCR_C_REGNUM in sh64 is hard to test. */
2061 && gdbarch_bfd_arch_info (gdbarch)->mach == bfd_mach_sh5
2063 || (bfd_arch == bfd_arch_spu
2064 /* SPU pseudo registers except SPU_SP_REGNUM are got by
2065 TARGET_OBJECT_SPU. */
2066 && regnum >= gdbarch_num_regs (gdbarch) && regnum != 130))
2069 std::vector<gdb_byte> expected (register_size (gdbarch, regnum), 0);
2070 std::vector<gdb_byte> buf (register_size (gdbarch, regnum), 0);
2071 const auto type = register_type (gdbarch, regnum);
2073 if (TYPE_CODE (type) == TYPE_CODE_FLT
2074 || TYPE_CODE (type) == TYPE_CODE_DECFLOAT)
2076 /* Generate valid float format. */
2077 target_float_from_string (expected.data (), type, "1.25");
2079 else if (TYPE_CODE (type) == TYPE_CODE_INT
2080 || TYPE_CODE (type) == TYPE_CODE_ARRAY
2081 || TYPE_CODE (type) == TYPE_CODE_PTR
2082 || TYPE_CODE (type) == TYPE_CODE_UNION
2083 || TYPE_CODE (type) == TYPE_CODE_STRUCT)
2085 if (bfd_arch == bfd_arch_ia64
2086 || (regnum >= gdbarch_num_regs (gdbarch)
2087 && (bfd_arch == bfd_arch_xtensa
2088 || bfd_arch == bfd_arch_bfin
2089 || bfd_arch == bfd_arch_m32c
2090 /* m68hc11 pseudo registers are in memory. */
2091 || bfd_arch == bfd_arch_m68hc11
2092 || bfd_arch == bfd_arch_m68hc12
2093 || bfd_arch == bfd_arch_s390))
2094 || (bfd_arch == bfd_arch_frv
2095 /* FRV pseudo registers except iacc0. */
2096 && regnum > gdbarch_num_regs (gdbarch)))
2098 /* Skip setting the expected values for some architecture
2101 else if (bfd_arch == bfd_arch_rl78 && regnum == 40)
2103 /* RL78_PC_REGNUM */
2104 for (auto j = 0; j < register_size (gdbarch, regnum) - 1; j++)
2109 for (auto j = 0; j < register_size (gdbarch, regnum); j++)
2113 else if (TYPE_CODE (type) == TYPE_CODE_FLAGS)
2115 /* No idea how to test flags. */
2120 /* If we don't know how to create the expected value for the
2121 this type, make it fail. */
2125 readwrite.cooked_write (regnum, expected.data ());
2127 SELF_CHECK (readwrite.cooked_read (regnum, buf.data ()) == REG_VALID);
2128 SELF_CHECK (expected == buf);
2132 } // namespace selftests
2133 #endif /* GDB_SELF_TEST */
2136 _initialize_regcache (void)
2138 regcache_descr_handle
2139 = gdbarch_data_register_post_init (init_regcache_descr);
2141 observer_attach_target_changed (regcache_observer_target_changed);
2142 observer_attach_thread_ptid_changed (regcache::regcache_thread_ptid_changed);
2144 add_com ("flushregs", class_maintenance, reg_flush_command,
2145 _("Force gdb to flush its register cache (maintainer command)"));
2147 add_cmd ("registers", class_maintenance, maintenance_print_registers,
2148 _("Print the internal register configuration.\n"
2149 "Takes an optional file parameter."), &maintenanceprintlist);
2150 add_cmd ("raw-registers", class_maintenance,
2151 maintenance_print_raw_registers,
2152 _("Print the internal register configuration "
2153 "including raw values.\n"
2154 "Takes an optional file parameter."), &maintenanceprintlist);
2155 add_cmd ("cooked-registers", class_maintenance,
2156 maintenance_print_cooked_registers,
2157 _("Print the internal register configuration "
2158 "including cooked values.\n"
2159 "Takes an optional file parameter."), &maintenanceprintlist);
2160 add_cmd ("register-groups", class_maintenance,
2161 maintenance_print_register_groups,
2162 _("Print the internal register configuration "
2163 "including each register's group.\n"
2164 "Takes an optional file parameter."),
2165 &maintenanceprintlist);
2166 add_cmd ("remote-registers", class_maintenance,
2167 maintenance_print_remote_registers, _("\
2168 Print the internal register configuration including each register's\n\
2169 remote register number and buffer offset in the g/G packets.\n\
2170 Takes an optional file parameter."),
2171 &maintenanceprintlist);
2174 selftests::register_test ("current_regcache", selftests::current_regcache_test);
2176 selftests::register_test_foreach_arch ("regcache::cooked_read_test",
2177 selftests::cooked_read_test);
2178 selftests::register_test_foreach_arch ("regcache::cooked_write_test",
2179 selftests::cooked_write_test);