1 /* cpustate.h -- Prototypes for AArch64 simulator functions.
3 Copyright (C) 2015-2024 Free Software Foundation, Inc.
5 Contributed by Red Hat.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 /* This must come before any other includes. */
29 #include "sim-signal.h"
31 #include "simulator.h"
32 #include "libiberty.h"
34 #include "aarch64-sim.h"
36 /* Some operands are allowed to access the stack pointer (reg 31).
37 For others a read from r31 always returns 0, and a write to r31 is ignored. */
38 #define reg_num(reg) (((reg) == R31 && !r31_is_sp) ? 32 : (reg))
41 aarch64_set_reg_u64 (sim_cpu
*cpu
, GReg reg
, int r31_is_sp
, uint64_t val
)
43 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
45 if (reg
== R31
&& ! r31_is_sp
)
47 TRACE_REGISTER (cpu
, "GR[31] NOT CHANGED!");
51 if (val
!= aarch64_cpu
->gr
[reg
].u64
)
53 "GR[%2d] changes from %16" PRIx64
" to %16" PRIx64
,
54 reg
, aarch64_cpu
->gr
[reg
].u64
, val
);
56 aarch64_cpu
->gr
[reg
].u64
= val
;
60 aarch64_set_reg_s64 (sim_cpu
*cpu
, GReg reg
, int r31_is_sp
, int64_t val
)
62 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
64 if (reg
== R31
&& ! r31_is_sp
)
66 TRACE_REGISTER (cpu
, "GR[31] NOT CHANGED!");
70 if (val
!= aarch64_cpu
->gr
[reg
].s64
)
72 "GR[%2d] changes from %16" PRIx64
" to %16" PRIx64
,
73 reg
, aarch64_cpu
->gr
[reg
].s64
, val
);
75 aarch64_cpu
->gr
[reg
].s64
= val
;
79 aarch64_get_reg_u64 (sim_cpu
*cpu
, GReg reg
, int r31_is_sp
)
81 return AARCH64_SIM_CPU (cpu
)->gr
[reg_num(reg
)].u64
;
85 aarch64_get_reg_s64 (sim_cpu
*cpu
, GReg reg
, int r31_is_sp
)
87 return AARCH64_SIM_CPU (cpu
)->gr
[reg_num(reg
)].s64
;
91 aarch64_get_reg_u32 (sim_cpu
*cpu
, GReg reg
, int r31_is_sp
)
93 return AARCH64_SIM_CPU (cpu
)->gr
[reg_num(reg
)].u32
;
97 aarch64_get_reg_s32 (sim_cpu
*cpu
, GReg reg
, int r31_is_sp
)
99 return AARCH64_SIM_CPU (cpu
)->gr
[reg_num(reg
)].s32
;
103 aarch64_set_reg_s32 (sim_cpu
*cpu
, GReg reg
, int r31_is_sp
, int32_t val
)
105 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
107 if (reg
== R31
&& ! r31_is_sp
)
109 TRACE_REGISTER (cpu
, "GR[31] NOT CHANGED!");
113 if (val
!= aarch64_cpu
->gr
[reg
].s32
)
114 TRACE_REGISTER (cpu
, "GR[%2d] changes from %8x to %8x",
115 reg
, aarch64_cpu
->gr
[reg
].s32
, val
);
117 /* The ARM ARM states that (C1.2.4):
118 When the data size is 32 bits, the lower 32 bits of the
119 register are used and the upper 32 bits are ignored on
120 a read and cleared to zero on a write.
121 We simulate this by first clearing the whole 64-bits and
122 then writing to the 32-bit value in the GRegister union. */
123 aarch64_cpu
->gr
[reg
].s64
= 0;
124 aarch64_cpu
->gr
[reg
].s32
= val
;
128 aarch64_set_reg_u32 (sim_cpu
*cpu
, GReg reg
, int r31_is_sp
, uint32_t val
)
130 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
132 if (reg
== R31
&& ! r31_is_sp
)
134 TRACE_REGISTER (cpu
, "GR[31] NOT CHANGED!");
138 if (val
!= aarch64_cpu
->gr
[reg
].u32
)
139 TRACE_REGISTER (cpu
, "GR[%2d] changes from %8x to %8x",
140 reg
, aarch64_cpu
->gr
[reg
].u32
, val
);
142 aarch64_cpu
->gr
[reg
].u64
= 0;
143 aarch64_cpu
->gr
[reg
].u32
= val
;
147 aarch64_get_reg_u16 (sim_cpu
*cpu
, GReg reg
, int r31_is_sp
)
149 return AARCH64_SIM_CPU (cpu
)->gr
[reg_num(reg
)].u16
;
153 aarch64_get_reg_s16 (sim_cpu
*cpu
, GReg reg
, int r31_is_sp
)
155 return AARCH64_SIM_CPU (cpu
)->gr
[reg_num(reg
)].s16
;
159 aarch64_get_reg_u8 (sim_cpu
*cpu
, GReg reg
, int r31_is_sp
)
161 return AARCH64_SIM_CPU (cpu
)->gr
[reg_num(reg
)].u8
;
165 aarch64_get_reg_s8 (sim_cpu
*cpu
, GReg reg
, int r31_is_sp
)
167 return AARCH64_SIM_CPU (cpu
)->gr
[reg_num(reg
)].s8
;
171 aarch64_get_PC (sim_cpu
*cpu
)
173 return AARCH64_SIM_CPU (cpu
)->pc
;
177 aarch64_get_next_PC (sim_cpu
*cpu
)
179 return AARCH64_SIM_CPU (cpu
)->nextpc
;
183 aarch64_set_next_PC (sim_cpu
*cpu
, uint64_t next
)
185 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
187 if (next
!= aarch64_cpu
->nextpc
+ 4)
189 "NextPC changes from %16" PRIx64
" to %16" PRIx64
,
190 aarch64_cpu
->nextpc
, next
);
192 aarch64_cpu
->nextpc
= next
;
196 aarch64_set_next_PC_by_offset (sim_cpu
*cpu
, int64_t offset
)
198 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
200 if (aarch64_cpu
->pc
+ offset
!= aarch64_cpu
->nextpc
+ 4)
202 "NextPC changes from %16" PRIx64
" to %16" PRIx64
,
203 aarch64_cpu
->nextpc
, aarch64_cpu
->pc
+ offset
);
205 aarch64_cpu
->nextpc
= aarch64_cpu
->pc
+ offset
;
208 /* Install nextpc as current pc. */
210 aarch64_update_PC (sim_cpu
*cpu
)
212 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
214 aarch64_cpu
->pc
= aarch64_cpu
->nextpc
;
215 /* Rezero the register we hand out when asked for ZR just in case it
216 was used as the destination for a write by the previous
218 aarch64_cpu
->gr
[32].u64
= 0UL;
221 /* This instruction can be used to save the next PC to LR
222 just before installing a branch PC. */
224 aarch64_save_LR (sim_cpu
*cpu
)
226 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
228 if (aarch64_cpu
->gr
[LR
].u64
!= aarch64_cpu
->nextpc
)
230 "LR changes from %16" PRIx64
" to %16" PRIx64
,
231 aarch64_cpu
->gr
[LR
].u64
, aarch64_cpu
->nextpc
);
233 aarch64_cpu
->gr
[LR
].u64
= aarch64_cpu
->nextpc
;
237 decode_cpsr (FlagMask flags
)
239 switch (flags
& CPSR_ALL_FLAGS
)
242 case 0: return "----";
243 case 1: return "---V";
244 case 2: return "--C-";
245 case 3: return "--CV";
246 case 4: return "-Z--";
247 case 5: return "-Z-V";
248 case 6: return "-ZC-";
249 case 7: return "-ZCV";
250 case 8: return "N---";
251 case 9: return "N--V";
252 case 10: return "N-C-";
253 case 11: return "N-CV";
254 case 12: return "NZ--";
255 case 13: return "NZ-V";
256 case 14: return "NZC-";
257 case 15: return "NZCV";
261 /* Retrieve the CPSR register as an int. */
263 aarch64_get_CPSR (sim_cpu
*cpu
)
265 return AARCH64_SIM_CPU (cpu
)->CPSR
;
268 /* Set the CPSR register as an int. */
270 aarch64_set_CPSR (sim_cpu
*cpu
, uint32_t new_flags
)
272 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
274 if (TRACE_REGISTER_P (cpu
))
276 if (aarch64_cpu
->CPSR
!= new_flags
)
278 "CPSR changes from %s to %s",
279 decode_cpsr (aarch64_cpu
->CPSR
), decode_cpsr (new_flags
));
282 "CPSR stays at %s", decode_cpsr (aarch64_cpu
->CPSR
));
285 aarch64_cpu
->CPSR
= new_flags
& CPSR_ALL_FLAGS
;
288 /* Read a specific subset of the CPSR as a bit pattern. */
290 aarch64_get_CPSR_bits (sim_cpu
*cpu
, FlagMask mask
)
292 return AARCH64_SIM_CPU (cpu
)->CPSR
& mask
;
295 /* Assign a specific subset of the CPSR as a bit pattern. */
297 aarch64_set_CPSR_bits (sim_cpu
*cpu
, uint32_t mask
, uint32_t value
)
299 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
300 uint32_t old_flags
= aarch64_cpu
->CPSR
;
302 mask
&= CPSR_ALL_FLAGS
;
303 aarch64_cpu
->CPSR
&= ~ mask
;
304 aarch64_cpu
->CPSR
|= (value
& mask
);
306 if (old_flags
!= aarch64_cpu
->CPSR
)
308 "CPSR changes from %s to %s",
309 decode_cpsr (old_flags
), decode_cpsr (aarch64_cpu
->CPSR
));
312 /* Test the value of a single CPSR returned as non-zero or zero. */
314 aarch64_test_CPSR_bit (sim_cpu
*cpu
, FlagMask bit
)
316 return AARCH64_SIM_CPU (cpu
)->CPSR
& bit
;
319 /* Set a single flag in the CPSR. */
321 aarch64_set_CPSR_bit (sim_cpu
*cpu
, FlagMask bit
)
323 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
324 uint32_t old_flags
= aarch64_cpu
->CPSR
;
326 aarch64_cpu
->CPSR
|= (bit
& CPSR_ALL_FLAGS
);
328 if (old_flags
!= aarch64_cpu
->CPSR
)
330 "CPSR changes from %s to %s",
331 decode_cpsr (old_flags
), decode_cpsr (aarch64_cpu
->CPSR
));
334 /* Clear a single flag in the CPSR. */
336 aarch64_clear_CPSR_bit (sim_cpu
*cpu
, FlagMask bit
)
338 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
339 uint32_t old_flags
= aarch64_cpu
->CPSR
;
341 aarch64_cpu
->CPSR
&= ~(bit
& CPSR_ALL_FLAGS
);
343 if (old_flags
!= aarch64_cpu
->CPSR
)
345 "CPSR changes from %s to %s",
346 decode_cpsr (old_flags
), decode_cpsr (aarch64_cpu
->CPSR
));
350 aarch64_get_FP_half (sim_cpu
*cpu
, VReg reg
)
352 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
360 u
.h
[1] = aarch64_cpu
->fr
[reg
].h
[0];
366 aarch64_get_FP_float (sim_cpu
*cpu
, VReg reg
)
368 return AARCH64_SIM_CPU (cpu
)->fr
[reg
].s
;
372 aarch64_get_FP_double (sim_cpu
*cpu
, VReg reg
)
374 return AARCH64_SIM_CPU (cpu
)->fr
[reg
].d
;
378 aarch64_get_FP_long_double (sim_cpu
*cpu
, VReg reg
, FRegister
*a
)
380 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
382 a
->v
[0] = aarch64_cpu
->fr
[reg
].v
[0];
383 a
->v
[1] = aarch64_cpu
->fr
[reg
].v
[1];
387 aarch64_set_FP_half (sim_cpu
*cpu
, VReg reg
, float val
)
389 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
397 aarch64_cpu
->fr
[reg
].h
[0] = u
.h
[1];
398 aarch64_cpu
->fr
[reg
].h
[1] = 0;
403 aarch64_set_FP_float (sim_cpu
*cpu
, VReg reg
, float val
)
405 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
407 if (val
!= aarch64_cpu
->fr
[reg
].s
408 /* Handle +/- zero. */
409 || signbit (val
) != signbit (aarch64_cpu
->fr
[reg
].s
))
415 "FR[%d].s changes from %f to %f [hex: %0" PRIx64
"]",
416 reg
, aarch64_cpu
->fr
[reg
].s
, val
, v
.v
[0]);
419 aarch64_cpu
->fr
[reg
].s
= val
;
423 aarch64_set_FP_double (sim_cpu
*cpu
, VReg reg
, double val
)
425 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
427 if (val
!= aarch64_cpu
->fr
[reg
].d
428 /* Handle +/- zero. */
429 || signbit (val
) != signbit (aarch64_cpu
->fr
[reg
].d
))
435 "FR[%d].d changes from %f to %f [hex: %0" PRIx64
"]",
436 reg
, aarch64_cpu
->fr
[reg
].d
, val
, v
.v
[0]);
438 aarch64_cpu
->fr
[reg
].d
= val
;
442 aarch64_set_FP_long_double (sim_cpu
*cpu
, VReg reg
, FRegister a
)
444 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
446 if (aarch64_cpu
->fr
[reg
].v
[0] != a
.v
[0]
447 || aarch64_cpu
->fr
[reg
].v
[1] != a
.v
[1])
449 "FR[%d].q changes from [%0" PRIx64
" %0" PRIx64
"] to [%0"
450 PRIx64
" %0" PRIx64
"] ",
452 aarch64_cpu
->fr
[reg
].v
[0], aarch64_cpu
->fr
[reg
].v
[1],
455 aarch64_cpu
->fr
[reg
].v
[0] = a
.v
[0];
456 aarch64_cpu
->fr
[reg
].v
[1] = a
.v
[1];
459 #define GET_VEC_ELEMENT(REG, ELEMENT, FIELD) \
462 struct aarch64_sim_cpu *aarch64_cpu = AARCH64_SIM_CPU (cpu); \
464 if (ELEMENT >= ARRAY_SIZE (aarch64_cpu->fr[0].FIELD)) \
466 TRACE_REGISTER (cpu, \
467 "Internal SIM error: invalid element number: %d ",\
469 sim_engine_halt (CPU_STATE (cpu), cpu, NULL, aarch64_get_PC (cpu), \
470 sim_stopped, SIM_SIGBUS); \
472 return aarch64_cpu->fr[REG].FIELD [ELEMENT]; \
477 aarch64_get_vec_u64 (sim_cpu
*cpu
, VReg reg
, unsigned element
)
479 GET_VEC_ELEMENT (reg
, element
, v
);
483 aarch64_get_vec_u32 (sim_cpu
*cpu
, VReg reg
, unsigned element
)
485 GET_VEC_ELEMENT (reg
, element
, w
);
489 aarch64_get_vec_u16 (sim_cpu
*cpu
, VReg reg
, unsigned element
)
491 GET_VEC_ELEMENT (reg
, element
, h
);
495 aarch64_get_vec_u8 (sim_cpu
*cpu
, VReg reg
, unsigned element
)
497 GET_VEC_ELEMENT (reg
, element
, b
);
501 aarch64_get_vec_s64 (sim_cpu
*cpu
, VReg reg
, unsigned element
)
503 GET_VEC_ELEMENT (reg
, element
, V
);
507 aarch64_get_vec_s32 (sim_cpu
*cpu
, VReg reg
, unsigned element
)
509 GET_VEC_ELEMENT (reg
, element
, W
);
513 aarch64_get_vec_s16 (sim_cpu
*cpu
, VReg reg
, unsigned element
)
515 GET_VEC_ELEMENT (reg
, element
, H
);
519 aarch64_get_vec_s8 (sim_cpu
*cpu
, VReg reg
, unsigned element
)
521 GET_VEC_ELEMENT (reg
, element
, B
);
525 aarch64_get_vec_float (sim_cpu
*cpu
, VReg reg
, unsigned element
)
527 GET_VEC_ELEMENT (reg
, element
, S
);
531 aarch64_get_vec_double (sim_cpu
*cpu
, VReg reg
, unsigned element
)
533 GET_VEC_ELEMENT (reg
, element
, D
);
537 #define SET_VEC_ELEMENT(REG, ELEMENT, VAL, FIELD, PRINTER) \
540 struct aarch64_sim_cpu *aarch64_cpu = AARCH64_SIM_CPU (cpu); \
542 if (ELEMENT >= ARRAY_SIZE (aarch64_cpu->fr[0].FIELD)) \
544 TRACE_REGISTER (cpu, \
545 "Internal SIM error: invalid element number: %d ",\
547 sim_engine_halt (CPU_STATE (cpu), cpu, NULL, aarch64_get_PC (cpu), \
548 sim_stopped, SIM_SIGBUS); \
550 if (VAL != aarch64_cpu->fr[REG].FIELD [ELEMENT]) \
551 TRACE_REGISTER (cpu, \
552 "VR[%2d]." #FIELD " [%d] changes from " PRINTER \
553 " to " PRINTER , REG, \
554 ELEMENT, aarch64_cpu->fr[REG].FIELD [ELEMENT], VAL); \
556 aarch64_cpu->fr[REG].FIELD [ELEMENT] = VAL; \
561 aarch64_set_vec_u64 (sim_cpu
*cpu
, VReg reg
, unsigned element
, uint64_t val
)
563 SET_VEC_ELEMENT (reg
, element
, val
, v
, "%16" PRIx64
);
567 aarch64_set_vec_u32 (sim_cpu
*cpu
, VReg reg
, unsigned element
, uint32_t val
)
569 SET_VEC_ELEMENT (reg
, element
, val
, w
, "%8x");
573 aarch64_set_vec_u16 (sim_cpu
*cpu
, VReg reg
, unsigned element
, uint16_t val
)
575 SET_VEC_ELEMENT (reg
, element
, val
, h
, "%4x");
579 aarch64_set_vec_u8 (sim_cpu
*cpu
, VReg reg
, unsigned element
, uint8_t val
)
581 SET_VEC_ELEMENT (reg
, element
, val
, b
, "%x");
585 aarch64_set_vec_s64 (sim_cpu
*cpu
, VReg reg
, unsigned element
, int64_t val
)
587 SET_VEC_ELEMENT (reg
, element
, val
, V
, "%16" PRIx64
);
591 aarch64_set_vec_s32 (sim_cpu
*cpu
, VReg reg
, unsigned element
, int32_t val
)
593 SET_VEC_ELEMENT (reg
, element
, val
, W
, "%8x");
597 aarch64_set_vec_s16 (sim_cpu
*cpu
, VReg reg
, unsigned element
, int16_t val
)
599 SET_VEC_ELEMENT (reg
, element
, val
, H
, "%4x");
603 aarch64_set_vec_s8 (sim_cpu
*cpu
, VReg reg
, unsigned element
, int8_t val
)
605 SET_VEC_ELEMENT (reg
, element
, val
, B
, "%x");
609 aarch64_set_vec_float (sim_cpu
*cpu
, VReg reg
, unsigned element
, float val
)
611 SET_VEC_ELEMENT (reg
, element
, val
, S
, "%f");
615 aarch64_set_vec_double (sim_cpu
*cpu
, VReg reg
, unsigned element
, double val
)
617 SET_VEC_ELEMENT (reg
, element
, val
, D
, "%f");
621 aarch64_set_FPSR (sim_cpu
*cpu
, uint32_t value
)
623 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
625 if (aarch64_cpu
->FPSR
!= value
)
627 "FPSR changes from %x to %x", aarch64_cpu
->FPSR
, value
);
629 aarch64_cpu
->FPSR
= value
& FPSR_ALL_FPSRS
;
633 aarch64_get_FPSR (sim_cpu
*cpu
)
635 return AARCH64_SIM_CPU (cpu
)->FPSR
;
639 aarch64_set_FPSR_bits (sim_cpu
*cpu
, uint32_t mask
, uint32_t value
)
641 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
642 uint32_t old_FPSR
= aarch64_cpu
->FPSR
;
644 mask
&= FPSR_ALL_FPSRS
;
645 aarch64_cpu
->FPSR
&= ~mask
;
646 aarch64_cpu
->FPSR
|= (value
& mask
);
648 if (aarch64_cpu
->FPSR
!= old_FPSR
)
650 "FPSR changes from %x to %x", old_FPSR
, aarch64_cpu
->FPSR
);
654 aarch64_get_FPSR_bits (sim_cpu
*cpu
, uint32_t mask
)
656 mask
&= FPSR_ALL_FPSRS
;
657 return AARCH64_SIM_CPU (cpu
)->FPSR
& mask
;
661 aarch64_test_FPSR_bit (sim_cpu
*cpu
, FPSRMask flag
)
663 return AARCH64_SIM_CPU (cpu
)->FPSR
& flag
;
667 aarch64_get_thread_id (sim_cpu
*cpu
)
669 return AARCH64_SIM_CPU (cpu
)->tpidr
;
673 aarch64_get_FPCR (sim_cpu
*cpu
)
675 return AARCH64_SIM_CPU (cpu
)->FPCR
;
679 aarch64_set_FPCR (sim_cpu
*cpu
, uint32_t val
)
681 struct aarch64_sim_cpu
*aarch64_cpu
= AARCH64_SIM_CPU (cpu
);
683 if (aarch64_cpu
->FPCR
!= val
)
685 "FPCR changes from %x to %x", aarch64_cpu
->FPCR
, val
);
686 aarch64_cpu
->FPCR
= val
;