gdb: fix ARI warning in sparc-tdep.c
[external/binutils.git] / gdb / sparc-tdep.c
1 /* Target-dependent code for SPARC.
2
3    Copyright (C) 2003-2017 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 #include "defs.h"
21 #include "arch-utils.h"
22 #include "dis-asm.h"
23 #include "dwarf2-frame.h"
24 #include "floatformat.h"
25 #include "frame.h"
26 #include "frame-base.h"
27 #include "frame-unwind.h"
28 #include "gdbcore.h"
29 #include "gdbtypes.h"
30 #include "inferior.h"
31 #include "symtab.h"
32 #include "objfiles.h"
33 #include "osabi.h"
34 #include "regcache.h"
35 #include "target.h"
36 #include "target-descriptions.h"
37 #include "value.h"
38
39 #include "sparc-tdep.h"
40 #include "sparc-ravenscar-thread.h"
41 #include <algorithm>
42
43 struct regset;
44
45 /* This file implements the SPARC 32-bit ABI as defined by the section
46    "Low-Level System Information" of the SPARC Compliance Definition
47    (SCD) 2.4.1, which is the 32-bit System V psABI for SPARC.  The SCD
48    lists changes with respect to the original 32-bit psABI as defined
49    in the "System V ABI, SPARC Processor Supplement".
50
51    Note that if we talk about SunOS, we mean SunOS 4.x, which was
52    BSD-based, which is sometimes (retroactively?) referred to as
53    Solaris 1.x.  If we talk about Solaris we mean Solaris 2.x and
54    above (Solaris 7, 8 and 9 are nothing but Solaris 2.7, 2.8 and 2.9
55    suffering from severe version number inflation).  Solaris 2.x is
56    also known as SunOS 5.x, since that's what uname(1) says.  Solaris
57    2.x is SVR4-based.  */
58
59 /* Please use the sparc32_-prefix for 32-bit specific code, the
60    sparc64_-prefix for 64-bit specific code and the sparc_-prefix for
61    code that can handle both.  The 64-bit specific code lives in
62    sparc64-tdep.c; don't add any here.  */
63
64 /* The SPARC Floating-Point Quad-Precision format is similar to
65    big-endian IA-64 Quad-Precision format.  */
66 #define floatformats_sparc_quad floatformats_ia64_quad
67
68 /* The stack pointer is offset from the stack frame by a BIAS of 2047
69    (0x7ff) for 64-bit code.  BIAS is likely to be defined on SPARC
70    hosts, so undefine it first.  */
71 #undef BIAS
72 #define BIAS 2047
73
74 /* Macros to extract fields from SPARC instructions.  */
75 #define X_OP(i) (((i) >> 30) & 0x3)
76 #define X_RD(i) (((i) >> 25) & 0x1f)
77 #define X_A(i) (((i) >> 29) & 1)
78 #define X_COND(i) (((i) >> 25) & 0xf)
79 #define X_OP2(i) (((i) >> 22) & 0x7)
80 #define X_IMM22(i) ((i) & 0x3fffff)
81 #define X_OP3(i) (((i) >> 19) & 0x3f)
82 #define X_RS1(i) (((i) >> 14) & 0x1f)
83 #define X_RS2(i) ((i) & 0x1f)
84 #define X_I(i) (((i) >> 13) & 1)
85 /* Sign extension macros.  */
86 #define X_DISP22(i) ((X_IMM22 (i) ^ 0x200000) - 0x200000)
87 #define X_DISP19(i) ((((i) & 0x7ffff) ^ 0x40000) - 0x40000)
88 #define X_DISP10(i) ((((((i) >> 11) && 0x300) | (((i) >> 5) & 0xff)) ^ 0x200) - 0x200)
89 #define X_SIMM13(i) ((((i) & 0x1fff) ^ 0x1000) - 0x1000)
90 /* Macros to identify some instructions.  */
91 /* RETURN (RETT in V8) */
92 #define X_RETTURN(i) ((X_OP (i) == 0x2) && (X_OP3 (i) == 0x39))
93
94 /* Fetch the instruction at PC.  Instructions are always big-endian
95    even if the processor operates in little-endian mode.  */
96
97 unsigned long
98 sparc_fetch_instruction (CORE_ADDR pc)
99 {
100   gdb_byte buf[4];
101   unsigned long insn;
102   int i;
103
104   /* If we can't read the instruction at PC, return zero.  */
105   if (target_read_memory (pc, buf, sizeof (buf)))
106     return 0;
107
108   insn = 0;
109   for (i = 0; i < sizeof (buf); i++)
110     insn = (insn << 8) | buf[i];
111   return insn;
112 }
113 \f
114
115 /* Return non-zero if the instruction corresponding to PC is an "unimp"
116    instruction.  */
117
118 static int
119 sparc_is_unimp_insn (CORE_ADDR pc)
120 {
121   const unsigned long insn = sparc_fetch_instruction (pc);
122   
123   return ((insn & 0xc1c00000) == 0);
124 }
125
126 /* Return non-zero if the instruction corresponding to PC is an
127    "annulled" branch, i.e. the annul bit is set.  */
128
129 int
130 sparc_is_annulled_branch_insn (CORE_ADDR pc)
131 {
132   /* The branch instructions featuring an annul bit can be identified
133      by the following bit patterns:
134
135      OP=0
136       OP2=1: Branch on Integer Condition Codes with Prediction (BPcc).
137       OP2=2: Branch on Integer Condition Codes (Bcc).
138       OP2=5: Branch on FP Condition Codes with Prediction (FBfcc).
139       OP2=6: Branch on FP Condition Codes (FBcc).
140       OP2=3 && Bit28=0:
141              Branch on Integer Register with Prediction (BPr).
142
143      This leaves out ILLTRAP (OP2=0), SETHI/NOP (OP2=4) and the V8
144      coprocessor branch instructions (Op2=7).  */
145
146   const unsigned long insn = sparc_fetch_instruction (pc);
147   const unsigned op2 = X_OP2 (insn);
148
149   if ((X_OP (insn) == 0)
150       && ((op2 == 1) || (op2 == 2) || (op2 == 5) || (op2 == 6)
151           || ((op2 == 3) && ((insn & 0x10000000) == 0))))
152     return X_A (insn);
153   else
154     return 0;
155 }
156
157 /* OpenBSD/sparc includes StackGhost, which according to the author's
158    website http://stackghost.cerias.purdue.edu "... transparently and
159    automatically protects applications' stack frames; more
160    specifically, it guards the return pointers.  The protection
161    mechanisms require no application source or binary modification and
162    imposes only a negligible performance penalty."
163
164    The same website provides the following description of how
165    StackGhost works:
166
167    "StackGhost interfaces with the kernel trap handler that would
168    normally write out registers to the stack and the handler that
169    would read them back in.  By XORing a cookie into the
170    return-address saved in the user stack when it is actually written
171    to the stack, and then XOR it out when the return-address is pulled
172    from the stack, StackGhost can cause attacker corrupted return
173    pointers to behave in a manner the attacker cannot predict.
174    StackGhost can also use several unused bits in the return pointer
175    to detect a smashed return pointer and abort the process."
176
177    For GDB this means that whenever we're reading %i7 from a stack
178    frame's window save area, we'll have to XOR the cookie.
179
180    More information on StackGuard can be found on in:
181
182    Mike Frantzen and Mike Shuey.  "StackGhost: Hardware Facilitated
183    Stack Protection."  2001.  Published in USENIX Security Symposium
184    '01.  */
185
186 /* Fetch StackGhost Per-Process XOR cookie.  */
187
188 ULONGEST
189 sparc_fetch_wcookie (struct gdbarch *gdbarch)
190 {
191   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
192   struct target_ops *ops = &current_target;
193   gdb_byte buf[8];
194   int len;
195
196   len = target_read (ops, TARGET_OBJECT_WCOOKIE, NULL, buf, 0, 8);
197   if (len == -1)
198     return 0;
199
200   /* We should have either an 32-bit or an 64-bit cookie.  */
201   gdb_assert (len == 4 || len == 8);
202
203   return extract_unsigned_integer (buf, len, byte_order);
204 }
205 \f
206
207 /* The functions on this page are intended to be used to classify
208    function arguments.  */
209
210 /* Check whether TYPE is "Integral or Pointer".  */
211
212 static int
213 sparc_integral_or_pointer_p (const struct type *type)
214 {
215   int len = TYPE_LENGTH (type);
216
217   switch (TYPE_CODE (type))
218     {
219     case TYPE_CODE_INT:
220     case TYPE_CODE_BOOL:
221     case TYPE_CODE_CHAR:
222     case TYPE_CODE_ENUM:
223     case TYPE_CODE_RANGE:
224       /* We have byte, half-word, word and extended-word/doubleword
225          integral types.  The doubleword is an extension to the
226          original 32-bit ABI by the SCD 2.4.x.  */
227       return (len == 1 || len == 2 || len == 4 || len == 8);
228     case TYPE_CODE_PTR:
229     case TYPE_CODE_REF:
230       /* Allow either 32-bit or 64-bit pointers.  */
231       return (len == 4 || len == 8);
232     default:
233       break;
234     }
235
236   return 0;
237 }
238
239 /* Check whether TYPE is "Floating".  */
240
241 static int
242 sparc_floating_p (const struct type *type)
243 {
244   switch (TYPE_CODE (type))
245     {
246     case TYPE_CODE_FLT:
247       {
248         int len = TYPE_LENGTH (type);
249         return (len == 4 || len == 8 || len == 16);
250       }
251     default:
252       break;
253     }
254
255   return 0;
256 }
257
258 /* Check whether TYPE is "Complex Floating".  */
259
260 static int
261 sparc_complex_floating_p (const struct type *type)
262 {
263   switch (TYPE_CODE (type))
264     {
265     case TYPE_CODE_COMPLEX:
266       {
267         int len = TYPE_LENGTH (type);
268         return (len == 8 || len == 16 || len == 32);
269       }
270     default:
271       break;
272     }
273
274   return 0;
275 }
276
277 /* Check whether TYPE is "Structure or Union".
278
279    In terms of Ada subprogram calls, arrays are treated the same as
280    struct and union types.  So this function also returns non-zero
281    for array types.  */
282
283 static int
284 sparc_structure_or_union_p (const struct type *type)
285 {
286   switch (TYPE_CODE (type))
287     {
288     case TYPE_CODE_STRUCT:
289     case TYPE_CODE_UNION:
290     case TYPE_CODE_ARRAY:
291       return 1;
292     default:
293       break;
294     }
295
296   return 0;
297 }
298
299 /* Register information.  */
300 #define SPARC32_FPU_REGISTERS                             \
301   "f0", "f1", "f2", "f3", "f4", "f5", "f6", "f7",         \
302   "f8", "f9", "f10", "f11", "f12", "f13", "f14", "f15",   \
303   "f16", "f17", "f18", "f19", "f20", "f21", "f22", "f23", \
304   "f24", "f25", "f26", "f27", "f28", "f29", "f30", "f31"
305 #define SPARC32_CP0_REGISTERS \
306   "y", "psr", "wim", "tbr", "pc", "npc", "fsr", "csr"
307
308 static const char *sparc_core_register_names[] = { SPARC_CORE_REGISTERS };
309 static const char *sparc32_fpu_register_names[] = { SPARC32_FPU_REGISTERS };
310 static const char *sparc32_cp0_register_names[] = { SPARC32_CP0_REGISTERS };
311
312 static const char *sparc32_register_names[] =
313 {
314   SPARC_CORE_REGISTERS,
315   SPARC32_FPU_REGISTERS,
316   SPARC32_CP0_REGISTERS
317 };
318
319 /* Total number of registers.  */
320 #define SPARC32_NUM_REGS ARRAY_SIZE (sparc32_register_names)
321
322 /* We provide the aliases %d0..%d30 for the floating registers as
323    "psuedo" registers.  */
324
325 static const char *sparc32_pseudo_register_names[] =
326 {
327   "d0", "d2", "d4", "d6", "d8", "d10", "d12", "d14",
328   "d16", "d18", "d20", "d22", "d24", "d26", "d28", "d30"
329 };
330
331 /* Total number of pseudo registers.  */
332 #define SPARC32_NUM_PSEUDO_REGS ARRAY_SIZE (sparc32_pseudo_register_names)
333
334 /* Return the name of pseudo register REGNUM.  */
335
336 static const char *
337 sparc32_pseudo_register_name (struct gdbarch *gdbarch, int regnum)
338 {
339   regnum -= gdbarch_num_regs (gdbarch);
340
341   if (regnum < SPARC32_NUM_PSEUDO_REGS)
342     return sparc32_pseudo_register_names[regnum];
343
344   internal_error (__FILE__, __LINE__,
345                   _("sparc32_pseudo_register_name: bad register number %d"),
346                   regnum);
347 }
348
349 /* Return the name of register REGNUM.  */
350
351 static const char *
352 sparc32_register_name (struct gdbarch *gdbarch, int regnum)
353 {
354   if (tdesc_has_registers (gdbarch_target_desc (gdbarch)))
355     return tdesc_register_name (gdbarch, regnum);
356
357   if (regnum >= 0 && regnum < gdbarch_num_regs (gdbarch))
358     return sparc32_register_names[regnum];
359
360   return sparc32_pseudo_register_name (gdbarch, regnum);
361 }
362 \f
363 /* Construct types for ISA-specific registers.  */
364
365 static struct type *
366 sparc_psr_type (struct gdbarch *gdbarch)
367 {
368   struct gdbarch_tdep *tdep = gdbarch_tdep (gdbarch);
369
370   if (!tdep->sparc_psr_type)
371     {
372       struct type *type;
373
374       type = arch_flags_type (gdbarch, "builtin_type_sparc_psr", 4);
375       append_flags_type_flag (type, 5, "ET");
376       append_flags_type_flag (type, 6, "PS");
377       append_flags_type_flag (type, 7, "S");
378       append_flags_type_flag (type, 12, "EF");
379       append_flags_type_flag (type, 13, "EC");
380
381       tdep->sparc_psr_type = type;
382     }
383
384   return tdep->sparc_psr_type;
385 }
386
387 static struct type *
388 sparc_fsr_type (struct gdbarch *gdbarch)
389 {
390   struct gdbarch_tdep *tdep = gdbarch_tdep (gdbarch);
391
392   if (!tdep->sparc_fsr_type)
393     {
394       struct type *type;
395
396       type = arch_flags_type (gdbarch, "builtin_type_sparc_fsr", 4);
397       append_flags_type_flag (type, 0, "NXA");
398       append_flags_type_flag (type, 1, "DZA");
399       append_flags_type_flag (type, 2, "UFA");
400       append_flags_type_flag (type, 3, "OFA");
401       append_flags_type_flag (type, 4, "NVA");
402       append_flags_type_flag (type, 5, "NXC");
403       append_flags_type_flag (type, 6, "DZC");
404       append_flags_type_flag (type, 7, "UFC");
405       append_flags_type_flag (type, 8, "OFC");
406       append_flags_type_flag (type, 9, "NVC");
407       append_flags_type_flag (type, 22, "NS");
408       append_flags_type_flag (type, 23, "NXM");
409       append_flags_type_flag (type, 24, "DZM");
410       append_flags_type_flag (type, 25, "UFM");
411       append_flags_type_flag (type, 26, "OFM");
412       append_flags_type_flag (type, 27, "NVM");
413
414       tdep->sparc_fsr_type = type;
415     }
416
417   return tdep->sparc_fsr_type;
418 }
419
420 /* Return the GDB type object for the "standard" data type of data in
421    pseudo register REGNUM.  */
422
423 static struct type *
424 sparc32_pseudo_register_type (struct gdbarch *gdbarch, int regnum)
425 {
426   regnum -= gdbarch_num_regs (gdbarch);
427
428   if (regnum >= SPARC32_D0_REGNUM && regnum <= SPARC32_D30_REGNUM)
429     return builtin_type (gdbarch)->builtin_double;
430
431   internal_error (__FILE__, __LINE__,
432                   _("sparc32_pseudo_register_type: bad register number %d"),
433                   regnum);
434 }
435
436 /* Return the GDB type object for the "standard" data type of data in
437    register REGNUM.  */
438
439 static struct type *
440 sparc32_register_type (struct gdbarch *gdbarch, int regnum)
441 {
442   if (tdesc_has_registers (gdbarch_target_desc (gdbarch)))
443     return tdesc_register_type (gdbarch, regnum);
444
445   if (regnum >= SPARC_F0_REGNUM && regnum <= SPARC_F31_REGNUM)
446     return builtin_type (gdbarch)->builtin_float;
447
448   if (regnum == SPARC_SP_REGNUM || regnum == SPARC_FP_REGNUM)
449     return builtin_type (gdbarch)->builtin_data_ptr;
450
451   if (regnum == SPARC32_PC_REGNUM || regnum == SPARC32_NPC_REGNUM)
452     return builtin_type (gdbarch)->builtin_func_ptr;
453
454   if (regnum == SPARC32_PSR_REGNUM)
455     return sparc_psr_type (gdbarch);
456
457   if (regnum == SPARC32_FSR_REGNUM)
458     return sparc_fsr_type (gdbarch);
459
460   if (regnum >= gdbarch_num_regs (gdbarch))
461     return sparc32_pseudo_register_type (gdbarch, regnum);
462
463   return builtin_type (gdbarch)->builtin_int32;
464 }
465
466 static enum register_status
467 sparc32_pseudo_register_read (struct gdbarch *gdbarch,
468                               struct regcache *regcache,
469                               int regnum, gdb_byte *buf)
470 {
471   enum register_status status;
472
473   regnum -= gdbarch_num_regs (gdbarch);
474   gdb_assert (regnum >= SPARC32_D0_REGNUM && regnum <= SPARC32_D30_REGNUM);
475
476   regnum = SPARC_F0_REGNUM + 2 * (regnum - SPARC32_D0_REGNUM);
477   status = regcache_raw_read (regcache, regnum, buf);
478   if (status == REG_VALID)
479     status = regcache_raw_read (regcache, regnum + 1, buf + 4);
480   return status;
481 }
482
483 static void
484 sparc32_pseudo_register_write (struct gdbarch *gdbarch,
485                                struct regcache *regcache,
486                                int regnum, const gdb_byte *buf)
487 {
488   regnum -= gdbarch_num_regs (gdbarch);
489   gdb_assert (regnum >= SPARC32_D0_REGNUM && regnum <= SPARC32_D30_REGNUM);
490
491   regnum = SPARC_F0_REGNUM + 2 * (regnum - SPARC32_D0_REGNUM);
492   regcache_raw_write (regcache, regnum, buf);
493   regcache_raw_write (regcache, regnum + 1, buf + 4);
494 }
495 \f
496 /* Implement the stack_frame_destroyed_p gdbarch method.  */
497
498 int
499 sparc_stack_frame_destroyed_p (struct gdbarch *gdbarch, CORE_ADDR pc)
500 {
501   /* This function must return true if we are one instruction after an
502      instruction that destroyed the stack frame of the current
503      function.  The SPARC instructions used to restore the callers
504      stack frame are RESTORE and RETURN/RETT.
505
506      Of these RETURN/RETT is a branch instruction and thus we return
507      true if we are in its delay slot.
508
509      RESTORE is almost always found in the delay slot of a branch
510      instruction that transfers control to the caller, such as JMPL.
511      Thus the next instruction is in the caller frame and we don't
512      need to do anything about it.  */
513
514   unsigned int insn = sparc_fetch_instruction (pc - 4);
515
516   return X_RETTURN (insn);
517 }
518 \f
519
520 static CORE_ADDR
521 sparc32_frame_align (struct gdbarch *gdbarch, CORE_ADDR address)
522 {
523   /* The ABI requires double-word alignment.  */
524   return address & ~0x7;
525 }
526
527 static CORE_ADDR
528 sparc32_push_dummy_code (struct gdbarch *gdbarch, CORE_ADDR sp,
529                          CORE_ADDR funcaddr,
530                          struct value **args, int nargs,
531                          struct type *value_type,
532                          CORE_ADDR *real_pc, CORE_ADDR *bp_addr,
533                          struct regcache *regcache)
534 {
535   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
536
537   *bp_addr = sp - 4;
538   *real_pc = funcaddr;
539
540   if (using_struct_return (gdbarch, NULL, value_type))
541     {
542       gdb_byte buf[4];
543
544       /* This is an UNIMP instruction.  */
545       store_unsigned_integer (buf, 4, byte_order,
546                               TYPE_LENGTH (value_type) & 0x1fff);
547       write_memory (sp - 8, buf, 4);
548       return sp - 8;
549     }
550
551   return sp - 4;
552 }
553
554 static CORE_ADDR
555 sparc32_store_arguments (struct regcache *regcache, int nargs,
556                          struct value **args, CORE_ADDR sp,
557                          int struct_return, CORE_ADDR struct_addr)
558 {
559   struct gdbarch *gdbarch = get_regcache_arch (regcache);
560   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
561   /* Number of words in the "parameter array".  */
562   int num_elements = 0;
563   int element = 0;
564   int i;
565
566   for (i = 0; i < nargs; i++)
567     {
568       struct type *type = value_type (args[i]);
569       int len = TYPE_LENGTH (type);
570
571       if (sparc_structure_or_union_p (type)
572           || (sparc_floating_p (type) && len == 16)
573           || sparc_complex_floating_p (type))
574         {
575           /* Structure, Union and Quad-Precision Arguments.  */
576           sp -= len;
577
578           /* Use doubleword alignment for these values.  That's always
579              correct, and wasting a few bytes shouldn't be a problem.  */
580           sp &= ~0x7;
581
582           write_memory (sp, value_contents (args[i]), len);
583           args[i] = value_from_pointer (lookup_pointer_type (type), sp);
584           num_elements++;
585         }
586       else if (sparc_floating_p (type))
587         {
588           /* Floating arguments.  */
589           gdb_assert (len == 4 || len == 8);
590           num_elements += (len / 4);
591         }
592       else
593         {
594           /* Integral and pointer arguments.  */
595           gdb_assert (sparc_integral_or_pointer_p (type));
596
597           if (len < 4)
598             args[i] = value_cast (builtin_type (gdbarch)->builtin_int32,
599                                   args[i]);
600           num_elements += ((len + 3) / 4);
601         }
602     }
603
604   /* Always allocate at least six words.  */
605   sp -= std::max (6, num_elements) * 4;
606
607   /* The psABI says that "Software convention requires space for the
608      struct/union return value pointer, even if the word is unused."  */
609   sp -= 4;
610
611   /* The psABI says that "Although software convention and the
612      operating system require every stack frame to be doubleword
613      aligned."  */
614   sp &= ~0x7;
615
616   for (i = 0; i < nargs; i++)
617     {
618       const bfd_byte *valbuf = value_contents (args[i]);
619       struct type *type = value_type (args[i]);
620       int len = TYPE_LENGTH (type);
621
622       gdb_assert (len == 4 || len == 8);
623
624       if (element < 6)
625         {
626           int regnum = SPARC_O0_REGNUM + element;
627
628           regcache_cooked_write (regcache, regnum, valbuf);
629           if (len > 4 && element < 5)
630             regcache_cooked_write (regcache, regnum + 1, valbuf + 4);
631         }
632
633       /* Always store the argument in memory.  */
634       write_memory (sp + 4 + element * 4, valbuf, len);
635       element += len / 4;
636     }
637
638   gdb_assert (element == num_elements);
639
640   if (struct_return)
641     {
642       gdb_byte buf[4];
643
644       store_unsigned_integer (buf, 4, byte_order, struct_addr);
645       write_memory (sp, buf, 4);
646     }
647
648   return sp;
649 }
650
651 static CORE_ADDR
652 sparc32_push_dummy_call (struct gdbarch *gdbarch, struct value *function,
653                          struct regcache *regcache, CORE_ADDR bp_addr,
654                          int nargs, struct value **args, CORE_ADDR sp,
655                          int struct_return, CORE_ADDR struct_addr)
656 {
657   CORE_ADDR call_pc = (struct_return ? (bp_addr - 12) : (bp_addr - 8));
658
659   /* Set return address.  */
660   regcache_cooked_write_unsigned (regcache, SPARC_O7_REGNUM, call_pc);
661
662   /* Set up function arguments.  */
663   sp = sparc32_store_arguments (regcache, nargs, args, sp,
664                                 struct_return, struct_addr);
665
666   /* Allocate the 16-word window save area.  */
667   sp -= 16 * 4;
668
669   /* Stack should be doubleword aligned at this point.  */
670   gdb_assert (sp % 8 == 0);
671
672   /* Finally, update the stack pointer.  */
673   regcache_cooked_write_unsigned (regcache, SPARC_SP_REGNUM, sp);
674
675   return sp;
676 }
677 \f
678
679 /* Use the program counter to determine the contents and size of a
680    breakpoint instruction.  Return a pointer to a string of bytes that
681    encode a breakpoint instruction, store the length of the string in
682    *LEN and optionally adjust *PC to point to the correct memory
683    location for inserting the breakpoint.  */
684 constexpr gdb_byte sparc_break_insn[] = { 0x91, 0xd0, 0x20, 0x01 };
685
686 typedef BP_MANIPULATION (sparc_break_insn) sparc_breakpoint;
687 \f
688
689 /* Allocate and initialize a frame cache.  */
690
691 static struct sparc_frame_cache *
692 sparc_alloc_frame_cache (void)
693 {
694   struct sparc_frame_cache *cache;
695
696   cache = FRAME_OBSTACK_ZALLOC (struct sparc_frame_cache);
697
698   /* Base address.  */
699   cache->base = 0;
700   cache->pc = 0;
701
702   /* Frameless until proven otherwise.  */
703   cache->frameless_p = 1;
704   cache->frame_offset = 0;
705   cache->saved_regs_mask = 0;
706   cache->copied_regs_mask = 0;
707   cache->struct_return_p = 0;
708
709   return cache;
710 }
711
712 /* GCC generates several well-known sequences of instructions at the begining
713    of each function prologue when compiling with -fstack-check.  If one of
714    such sequences starts at START_PC, then return the address of the
715    instruction immediately past this sequence.  Otherwise, return START_PC.  */
716    
717 static CORE_ADDR
718 sparc_skip_stack_check (const CORE_ADDR start_pc)
719 {
720   CORE_ADDR pc = start_pc;
721   unsigned long insn;
722   int probing_loop = 0;
723
724   /* With GCC, all stack checking sequences begin with the same two
725      instructions, plus an optional one in the case of a probing loop:
726
727          sethi <some immediate>, %g1
728          sub %sp, %g1, %g1
729
730      or:
731
732          sethi <some immediate>, %g1
733          sethi <some immediate>, %g4
734          sub %sp, %g1, %g1
735
736      or:
737
738          sethi <some immediate>, %g1
739          sub %sp, %g1, %g1
740          sethi <some immediate>, %g4
741
742      If the optional instruction is found (setting g4), assume that a
743      probing loop will follow.  */
744
745   /* sethi <some immediate>, %g1 */
746   insn = sparc_fetch_instruction (pc);
747   pc = pc + 4;
748   if (!(X_OP (insn) == 0 && X_OP2 (insn) == 0x4 && X_RD (insn) == 1))
749     return start_pc;
750
751   /* optional: sethi <some immediate>, %g4 */
752   insn = sparc_fetch_instruction (pc);
753   pc = pc + 4;
754   if (X_OP (insn) == 0 && X_OP2 (insn) == 0x4 && X_RD (insn) == 4)
755     {
756       probing_loop = 1;
757       insn = sparc_fetch_instruction (pc);
758       pc = pc + 4;
759     }
760
761   /* sub %sp, %g1, %g1 */
762   if (!(X_OP (insn) == 2 && X_OP3 (insn) == 0x4 && !X_I(insn)
763         && X_RD (insn) == 1 && X_RS1 (insn) == 14 && X_RS2 (insn) == 1))
764     return start_pc;
765
766   insn = sparc_fetch_instruction (pc);
767   pc = pc + 4;
768
769   /* optional: sethi <some immediate>, %g4 */
770   if (X_OP (insn) == 0 && X_OP2 (insn) == 0x4 && X_RD (insn) == 4)
771     {
772       probing_loop = 1;
773       insn = sparc_fetch_instruction (pc);
774       pc = pc + 4;
775     }
776
777   /* First possible sequence:
778          [first two instructions above]
779          clr [%g1 - some immediate]  */
780
781   /* clr [%g1 - some immediate]  */
782   if (X_OP (insn) == 3 && X_OP3(insn) == 0x4 && X_I(insn)
783       && X_RS1 (insn) == 1 && X_RD (insn) == 0)
784     {
785       /* Valid stack-check sequence, return the new PC.  */
786       return pc;
787     }
788
789   /* Second possible sequence: A small number of probes.
790          [first two instructions above]
791          clr [%g1]
792          add   %g1, -<some immediate>, %g1
793          clr [%g1]
794          [repeat the two instructions above any (small) number of times]
795          clr [%g1 - some immediate]  */
796
797   /* clr [%g1] */
798   else if (X_OP (insn) == 3 && X_OP3(insn) == 0x4 && !X_I(insn)
799       && X_RS1 (insn) == 1 && X_RD (insn) == 0)
800     {
801       while (1)
802         {
803           /* add %g1, -<some immediate>, %g1 */
804           insn = sparc_fetch_instruction (pc);
805           pc = pc + 4;
806           if (!(X_OP (insn) == 2  && X_OP3(insn) == 0 && X_I(insn)
807                 && X_RS1 (insn) == 1 && X_RD (insn) == 1))
808             break;
809
810           /* clr [%g1] */
811           insn = sparc_fetch_instruction (pc);
812           pc = pc + 4;
813           if (!(X_OP (insn) == 3 && X_OP3(insn) == 0x4 && !X_I(insn)
814                 && X_RD (insn) == 0 && X_RS1 (insn) == 1))
815             return start_pc;
816         }
817
818       /* clr [%g1 - some immediate] */
819       if (!(X_OP (insn) == 3 && X_OP3(insn) == 0x4 && X_I(insn)
820             && X_RS1 (insn) == 1 && X_RD (insn) == 0))
821         return start_pc;
822
823       /* We found a valid stack-check sequence, return the new PC.  */
824       return pc;
825     }
826   
827   /* Third sequence: A probing loop.
828          [first three instructions above]
829          sub  %g1, %g4, %g4
830          cmp  %g1, %g4
831          be  <disp>
832          add  %g1, -<some immediate>, %g1
833          ba  <disp>
834          clr  [%g1]
835
836      And an optional last probe for the remainder:
837
838          clr [%g4 - some immediate]  */
839
840   if (probing_loop)
841     {
842       /* sub  %g1, %g4, %g4 */
843       if (!(X_OP (insn) == 2 && X_OP3 (insn) == 0x4 && !X_I(insn)
844             && X_RD (insn) == 4 && X_RS1 (insn) == 1 && X_RS2 (insn) == 4))
845         return start_pc;
846
847       /* cmp  %g1, %g4 */
848       insn = sparc_fetch_instruction (pc);
849       pc = pc + 4;
850       if (!(X_OP (insn) == 2 && X_OP3 (insn) == 0x14 && !X_I(insn)
851             && X_RD (insn) == 0 && X_RS1 (insn) == 1 && X_RS2 (insn) == 4))
852         return start_pc;
853
854       /* be  <disp> */
855       insn = sparc_fetch_instruction (pc);
856       pc = pc + 4;
857       if (!(X_OP (insn) == 0 && X_COND (insn) == 0x1))
858         return start_pc;
859
860       /* add  %g1, -<some immediate>, %g1 */
861       insn = sparc_fetch_instruction (pc);
862       pc = pc + 4;
863       if (!(X_OP (insn) == 2  && X_OP3(insn) == 0 && X_I(insn)
864             && X_RS1 (insn) == 1 && X_RD (insn) == 1))
865         return start_pc;
866
867       /* ba  <disp> */
868       insn = sparc_fetch_instruction (pc);
869       pc = pc + 4;
870       if (!(X_OP (insn) == 0 && X_COND (insn) == 0x8))
871         return start_pc;
872
873       /* clr  [%g1] (st %g0, [%g1] or st %g0, [%g1+0]) */
874       insn = sparc_fetch_instruction (pc);
875       pc = pc + 4;
876       if (!(X_OP (insn) == 3 && X_OP3(insn) == 0x4
877             && X_RD (insn) == 0 && X_RS1 (insn) == 1
878             && (!X_I(insn) || X_SIMM13 (insn) == 0)))
879         return start_pc;
880
881       /* We found a valid stack-check sequence, return the new PC.  */
882
883       /* optional: clr [%g4 - some immediate]  */
884       insn = sparc_fetch_instruction (pc);
885       pc = pc + 4;
886       if (!(X_OP (insn) == 3 && X_OP3(insn) == 0x4 && X_I(insn)
887             && X_RS1 (insn) == 4 && X_RD (insn) == 0))
888         return pc - 4;
889       else
890         return pc;
891     }
892
893   /* No stack check code in our prologue, return the start_pc.  */
894   return start_pc;
895 }
896
897 /* Record the effect of a SAVE instruction on CACHE.  */
898
899 void
900 sparc_record_save_insn (struct sparc_frame_cache *cache)
901 {
902   /* The frame is set up.  */
903   cache->frameless_p = 0;
904
905   /* The frame pointer contains the CFA.  */
906   cache->frame_offset = 0;
907
908   /* The `local' and `in' registers are all saved.  */
909   cache->saved_regs_mask = 0xffff;
910
911   /* The `out' registers are all renamed.  */
912   cache->copied_regs_mask = 0xff;
913 }
914
915 /* Do a full analysis of the prologue at PC and update CACHE accordingly.
916    Bail out early if CURRENT_PC is reached.  Return the address where
917    the analysis stopped.
918
919    We handle both the traditional register window model and the single
920    register window (aka flat) model.  */
921
922 CORE_ADDR
923 sparc_analyze_prologue (struct gdbarch *gdbarch, CORE_ADDR pc,
924                         CORE_ADDR current_pc, struct sparc_frame_cache *cache)
925 {
926   struct gdbarch_tdep *tdep = gdbarch_tdep (gdbarch);
927   unsigned long insn;
928   int offset = 0;
929   int dest = -1;
930
931   pc = sparc_skip_stack_check (pc);
932
933   if (current_pc <= pc)
934     return current_pc;
935
936   /* We have to handle to "Procedure Linkage Table" (PLT) special.  On
937      SPARC the linker usually defines a symbol (typically
938      _PROCEDURE_LINKAGE_TABLE_) at the start of the .plt section.
939      This symbol makes us end up here with PC pointing at the start of
940      the PLT and CURRENT_PC probably pointing at a PLT entry.  If we
941      would do our normal prologue analysis, we would probably conclude
942      that we've got a frame when in reality we don't, since the
943      dynamic linker patches up the first PLT with some code that
944      starts with a SAVE instruction.  Patch up PC such that it points
945      at the start of our PLT entry.  */
946   if (tdep->plt_entry_size > 0 && in_plt_section (current_pc))
947     pc = current_pc - ((current_pc - pc) % tdep->plt_entry_size);
948
949   insn = sparc_fetch_instruction (pc);
950
951   /* Recognize store insns and record their sources.  */
952   while (X_OP (insn) == 3
953          && (X_OP3 (insn) == 0x4     /* stw */
954              || X_OP3 (insn) == 0x7  /* std */
955              || X_OP3 (insn) == 0xe) /* stx */
956          && X_RS1 (insn) == SPARC_SP_REGNUM)
957     {
958       int regnum = X_RD (insn);
959
960       /* Recognize stores into the corresponding stack slots.  */
961       if (regnum >= SPARC_L0_REGNUM && regnum <= SPARC_I7_REGNUM
962           && ((X_I (insn)
963                && X_SIMM13 (insn) == (X_OP3 (insn) == 0xe
964                                       ? (regnum - SPARC_L0_REGNUM) * 8 + BIAS
965                                       : (regnum - SPARC_L0_REGNUM) * 4))
966               || (!X_I (insn) && regnum == SPARC_L0_REGNUM)))
967         {
968           cache->saved_regs_mask |= (1 << (regnum - SPARC_L0_REGNUM));
969           if (X_OP3 (insn) == 0x7)
970             cache->saved_regs_mask |= (1 << (regnum + 1 - SPARC_L0_REGNUM));
971         }
972
973       offset += 4;
974
975       insn = sparc_fetch_instruction (pc + offset);
976     }
977
978   /* Recognize a SETHI insn and record its destination.  */
979   if (X_OP (insn) == 0 && X_OP2 (insn) == 0x04)
980     {
981       dest = X_RD (insn);
982       offset += 4;
983
984       insn = sparc_fetch_instruction (pc + offset);
985     }
986
987   /* Allow for an arithmetic operation on DEST or %g1.  */
988   if (X_OP (insn) == 2 && X_I (insn)
989       && (X_RD (insn) == 1 || X_RD (insn) == dest))
990     {
991       offset += 4;
992
993       insn = sparc_fetch_instruction (pc + offset);
994     }
995
996   /* Check for the SAVE instruction that sets up the frame.  */
997   if (X_OP (insn) == 2 && X_OP3 (insn) == 0x3c)
998     {
999       sparc_record_save_insn (cache);
1000       offset += 4;
1001       return pc + offset;
1002     }
1003
1004   /* Check for an arithmetic operation on %sp.  */
1005   if (X_OP (insn) == 2
1006       && (X_OP3 (insn) == 0 || X_OP3 (insn) == 0x4)
1007       && X_RS1 (insn) == SPARC_SP_REGNUM
1008       && X_RD (insn) == SPARC_SP_REGNUM)
1009     {
1010       if (X_I (insn))
1011         {
1012           cache->frame_offset = X_SIMM13 (insn);
1013           if (X_OP3 (insn) == 0)
1014             cache->frame_offset = -cache->frame_offset;
1015         }
1016       offset += 4;
1017
1018       insn = sparc_fetch_instruction (pc + offset);
1019
1020       /* Check for an arithmetic operation that sets up the frame.  */
1021       if (X_OP (insn) == 2
1022           && (X_OP3 (insn) == 0 || X_OP3 (insn) == 0x4)
1023           && X_RS1 (insn) == SPARC_SP_REGNUM
1024           && X_RD (insn) == SPARC_FP_REGNUM)
1025         {
1026           cache->frameless_p = 0;
1027           cache->frame_offset = 0;
1028           /* We could check that the amount subtracted to %sp above is the
1029              same as the one added here, but this seems superfluous.  */
1030           cache->copied_regs_mask |= 0x40;
1031           offset += 4;
1032
1033           insn = sparc_fetch_instruction (pc + offset);
1034         }
1035
1036       /* Check for a move (or) operation that copies the return register.  */
1037       if (X_OP (insn) == 2
1038           && X_OP3 (insn) == 0x2
1039           && !X_I (insn)
1040           && X_RS1 (insn) == SPARC_G0_REGNUM
1041           && X_RS2 (insn) == SPARC_O7_REGNUM
1042           && X_RD (insn) == SPARC_I7_REGNUM)
1043         {
1044            cache->copied_regs_mask |= 0x80;
1045            offset += 4;
1046         }
1047
1048       return pc + offset;
1049     }
1050
1051   return pc;
1052 }
1053
1054 static CORE_ADDR
1055 sparc_unwind_pc (struct gdbarch *gdbarch, struct frame_info *this_frame)
1056 {
1057   struct gdbarch_tdep *tdep = gdbarch_tdep (gdbarch);
1058   return frame_unwind_register_unsigned (this_frame, tdep->pc_regnum);
1059 }
1060
1061 /* Return PC of first real instruction of the function starting at
1062    START_PC.  */
1063
1064 static CORE_ADDR
1065 sparc32_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR start_pc)
1066 {
1067   struct symtab_and_line sal;
1068   CORE_ADDR func_start, func_end;
1069   struct sparc_frame_cache cache;
1070
1071   /* This is the preferred method, find the end of the prologue by
1072      using the debugging information.  */
1073   if (find_pc_partial_function (start_pc, NULL, &func_start, &func_end))
1074     {
1075       sal = find_pc_line (func_start, 0);
1076
1077       if (sal.end < func_end
1078           && start_pc <= sal.end)
1079         return sal.end;
1080     }
1081
1082   start_pc = sparc_analyze_prologue (gdbarch, start_pc, 0xffffffffUL, &cache);
1083
1084   /* The psABI says that "Although the first 6 words of arguments
1085      reside in registers, the standard stack frame reserves space for
1086      them.".  It also suggests that a function may use that space to
1087      "write incoming arguments 0 to 5" into that space, and that's
1088      indeed what GCC seems to be doing.  In that case GCC will
1089      generate debug information that points to the stack slots instead
1090      of the registers, so we should consider the instructions that
1091      write out these incoming arguments onto the stack.  */
1092
1093   while (1)
1094     {
1095       unsigned long insn = sparc_fetch_instruction (start_pc);
1096
1097       /* Recognize instructions that store incoming arguments into the
1098          corresponding stack slots.  */
1099       if (X_OP (insn) == 3 && (X_OP3 (insn) & 0x3c) == 0x04
1100           && X_I (insn) && X_RS1 (insn) == SPARC_FP_REGNUM)
1101         {
1102           int regnum = X_RD (insn);
1103
1104           /* Case of arguments still in %o[0..5].  */
1105           if (regnum >= SPARC_O0_REGNUM && regnum <= SPARC_O5_REGNUM
1106               && !(cache.copied_regs_mask & (1 << (regnum - SPARC_O0_REGNUM)))
1107               && X_SIMM13 (insn) == 68 + (regnum - SPARC_O0_REGNUM) * 4)
1108             {
1109               start_pc += 4;
1110               continue;
1111             }
1112
1113           /* Case of arguments copied into %i[0..5].  */
1114           if (regnum >= SPARC_I0_REGNUM && regnum <= SPARC_I5_REGNUM
1115               && (cache.copied_regs_mask & (1 << (regnum - SPARC_I0_REGNUM)))
1116               && X_SIMM13 (insn) == 68 + (regnum - SPARC_I0_REGNUM) * 4)
1117             {
1118               start_pc += 4;
1119               continue;
1120             }
1121         }
1122
1123       break;
1124     }
1125
1126   return start_pc;
1127 }
1128
1129 /* Normal frames.  */
1130
1131 struct sparc_frame_cache *
1132 sparc_frame_cache (struct frame_info *this_frame, void **this_cache)
1133 {
1134   struct sparc_frame_cache *cache;
1135
1136   if (*this_cache)
1137     return (struct sparc_frame_cache *) *this_cache;
1138
1139   cache = sparc_alloc_frame_cache ();
1140   *this_cache = cache;
1141
1142   cache->pc = get_frame_func (this_frame);
1143   if (cache->pc != 0)
1144     sparc_analyze_prologue (get_frame_arch (this_frame), cache->pc,
1145                             get_frame_pc (this_frame), cache);
1146
1147   if (cache->frameless_p)
1148     {
1149       /* This function is frameless, so %fp (%i6) holds the frame
1150          pointer for our calling frame.  Use %sp (%o6) as this frame's
1151          base address.  */
1152       cache->base =
1153         get_frame_register_unsigned (this_frame, SPARC_SP_REGNUM);
1154     }
1155   else
1156     {
1157       /* For normal frames, %fp (%i6) holds the frame pointer, the
1158          base address for the current stack frame.  */
1159       cache->base =
1160         get_frame_register_unsigned (this_frame, SPARC_FP_REGNUM);
1161     }
1162
1163   cache->base += cache->frame_offset;
1164
1165   if (cache->base & 1)
1166     cache->base += BIAS;
1167
1168   return cache;
1169 }
1170
1171 static int
1172 sparc32_struct_return_from_sym (struct symbol *sym)
1173 {
1174   struct type *type = check_typedef (SYMBOL_TYPE (sym));
1175   enum type_code code = TYPE_CODE (type);
1176
1177   if (code == TYPE_CODE_FUNC || code == TYPE_CODE_METHOD)
1178     {
1179       type = check_typedef (TYPE_TARGET_TYPE (type));
1180       if (sparc_structure_or_union_p (type)
1181           || (sparc_floating_p (type) && TYPE_LENGTH (type) == 16))
1182         return 1;
1183     }
1184
1185   return 0;
1186 }
1187
1188 struct sparc_frame_cache *
1189 sparc32_frame_cache (struct frame_info *this_frame, void **this_cache)
1190 {
1191   struct sparc_frame_cache *cache;
1192   struct symbol *sym;
1193
1194   if (*this_cache)
1195     return (struct sparc_frame_cache *) *this_cache;
1196
1197   cache = sparc_frame_cache (this_frame, this_cache);
1198
1199   sym = find_pc_function (cache->pc);
1200   if (sym)
1201     {
1202       cache->struct_return_p = sparc32_struct_return_from_sym (sym);
1203     }
1204   else
1205     {
1206       /* There is no debugging information for this function to
1207          help us determine whether this function returns a struct
1208          or not.  So we rely on another heuristic which is to check
1209          the instruction at the return address and see if this is
1210          an "unimp" instruction.  If it is, then it is a struct-return
1211          function.  */
1212       CORE_ADDR pc;
1213       int regnum =
1214         (cache->copied_regs_mask & 0x80) ? SPARC_I7_REGNUM : SPARC_O7_REGNUM;
1215
1216       pc = get_frame_register_unsigned (this_frame, regnum) + 8;
1217       if (sparc_is_unimp_insn (pc))
1218         cache->struct_return_p = 1;
1219     }
1220
1221   return cache;
1222 }
1223
1224 static void
1225 sparc32_frame_this_id (struct frame_info *this_frame, void **this_cache,
1226                        struct frame_id *this_id)
1227 {
1228   struct sparc_frame_cache *cache =
1229     sparc32_frame_cache (this_frame, this_cache);
1230
1231   /* This marks the outermost frame.  */
1232   if (cache->base == 0)
1233     return;
1234
1235   (*this_id) = frame_id_build (cache->base, cache->pc);
1236 }
1237
1238 static struct value *
1239 sparc32_frame_prev_register (struct frame_info *this_frame,
1240                              void **this_cache, int regnum)
1241 {
1242   struct gdbarch *gdbarch = get_frame_arch (this_frame);
1243   struct sparc_frame_cache *cache =
1244     sparc32_frame_cache (this_frame, this_cache);
1245
1246   if (regnum == SPARC32_PC_REGNUM || regnum == SPARC32_NPC_REGNUM)
1247     {
1248       CORE_ADDR pc = (regnum == SPARC32_NPC_REGNUM) ? 4 : 0;
1249
1250       /* If this functions has a Structure, Union or Quad-Precision
1251          return value, we have to skip the UNIMP instruction that encodes
1252          the size of the structure.  */
1253       if (cache->struct_return_p)
1254         pc += 4;
1255
1256       regnum =
1257         (cache->copied_regs_mask & 0x80) ? SPARC_I7_REGNUM : SPARC_O7_REGNUM;
1258       pc += get_frame_register_unsigned (this_frame, regnum) + 8;
1259       return frame_unwind_got_constant (this_frame, regnum, pc);
1260     }
1261
1262   /* Handle StackGhost.  */
1263   {
1264     ULONGEST wcookie = sparc_fetch_wcookie (gdbarch);
1265
1266     if (wcookie != 0 && !cache->frameless_p && regnum == SPARC_I7_REGNUM)
1267       {
1268         CORE_ADDR addr = cache->base + (regnum - SPARC_L0_REGNUM) * 4;
1269         ULONGEST i7;
1270
1271         /* Read the value in from memory.  */
1272         i7 = get_frame_memory_unsigned (this_frame, addr, 4);
1273         return frame_unwind_got_constant (this_frame, regnum, i7 ^ wcookie);
1274       }
1275   }
1276
1277   /* The previous frame's `local' and `in' registers may have been saved
1278      in the register save area.  */
1279   if (regnum >= SPARC_L0_REGNUM && regnum <= SPARC_I7_REGNUM
1280       && (cache->saved_regs_mask & (1 << (regnum - SPARC_L0_REGNUM))))
1281     {
1282       CORE_ADDR addr = cache->base + (regnum - SPARC_L0_REGNUM) * 4;
1283
1284       return frame_unwind_got_memory (this_frame, regnum, addr);
1285     }
1286
1287   /* The previous frame's `out' registers may be accessible as the current
1288      frame's `in' registers.  */
1289   if (regnum >= SPARC_O0_REGNUM && regnum <= SPARC_O7_REGNUM
1290       && (cache->copied_regs_mask & (1 << (regnum - SPARC_O0_REGNUM))))
1291     regnum += (SPARC_I0_REGNUM - SPARC_O0_REGNUM);
1292
1293   return frame_unwind_got_register (this_frame, regnum, regnum);
1294 }
1295
1296 static const struct frame_unwind sparc32_frame_unwind =
1297 {
1298   NORMAL_FRAME,
1299   default_frame_unwind_stop_reason,
1300   sparc32_frame_this_id,
1301   sparc32_frame_prev_register,
1302   NULL,
1303   default_frame_sniffer
1304 };
1305 \f
1306
1307 static CORE_ADDR
1308 sparc32_frame_base_address (struct frame_info *this_frame, void **this_cache)
1309 {
1310   struct sparc_frame_cache *cache =
1311     sparc32_frame_cache (this_frame, this_cache);
1312
1313   return cache->base;
1314 }
1315
1316 static const struct frame_base sparc32_frame_base =
1317 {
1318   &sparc32_frame_unwind,
1319   sparc32_frame_base_address,
1320   sparc32_frame_base_address,
1321   sparc32_frame_base_address
1322 };
1323
1324 static struct frame_id
1325 sparc_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame)
1326 {
1327   CORE_ADDR sp;
1328
1329   sp = get_frame_register_unsigned (this_frame, SPARC_SP_REGNUM);
1330   if (sp & 1)
1331     sp += BIAS;
1332   return frame_id_build (sp, get_frame_pc (this_frame));
1333 }
1334 \f
1335
1336 /* Extract a function return value of TYPE from REGCACHE, and copy
1337    that into VALBUF.  */
1338
1339 static void
1340 sparc32_extract_return_value (struct type *type, struct regcache *regcache,
1341                               gdb_byte *valbuf)
1342 {
1343   int len = TYPE_LENGTH (type);
1344   gdb_byte buf[32];
1345
1346   gdb_assert (!sparc_structure_or_union_p (type));
1347   gdb_assert (!(sparc_floating_p (type) && len == 16));
1348
1349   if (sparc_floating_p (type) || sparc_complex_floating_p (type))
1350     {
1351       /* Floating return values.  */
1352       regcache_cooked_read (regcache, SPARC_F0_REGNUM, buf);
1353       if (len > 4)
1354         regcache_cooked_read (regcache, SPARC_F1_REGNUM, buf + 4);
1355       if (len > 8)
1356         {
1357           regcache_cooked_read (regcache, SPARC_F2_REGNUM, buf + 8);
1358           regcache_cooked_read (regcache, SPARC_F3_REGNUM, buf + 12);
1359         }
1360       if (len > 16)
1361         {
1362           regcache_cooked_read (regcache, SPARC_F4_REGNUM, buf + 16);
1363           regcache_cooked_read (regcache, SPARC_F5_REGNUM, buf + 20);
1364           regcache_cooked_read (regcache, SPARC_F6_REGNUM, buf + 24);
1365           regcache_cooked_read (regcache, SPARC_F7_REGNUM, buf + 28);
1366         }
1367       memcpy (valbuf, buf, len);
1368     }
1369   else
1370     {
1371       /* Integral and pointer return values.  */
1372       gdb_assert (sparc_integral_or_pointer_p (type));
1373
1374       regcache_cooked_read (regcache, SPARC_O0_REGNUM, buf);
1375       if (len > 4)
1376         {
1377           regcache_cooked_read (regcache, SPARC_O1_REGNUM, buf + 4);
1378           gdb_assert (len == 8);
1379           memcpy (valbuf, buf, 8);
1380         }
1381       else
1382         {
1383           /* Just stripping off any unused bytes should preserve the
1384              signed-ness just fine.  */
1385           memcpy (valbuf, buf + 4 - len, len);
1386         }
1387     }
1388 }
1389
1390 /* Store the function return value of type TYPE from VALBUF into
1391    REGCACHE.  */
1392
1393 static void
1394 sparc32_store_return_value (struct type *type, struct regcache *regcache,
1395                             const gdb_byte *valbuf)
1396 {
1397   int len = TYPE_LENGTH (type);
1398   gdb_byte buf[8];
1399
1400   gdb_assert (!sparc_structure_or_union_p (type));
1401   gdb_assert (!(sparc_floating_p (type) && len == 16));
1402   gdb_assert (len <= 8);
1403
1404   if (sparc_floating_p (type) || sparc_complex_floating_p (type))
1405     {
1406       /* Floating return values.  */
1407       memcpy (buf, valbuf, len);
1408       regcache_cooked_write (regcache, SPARC_F0_REGNUM, buf);
1409       if (len > 4)
1410         regcache_cooked_write (regcache, SPARC_F1_REGNUM, buf + 4);
1411       if (len > 8)
1412         {
1413           regcache_cooked_write (regcache, SPARC_F2_REGNUM, buf + 8);
1414           regcache_cooked_write (regcache, SPARC_F3_REGNUM, buf + 12);
1415         }
1416       if (len > 16)
1417         {
1418           regcache_cooked_write (regcache, SPARC_F4_REGNUM, buf + 16);
1419           regcache_cooked_write (regcache, SPARC_F5_REGNUM, buf + 20);
1420           regcache_cooked_write (regcache, SPARC_F6_REGNUM, buf + 24);
1421           regcache_cooked_write (regcache, SPARC_F7_REGNUM, buf + 28);
1422         }
1423     }
1424   else
1425     {
1426       /* Integral and pointer return values.  */
1427       gdb_assert (sparc_integral_or_pointer_p (type));
1428
1429       if (len > 4)
1430         {
1431           gdb_assert (len == 8);
1432           memcpy (buf, valbuf, 8);
1433           regcache_cooked_write (regcache, SPARC_O1_REGNUM, buf + 4);
1434         }
1435       else
1436         {
1437           /* ??? Do we need to do any sign-extension here?  */
1438           memcpy (buf + 4 - len, valbuf, len);
1439         }
1440       regcache_cooked_write (regcache, SPARC_O0_REGNUM, buf);
1441     }
1442 }
1443
1444 static enum return_value_convention
1445 sparc32_return_value (struct gdbarch *gdbarch, struct value *function,
1446                       struct type *type, struct regcache *regcache,
1447                       gdb_byte *readbuf, const gdb_byte *writebuf)
1448 {
1449   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1450
1451   /* The psABI says that "...every stack frame reserves the word at
1452      %fp+64.  If a function returns a structure, union, or
1453      quad-precision value, this word should hold the address of the
1454      object into which the return value should be copied."  This
1455      guarantees that we can always find the return value, not just
1456      before the function returns.  */
1457
1458   if (sparc_structure_or_union_p (type)
1459       || (sparc_floating_p (type) && TYPE_LENGTH (type) == 16))
1460     {
1461       ULONGEST sp;
1462       CORE_ADDR addr;
1463
1464       if (readbuf)
1465         {
1466           regcache_cooked_read_unsigned (regcache, SPARC_SP_REGNUM, &sp);
1467           addr = read_memory_unsigned_integer (sp + 64, 4, byte_order);
1468           read_memory (addr, readbuf, TYPE_LENGTH (type));
1469         }
1470       if (writebuf)
1471         {
1472           regcache_cooked_read_unsigned (regcache, SPARC_SP_REGNUM, &sp);
1473           addr = read_memory_unsigned_integer (sp + 64, 4, byte_order);
1474           write_memory (addr, writebuf, TYPE_LENGTH (type));
1475         }
1476
1477       return RETURN_VALUE_ABI_PRESERVES_ADDRESS;
1478     }
1479
1480   if (readbuf)
1481     sparc32_extract_return_value (type, regcache, readbuf);
1482   if (writebuf)
1483     sparc32_store_return_value (type, regcache, writebuf);
1484
1485   return RETURN_VALUE_REGISTER_CONVENTION;
1486 }
1487
1488 static int
1489 sparc32_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type)
1490 {
1491   return (sparc_structure_or_union_p (type)
1492           || (sparc_floating_p (type) && TYPE_LENGTH (type) == 16)
1493           || sparc_complex_floating_p (type));
1494 }
1495
1496 static int
1497 sparc32_dwarf2_struct_return_p (struct frame_info *this_frame)
1498 {
1499   CORE_ADDR pc = get_frame_address_in_block (this_frame);
1500   struct symbol *sym = find_pc_function (pc);
1501
1502   if (sym)
1503     return sparc32_struct_return_from_sym (sym);
1504   return 0;
1505 }
1506
1507 static void
1508 sparc32_dwarf2_frame_init_reg (struct gdbarch *gdbarch, int regnum,
1509                                struct dwarf2_frame_state_reg *reg,
1510                                struct frame_info *this_frame)
1511 {
1512   int off;
1513
1514   switch (regnum)
1515     {
1516     case SPARC_G0_REGNUM:
1517       /* Since %g0 is always zero, there is no point in saving it, and
1518          people will be inclined omit it from the CFI.  Make sure we
1519          don't warn about that.  */
1520       reg->how = DWARF2_FRAME_REG_SAME_VALUE;
1521       break;
1522     case SPARC_SP_REGNUM:
1523       reg->how = DWARF2_FRAME_REG_CFA;
1524       break;
1525     case SPARC32_PC_REGNUM:
1526     case SPARC32_NPC_REGNUM:
1527       reg->how = DWARF2_FRAME_REG_RA_OFFSET;
1528       off = 8;
1529       if (sparc32_dwarf2_struct_return_p (this_frame))
1530         off += 4;
1531       if (regnum == SPARC32_NPC_REGNUM)
1532         off += 4;
1533       reg->loc.offset = off;
1534       break;
1535     }
1536 }
1537
1538 \f
1539 /* The SPARC Architecture doesn't have hardware single-step support,
1540    and most operating systems don't implement it either, so we provide
1541    software single-step mechanism.  */
1542
1543 static CORE_ADDR
1544 sparc_analyze_control_transfer (struct regcache *regcache,
1545                                 CORE_ADDR pc, CORE_ADDR *npc)
1546 {
1547   unsigned long insn = sparc_fetch_instruction (pc);
1548   int conditional_p = X_COND (insn) & 0x7;
1549   int branch_p = 0, fused_p = 0;
1550   long offset = 0;                      /* Must be signed for sign-extend.  */
1551
1552   if (X_OP (insn) == 0 && X_OP2 (insn) == 3)
1553     {
1554       if ((insn & 0x10000000) == 0)
1555         {
1556           /* Branch on Integer Register with Prediction (BPr).  */
1557           branch_p = 1;
1558           conditional_p = 1;
1559         }
1560       else
1561         {
1562           /* Compare and Branch  */
1563           branch_p = 1;
1564           fused_p = 1;
1565           offset = 4 * X_DISP10 (insn);
1566         }
1567     }
1568   else if (X_OP (insn) == 0 && X_OP2 (insn) == 6)
1569     {
1570       /* Branch on Floating-Point Condition Codes (FBfcc).  */
1571       branch_p = 1;
1572       offset = 4 * X_DISP22 (insn);
1573     }
1574   else if (X_OP (insn) == 0 && X_OP2 (insn) == 5)
1575     {
1576       /* Branch on Floating-Point Condition Codes with Prediction
1577          (FBPfcc).  */
1578       branch_p = 1;
1579       offset = 4 * X_DISP19 (insn);
1580     }
1581   else if (X_OP (insn) == 0 && X_OP2 (insn) == 2)
1582     {
1583       /* Branch on Integer Condition Codes (Bicc).  */
1584       branch_p = 1;
1585       offset = 4 * X_DISP22 (insn);
1586     }
1587   else if (X_OP (insn) == 0 && X_OP2 (insn) == 1)
1588     {
1589       /* Branch on Integer Condition Codes with Prediction (BPcc).  */
1590       branch_p = 1;
1591       offset = 4 * X_DISP19 (insn);
1592     }
1593   else if (X_OP (insn) == 2 && X_OP3 (insn) == 0x3a)
1594     {
1595       struct frame_info *frame = get_current_frame ();
1596
1597       /* Trap instruction (TRAP).  */
1598       return gdbarch_tdep (get_regcache_arch (regcache))->step_trap (frame,
1599                                                                      insn);
1600     }
1601
1602   /* FIXME: Handle DONE and RETRY instructions.  */
1603
1604   if (branch_p)
1605     {
1606       if (fused_p)
1607         {
1608           /* Fused compare-and-branch instructions are non-delayed,
1609              and do not have an annuling capability.  So we need to
1610              always set a breakpoint on both the NPC and the branch
1611              target address.  */
1612           gdb_assert (offset != 0);
1613           return pc + offset;
1614         }
1615       else if (conditional_p)
1616         {
1617           /* For conditional branches, return nPC + 4 iff the annul
1618              bit is 1.  */
1619           return (X_A (insn) ? *npc + 4 : 0);
1620         }
1621       else
1622         {
1623           /* For unconditional branches, return the target if its
1624              specified condition is "always" and return nPC + 4 if the
1625              condition is "never".  If the annul bit is 1, set *NPC to
1626              zero.  */
1627           if (X_COND (insn) == 0x0)
1628             pc = *npc, offset = 4;
1629           if (X_A (insn))
1630             *npc = 0;
1631
1632           return pc + offset;
1633         }
1634     }
1635
1636   return 0;
1637 }
1638
1639 static CORE_ADDR
1640 sparc_step_trap (struct frame_info *frame, unsigned long insn)
1641 {
1642   return 0;
1643 }
1644
1645 static VEC (CORE_ADDR) *
1646 sparc_software_single_step (struct regcache *regcache)
1647 {
1648   struct gdbarch *arch = get_regcache_arch (regcache);
1649   struct gdbarch_tdep *tdep = gdbarch_tdep (arch);
1650   CORE_ADDR npc, nnpc;
1651
1652   CORE_ADDR pc, orig_npc;
1653   VEC (CORE_ADDR) *next_pcs = NULL;
1654
1655   pc = regcache_raw_get_unsigned (regcache, tdep->pc_regnum);
1656   orig_npc = npc = regcache_raw_get_unsigned (regcache, tdep->npc_regnum);
1657
1658   /* Analyze the instruction at PC.  */
1659   nnpc = sparc_analyze_control_transfer (regcache, pc, &npc);
1660   if (npc != 0)
1661     VEC_safe_push (CORE_ADDR, next_pcs, npc);
1662
1663   if (nnpc != 0)
1664     VEC_safe_push (CORE_ADDR, next_pcs, nnpc);
1665
1666   /* Assert that we have set at least one breakpoint, and that
1667      they're not set at the same spot - unless we're going
1668      from here straight to NULL, i.e. a call or jump to 0.  */
1669   gdb_assert (npc != 0 || nnpc != 0 || orig_npc == 0);
1670   gdb_assert (nnpc != npc || orig_npc == 0);
1671
1672   return next_pcs;
1673 }
1674
1675 static void
1676 sparc_write_pc (struct regcache *regcache, CORE_ADDR pc)
1677 {
1678   struct gdbarch_tdep *tdep = gdbarch_tdep (get_regcache_arch (regcache));
1679
1680   regcache_cooked_write_unsigned (regcache, tdep->pc_regnum, pc);
1681   regcache_cooked_write_unsigned (regcache, tdep->npc_regnum, pc + 4);
1682 }
1683 \f
1684
1685 /* Iterate over core file register note sections.  */
1686
1687 static void
1688 sparc_iterate_over_regset_sections (struct gdbarch *gdbarch,
1689                                     iterate_over_regset_sections_cb *cb,
1690                                     void *cb_data,
1691                                     const struct regcache *regcache)
1692 {
1693   struct gdbarch_tdep *tdep = gdbarch_tdep (gdbarch);
1694
1695   cb (".reg", tdep->sizeof_gregset, tdep->gregset, NULL, cb_data);
1696   cb (".reg2", tdep->sizeof_fpregset, tdep->fpregset, NULL, cb_data);
1697 }
1698 \f
1699
1700 static int
1701 validate_tdesc_registers (const struct target_desc *tdesc,
1702                           struct tdesc_arch_data *tdesc_data,
1703                           const char *feature_name,
1704                           const char *register_names[],
1705                           unsigned int registers_num,
1706                           unsigned int reg_start)
1707 {
1708   int valid_p = 1;
1709   const struct tdesc_feature *feature;
1710
1711   feature = tdesc_find_feature (tdesc, feature_name);
1712   if (feature == NULL)
1713     return 0;
1714
1715   for (unsigned int i = 0; i < registers_num; i++)
1716     valid_p &= tdesc_numbered_register (feature, tdesc_data,
1717                                         reg_start + i,
1718                                         register_names[i]);
1719
1720   return valid_p;
1721 }
1722
1723 static struct gdbarch *
1724 sparc32_gdbarch_init (struct gdbarch_info info, struct gdbarch_list *arches)
1725 {
1726   struct gdbarch_tdep *tdep;
1727   const struct target_desc *tdesc = info.target_desc;
1728   struct gdbarch *gdbarch;
1729   int valid_p = 1;
1730
1731   /* If there is already a candidate, use it.  */
1732   arches = gdbarch_list_lookup_by_info (arches, &info);
1733   if (arches != NULL)
1734     return arches->gdbarch;
1735
1736   /* Allocate space for the new architecture.  */
1737   tdep = XCNEW (struct gdbarch_tdep);
1738   gdbarch = gdbarch_alloc (&info, tdep);
1739
1740   tdep->pc_regnum = SPARC32_PC_REGNUM;
1741   tdep->npc_regnum = SPARC32_NPC_REGNUM;
1742   tdep->step_trap = sparc_step_trap;
1743   tdep->fpu_register_names = sparc32_fpu_register_names;
1744   tdep->fpu_registers_num = ARRAY_SIZE (sparc32_fpu_register_names);
1745   tdep->cp0_register_names = sparc32_cp0_register_names;
1746   tdep->cp0_registers_num = ARRAY_SIZE (sparc32_cp0_register_names);
1747
1748   set_gdbarch_long_double_bit (gdbarch, 128);
1749   set_gdbarch_long_double_format (gdbarch, floatformats_sparc_quad);
1750
1751   set_gdbarch_num_regs (gdbarch, SPARC32_NUM_REGS);
1752   set_gdbarch_register_name (gdbarch, sparc32_register_name);
1753   set_gdbarch_register_type (gdbarch, sparc32_register_type);
1754   set_gdbarch_num_pseudo_regs (gdbarch, SPARC32_NUM_PSEUDO_REGS);
1755   set_tdesc_pseudo_register_name (gdbarch, sparc32_pseudo_register_name);
1756   set_tdesc_pseudo_register_type (gdbarch, sparc32_pseudo_register_type);
1757   set_gdbarch_pseudo_register_read (gdbarch, sparc32_pseudo_register_read);
1758   set_gdbarch_pseudo_register_write (gdbarch, sparc32_pseudo_register_write);
1759
1760   /* Register numbers of various important registers.  */
1761   set_gdbarch_sp_regnum (gdbarch, SPARC_SP_REGNUM); /* %sp */
1762   set_gdbarch_pc_regnum (gdbarch, SPARC32_PC_REGNUM); /* %pc */
1763   set_gdbarch_fp0_regnum (gdbarch, SPARC_F0_REGNUM); /* %f0 */
1764
1765   /* Call dummy code.  */
1766   set_gdbarch_frame_align (gdbarch, sparc32_frame_align);
1767   set_gdbarch_call_dummy_location (gdbarch, ON_STACK);
1768   set_gdbarch_push_dummy_code (gdbarch, sparc32_push_dummy_code);
1769   set_gdbarch_push_dummy_call (gdbarch, sparc32_push_dummy_call);
1770
1771   set_gdbarch_return_value (gdbarch, sparc32_return_value);
1772   set_gdbarch_stabs_argument_has_addr
1773     (gdbarch, sparc32_stabs_argument_has_addr);
1774
1775   set_gdbarch_skip_prologue (gdbarch, sparc32_skip_prologue);
1776
1777   /* Stack grows downward.  */
1778   set_gdbarch_inner_than (gdbarch, core_addr_lessthan);
1779
1780   set_gdbarch_breakpoint_kind_from_pc (gdbarch,
1781                                        sparc_breakpoint::kind_from_pc);
1782   set_gdbarch_sw_breakpoint_from_kind (gdbarch,
1783                                        sparc_breakpoint::bp_from_kind);
1784
1785   set_gdbarch_frame_args_skip (gdbarch, 8);
1786
1787   set_gdbarch_print_insn (gdbarch, print_insn_sparc);
1788
1789   set_gdbarch_software_single_step (gdbarch, sparc_software_single_step);
1790   set_gdbarch_write_pc (gdbarch, sparc_write_pc);
1791
1792   set_gdbarch_dummy_id (gdbarch, sparc_dummy_id);
1793
1794   set_gdbarch_unwind_pc (gdbarch, sparc_unwind_pc);
1795
1796   frame_base_set_default (gdbarch, &sparc32_frame_base);
1797
1798   /* Hook in the DWARF CFI frame unwinder.  */
1799   dwarf2_frame_set_init_reg (gdbarch, sparc32_dwarf2_frame_init_reg);
1800   /* FIXME: kettenis/20050423: Don't enable the unwinder until the
1801      StackGhost issues have been resolved.  */
1802
1803   /* Hook in ABI-specific overrides, if they have been registered.  */
1804   gdbarch_init_osabi (info, gdbarch);
1805
1806   frame_unwind_append_unwinder (gdbarch, &sparc32_frame_unwind);
1807
1808   if (tdesc_has_registers (tdesc))
1809     {
1810       struct tdesc_arch_data *tdesc_data = tdesc_data_alloc ();
1811
1812       /* Validate that the descriptor provides the mandatory registers
1813          and allocate their numbers. */
1814       valid_p &= validate_tdesc_registers (tdesc, tdesc_data,
1815                                            "org.gnu.gdb.sparc.cpu",
1816                                            sparc_core_register_names,
1817                                            ARRAY_SIZE (sparc_core_register_names),
1818                                            SPARC_G0_REGNUM);
1819       valid_p &= validate_tdesc_registers (tdesc, tdesc_data,
1820                                            "org.gnu.gdb.sparc.fpu",
1821                                            tdep->fpu_register_names,
1822                                            tdep->fpu_registers_num,
1823                                            SPARC_F0_REGNUM);
1824       valid_p &= validate_tdesc_registers (tdesc, tdesc_data,
1825                                            "org.gnu.gdb.sparc.cp0",
1826                                            tdep->cp0_register_names,
1827                                            tdep->cp0_registers_num,
1828                                            SPARC_F0_REGNUM
1829                                            + tdep->fpu_registers_num);
1830       if (!valid_p)
1831         {
1832           tdesc_data_cleanup (tdesc_data);
1833           return NULL;
1834         }
1835
1836       /* Target description may have changed. */
1837       info.tdep_info = tdesc_data;
1838       tdesc_use_registers (gdbarch, tdesc, tdesc_data);
1839     }
1840
1841   /* If we have register sets, enable the generic core file support.  */
1842   if (tdep->gregset)
1843     set_gdbarch_iterate_over_regset_sections
1844       (gdbarch, sparc_iterate_over_regset_sections);
1845
1846   register_sparc_ravenscar_ops (gdbarch);
1847
1848   return gdbarch;
1849 }
1850 \f
1851 /* Helper functions for dealing with register windows.  */
1852
1853 void
1854 sparc_supply_rwindow (struct regcache *regcache, CORE_ADDR sp, int regnum)
1855 {
1856   struct gdbarch *gdbarch = get_regcache_arch (regcache);
1857   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1858   int offset = 0;
1859   gdb_byte buf[8];
1860   int i;
1861
1862   if (sp & 1)
1863     {
1864       /* Registers are 64-bit.  */
1865       sp += BIAS;
1866
1867       for (i = SPARC_L0_REGNUM; i <= SPARC_I7_REGNUM; i++)
1868         {
1869           if (regnum == i || regnum == -1)
1870             {
1871               target_read_memory (sp + ((i - SPARC_L0_REGNUM) * 8), buf, 8);
1872
1873               /* Handle StackGhost.  */
1874               if (i == SPARC_I7_REGNUM)
1875                 {
1876                   ULONGEST wcookie = sparc_fetch_wcookie (gdbarch);
1877                   ULONGEST i7;
1878
1879                   i7 = extract_unsigned_integer (buf + offset, 8, byte_order);
1880                   store_unsigned_integer (buf + offset, 8, byte_order,
1881                                           i7 ^ wcookie);
1882                 }
1883
1884               regcache_raw_supply (regcache, i, buf);
1885             }
1886         }
1887     }
1888   else
1889     {
1890       /* Registers are 32-bit.  Toss any sign-extension of the stack
1891          pointer.  */
1892       sp &= 0xffffffffUL;
1893
1894       /* Clear out the top half of the temporary buffer, and put the
1895          register value in the bottom half if we're in 64-bit mode.  */
1896       if (gdbarch_ptr_bit (get_regcache_arch (regcache)) == 64)
1897         {
1898           memset (buf, 0, 4);
1899           offset = 4;
1900         }
1901
1902       for (i = SPARC_L0_REGNUM; i <= SPARC_I7_REGNUM; i++)
1903         {
1904           if (regnum == i || regnum == -1)
1905             {
1906               target_read_memory (sp + ((i - SPARC_L0_REGNUM) * 4),
1907                                   buf + offset, 4);
1908
1909               /* Handle StackGhost.  */
1910               if (i == SPARC_I7_REGNUM)
1911                 {
1912                   ULONGEST wcookie = sparc_fetch_wcookie (gdbarch);
1913                   ULONGEST i7;
1914
1915                   i7 = extract_unsigned_integer (buf + offset, 4, byte_order);
1916                   store_unsigned_integer (buf + offset, 4, byte_order,
1917                                           i7 ^ wcookie);
1918                 }
1919
1920               regcache_raw_supply (regcache, i, buf);
1921             }
1922         }
1923     }
1924 }
1925
1926 void
1927 sparc_collect_rwindow (const struct regcache *regcache,
1928                        CORE_ADDR sp, int regnum)
1929 {
1930   struct gdbarch *gdbarch = get_regcache_arch (regcache);
1931   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1932   int offset = 0;
1933   gdb_byte buf[8];
1934   int i;
1935
1936   if (sp & 1)
1937     {
1938       /* Registers are 64-bit.  */
1939       sp += BIAS;
1940
1941       for (i = SPARC_L0_REGNUM; i <= SPARC_I7_REGNUM; i++)
1942         {
1943           if (regnum == -1 || regnum == SPARC_SP_REGNUM || regnum == i)
1944             {
1945               regcache_raw_collect (regcache, i, buf);
1946
1947               /* Handle StackGhost.  */
1948               if (i == SPARC_I7_REGNUM)
1949                 {
1950                   ULONGEST wcookie = sparc_fetch_wcookie (gdbarch);
1951                   ULONGEST i7;
1952
1953                   i7 = extract_unsigned_integer (buf + offset, 8, byte_order);
1954                   store_unsigned_integer (buf, 8, byte_order, i7 ^ wcookie);
1955                 }
1956
1957               target_write_memory (sp + ((i - SPARC_L0_REGNUM) * 8), buf, 8);
1958             }
1959         }
1960     }
1961   else
1962     {
1963       /* Registers are 32-bit.  Toss any sign-extension of the stack
1964          pointer.  */
1965       sp &= 0xffffffffUL;
1966
1967       /* Only use the bottom half if we're in 64-bit mode.  */
1968       if (gdbarch_ptr_bit (get_regcache_arch (regcache)) == 64)
1969         offset = 4;
1970
1971       for (i = SPARC_L0_REGNUM; i <= SPARC_I7_REGNUM; i++)
1972         {
1973           if (regnum == -1 || regnum == SPARC_SP_REGNUM || regnum == i)
1974             {
1975               regcache_raw_collect (regcache, i, buf);
1976
1977               /* Handle StackGhost.  */
1978               if (i == SPARC_I7_REGNUM)
1979                 {
1980                   ULONGEST wcookie = sparc_fetch_wcookie (gdbarch);
1981                   ULONGEST i7;
1982
1983                   i7 = extract_unsigned_integer (buf + offset, 4, byte_order);
1984                   store_unsigned_integer (buf + offset, 4, byte_order,
1985                                           i7 ^ wcookie);
1986                 }
1987
1988               target_write_memory (sp + ((i - SPARC_L0_REGNUM) * 4),
1989                                    buf + offset, 4);
1990             }
1991         }
1992     }
1993 }
1994
1995 /* Helper functions for dealing with register sets.  */
1996
1997 void
1998 sparc32_supply_gregset (const struct sparc_gregmap *gregmap,
1999                         struct regcache *regcache,
2000                         int regnum, const void *gregs)
2001 {
2002   const gdb_byte *regs = (const gdb_byte *) gregs;
2003   gdb_byte zero[4] = { 0 };
2004   int i;
2005
2006   if (regnum == SPARC32_PSR_REGNUM || regnum == -1)
2007     regcache_raw_supply (regcache, SPARC32_PSR_REGNUM,
2008                          regs + gregmap->r_psr_offset);
2009
2010   if (regnum == SPARC32_PC_REGNUM || regnum == -1)
2011     regcache_raw_supply (regcache, SPARC32_PC_REGNUM,
2012                          regs + gregmap->r_pc_offset);
2013
2014   if (regnum == SPARC32_NPC_REGNUM || regnum == -1)
2015     regcache_raw_supply (regcache, SPARC32_NPC_REGNUM,
2016                          regs + gregmap->r_npc_offset);
2017
2018   if (regnum == SPARC32_Y_REGNUM || regnum == -1)
2019     regcache_raw_supply (regcache, SPARC32_Y_REGNUM,
2020                          regs + gregmap->r_y_offset);
2021
2022   if (regnum == SPARC_G0_REGNUM || regnum == -1)
2023     regcache_raw_supply (regcache, SPARC_G0_REGNUM, &zero);
2024
2025   if ((regnum >= SPARC_G1_REGNUM && regnum <= SPARC_O7_REGNUM) || regnum == -1)
2026     {
2027       int offset = gregmap->r_g1_offset;
2028
2029       for (i = SPARC_G1_REGNUM; i <= SPARC_O7_REGNUM; i++)
2030         {
2031           if (regnum == i || regnum == -1)
2032             regcache_raw_supply (regcache, i, regs + offset);
2033           offset += 4;
2034         }
2035     }
2036
2037   if ((regnum >= SPARC_L0_REGNUM && regnum <= SPARC_I7_REGNUM) || regnum == -1)
2038     {
2039       /* Not all of the register set variants include Locals and
2040          Inputs.  For those that don't, we read them off the stack.  */
2041       if (gregmap->r_l0_offset == -1)
2042         {
2043           ULONGEST sp;
2044
2045           regcache_cooked_read_unsigned (regcache, SPARC_SP_REGNUM, &sp);
2046           sparc_supply_rwindow (regcache, sp, regnum);
2047         }
2048       else
2049         {
2050           int offset = gregmap->r_l0_offset;
2051
2052           for (i = SPARC_L0_REGNUM; i <= SPARC_I7_REGNUM; i++)
2053             {
2054               if (regnum == i || regnum == -1)
2055                 regcache_raw_supply (regcache, i, regs + offset);
2056               offset += 4;
2057             }
2058         }
2059     }
2060 }
2061
2062 void
2063 sparc32_collect_gregset (const struct sparc_gregmap *gregmap,
2064                          const struct regcache *regcache,
2065                          int regnum, void *gregs)
2066 {
2067   gdb_byte *regs = (gdb_byte *) gregs;
2068   int i;
2069
2070   if (regnum == SPARC32_PSR_REGNUM || regnum == -1)
2071     regcache_raw_collect (regcache, SPARC32_PSR_REGNUM,
2072                           regs + gregmap->r_psr_offset);
2073
2074   if (regnum == SPARC32_PC_REGNUM || regnum == -1)
2075     regcache_raw_collect (regcache, SPARC32_PC_REGNUM,
2076                           regs + gregmap->r_pc_offset);
2077
2078   if (regnum == SPARC32_NPC_REGNUM || regnum == -1)
2079     regcache_raw_collect (regcache, SPARC32_NPC_REGNUM,
2080                           regs + gregmap->r_npc_offset);
2081
2082   if (regnum == SPARC32_Y_REGNUM || regnum == -1)
2083     regcache_raw_collect (regcache, SPARC32_Y_REGNUM,
2084                           regs + gregmap->r_y_offset);
2085
2086   if ((regnum >= SPARC_G1_REGNUM && regnum <= SPARC_O7_REGNUM) || regnum == -1)
2087     {
2088       int offset = gregmap->r_g1_offset;
2089
2090       /* %g0 is always zero.  */
2091       for (i = SPARC_G1_REGNUM; i <= SPARC_O7_REGNUM; i++)
2092         {
2093           if (regnum == i || regnum == -1)
2094             regcache_raw_collect (regcache, i, regs + offset);
2095           offset += 4;
2096         }
2097     }
2098
2099   if ((regnum >= SPARC_L0_REGNUM && regnum <= SPARC_I7_REGNUM) || regnum == -1)
2100     {
2101       /* Not all of the register set variants include Locals and
2102          Inputs.  For those that don't, we read them off the stack.  */
2103       if (gregmap->r_l0_offset != -1)
2104         {
2105           int offset = gregmap->r_l0_offset;
2106
2107           for (i = SPARC_L0_REGNUM; i <= SPARC_I7_REGNUM; i++)
2108             {
2109               if (regnum == i || regnum == -1)
2110                 regcache_raw_collect (regcache, i, regs + offset);
2111               offset += 4;
2112             }
2113         }
2114     }
2115 }
2116
2117 void
2118 sparc32_supply_fpregset (const struct sparc_fpregmap *fpregmap,
2119                          struct regcache *regcache,
2120                          int regnum, const void *fpregs)
2121 {
2122   const gdb_byte *regs = (const gdb_byte *) fpregs;
2123   int i;
2124
2125   for (i = 0; i < 32; i++)
2126     {
2127       if (regnum == (SPARC_F0_REGNUM + i) || regnum == -1)
2128         regcache_raw_supply (regcache, SPARC_F0_REGNUM + i,
2129                              regs + fpregmap->r_f0_offset + (i * 4));
2130     }
2131
2132   if (regnum == SPARC32_FSR_REGNUM || regnum == -1)
2133     regcache_raw_supply (regcache, SPARC32_FSR_REGNUM,
2134                          regs + fpregmap->r_fsr_offset);
2135 }
2136
2137 void
2138 sparc32_collect_fpregset (const struct sparc_fpregmap *fpregmap,
2139                           const struct regcache *regcache,
2140                           int regnum, void *fpregs)
2141 {
2142   gdb_byte *regs = (gdb_byte *) fpregs;
2143   int i;
2144
2145   for (i = 0; i < 32; i++)
2146     {
2147       if (regnum == (SPARC_F0_REGNUM + i) || regnum == -1)
2148         regcache_raw_collect (regcache, SPARC_F0_REGNUM + i,
2149                               regs + fpregmap->r_f0_offset + (i * 4));
2150     }
2151
2152   if (regnum == SPARC32_FSR_REGNUM || regnum == -1)
2153     regcache_raw_collect (regcache, SPARC32_FSR_REGNUM,
2154                           regs + fpregmap->r_fsr_offset);
2155 }
2156 \f
2157
2158 /* SunOS 4.  */
2159
2160 /* From <machine/reg.h>.  */
2161 const struct sparc_gregmap sparc32_sunos4_gregmap =
2162 {
2163   0 * 4,                        /* %psr */
2164   1 * 4,                        /* %pc */
2165   2 * 4,                        /* %npc */
2166   3 * 4,                        /* %y */
2167   -1,                           /* %wim */
2168   -1,                           /* %tbr */
2169   4 * 4,                        /* %g1 */
2170   -1                            /* %l0 */
2171 };
2172
2173 const struct sparc_fpregmap sparc32_sunos4_fpregmap =
2174 {
2175   0 * 4,                        /* %f0 */
2176   33 * 4,                       /* %fsr */
2177 };
2178
2179 const struct sparc_fpregmap sparc32_bsd_fpregmap =
2180 {
2181   0 * 4,                        /* %f0 */
2182   32 * 4,                       /* %fsr */
2183 };
2184 \f
2185
2186 /* Provide a prototype to silence -Wmissing-prototypes.  */
2187 void _initialize_sparc_tdep (void);
2188
2189 void
2190 _initialize_sparc_tdep (void)
2191 {
2192   register_gdbarch_init (bfd_arch_sparc, sparc32_gdbarch_init);
2193 }