Index: mi/ChangeLog
[platform/upstream/binutils.git] / gdb / regcache.c
1 /* Cache and manage the values of registers for GDB, the GNU debugger.
2
3    Copyright 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000,
4    2001, 2002 Free Software Foundation, Inc.
5
6    This file is part of GDB.
7
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.
12
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.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 59 Temple Place - Suite 330,
21    Boston, MA 02111-1307, USA.  */
22
23 #include "defs.h"
24 #include "inferior.h"
25 #include "target.h"
26 #include "gdbarch.h"
27 #include "gdbcmd.h"
28 #include "regcache.h"
29 #include "reggroups.h"
30 #include "gdb_assert.h"
31 #include "gdb_string.h"
32 #include "gdbcmd.h"             /* For maintenanceprintlist.  */
33
34 /*
35  * DATA STRUCTURE
36  *
37  * Here is the actual register cache.
38  */
39
40 /* Per-architecture object describing the layout of a register cache.
41    Computed once when the architecture is created */
42
43 struct gdbarch_data *regcache_descr_handle;
44
45 struct regcache_descr
46 {
47   /* The architecture this descriptor belongs to.  */
48   struct gdbarch *gdbarch;
49
50   /* Is this a ``legacy'' register cache?  Such caches reserve space
51      for raw and pseudo registers and allow access to both.  */
52   int legacy_p;
53
54   /* The raw register cache.  Each raw (or hard) register is supplied
55      by the target interface.  The raw cache should not contain
56      redundant information - if the PC is constructed from two
57      registers then those regigisters and not the PC lives in the raw
58      cache.  */
59   int nr_raw_registers;
60   long sizeof_raw_registers;
61   long sizeof_raw_register_valid_p;
62
63   /* The cooked register space.  Each cooked register in the range
64      [0..NR_RAW_REGISTERS) is direct-mapped onto the corresponding raw
65      register.  The remaining [NR_RAW_REGISTERS
66      .. NR_COOKED_REGISTERS) (a.k.a. pseudo regiters) are mapped onto
67      both raw registers and memory by the architecture methods
68      gdbarch_register_read and gdbarch_register_write.  */
69   int nr_cooked_registers;
70   long sizeof_cooked_registers;
71   long sizeof_cooked_register_valid_p;
72
73   /* Offset and size (in 8 bit bytes), of reach register in the
74      register cache.  All registers (including those in the range
75      [NR_RAW_REGISTERS .. NR_COOKED_REGISTERS) are given an offset.
76      Assigning all registers an offset makes it possible to keep
77      legacy code, such as that found in read_register_bytes() and
78      write_register_bytes() working.  */
79   long *register_offset;
80   long *sizeof_register;
81
82   /* Cached table containing the type of each register.  */
83   struct type **register_type;
84 };
85
86 static void
87 init_legacy_regcache_descr (struct gdbarch *gdbarch,
88                             struct regcache_descr *descr)
89 {
90   int i;
91   /* FIXME: cagney/2002-05-11: gdbarch_data() should take that
92      ``gdbarch'' as a parameter.  */
93   gdb_assert (gdbarch != NULL);
94
95   /* Compute the offset of each register.  Legacy architectures define
96      DEPRECATED_REGISTER_BYTE() so use that.  */
97   /* FIXME: cagney/2002-11-07: Instead of using
98      DEPRECATED_REGISTER_BYTE() this code should, as is done in
99      init_regcache_descr(), compute the offets at runtime.  This
100      currently isn't possible as some ISAs define overlapping register
101      regions - see the mess in read_register_bytes() and
102      write_register_bytes() registers.  */
103   descr->sizeof_register
104     = GDBARCH_OBSTACK_CALLOC (gdbarch, descr->nr_cooked_registers, long);
105   descr->register_offset
106     = GDBARCH_OBSTACK_CALLOC (gdbarch, descr->nr_cooked_registers, long);
107   for (i = 0; i < descr->nr_cooked_registers; i++)
108     {
109       /* FIXME: cagney/2001-12-04: This code shouldn't need to use
110          DEPRECATED_REGISTER_BYTE().  Unfortunately, legacy code likes
111          to lay the buffer out so that certain registers just happen
112          to overlap.  Ulgh!  New targets use gdbarch's register
113          read/write and entirely avoid this uglyness.  */
114       descr->register_offset[i] = DEPRECATED_REGISTER_BYTE (i);
115       descr->sizeof_register[i] = DEPRECATED_REGISTER_RAW_SIZE (i);
116       gdb_assert (MAX_REGISTER_SIZE >= DEPRECATED_REGISTER_RAW_SIZE (i));
117       gdb_assert (MAX_REGISTER_SIZE >= DEPRECATED_REGISTER_VIRTUAL_SIZE (i));
118     }
119
120   /* Compute the real size of the register buffer.  Start out by
121      trusting DEPRECATED_REGISTER_BYTES, but then adjust it upwards
122      should that be found to not be sufficient.  */
123   /* FIXME: cagney/2002-11-05: Instead of using the macro
124      DEPRECATED_REGISTER_BYTES, this code should, as is done in
125      init_regcache_descr(), compute the total number of register bytes
126      using the accumulated offsets.  */
127   descr->sizeof_cooked_registers = DEPRECATED_REGISTER_BYTES; /* OK */
128   for (i = 0; i < descr->nr_cooked_registers; i++)
129     {
130       long regend;
131       /* Keep extending the buffer so that there is always enough
132          space for all registers.  The comparison is necessary since
133          legacy code is free to put registers in random places in the
134          buffer separated by holes.  Once DEPRECATED_REGISTER_BYTE()
135          is killed this can be greatly simplified.  */
136       regend = descr->register_offset[i] + descr->sizeof_register[i];
137       if (descr->sizeof_cooked_registers < regend)
138         descr->sizeof_cooked_registers = regend;
139     }
140   /* FIXME: cagney/2002-05-11: Shouldn't be including pseudo-registers
141      in the register cache.  Unfortunately some architectures still
142      rely on this and the pseudo_register_write() method.  */
143   descr->sizeof_raw_registers = descr->sizeof_cooked_registers;
144 }
145
146 static void *
147 init_regcache_descr (struct gdbarch *gdbarch)
148 {
149   int i;
150   struct regcache_descr *descr;
151   gdb_assert (gdbarch != NULL);
152
153   /* Create an initial, zero filled, table.  */
154   descr = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct regcache_descr);
155   descr->gdbarch = gdbarch;
156
157   /* Total size of the register space.  The raw registers are mapped
158      directly onto the raw register cache while the pseudo's are
159      either mapped onto raw-registers or memory.  */
160   descr->nr_cooked_registers = NUM_REGS + NUM_PSEUDO_REGS;
161   descr->sizeof_cooked_register_valid_p = NUM_REGS + NUM_PSEUDO_REGS;
162
163   /* Fill in a table of register types.  */
164   descr->register_type
165     = GDBARCH_OBSTACK_CALLOC (gdbarch, descr->nr_cooked_registers, struct type *);
166   for (i = 0; i < descr->nr_cooked_registers; i++)
167     {
168       if (gdbarch_register_type_p (gdbarch))
169         {
170           gdb_assert (!DEPRECATED_REGISTER_VIRTUAL_TYPE_P ()); /* OK */
171           descr->register_type[i] = gdbarch_register_type (gdbarch, i);
172         }
173       else
174         descr->register_type[i] = DEPRECATED_REGISTER_VIRTUAL_TYPE (i); /* OK */
175     }
176
177   /* Construct a strictly RAW register cache.  Don't allow pseudo's
178      into the register cache.  */
179   descr->nr_raw_registers = NUM_REGS;
180
181   /* FIXME: cagney/2002-08-13: Overallocate the register_valid_p
182      array.  This pretects GDB from erant code that accesses elements
183      of the global register_valid_p[] array in the range [NUM_REGS
184      .. NUM_REGS + NUM_PSEUDO_REGS).  */
185   descr->sizeof_raw_register_valid_p = descr->sizeof_cooked_register_valid_p;
186
187   /* If an old style architecture, fill in the remainder of the
188      register cache descriptor using the register macros.  */
189   /* NOTE: cagney/2003-06-29: If either of DEPRECATED_REGISTER_BYTE or
190      DEPRECATED_REGISTER_RAW_SIZE are still present, things are most likely
191      totally screwed.  Ex: an architecture with raw register sizes
192      smaller than what DEPRECATED_REGISTER_BYTE indicates; non
193      monotonic DEPRECATED_REGISTER_BYTE values.  For GDB 6 check for
194      these nasty methods and fall back to legacy code when present.
195      Sigh!  */
196   if ((!gdbarch_pseudo_register_read_p (gdbarch)
197        && !gdbarch_pseudo_register_write_p (gdbarch)
198        && !gdbarch_register_type_p (gdbarch))
199       || DEPRECATED_REGISTER_BYTE_P ()
200       || DEPRECATED_REGISTER_RAW_SIZE_P ())
201     {
202       descr->legacy_p = 1;
203       init_legacy_regcache_descr (gdbarch, descr);
204       return descr;
205     }
206
207   /* Lay out the register cache.
208
209      NOTE: cagney/2002-05-22: Only register_type() is used when
210      constructing the register cache.  It is assumed that the
211      register's raw size, virtual size and type length are all the
212      same.  */
213
214   {
215     long offset = 0;
216     descr->sizeof_register
217       = GDBARCH_OBSTACK_CALLOC (gdbarch, descr->nr_cooked_registers, long);
218     descr->register_offset
219       = GDBARCH_OBSTACK_CALLOC (gdbarch, descr->nr_cooked_registers, long);
220     for (i = 0; i < descr->nr_cooked_registers; i++)
221       {
222         descr->sizeof_register[i] = TYPE_LENGTH (descr->register_type[i]);
223         descr->register_offset[i] = offset;
224         offset += descr->sizeof_register[i];
225         gdb_assert (MAX_REGISTER_SIZE >= descr->sizeof_register[i]);
226       }
227     /* Set the real size of the register cache buffer.  */
228     descr->sizeof_cooked_registers = offset;
229   }
230
231   /* FIXME: cagney/2002-05-22: Should only need to allocate space for
232      the raw registers.  Unfortunately some code still accesses the
233      register array directly using the global registers[].  Until that
234      code has been purged, play safe and over allocating the register
235      buffer.  Ulgh!  */
236   descr->sizeof_raw_registers = descr->sizeof_cooked_registers;
237
238   /* Sanity check.  Confirm that there is agreement between the
239      regcache and the target's redundant DEPRECATED_REGISTER_BYTE (new
240      targets should not even be defining it).  */
241   for (i = 0; i < descr->nr_cooked_registers; i++)
242     {
243       if (DEPRECATED_REGISTER_BYTE_P ())
244         gdb_assert (descr->register_offset[i] == DEPRECATED_REGISTER_BYTE (i));
245 #if 0
246       gdb_assert (descr->sizeof_register[i] == DEPRECATED_REGISTER_RAW_SIZE (i));
247       gdb_assert (descr->sizeof_register[i] == DEPRECATED_REGISTER_VIRTUAL_SIZE (i));
248 #endif
249     }
250   /* gdb_assert (descr->sizeof_raw_registers == DEPRECATED_REGISTER_BYTES (i));  */
251
252   return descr;
253 }
254
255 static struct regcache_descr *
256 regcache_descr (struct gdbarch *gdbarch)
257 {
258   return gdbarch_data (gdbarch, regcache_descr_handle);
259 }
260
261 /* Utility functions returning useful register attributes stored in
262    the regcache descr.  */
263
264 struct type *
265 register_type (struct gdbarch *gdbarch, int regnum)
266 {
267   struct regcache_descr *descr = regcache_descr (gdbarch);
268   gdb_assert (regnum >= 0 && regnum < descr->nr_cooked_registers);
269   return descr->register_type[regnum];
270 }
271
272 /* Utility functions returning useful register attributes stored in
273    the regcache descr.  */
274
275 int
276 register_size (struct gdbarch *gdbarch, int regnum)
277 {
278   struct regcache_descr *descr = regcache_descr (gdbarch);
279   int size;
280   gdb_assert (regnum >= 0 && regnum < (NUM_REGS + NUM_PSEUDO_REGS));
281   size = descr->sizeof_register[regnum];
282   /* NB: The deprecated DEPRECATED_REGISTER_RAW_SIZE, if not provided, defaults
283      to the size of the register's type.  */
284   gdb_assert (size == DEPRECATED_REGISTER_RAW_SIZE (regnum)); /* OK */
285   /* NB: Don't check the register's virtual size.  It, in say the case
286      of the MIPS, may not match the raw size!  */
287   return size;
288 }
289
290 /* The register cache for storing raw register values.  */
291
292 struct regcache
293 {
294   struct regcache_descr *descr;
295   /* The register buffers.  A read-only register cache can hold the
296      full [0 .. NUM_REGS + NUM_PSEUDO_REGS) while a read/write
297      register cache can only hold [0 .. NUM_REGS).  */
298   char *registers;
299   char *register_valid_p;
300   /* Is this a read-only cache?  A read-only cache is used for saving
301      the target's register state (e.g, across an inferior function
302      call or just before forcing a function return).  A read-only
303      cache can only be updated via the methods regcache_dup() and
304      regcache_cpy().  The actual contents are determined by the
305      reggroup_save and reggroup_restore methods.  */
306   int readonly_p;
307 };
308
309 struct regcache *
310 regcache_xmalloc (struct gdbarch *gdbarch)
311 {
312   struct regcache_descr *descr;
313   struct regcache *regcache;
314   gdb_assert (gdbarch != NULL);
315   descr = regcache_descr (gdbarch);
316   regcache = XMALLOC (struct regcache);
317   regcache->descr = descr;
318   regcache->registers
319     = XCALLOC (descr->sizeof_raw_registers, char);
320   regcache->register_valid_p
321     = XCALLOC (descr->sizeof_raw_register_valid_p, char);
322   regcache->readonly_p = 1;
323   return regcache;
324 }
325
326 void
327 regcache_xfree (struct regcache *regcache)
328 {
329   if (regcache == NULL)
330     return;
331   xfree (regcache->registers);
332   xfree (regcache->register_valid_p);
333   xfree (regcache);
334 }
335
336 static void
337 do_regcache_xfree (void *data)
338 {
339   regcache_xfree (data);
340 }
341
342 struct cleanup *
343 make_cleanup_regcache_xfree (struct regcache *regcache)
344 {
345   return make_cleanup (do_regcache_xfree, regcache);
346 }
347
348 /* Return REGCACHE's architecture.  */
349
350 struct gdbarch *
351 get_regcache_arch (const struct regcache *regcache)
352 {
353   return regcache->descr->gdbarch;
354 }
355
356 /* Return  a pointer to register REGNUM's buffer cache.  */
357
358 static char *
359 register_buffer (const struct regcache *regcache, int regnum)
360 {
361   return regcache->registers + regcache->descr->register_offset[regnum];
362 }
363
364 void
365 regcache_save (struct regcache *dst, regcache_cooked_read_ftype *cooked_read,
366                void *src)
367 {
368   struct gdbarch *gdbarch = dst->descr->gdbarch;
369   char buf[MAX_REGISTER_SIZE];
370   int regnum;
371   /* The DST should be `read-only', if it wasn't then the save would
372      end up trying to write the register values back out to the
373      target.  */
374   gdb_assert (dst->readonly_p);
375   /* Clear the dest.  */
376   memset (dst->registers, 0, dst->descr->sizeof_cooked_registers);
377   memset (dst->register_valid_p, 0, dst->descr->sizeof_cooked_register_valid_p);
378   /* Copy over any registers (identified by their membership in the
379      save_reggroup) and mark them as valid.  The full [0 .. NUM_REGS +
380      NUM_PSEUDO_REGS) range is checked since some architectures need
381      to save/restore `cooked' registers that live in memory.  */
382   for (regnum = 0; regnum < dst->descr->nr_cooked_registers; regnum++)
383     {
384       if (gdbarch_register_reggroup_p (gdbarch, regnum, save_reggroup))
385         {
386           int valid = cooked_read (src, regnum, buf);
387           if (valid)
388             {
389               memcpy (register_buffer (dst, regnum), buf,
390                       register_size (gdbarch, regnum));
391               dst->register_valid_p[regnum] = 1;
392             }
393         }
394     }
395 }
396
397 void
398 regcache_restore (struct regcache *dst,
399                   regcache_cooked_read_ftype *cooked_read,
400                   void *src)
401 {
402   struct gdbarch *gdbarch = dst->descr->gdbarch;
403   char buf[MAX_REGISTER_SIZE];
404   int regnum;
405   /* The dst had better not be read-only.  If it is, the `restore'
406      doesn't make much sense.  */
407   gdb_assert (!dst->readonly_p);
408   /* Copy over any registers, being careful to only restore those that
409      were both saved and need to be restored.  The full [0 .. NUM_REGS
410      + NUM_PSEUDO_REGS) range is checked since some architectures need
411      to save/restore `cooked' registers that live in memory.  */
412   for (regnum = 0; regnum < dst->descr->nr_cooked_registers; regnum++)
413     {
414       if (gdbarch_register_reggroup_p (gdbarch, regnum, restore_reggroup))
415         {
416           int valid = cooked_read (src, regnum, buf);
417           if (valid)
418             regcache_cooked_write (dst, regnum, buf);
419         }
420     }
421 }
422
423 static int
424 do_cooked_read (void *src, int regnum, void *buf)
425 {
426   struct regcache *regcache = src;
427   if (!regcache->register_valid_p[regnum] && regcache->readonly_p)
428     /* Don't even think about fetching a register from a read-only
429        cache when the register isn't yet valid.  There isn't a target
430        from which the register value can be fetched.  */
431     return 0;
432   regcache_cooked_read (regcache, regnum, buf);
433   return 1;
434 }
435
436
437 void
438 regcache_cpy (struct regcache *dst, struct regcache *src)
439 {
440   int i;
441   char *buf;
442   gdb_assert (src != NULL && dst != NULL);
443   gdb_assert (src->descr->gdbarch == dst->descr->gdbarch);
444   gdb_assert (src != dst);
445   gdb_assert (src->readonly_p || dst->readonly_p);
446   if (!src->readonly_p)
447     regcache_save (dst, do_cooked_read, src);
448   else if (!dst->readonly_p)
449     regcache_restore (dst, do_cooked_read, src);
450   else
451     regcache_cpy_no_passthrough (dst, src);
452 }
453
454 void
455 regcache_cpy_no_passthrough (struct regcache *dst, struct regcache *src)
456 {
457   int i;
458   gdb_assert (src != NULL && dst != NULL);
459   gdb_assert (src->descr->gdbarch == dst->descr->gdbarch);
460   /* NOTE: cagney/2002-05-17: Don't let the caller do a no-passthrough
461      move of data into the current_regcache().  Doing this would be
462      silly - it would mean that valid_p would be completly invalid.  */
463   gdb_assert (dst != current_regcache);
464   memcpy (dst->registers, src->registers, dst->descr->sizeof_raw_registers);
465   memcpy (dst->register_valid_p, src->register_valid_p,
466           dst->descr->sizeof_raw_register_valid_p);
467 }
468
469 struct regcache *
470 regcache_dup (struct regcache *src)
471 {
472   struct regcache *newbuf;
473   gdb_assert (current_regcache != NULL);
474   newbuf = regcache_xmalloc (src->descr->gdbarch);
475   regcache_cpy (newbuf, src);
476   return newbuf;
477 }
478
479 struct regcache *
480 regcache_dup_no_passthrough (struct regcache *src)
481 {
482   struct regcache *newbuf;
483   gdb_assert (current_regcache != NULL);
484   newbuf = regcache_xmalloc (src->descr->gdbarch);
485   regcache_cpy_no_passthrough (newbuf, src);
486   return newbuf;
487 }
488
489 int
490 regcache_valid_p (struct regcache *regcache, int regnum)
491 {
492   gdb_assert (regcache != NULL);
493   gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
494   return regcache->register_valid_p[regnum];
495 }
496
497 char *
498 deprecated_grub_regcache_for_registers (struct regcache *regcache)
499 {
500   return regcache->registers;
501 }
502
503 /* Global structure containing the current regcache.  */
504 /* FIXME: cagney/2002-05-11: The two global arrays registers[] and
505    deprecated_register_valid[] currently point into this structure.  */
506 struct regcache *current_regcache;
507
508 /* NOTE: this is a write-through cache.  There is no "dirty" bit for
509    recording if the register values have been changed (eg. by the
510    user).  Therefore all registers must be written back to the
511    target when appropriate.  */
512
513 /* REGISTERS contains the cached register values (in target byte order). */
514
515 char *deprecated_registers;
516
517 /* DEPRECATED_REGISTER_VALID is 0 if the register needs to be fetched,
518                      1 if it has been fetched, and
519                     -1 if the register value was not available.  
520
521    "Not available" indicates that the target is not not able to supply
522    the register at this state.  The register may become available at a
523    later time (after the next resume).  This often occures when GDB is
524    manipulating a target that contains only a snapshot of the entire
525    system being debugged - some of the registers in such a system may
526    not have been saved.  */
527
528 signed char *deprecated_register_valid;
529
530 /* The thread/process associated with the current set of registers. */
531
532 static ptid_t registers_ptid;
533
534 /*
535  * FUNCTIONS:
536  */
537
538 /* REGISTER_CACHED()
539
540    Returns 0 if the value is not in the cache (needs fetch).
541           >0 if the value is in the cache.
542           <0 if the value is permanently unavailable (don't ask again).  */
543
544 int
545 register_cached (int regnum)
546 {
547   return deprecated_register_valid[regnum];
548 }
549
550 /* Record that REGNUM's value is cached if STATE is >0, uncached but
551    fetchable if STATE is 0, and uncached and unfetchable if STATE is <0.  */
552
553 void
554 set_register_cached (int regnum, int state)
555 {
556   gdb_assert (regnum >= 0);
557   gdb_assert (regnum < current_regcache->descr->nr_raw_registers);
558   current_regcache->register_valid_p[regnum] = state;
559 }
560
561 /* Return whether register REGNUM is a real register.  */
562
563 static int
564 real_register (int regnum)
565 {
566   return regnum >= 0 && regnum < NUM_REGS;
567 }
568
569 /* Low level examining and depositing of registers.
570
571    The caller is responsible for making sure that the inferior is
572    stopped before calling the fetching routines, or it will get
573    garbage.  (a change from GDB version 3, in which the caller got the
574    value from the last stop).  */
575
576 /* REGISTERS_CHANGED ()
577
578    Indicate that registers may have changed, so invalidate the cache.  */
579
580 void
581 registers_changed (void)
582 {
583   int i;
584
585   registers_ptid = pid_to_ptid (-1);
586
587   /* Force cleanup of any alloca areas if using C alloca instead of
588      a builtin alloca.  This particular call is used to clean up
589      areas allocated by low level target code which may build up
590      during lengthy interactions between gdb and the target before
591      gdb gives control to the user (ie watchpoints).  */
592   alloca (0);
593
594   for (i = 0; i < current_regcache->descr->nr_raw_registers; i++)
595     set_register_cached (i, 0);
596
597   if (registers_changed_hook)
598     registers_changed_hook ();
599 }
600
601 /* DEPRECATED_REGISTERS_FETCHED ()
602
603    Indicate that all registers have been fetched, so mark them all valid.  */
604
605 /* NOTE: cagney/2001-12-04: This function does not set valid on the
606    pseudo-register range since pseudo registers are always supplied
607    using supply_register().  */
608 /* FIXME: cagney/2001-12-04: This function is DEPRECATED.  The target
609    code was blatting the registers[] array and then calling this.
610    Since targets should only be using supply_register() the need for
611    this function/hack is eliminated.  */
612
613 void
614 deprecated_registers_fetched (void)
615 {
616   int i;
617
618   for (i = 0; i < NUM_REGS; i++)
619     set_register_cached (i, 1);
620   /* Do not assume that the pseudo-regs have also been fetched.
621      Fetching all real regs NEVER accounts for pseudo-regs.  */
622 }
623
624 /* deprecated_read_register_bytes and deprecated_write_register_bytes
625    are generally a *BAD* idea.  They are inefficient because they need
626    to check for partial updates, which can only be done by scanning
627    through all of the registers and seeing if the bytes that are being
628    read/written fall inside of an invalid register.  [The main reason
629    this is necessary is that register sizes can vary, so a simple
630    index won't suffice.]  It is far better to call read_register_gen
631    and write_register_gen if you want to get at the raw register
632    contents, as it only takes a regnum as an argument, and therefore
633    can't do a partial register update.
634
635    Prior to the recent fixes to check for partial updates, both read
636    and deprecated_write_register_bytes always checked to see if any
637    registers were stale, and then called target_fetch_registers (-1)
638    to update the whole set.  This caused really slowed things down for
639    remote targets.  */
640
641 /* Copy INLEN bytes of consecutive data from registers
642    starting with the INREGBYTE'th byte of register data
643    into memory at MYADDR.  */
644
645 void
646 deprecated_read_register_bytes (int in_start, char *in_buf, int in_len)
647 {
648   int in_end = in_start + in_len;
649   int regnum;
650   char reg_buf[MAX_REGISTER_SIZE];
651
652   /* See if we are trying to read bytes from out-of-date registers.  If so,
653      update just those registers.  */
654
655   for (regnum = 0; regnum < NUM_REGS + NUM_PSEUDO_REGS; regnum++)
656     {
657       int reg_start;
658       int reg_end;
659       int reg_len;
660       int start;
661       int end;
662       int byte;
663
664       reg_start = DEPRECATED_REGISTER_BYTE (regnum);
665       reg_len = DEPRECATED_REGISTER_RAW_SIZE (regnum);
666       reg_end = reg_start + reg_len;
667
668       if (reg_end <= in_start || in_end <= reg_start)
669         /* The range the user wants to read doesn't overlap with regnum.  */
670         continue;
671
672       if (REGISTER_NAME (regnum) != NULL && *REGISTER_NAME (regnum) != '\0')
673         /* Force the cache to fetch the entire register.  */
674         deprecated_read_register_gen (regnum, reg_buf);
675       else
676         /* Legacy note: even though this register is ``invalid'' we
677            still need to return something.  It would appear that some
678            code relies on apparent gaps in the register array also
679            being returned.  */
680         /* FIXME: cagney/2001-08-18: This is just silly.  It defeats
681            the entire register read/write flow of control.  Must
682            resist temptation to return 0xdeadbeef.  */
683         memcpy (reg_buf, &deprecated_registers[reg_start], reg_len);
684
685       /* Legacy note: This function, for some reason, allows a NULL
686          input buffer.  If the buffer is NULL, the registers are still
687          fetched, just the final transfer is skipped. */
688       if (in_buf == NULL)
689         continue;
690
691       /* start = max (reg_start, in_start) */
692       if (reg_start > in_start)
693         start = reg_start;
694       else
695         start = in_start;
696
697       /* end = min (reg_end, in_end) */
698       if (reg_end < in_end)
699         end = reg_end;
700       else
701         end = in_end;
702
703       /* Transfer just the bytes common to both IN_BUF and REG_BUF */
704       for (byte = start; byte < end; byte++)
705         {
706           in_buf[byte - in_start] = reg_buf[byte - reg_start];
707         }
708     }
709 }
710
711 /* Read register REGNUM into memory at MYADDR, which must be large
712    enough for REGISTER_RAW_BYTES (REGNUM).  Target byte-order.  If the
713    register is known to be the size of a CORE_ADDR or smaller,
714    read_register can be used instead.  */
715
716 static void
717 legacy_read_register_gen (int regnum, char *myaddr)
718 {
719   gdb_assert (regnum >= 0 && regnum < (NUM_REGS + NUM_PSEUDO_REGS));
720   if (! ptid_equal (registers_ptid, inferior_ptid))
721     {
722       registers_changed ();
723       registers_ptid = inferior_ptid;
724     }
725
726   if (!register_cached (regnum))
727     target_fetch_registers (regnum);
728
729   memcpy (myaddr, register_buffer (current_regcache, regnum),
730           DEPRECATED_REGISTER_RAW_SIZE (regnum));
731 }
732
733 void
734 regcache_raw_read (struct regcache *regcache, int regnum, void *buf)
735 {
736   gdb_assert (regcache != NULL && buf != NULL);
737   gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
738   if (regcache->descr->legacy_p
739       && !regcache->readonly_p)
740     {
741       gdb_assert (regcache == current_regcache);
742       /* For moment, just use underlying legacy code.  Ulgh!!! This
743          silently and very indirectly updates the regcache's regcache
744          via the global deprecated_register_valid[].  */
745       legacy_read_register_gen (regnum, buf);
746       return;
747     }
748   /* Make certain that the register cache is up-to-date with respect
749      to the current thread.  This switching shouldn't be necessary
750      only there is still only one target side register cache.  Sigh!
751      On the bright side, at least there is a regcache object.  */
752   if (!regcache->readonly_p)
753     {
754       gdb_assert (regcache == current_regcache);
755       if (! ptid_equal (registers_ptid, inferior_ptid))
756         {
757           registers_changed ();
758           registers_ptid = inferior_ptid;
759         }
760       if (!register_cached (regnum))
761         target_fetch_registers (regnum);
762     }
763   /* Copy the value directly into the register cache.  */
764   memcpy (buf, register_buffer (regcache, regnum),
765           regcache->descr->sizeof_register[regnum]);
766 }
767
768 void
769 regcache_raw_read_signed (struct regcache *regcache, int regnum, LONGEST *val)
770 {
771   char *buf;
772   gdb_assert (regcache != NULL);
773   gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
774   buf = alloca (regcache->descr->sizeof_register[regnum]);
775   regcache_raw_read (regcache, regnum, buf);
776   (*val) = extract_signed_integer (buf,
777                                    regcache->descr->sizeof_register[regnum]);
778 }
779
780 void
781 regcache_raw_read_unsigned (struct regcache *regcache, int regnum,
782                             ULONGEST *val)
783 {
784   char *buf;
785   gdb_assert (regcache != NULL);
786   gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
787   buf = alloca (regcache->descr->sizeof_register[regnum]);
788   regcache_raw_read (regcache, regnum, buf);
789   (*val) = extract_unsigned_integer (buf,
790                                      regcache->descr->sizeof_register[regnum]);
791 }
792
793 void
794 regcache_raw_write_signed (struct regcache *regcache, int regnum, LONGEST val)
795 {
796   void *buf;
797   gdb_assert (regcache != NULL);
798   gdb_assert (regnum >=0 && regnum < regcache->descr->nr_raw_registers);
799   buf = alloca (regcache->descr->sizeof_register[regnum]);
800   store_signed_integer (buf, regcache->descr->sizeof_register[regnum], val);
801   regcache_raw_write (regcache, regnum, buf);
802 }
803
804 void
805 regcache_raw_write_unsigned (struct regcache *regcache, int regnum,
806                              ULONGEST val)
807 {
808   void *buf;
809   gdb_assert (regcache != NULL);
810   gdb_assert (regnum >=0 && regnum < regcache->descr->nr_raw_registers);
811   buf = alloca (regcache->descr->sizeof_register[regnum]);
812   store_unsigned_integer (buf, regcache->descr->sizeof_register[regnum], val);
813   regcache_raw_write (regcache, regnum, buf);
814 }
815
816 void
817 deprecated_read_register_gen (int regnum, char *buf)
818 {
819   gdb_assert (current_regcache != NULL);
820   gdb_assert (current_regcache->descr->gdbarch == current_gdbarch);
821   if (current_regcache->descr->legacy_p)
822     {
823       legacy_read_register_gen (regnum, buf);
824       return;
825     }
826   regcache_cooked_read (current_regcache, regnum, buf);
827 }
828
829 void
830 regcache_cooked_read (struct regcache *regcache, int regnum, void *buf)
831 {
832   gdb_assert (regnum >= 0);
833   gdb_assert (regnum < regcache->descr->nr_cooked_registers);
834   if (regnum < regcache->descr->nr_raw_registers)
835     regcache_raw_read (regcache, regnum, buf);
836   else if (regcache->readonly_p
837            && regnum < regcache->descr->nr_cooked_registers
838            && regcache->register_valid_p[regnum])
839     /* Read-only register cache, perhaphs the cooked value was cached?  */
840     memcpy (buf, register_buffer (regcache, regnum),
841             regcache->descr->sizeof_register[regnum]);
842   else
843     gdbarch_pseudo_register_read (regcache->descr->gdbarch, regcache,
844                                   regnum, buf);
845 }
846
847 void
848 regcache_cooked_read_signed (struct regcache *regcache, int regnum,
849                              LONGEST *val)
850 {
851   char *buf;
852   gdb_assert (regcache != NULL);
853   gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_cooked_registers);
854   buf = alloca (regcache->descr->sizeof_register[regnum]);
855   regcache_cooked_read (regcache, regnum, buf);
856   (*val) = extract_signed_integer (buf,
857                                    regcache->descr->sizeof_register[regnum]);
858 }
859
860 void
861 regcache_cooked_read_unsigned (struct regcache *regcache, int regnum,
862                                ULONGEST *val)
863 {
864   char *buf;
865   gdb_assert (regcache != NULL);
866   gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_cooked_registers);
867   buf = alloca (regcache->descr->sizeof_register[regnum]);
868   regcache_cooked_read (regcache, regnum, buf);
869   (*val) = extract_unsigned_integer (buf,
870                                      regcache->descr->sizeof_register[regnum]);
871 }
872
873 void
874 regcache_cooked_write_signed (struct regcache *regcache, int regnum,
875                               LONGEST val)
876 {
877   void *buf;
878   gdb_assert (regcache != NULL);
879   gdb_assert (regnum >=0 && regnum < regcache->descr->nr_cooked_registers);
880   buf = alloca (regcache->descr->sizeof_register[regnum]);
881   store_signed_integer (buf, regcache->descr->sizeof_register[regnum], val);
882   regcache_cooked_write (regcache, regnum, buf);
883 }
884
885 void
886 regcache_cooked_write_unsigned (struct regcache *regcache, int regnum,
887                                 ULONGEST val)
888 {
889   void *buf;
890   gdb_assert (regcache != NULL);
891   gdb_assert (regnum >=0 && regnum < regcache->descr->nr_cooked_registers);
892   buf = alloca (regcache->descr->sizeof_register[regnum]);
893   store_unsigned_integer (buf, regcache->descr->sizeof_register[regnum], val);
894   regcache_cooked_write (regcache, regnum, buf);
895 }
896
897 /* Write register REGNUM at MYADDR to the target.  MYADDR points at
898    REGISTER_RAW_BYTES(REGNUM), which must be in target byte-order.  */
899
900 static void
901 legacy_write_register_gen (int regnum, const void *myaddr)
902 {
903   int size;
904   gdb_assert (regnum >= 0 && regnum < (NUM_REGS + NUM_PSEUDO_REGS));
905
906   /* On the sparc, writing %g0 is a no-op, so we don't even want to
907      change the registers array if something writes to this register.  */
908   if (CANNOT_STORE_REGISTER (regnum))
909     return;
910
911   if (! ptid_equal (registers_ptid, inferior_ptid))
912     {
913       registers_changed ();
914       registers_ptid = inferior_ptid;
915     }
916
917   size = DEPRECATED_REGISTER_RAW_SIZE (regnum);
918
919   if (real_register (regnum))
920     {
921       /* If we have a valid copy of the register, and new value == old
922          value, then don't bother doing the actual store. */
923       if (register_cached (regnum)
924           && (memcmp (register_buffer (current_regcache, regnum), myaddr, size)
925               == 0))
926         return;
927       else
928         target_prepare_to_store ();
929     }
930
931   memcpy (register_buffer (current_regcache, regnum), myaddr, size);
932
933   set_register_cached (regnum, 1);
934   target_store_registers (regnum);
935 }
936
937 void
938 regcache_raw_write (struct regcache *regcache, int regnum, const void *buf)
939 {
940   gdb_assert (regcache != NULL && buf != NULL);
941   gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
942   gdb_assert (!regcache->readonly_p);
943
944   if (regcache->descr->legacy_p)
945     {
946       /* For moment, just use underlying legacy code.  Ulgh!!! This
947          silently and very indirectly updates the regcache's buffers
948          via the globals deprecated_register_valid[] and registers[].  */
949       gdb_assert (regcache == current_regcache);
950       legacy_write_register_gen (regnum, buf);
951       return;
952     }
953
954   /* On the sparc, writing %g0 is a no-op, so we don't even want to
955      change the registers array if something writes to this register.  */
956   if (CANNOT_STORE_REGISTER (regnum))
957     return;
958
959   /* Make certain that the correct cache is selected.  */
960   gdb_assert (regcache == current_regcache);
961   if (! ptid_equal (registers_ptid, inferior_ptid))
962     {
963       registers_changed ();
964       registers_ptid = inferior_ptid;
965     }
966
967   /* If we have a valid copy of the register, and new value == old
968      value, then don't bother doing the actual store. */
969   if (regcache_valid_p (regcache, regnum)
970       && (memcmp (register_buffer (regcache, regnum), buf,
971                   regcache->descr->sizeof_register[regnum]) == 0))
972     return;
973
974   target_prepare_to_store ();
975   memcpy (register_buffer (regcache, regnum), buf,
976           regcache->descr->sizeof_register[regnum]);
977   regcache->register_valid_p[regnum] = 1;
978   target_store_registers (regnum);
979 }
980
981 void
982 deprecated_write_register_gen (int regnum, char *buf)
983 {
984   gdb_assert (current_regcache != NULL);
985   gdb_assert (current_regcache->descr->gdbarch == current_gdbarch);
986   if (current_regcache->descr->legacy_p)
987     {
988       legacy_write_register_gen (regnum, buf);
989       return;
990     }
991   regcache_cooked_write (current_regcache, regnum, buf);
992 }
993
994 void
995 regcache_cooked_write (struct regcache *regcache, int regnum, const void *buf)
996 {
997   gdb_assert (regnum >= 0);
998   gdb_assert (regnum < regcache->descr->nr_cooked_registers);
999   if (regnum < regcache->descr->nr_raw_registers)
1000     regcache_raw_write (regcache, regnum, buf);
1001   else
1002     gdbarch_pseudo_register_write (regcache->descr->gdbarch, regcache,
1003                                    regnum, buf);
1004 }
1005
1006 /* Copy INLEN bytes of consecutive data from memory at MYADDR
1007    into registers starting with the MYREGSTART'th byte of register data.  */
1008
1009 void
1010 deprecated_write_register_bytes (int myregstart, char *myaddr, int inlen)
1011 {
1012   int myregend = myregstart + inlen;
1013   int regnum;
1014
1015   target_prepare_to_store ();
1016
1017   /* Scan through the registers updating any that are covered by the
1018      range myregstart<=>myregend using write_register_gen, which does
1019      nice things like handling threads, and avoiding updates when the
1020      new and old contents are the same.  */
1021
1022   for (regnum = 0; regnum < NUM_REGS + NUM_PSEUDO_REGS; regnum++)
1023     {
1024       int regstart, regend;
1025
1026       regstart = DEPRECATED_REGISTER_BYTE (regnum);
1027       regend = regstart + DEPRECATED_REGISTER_RAW_SIZE (regnum);
1028
1029       /* Is this register completely outside the range the user is writing?  */
1030       if (myregend <= regstart || regend <= myregstart)
1031         /* do nothing */ ;              
1032
1033       /* Is this register completely within the range the user is writing?  */
1034       else if (myregstart <= regstart && regend <= myregend)
1035         deprecated_write_register_gen (regnum, myaddr + (regstart - myregstart));
1036
1037       /* The register partially overlaps the range being written.  */
1038       else
1039         {
1040           char regbuf[MAX_REGISTER_SIZE];
1041           /* What's the overlap between this register's bytes and
1042              those the caller wants to write?  */
1043           int overlapstart = max (regstart, myregstart);
1044           int overlapend   = min (regend,   myregend);
1045
1046           /* We may be doing a partial update of an invalid register.
1047              Update it from the target before scribbling on it.  */
1048           deprecated_read_register_gen (regnum, regbuf);
1049
1050           memcpy (&deprecated_registers[overlapstart],
1051                   myaddr + (overlapstart - myregstart),
1052                   overlapend - overlapstart);
1053
1054           target_store_registers (regnum);
1055         }
1056     }
1057 }
1058
1059 /* Perform a partial register transfer using a read, modify, write
1060    operation.  */
1061
1062 typedef void (regcache_read_ftype) (struct regcache *regcache, int regnum,
1063                                     void *buf);
1064 typedef void (regcache_write_ftype) (struct regcache *regcache, int regnum,
1065                                      const void *buf);
1066
1067 static void
1068 regcache_xfer_part (struct regcache *regcache, int regnum,
1069                     int offset, int len, void *in, const void *out,
1070                     regcache_read_ftype *read, regcache_write_ftype *write)
1071 {
1072   struct regcache_descr *descr = regcache->descr;
1073   bfd_byte reg[MAX_REGISTER_SIZE];
1074   gdb_assert (offset >= 0 && offset <= descr->sizeof_register[regnum]);
1075   gdb_assert (len >= 0 && offset + len <= descr->sizeof_register[regnum]);
1076   /* Something to do?  */
1077   if (offset + len == 0)
1078     return;
1079   /* Read (when needed) ... */
1080   if (in != NULL
1081       || offset > 0
1082       || offset + len < descr->sizeof_register[regnum])
1083     {
1084       gdb_assert (read != NULL);
1085       read (regcache, regnum, reg);
1086     }
1087   /* ... modify ... */
1088   if (in != NULL)
1089     memcpy (in, reg + offset, len);
1090   if (out != NULL)
1091     memcpy (reg + offset, out, len);
1092   /* ... write (when needed).  */
1093   if (out != NULL)
1094     {
1095       gdb_assert (write != NULL);
1096       write (regcache, regnum, reg);
1097     }
1098 }
1099
1100 void
1101 regcache_raw_read_part (struct regcache *regcache, int regnum,
1102                         int offset, int len, void *buf)
1103 {
1104   struct regcache_descr *descr = regcache->descr;
1105   gdb_assert (regnum >= 0 && regnum < descr->nr_raw_registers);
1106   regcache_xfer_part (regcache, regnum, offset, len, buf, NULL,
1107                       regcache_raw_read, regcache_raw_write);
1108 }
1109
1110 void
1111 regcache_raw_write_part (struct regcache *regcache, int regnum,
1112                          int offset, int len, const void *buf)
1113 {
1114   struct regcache_descr *descr = regcache->descr;
1115   gdb_assert (regnum >= 0 && regnum < descr->nr_raw_registers);
1116   regcache_xfer_part (regcache, regnum, offset, len, NULL, buf,
1117                       regcache_raw_read, regcache_raw_write);
1118 }
1119
1120 void
1121 regcache_cooked_read_part (struct regcache *regcache, int regnum,
1122                            int offset, int len, void *buf)
1123 {
1124   struct regcache_descr *descr = regcache->descr;
1125   gdb_assert (regnum >= 0 && regnum < descr->nr_cooked_registers);
1126   regcache_xfer_part (regcache, regnum, offset, len, buf, NULL,
1127                       regcache_cooked_read, regcache_cooked_write);
1128 }
1129
1130 void
1131 regcache_cooked_write_part (struct regcache *regcache, int regnum,
1132                             int offset, int len, const void *buf)
1133 {
1134   struct regcache_descr *descr = regcache->descr;
1135   gdb_assert (regnum >= 0 && regnum < descr->nr_cooked_registers);
1136   regcache_xfer_part (regcache, regnum, offset, len, NULL, buf,
1137                       regcache_cooked_read, regcache_cooked_write);
1138 }
1139
1140 /* Hack to keep code that view the register buffer as raw bytes
1141    working.  */
1142
1143 int
1144 register_offset_hack (struct gdbarch *gdbarch, int regnum)
1145 {
1146   struct regcache_descr *descr = regcache_descr (gdbarch);
1147   gdb_assert (regnum >= 0 && regnum < descr->nr_cooked_registers);
1148   return descr->register_offset[regnum];
1149 }
1150
1151 /* Return the contents of register REGNUM as an unsigned integer.  */
1152
1153 ULONGEST
1154 read_register (int regnum)
1155 {
1156   char *buf = alloca (DEPRECATED_REGISTER_RAW_SIZE (regnum));
1157   deprecated_read_register_gen (regnum, buf);
1158   return (extract_unsigned_integer (buf, DEPRECATED_REGISTER_RAW_SIZE (regnum)));
1159 }
1160
1161 ULONGEST
1162 read_register_pid (int regnum, ptid_t ptid)
1163 {
1164   ptid_t save_ptid;
1165   int save_pid;
1166   CORE_ADDR retval;
1167
1168   if (ptid_equal (ptid, inferior_ptid))
1169     return read_register (regnum);
1170
1171   save_ptid = inferior_ptid;
1172
1173   inferior_ptid = ptid;
1174
1175   retval = read_register (regnum);
1176
1177   inferior_ptid = save_ptid;
1178
1179   return retval;
1180 }
1181
1182 /* Store VALUE into the raw contents of register number REGNUM.  */
1183
1184 void
1185 write_register (int regnum, LONGEST val)
1186 {
1187   void *buf;
1188   int size;
1189   size = DEPRECATED_REGISTER_RAW_SIZE (regnum);
1190   buf = alloca (size);
1191   store_signed_integer (buf, size, (LONGEST) val);
1192   deprecated_write_register_gen (regnum, buf);
1193 }
1194
1195 void
1196 write_register_pid (int regnum, CORE_ADDR val, ptid_t ptid)
1197 {
1198   ptid_t save_ptid;
1199
1200   if (ptid_equal (ptid, inferior_ptid))
1201     {
1202       write_register (regnum, val);
1203       return;
1204     }
1205
1206   save_ptid = inferior_ptid;
1207
1208   inferior_ptid = ptid;
1209
1210   write_register (regnum, val);
1211
1212   inferior_ptid = save_ptid;
1213 }
1214
1215 /* FIXME: kettenis/20030828: We should get rid of supply_register and
1216    regcache_collect in favour of regcache_raw_supply and
1217    regcache_raw_collect.  */
1218
1219 /* SUPPLY_REGISTER()
1220
1221    Record that register REGNUM contains VAL.  This is used when the
1222    value is obtained from the inferior or core dump, so there is no
1223    need to store the value there.
1224
1225    If VAL is a NULL pointer, then it's probably an unsupported register.
1226    We just set its value to all zeros.  We might want to record this
1227    fact, and report it to the users of read_register and friends.  */
1228
1229 void
1230 supply_register (int regnum, const void *val)
1231 {
1232   regcache_raw_supply (current_regcache, regnum, val);
1233
1234   /* On some architectures, e.g. HPPA, there are a few stray bits in
1235      some registers, that the rest of the code would like to ignore.  */
1236
1237   /* NOTE: cagney/2001-03-16: The macro CLEAN_UP_REGISTER_VALUE is
1238      going to be deprecated.  Instead architectures will leave the raw
1239      register value as is and instead clean things up as they pass
1240      through the method gdbarch_pseudo_register_read() clean up the
1241      values. */
1242
1243 #ifdef DEPRECATED_CLEAN_UP_REGISTER_VALUE
1244   DEPRECATED_CLEAN_UP_REGISTER_VALUE \
1245     (regnum, register_buffer (current_regcache, regnum));
1246 #endif
1247 }
1248
1249 void
1250 regcache_collect (int regnum, void *buf)
1251 {
1252   regcache_raw_collect (current_regcache, regnum, buf);
1253 }
1254
1255 /* Supply register REGNUM, whose contents are stored in BUF, to REGCACHE.  */
1256
1257 void
1258 regcache_raw_supply (struct regcache *regcache, int regnum, const void *buf)
1259 {
1260   void *regbuf;
1261   size_t size;
1262
1263   gdb_assert (regcache != NULL);
1264   gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
1265   gdb_assert (!regcache->readonly_p);
1266
1267   /* FIXME: kettenis/20030828: It shouldn't be necessary to handle
1268      CURRENT_REGCACHE specially here.  */
1269   if (regcache == current_regcache
1270       && !ptid_equal (registers_ptid, inferior_ptid))
1271     {
1272       registers_changed ();
1273       registers_ptid = inferior_ptid;
1274     }
1275
1276   regbuf = register_buffer (regcache, regnum);
1277   size = regcache->descr->sizeof_register[regnum];
1278
1279   if (buf)
1280     memcpy (regbuf, buf, size);
1281   else
1282     memset (regbuf, 0, size);
1283
1284   /* Mark the register as cached.  */
1285   regcache->register_valid_p[regnum] = 1;
1286 }
1287
1288 /* Collect register REGNUM from REGCACHE and store its contents in BUF.  */
1289
1290 void
1291 regcache_raw_collect (const struct regcache *regcache, int regnum, void *buf)
1292 {
1293   const void *regbuf;
1294   size_t size;
1295
1296   gdb_assert (regcache != NULL && buf != NULL);
1297   gdb_assert (regnum >= 0 && regnum < regcache->descr->nr_raw_registers);
1298
1299   regbuf = register_buffer (regcache, regnum);
1300   size = regcache->descr->sizeof_register[regnum];
1301   memcpy (buf, regbuf, size);
1302 }
1303
1304
1305 /* read_pc, write_pc, read_sp, deprecated_read_fp, etc.  Special
1306    handling for registers PC, SP, and FP.  */
1307
1308 /* NOTE: cagney/2001-02-18: The functions read_pc_pid(), read_pc(),
1309    read_sp(), and deprecated_read_fp(), will eventually be replaced by
1310    per-frame methods.  Instead of relying on the global INFERIOR_PTID,
1311    they will use the contextual information provided by the FRAME.
1312    These functions do not belong in the register cache.  */
1313
1314 /* NOTE: cagney/2003-06-07: The functions generic_target_write_pc(),
1315    write_pc_pid(), write_pc(), and deprecated_read_fp(), all need to
1316    be replaced by something that does not rely on global state.  But
1317    what?  */
1318
1319 CORE_ADDR
1320 read_pc_pid (ptid_t ptid)
1321 {
1322   ptid_t saved_inferior_ptid;
1323   CORE_ADDR pc_val;
1324
1325   /* In case ptid != inferior_ptid. */
1326   saved_inferior_ptid = inferior_ptid;
1327   inferior_ptid = ptid;
1328
1329   if (TARGET_READ_PC_P ())
1330     pc_val = TARGET_READ_PC (ptid);
1331   /* Else use per-frame method on get_current_frame.  */
1332   else if (PC_REGNUM >= 0)
1333     {
1334       CORE_ADDR raw_val = read_register_pid (PC_REGNUM, ptid);
1335       CORE_ADDR pc_val = ADDR_BITS_REMOVE (raw_val);
1336       return pc_val;
1337     }
1338   else
1339     internal_error (__FILE__, __LINE__, "read_pc_pid: Unable to find PC");
1340
1341   inferior_ptid = saved_inferior_ptid;
1342   return pc_val;
1343 }
1344
1345 CORE_ADDR
1346 read_pc (void)
1347 {
1348   return read_pc_pid (inferior_ptid);
1349 }
1350
1351 void
1352 generic_target_write_pc (CORE_ADDR pc, ptid_t ptid)
1353 {
1354 #ifdef PC_REGNUM
1355   if (PC_REGNUM >= 0)
1356     write_register_pid (PC_REGNUM, pc, ptid);
1357   if (DEPRECATED_NPC_REGNUM >= 0)
1358     write_register_pid (DEPRECATED_NPC_REGNUM, pc + 4, ptid);
1359 #else
1360   internal_error (__FILE__, __LINE__,
1361                   "generic_target_write_pc");
1362 #endif
1363 }
1364
1365 void
1366 write_pc_pid (CORE_ADDR pc, ptid_t ptid)
1367 {
1368   ptid_t saved_inferior_ptid;
1369
1370   /* In case ptid != inferior_ptid. */
1371   saved_inferior_ptid = inferior_ptid;
1372   inferior_ptid = ptid;
1373
1374   TARGET_WRITE_PC (pc, ptid);
1375
1376   inferior_ptid = saved_inferior_ptid;
1377 }
1378
1379 void
1380 write_pc (CORE_ADDR pc)
1381 {
1382   write_pc_pid (pc, inferior_ptid);
1383 }
1384
1385 /* Cope with strage ways of getting to the stack and frame pointers */
1386
1387 CORE_ADDR
1388 read_sp (void)
1389 {
1390   if (TARGET_READ_SP_P ())
1391     return TARGET_READ_SP ();
1392   else if (gdbarch_unwind_sp_p (current_gdbarch))
1393     return get_frame_sp (get_current_frame ());
1394   else if (SP_REGNUM >= 0)
1395     /* Try SP_REGNUM last: this makes all sorts of [wrong] assumptions
1396        about the architecture so put it at the end.  */
1397     return read_register (SP_REGNUM);
1398   internal_error (__FILE__, __LINE__, "read_sp: Unable to find SP");
1399 }
1400
1401 void
1402 deprecated_write_sp (CORE_ADDR val)
1403 {
1404   gdb_assert (SP_REGNUM >= 0);
1405   write_register (SP_REGNUM, val);
1406 }
1407
1408 CORE_ADDR
1409 deprecated_read_fp (void)
1410 {
1411   if (DEPRECATED_TARGET_READ_FP_P ())
1412     return DEPRECATED_TARGET_READ_FP ();
1413   else if (DEPRECATED_FP_REGNUM >= 0)
1414     return read_register (DEPRECATED_FP_REGNUM);
1415   else
1416     internal_error (__FILE__, __LINE__, "deprecated_read_fp");
1417 }
1418
1419 static void
1420 reg_flush_command (char *command, int from_tty)
1421 {
1422   /* Force-flush the register cache.  */
1423   registers_changed ();
1424   if (from_tty)
1425     printf_filtered ("Register cache flushed.\n");
1426 }
1427
1428 static void
1429 build_regcache (void)
1430 {
1431   current_regcache = regcache_xmalloc (current_gdbarch);
1432   current_regcache->readonly_p = 0;
1433   deprecated_registers = deprecated_grub_regcache_for_registers (current_regcache);
1434   deprecated_register_valid = current_regcache->register_valid_p;
1435 }
1436
1437 static void
1438 dump_endian_bytes (struct ui_file *file, enum bfd_endian endian,
1439                    const unsigned char *buf, long len)
1440 {
1441   int i;
1442   switch (endian)
1443     {
1444     case BFD_ENDIAN_BIG:
1445       for (i = 0; i < len; i++)
1446         fprintf_unfiltered (file, "%02x", buf[i]);
1447       break;
1448     case BFD_ENDIAN_LITTLE:
1449       for (i = len - 1; i >= 0; i--)
1450         fprintf_unfiltered (file, "%02x", buf[i]);
1451       break;
1452     default:
1453       internal_error (__FILE__, __LINE__, "Bad switch");
1454     }
1455 }
1456
1457 enum regcache_dump_what
1458 {
1459   regcache_dump_none, regcache_dump_raw, regcache_dump_cooked, regcache_dump_groups
1460 };
1461
1462 static void
1463 regcache_dump (struct regcache *regcache, struct ui_file *file,
1464                enum regcache_dump_what what_to_dump)
1465 {
1466   struct cleanup *cleanups = make_cleanup (null_cleanup, NULL);
1467   struct gdbarch *gdbarch = regcache->descr->gdbarch;
1468   int regnum;
1469   int footnote_nr = 0;
1470   int footnote_register_size = 0;
1471   int footnote_register_offset = 0;
1472   int footnote_register_type_name_null = 0;
1473   long register_offset = 0;
1474   unsigned char buf[MAX_REGISTER_SIZE];
1475
1476 #if 0
1477   fprintf_unfiltered (file, "legacy_p %d\n", regcache->descr->legacy_p);
1478   fprintf_unfiltered (file, "nr_raw_registers %d\n",
1479                       regcache->descr->nr_raw_registers);
1480   fprintf_unfiltered (file, "nr_cooked_registers %d\n",
1481                       regcache->descr->nr_cooked_registers);
1482   fprintf_unfiltered (file, "sizeof_raw_registers %ld\n",
1483                       regcache->descr->sizeof_raw_registers);
1484   fprintf_unfiltered (file, "sizeof_raw_register_valid_p %ld\n",
1485                       regcache->descr->sizeof_raw_register_valid_p);
1486   fprintf_unfiltered (file, "NUM_REGS %d\n", NUM_REGS);
1487   fprintf_unfiltered (file, "NUM_PSEUDO_REGS %d\n", NUM_PSEUDO_REGS);
1488 #endif
1489
1490   gdb_assert (regcache->descr->nr_cooked_registers
1491               == (NUM_REGS + NUM_PSEUDO_REGS));
1492
1493   for (regnum = -1; regnum < regcache->descr->nr_cooked_registers; regnum++)
1494     {
1495       /* Name.  */
1496       if (regnum < 0)
1497         fprintf_unfiltered (file, " %-10s", "Name");
1498       else
1499         {
1500           const char *p = REGISTER_NAME (regnum);
1501           if (p == NULL)
1502             p = "";
1503           else if (p[0] == '\0')
1504             p = "''";
1505           fprintf_unfiltered (file, " %-10s", p);
1506         }
1507
1508       /* Number.  */
1509       if (regnum < 0)
1510         fprintf_unfiltered (file, " %4s", "Nr");
1511       else
1512         fprintf_unfiltered (file, " %4d", regnum);
1513
1514       /* Relative number.  */
1515       if (regnum < 0)
1516         fprintf_unfiltered (file, " %4s", "Rel");
1517       else if (regnum < NUM_REGS)
1518         fprintf_unfiltered (file, " %4d", regnum);
1519       else
1520         fprintf_unfiltered (file, " %4d", (regnum - NUM_REGS));
1521
1522       /* Offset.  */
1523       if (regnum < 0)
1524         fprintf_unfiltered (file, " %6s  ", "Offset");
1525       else
1526         {
1527           fprintf_unfiltered (file, " %6ld",
1528                               regcache->descr->register_offset[regnum]);
1529           if (register_offset != regcache->descr->register_offset[regnum]
1530               || register_offset != DEPRECATED_REGISTER_BYTE (regnum)
1531               || (regnum > 0
1532                   && (regcache->descr->register_offset[regnum]
1533                       != (regcache->descr->register_offset[regnum - 1]
1534                           + regcache->descr->sizeof_register[regnum - 1])))
1535               )
1536             {
1537               if (!footnote_register_offset)
1538                 footnote_register_offset = ++footnote_nr;
1539               fprintf_unfiltered (file, "*%d", footnote_register_offset);
1540             }
1541           else
1542             fprintf_unfiltered (file, "  ");
1543           register_offset = (regcache->descr->register_offset[regnum]
1544                              + regcache->descr->sizeof_register[regnum]);
1545         }
1546
1547       /* Size.  */
1548       if (regnum < 0)
1549         fprintf_unfiltered (file, " %5s ", "Size");
1550       else
1551         {
1552           fprintf_unfiltered (file, " %5ld",
1553                               regcache->descr->sizeof_register[regnum]);
1554           if ((regcache->descr->sizeof_register[regnum]
1555                != DEPRECATED_REGISTER_RAW_SIZE (regnum))
1556               || (regcache->descr->sizeof_register[regnum]
1557                   != DEPRECATED_REGISTER_VIRTUAL_SIZE (regnum))
1558               || (regcache->descr->sizeof_register[regnum]
1559                   != TYPE_LENGTH (register_type (regcache->descr->gdbarch,
1560                                                  regnum)))
1561               )
1562             {
1563               if (!footnote_register_size)
1564                 footnote_register_size = ++footnote_nr;
1565               fprintf_unfiltered (file, "*%d", footnote_register_size);
1566             }
1567           else
1568             fprintf_unfiltered (file, " ");
1569         }
1570
1571       /* Type.  */
1572       {
1573         const char *t;
1574         if (regnum < 0)
1575           t = "Type";
1576         else
1577           {
1578             static const char blt[] = "builtin_type";
1579             t = TYPE_NAME (register_type (regcache->descr->gdbarch, regnum));
1580             if (t == NULL)
1581               {
1582                 char *n;
1583                 if (!footnote_register_type_name_null)
1584                   footnote_register_type_name_null = ++footnote_nr;
1585                 xasprintf (&n, "*%d", footnote_register_type_name_null);
1586                 make_cleanup (xfree, n);
1587                 t = n;
1588               }
1589             /* Chop a leading builtin_type.  */
1590             if (strncmp (t, blt, strlen (blt)) == 0)
1591               t += strlen (blt);
1592           }
1593         fprintf_unfiltered (file, " %-15s", t);
1594       }
1595
1596       /* Leading space always present.  */
1597       fprintf_unfiltered (file, " ");
1598
1599       /* Value, raw.  */
1600       if (what_to_dump == regcache_dump_raw)
1601         {
1602           if (regnum < 0)
1603             fprintf_unfiltered (file, "Raw value");
1604           else if (regnum >= regcache->descr->nr_raw_registers)
1605             fprintf_unfiltered (file, "<cooked>");
1606           else if (!regcache_valid_p (regcache, regnum))
1607             fprintf_unfiltered (file, "<invalid>");
1608           else
1609             {
1610               regcache_raw_read (regcache, regnum, buf);
1611               fprintf_unfiltered (file, "0x");
1612               dump_endian_bytes (file, TARGET_BYTE_ORDER, buf,
1613                                  DEPRECATED_REGISTER_RAW_SIZE (regnum));
1614             }
1615         }
1616
1617       /* Value, cooked.  */
1618       if (what_to_dump == regcache_dump_cooked)
1619         {
1620           if (regnum < 0)
1621             fprintf_unfiltered (file, "Cooked value");
1622           else
1623             {
1624               regcache_cooked_read (regcache, regnum, buf);
1625               fprintf_unfiltered (file, "0x");
1626               dump_endian_bytes (file, TARGET_BYTE_ORDER, buf,
1627                                  DEPRECATED_REGISTER_VIRTUAL_SIZE (regnum));
1628             }
1629         }
1630
1631       /* Group members.  */
1632       if (what_to_dump == regcache_dump_groups)
1633         {
1634           if (regnum < 0)
1635             fprintf_unfiltered (file, "Groups");
1636           else
1637             {
1638               const char *sep = "";
1639               struct reggroup *group;
1640               for (group = reggroup_next (gdbarch, NULL);
1641                    group != NULL;
1642                    group = reggroup_next (gdbarch, group))
1643                 {
1644                   if (gdbarch_register_reggroup_p (gdbarch, regnum, group))
1645                     {
1646                       fprintf_unfiltered (file, "%s%s", sep, reggroup_name (group));
1647                       sep = ",";
1648                     }
1649                 }
1650             }
1651         }
1652
1653       fprintf_unfiltered (file, "\n");
1654     }
1655
1656   if (footnote_register_size)
1657     fprintf_unfiltered (file, "*%d: Inconsistent register sizes.\n",
1658                         footnote_register_size);
1659   if (footnote_register_offset)
1660     fprintf_unfiltered (file, "*%d: Inconsistent register offsets.\n",
1661                         footnote_register_offset);
1662   if (footnote_register_type_name_null)
1663     fprintf_unfiltered (file, 
1664                         "*%d: Register type's name NULL.\n",
1665                         footnote_register_type_name_null);
1666   do_cleanups (cleanups);
1667 }
1668
1669 static void
1670 regcache_print (char *args, enum regcache_dump_what what_to_dump)
1671 {
1672   if (args == NULL)
1673     regcache_dump (current_regcache, gdb_stdout, what_to_dump);
1674   else
1675     {
1676       struct ui_file *file = gdb_fopen (args, "w");
1677       if (file == NULL)
1678         perror_with_name ("maintenance print architecture");
1679       regcache_dump (current_regcache, file, what_to_dump);    
1680       ui_file_delete (file);
1681     }
1682 }
1683
1684 static void
1685 maintenance_print_registers (char *args, int from_tty)
1686 {
1687   regcache_print (args, regcache_dump_none);
1688 }
1689
1690 static void
1691 maintenance_print_raw_registers (char *args, int from_tty)
1692 {
1693   regcache_print (args, regcache_dump_raw);
1694 }
1695
1696 static void
1697 maintenance_print_cooked_registers (char *args, int from_tty)
1698 {
1699   regcache_print (args, regcache_dump_cooked);
1700 }
1701
1702 static void
1703 maintenance_print_register_groups (char *args, int from_tty)
1704 {
1705   regcache_print (args, regcache_dump_groups);
1706 }
1707
1708 extern initialize_file_ftype _initialize_regcache; /* -Wmissing-prototype */
1709
1710 void
1711 _initialize_regcache (void)
1712 {
1713   regcache_descr_handle = register_gdbarch_data (init_regcache_descr);
1714   REGISTER_GDBARCH_SWAP (current_regcache);
1715   register_gdbarch_swap (&deprecated_registers, sizeof (deprecated_registers), NULL);
1716   register_gdbarch_swap (&deprecated_register_valid, sizeof (deprecated_register_valid), NULL);
1717   register_gdbarch_swap (NULL, 0, build_regcache);
1718
1719   add_com ("flushregs", class_maintenance, reg_flush_command,
1720            "Force gdb to flush its register cache (maintainer command)");
1721
1722    /* Initialize the thread/process associated with the current set of
1723       registers.  For now, -1 is special, and means `no current process'.  */
1724   registers_ptid = pid_to_ptid (-1);
1725
1726   add_cmd ("registers", class_maintenance,
1727            maintenance_print_registers,
1728            "Print the internal register configuration.\
1729 Takes an optional file parameter.",
1730            &maintenanceprintlist);
1731   add_cmd ("raw-registers", class_maintenance,
1732            maintenance_print_raw_registers,
1733            "Print the internal register configuration including raw values.\
1734 Takes an optional file parameter.",
1735            &maintenanceprintlist);
1736   add_cmd ("cooked-registers", class_maintenance,
1737            maintenance_print_cooked_registers,
1738            "Print the internal register configuration including cooked values.\
1739 Takes an optional file parameter.",
1740            &maintenanceprintlist);
1741   add_cmd ("register-groups", class_maintenance,
1742            maintenance_print_register_groups,
1743            "Print the internal register configuration including each register's group.\
1744 Takes an optional file parameter.",
1745            &maintenanceprintlist);
1746
1747 }