1 /* Cache and manage the values of registers for GDB, the GNU debugger.
2 Copyright 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000, 2001
3 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 2 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, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
28 #include "gdb_assert.h"
33 * Here is the actual register cache.
36 /* NOTE: this is a write-through cache. There is no "dirty" bit for
37 recording if the register values have been changed (eg. by the
38 user). Therefore all registers must be written back to the
39 target when appropriate. */
41 /* REGISTERS contains the cached register values (in target byte order). */
45 /* REGISTER_VALID is 0 if the register needs to be fetched,
46 1 if it has been fetched, and
47 -1 if the register value was not available.
48 "Not available" means don't try to fetch it again. */
50 signed char *register_valid;
52 /* The thread/process associated with the current set of registers.
53 For now, -1 is special, and means `no current process'. */
55 static int registers_pid = -1;
63 Returns 0 if the value is not in the cache (needs fetch).
64 >0 if the value is in the cache.
65 <0 if the value is permanently unavailable (don't ask again). */
68 register_cached (int regnum)
70 return register_valid[regnum];
73 /* Record that REGNUM's value is cached if STATE is >0, uncached but
74 fetchable if STATE is 0, and uncached and unfetchable if STATE is <0. */
77 set_register_cached (int regnum, int state)
79 register_valid[regnum] = state;
84 invalidate a single register REGNUM in the cache */
86 register_changed (int regnum)
88 set_register_cached (regnum, 0);
91 /* If REGNUM >= 0, return a pointer to register REGNUM's cache buffer area,
92 else return a pointer to the start of the cache buffer. */
95 register_buffer (int regnum)
100 return ®isters[REGISTER_BYTE (regnum)];
103 /* Return whether register REGNUM is a real register. */
106 real_register (int regnum)
108 return regnum >= 0 && regnum < NUM_REGS;
111 /* Return whether register REGNUM is a pseudo register. */
114 pseudo_register (int regnum)
116 return regnum >= NUM_REGS && regnum < NUM_REGS + NUM_PSEUDO_REGS;
119 /* Fetch register REGNUM into the cache. */
122 fetch_register (int regnum)
124 if (real_register (regnum))
125 target_fetch_registers (regnum);
126 else if (pseudo_register (regnum))
127 FETCH_PSEUDO_REGISTER (regnum);
130 /* Write register REGNUM cached value to the target. */
133 store_register (int regnum)
135 if (real_register (regnum))
136 target_store_registers (regnum);
137 else if (pseudo_register (regnum))
138 STORE_PSEUDO_REGISTER (regnum);
141 /* Low level examining and depositing of registers.
143 The caller is responsible for making sure that the inferior is
144 stopped before calling the fetching routines, or it will get
145 garbage. (a change from GDB version 3, in which the caller got the
146 value from the last stop). */
148 /* REGISTERS_CHANGED ()
150 Indicate that registers may have changed, so invalidate the cache. */
153 registers_changed (void)
159 /* Force cleanup of any alloca areas if using C alloca instead of
160 a builtin alloca. This particular call is used to clean up
161 areas allocated by low level target code which may build up
162 during lengthy interactions between gdb and the target before
163 gdb gives control to the user (ie watchpoints). */
166 for (i = 0; i < NUM_REGS; i++)
167 set_register_cached (i, 0);
169 /* Assume that if all the hardware regs have changed,
170 then so have the pseudo-registers. */
171 for (i = NUM_REGS; i < NUM_REGS + NUM_PSEUDO_REGS; i++)
172 set_register_cached (i, 0);
174 if (registers_changed_hook)
175 registers_changed_hook ();
178 /* REGISTERS_FETCHED ()
180 Indicate that all registers have been fetched, so mark them all valid. */
184 registers_fetched (void)
188 for (i = 0; i < NUM_REGS; i++)
189 set_register_cached (i, 1);
190 /* Do not assume that the pseudo-regs have also been fetched.
191 Fetching all real regs might not account for all pseudo-regs. */
194 /* read_register_bytes and write_register_bytes are generally a *BAD*
195 idea. They are inefficient because they need to check for partial
196 updates, which can only be done by scanning through all of the
197 registers and seeing if the bytes that are being read/written fall
198 inside of an invalid register. [The main reason this is necessary
199 is that register sizes can vary, so a simple index won't suffice.]
200 It is far better to call read_register_gen and write_register_gen
201 if you want to get at the raw register contents, as it only takes a
202 regnum as an argument, and therefore can't do a partial register
205 Prior to the recent fixes to check for partial updates, both read
206 and write_register_bytes always checked to see if any registers
207 were stale, and then called target_fetch_registers (-1) to update
208 the whole set. This caused really slowed things down for remote
211 /* Copy INLEN bytes of consecutive data from registers
212 starting with the INREGBYTE'th byte of register data
213 into memory at MYADDR. */
216 read_register_bytes (int in_start, char *in_buf, int in_len)
218 int in_end = in_start + in_len;
220 char *reg_buf = alloca (MAX_REGISTER_RAW_SIZE);
222 /* See if we are trying to read bytes from out-of-date registers. If so,
223 update just those registers. */
225 for (regnum = 0; regnum < NUM_REGS + NUM_PSEUDO_REGS; regnum++)
234 if (REGISTER_NAME (regnum) == NULL || *REGISTER_NAME (regnum) == '\0')
237 reg_start = REGISTER_BYTE (regnum);
238 reg_len = REGISTER_RAW_SIZE (regnum);
239 reg_end = reg_start + reg_len;
241 if (reg_end <= in_start || in_end <= reg_start)
242 /* The range the user wants to read doesn't overlap with regnum. */
245 /* Force the cache to fetch the entire register. */
246 read_register_gen (regnum, reg_buf);
248 /* Legacy note: This function, for some reason, allows a NULL
249 input buffer. If the buffer is NULL, the registers are still
250 fetched, just the final transfer is skipped. */
254 /* start = max (reg_start, in_start) */
255 if (reg_start > in_start)
260 /* end = min (reg_end, in_end) */
261 if (reg_end < in_end)
266 /* Transfer just the bytes common to both IN_BUF and REG_BUF */
267 for (byte = start; byte < end; byte++)
269 in_buf[byte - in_start] = reg_buf[byte - reg_start];
274 /* Read register REGNUM into memory at MYADDR, which must be large
275 enough for REGISTER_RAW_BYTES (REGNUM). Target byte-order. If the
276 register is known to be the size of a CORE_ADDR or smaller,
277 read_register can be used instead. */
280 legacy_read_register_gen (int regnum, char *myaddr)
282 gdb_assert (regnum >= 0 && regnum < (NUM_REGS + NUM_PSEUDO_REGS));
283 if (registers_pid != inferior_pid)
285 registers_changed ();
286 registers_pid = inferior_pid;
289 if (!register_cached (regnum))
290 fetch_register (regnum);
292 memcpy (myaddr, register_buffer (regnum),
293 REGISTER_RAW_SIZE (regnum));
297 regcache_read (int rawnum, char *buf)
299 gdb_assert (rawnum >= 0 && rawnum < NUM_REGS);
300 /* For moment, just use underlying legacy code. Ulgh!!! */
301 legacy_read_register_gen (rawnum, buf);
305 read_register_gen (int regnum, char *buf)
307 if (! gdbarch_register_read_p (current_gdbarch))
309 legacy_read_register_gen (regnum, buf);
312 gdbarch_register_read (current_gdbarch, regnum, buf);
316 /* Write register REGNUM at MYADDR to the target. MYADDR points at
317 REGISTER_RAW_BYTES(REGNUM), which must be in target byte-order. */
319 /* Registers we shouldn't try to store. */
320 #if !defined (CANNOT_STORE_REGISTER)
321 #define CANNOT_STORE_REGISTER(regnum) 0
325 legacy_write_register_gen (int regnum, char *myaddr)
328 gdb_assert (regnum >= 0 && regnum < (NUM_REGS + NUM_PSEUDO_REGS));
330 /* On the sparc, writing %g0 is a no-op, so we don't even want to
331 change the registers array if something writes to this register. */
332 if (CANNOT_STORE_REGISTER (regnum))
335 if (registers_pid != inferior_pid)
337 registers_changed ();
338 registers_pid = inferior_pid;
341 size = REGISTER_RAW_SIZE (regnum);
343 /* If we have a valid copy of the register, and new value == old value,
344 then don't bother doing the actual store. */
346 if (register_cached (regnum)
347 && memcmp (register_buffer (regnum), myaddr, size) == 0)
350 if (real_register (regnum))
351 target_prepare_to_store ();
353 memcpy (register_buffer (regnum), myaddr, size);
355 set_register_cached (regnum, 1);
356 store_register (regnum);
360 regcache_write (int rawnum, char *buf)
362 gdb_assert (rawnum >= 0 && rawnum < NUM_REGS);
363 /* For moment, just use underlying legacy code. Ulgh!!! */
364 legacy_write_register_gen (rawnum, buf);
368 write_register_gen (int regnum, char *buf)
370 if (! gdbarch_register_write_p (current_gdbarch))
372 legacy_write_register_gen (regnum, buf);
375 gdbarch_register_write (current_gdbarch, regnum, buf);
378 /* Copy INLEN bytes of consecutive data from memory at MYADDR
379 into registers starting with the MYREGSTART'th byte of register data. */
382 write_register_bytes (int myregstart, char *myaddr, int inlen)
384 int myregend = myregstart + inlen;
387 target_prepare_to_store ();
389 /* Scan through the registers updating any that are covered by the
390 range myregstart<=>myregend using write_register_gen, which does
391 nice things like handling threads, and avoiding updates when the
392 new and old contents are the same. */
394 for (regnum = 0; regnum < NUM_REGS + NUM_PSEUDO_REGS; regnum++)
396 int regstart, regend;
398 regstart = REGISTER_BYTE (regnum);
399 regend = regstart + REGISTER_RAW_SIZE (regnum);
401 /* Is this register completely outside the range the user is writing? */
402 if (myregend <= regstart || regend <= myregstart)
405 /* Is this register completely within the range the user is writing? */
406 else if (myregstart <= regstart && regend <= myregend)
407 write_register_gen (regnum, myaddr + (regstart - myregstart));
409 /* The register partially overlaps the range being written. */
412 char *regbuf = (char*) alloca (MAX_REGISTER_RAW_SIZE);
413 /* What's the overlap between this register's bytes and
414 those the caller wants to write? */
415 int overlapstart = max (regstart, myregstart);
416 int overlapend = min (regend, myregend);
418 /* We may be doing a partial update of an invalid register.
419 Update it from the target before scribbling on it. */
420 read_register_gen (regnum, regbuf);
422 memcpy (registers + overlapstart,
423 myaddr + (overlapstart - myregstart),
424 overlapend - overlapstart);
426 store_register (regnum);
432 /* Return the contents of register REGNUM as an unsigned integer. */
435 read_register (int regnum)
437 char *buf = alloca (REGISTER_RAW_SIZE (regnum));
438 read_register_gen (regnum, buf);
439 return (extract_unsigned_integer (buf, REGISTER_RAW_SIZE (regnum)));
443 read_register_pid (int regnum, int pid)
448 if (pid == inferior_pid)
449 return read_register (regnum);
451 save_pid = inferior_pid;
455 retval = read_register (regnum);
457 inferior_pid = save_pid;
462 /* Return the contents of register REGNUM as a signed integer. */
465 read_signed_register (int regnum)
467 void *buf = alloca (REGISTER_RAW_SIZE (regnum));
468 read_register_gen (regnum, buf);
469 return (extract_signed_integer (buf, REGISTER_RAW_SIZE (regnum)));
473 read_signed_register_pid (int regnum, int pid)
478 if (pid == inferior_pid)
479 return read_signed_register (regnum);
481 save_pid = inferior_pid;
485 retval = read_signed_register (regnum);
487 inferior_pid = save_pid;
492 /* Store VALUE into the raw contents of register number REGNUM. */
495 write_register (int regnum, LONGEST val)
499 size = REGISTER_RAW_SIZE (regnum);
501 store_signed_integer (buf, size, (LONGEST) val);
502 write_register_gen (regnum, buf);
506 write_register_pid (int regnum, CORE_ADDR val, int pid)
510 if (pid == inferior_pid)
512 write_register (regnum, val);
516 save_pid = inferior_pid;
520 write_register (regnum, val);
522 inferior_pid = save_pid;
527 Record that register REGNUM contains VAL. This is used when the
528 value is obtained from the inferior or core dump, so there is no
529 need to store the value there.
531 If VAL is a NULL pointer, then it's probably an unsupported register.
532 We just set its value to all zeros. We might want to record this
533 fact, and report it to the users of read_register and friends. */
536 supply_register (int regnum, char *val)
539 if (registers_pid != inferior_pid)
541 registers_changed ();
542 registers_pid = inferior_pid;
546 set_register_cached (regnum, 1);
548 memcpy (register_buffer (regnum), val,
549 REGISTER_RAW_SIZE (regnum));
551 memset (register_buffer (regnum), '\000',
552 REGISTER_RAW_SIZE (regnum));
554 /* On some architectures, e.g. HPPA, there are a few stray bits in
555 some registers, that the rest of the code would like to ignore. */
557 /* NOTE: cagney/2001-03-16: The macro CLEAN_UP_REGISTER_VALUE is
558 going to be deprecated. Instead architectures will leave the raw
559 register value as is and instead clean things up as they pass
560 through the method gdbarch_register_read() clean up the
563 #ifdef CLEAN_UP_REGISTER_VALUE
564 CLEAN_UP_REGISTER_VALUE (regnum, register_buffer (regnum));
568 /* read_pc, write_pc, read_sp, write_sp, read_fp, write_fp, etc.
569 Special handling for registers PC, SP, and FP. */
571 /* NOTE: cagney/2001-02-18: The functions generic_target_read_pc(),
572 read_pc_pid(), read_pc(), generic_target_write_pc(),
573 write_pc_pid(), write_pc(), generic_target_read_sp(), read_sp(),
574 generic_target_write_sp(), write_sp(), generic_target_read_fp(),
575 read_fp(), generic_target_write_fp(), write_fp will eventually be
576 moved out of the reg-cache into either frame.[hc] or to the
577 multi-arch framework. The are not part of the raw register cache. */
579 /* This routine is getting awfully cluttered with #if's. It's probably
580 time to turn this into READ_PC and define it in the tm.h file.
583 1999-06-08: The following were re-written so that it assumes the
584 existence of a TARGET_READ_PC et.al. macro. A default generic
585 version of that macro is made available where needed.
587 Since the ``TARGET_READ_PC'' et.al. macro is going to be controlled
588 by the multi-arch framework, it will eventually be possible to
589 eliminate the intermediate read_pc_pid(). The client would call
590 TARGET_READ_PC directly. (cagney). */
593 generic_target_read_pc (int pid)
598 CORE_ADDR pc_val = ADDR_BITS_REMOVE ((CORE_ADDR) read_register_pid (PC_REGNUM, pid));
602 internal_error (__FILE__, __LINE__,
603 "generic_target_read_pc");
608 read_pc_pid (int pid)
610 int saved_inferior_pid;
613 /* In case pid != inferior_pid. */
614 saved_inferior_pid = inferior_pid;
617 pc_val = TARGET_READ_PC (pid);
619 inferior_pid = saved_inferior_pid;
626 return read_pc_pid (inferior_pid);
630 generic_target_write_pc (CORE_ADDR pc, int pid)
634 write_register_pid (PC_REGNUM, pc, pid);
636 write_register_pid (NPC_REGNUM, pc + 4, pid);
637 if (NNPC_REGNUM >= 0)
638 write_register_pid (NNPC_REGNUM, pc + 8, pid);
640 internal_error (__FILE__, __LINE__,
641 "generic_target_write_pc");
646 write_pc_pid (CORE_ADDR pc, int pid)
648 int saved_inferior_pid;
650 /* In case pid != inferior_pid. */
651 saved_inferior_pid = inferior_pid;
654 TARGET_WRITE_PC (pc, pid);
656 inferior_pid = saved_inferior_pid;
660 write_pc (CORE_ADDR pc)
662 write_pc_pid (pc, inferior_pid);
665 /* Cope with strage ways of getting to the stack and frame pointers */
668 generic_target_read_sp (void)
672 return read_register (SP_REGNUM);
674 internal_error (__FILE__, __LINE__,
675 "generic_target_read_sp");
681 return TARGET_READ_SP ();
685 generic_target_write_sp (CORE_ADDR val)
690 write_register (SP_REGNUM, val);
694 internal_error (__FILE__, __LINE__,
695 "generic_target_write_sp");
699 write_sp (CORE_ADDR val)
701 TARGET_WRITE_SP (val);
705 generic_target_read_fp (void)
709 return read_register (FP_REGNUM);
711 internal_error (__FILE__, __LINE__,
712 "generic_target_read_fp");
718 return TARGET_READ_FP ();
722 generic_target_write_fp (CORE_ADDR val)
727 write_register (FP_REGNUM, val);
731 internal_error (__FILE__, __LINE__,
732 "generic_target_write_fp");
736 write_fp (CORE_ADDR val)
738 TARGET_WRITE_FP (val);
743 reg_flush_command (char *command, int from_tty)
745 /* Force-flush the register cache. */
746 registers_changed ();
748 printf_filtered ("Register cache flushed.\n");
753 build_regcache (void)
755 /* We allocate some extra slop since we do a lot of memcpy's around
756 `registers', and failing-soft is better than failing hard. */
757 int sizeof_registers = REGISTER_BYTES + /* SLOP */ 256;
758 int sizeof_register_valid =
759 (NUM_REGS + NUM_PSEUDO_REGS) * sizeof (*register_valid);
760 registers = xmalloc (sizeof_registers);
761 memset (registers, 0, sizeof_registers);
762 register_valid = xmalloc (sizeof_register_valid);
763 memset (register_valid, 0, sizeof_register_valid);
767 _initialize_regcache (void)
771 register_gdbarch_swap (®isters, sizeof (registers), NULL);
772 register_gdbarch_swap (®ister_valid, sizeof (register_valid), NULL);
773 register_gdbarch_swap (NULL, 0, build_regcache);
775 add_com ("flushregs", class_maintenance, reg_flush_command,
776 "Force gdb to flush its register cache (maintainer command)");