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