2 * Copyright (c) 2007 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 * FILE_ID: thread_status.h
33 #ifndef _ARM_THREAD_STATUS_H_
34 #define _ARM_THREAD_STATUS_H_
36 #include <mach/machine/_structs.h>
37 #include <mach/message.h>
38 #include <mach/arm/thread_state.h>
41 * Support for determining the state of a thread
49 #define ARM_THREAD_STATE 1
50 #define ARM_UNIFIED_THREAD_STATE ARM_THREAD_STATE
51 #define ARM_VFP_STATE 2
52 #define ARM_EXCEPTION_STATE 3
53 #define ARM_DEBUG_STATE 4 /* pre-armv8 */
54 #define THREAD_STATE_NONE 5
55 #define ARM_THREAD_STATE64 6
56 #define ARM_EXCEPTION_STATE64 7
57 // ARM_THREAD_STATE_LAST (legacy) 8
58 #define ARM_THREAD_STATE32 9
61 #define ARM_DEBUG_STATE32 14
62 #define ARM_DEBUG_STATE64 15
63 #define ARM_NEON_STATE 16
64 #define ARM_NEON_STATE64 17
65 #define ARM_CPMU_STATE64 18
67 #ifdef XNU_KERNEL_PRIVATE
69 #define ARM_SAVED_STATE32 20
70 #define ARM_SAVED_STATE64 21
71 #define ARM_NEON_SAVED_STATE32 22
72 #define ARM_NEON_SAVED_STATE64 23
73 #endif /* XNU_KERNEL_PRIVATE */
75 #define VALID_THREAD_STATE_FLAVOR(x)\
76 ((x == ARM_THREAD_STATE) || \
77 (x == ARM_VFP_STATE) || \
78 (x == ARM_EXCEPTION_STATE) || \
79 (x == ARM_DEBUG_STATE) || \
80 (x == THREAD_STATE_NONE) || \
81 (x == ARM_THREAD_STATE32) || \
82 (x == ARM_THREAD_STATE64) || \
83 (x == ARM_EXCEPTION_STATE64) || \
84 (x == ARM_NEON_STATE) || \
85 (x == ARM_NEON_STATE64) || \
86 (x == ARM_DEBUG_STATE32) || \
87 (x == ARM_DEBUG_STATE64))
89 struct arm_state_hdr
{
93 typedef struct arm_state_hdr arm_state_hdr_t
;
95 typedef _STRUCT_ARM_THREAD_STATE arm_thread_state_t
;
96 typedef _STRUCT_ARM_THREAD_STATE arm_thread_state32_t
;
97 typedef _STRUCT_ARM_THREAD_STATE64 arm_thread_state64_t
;
99 struct arm_unified_thread_state
{
102 arm_thread_state32_t ts_32
;
103 arm_thread_state64_t ts_64
;
106 #define ts_32 uts.ts_32
107 #define ts_64 uts.ts_64
108 typedef struct arm_unified_thread_state arm_unified_thread_state_t
;
110 #define ARM_THREAD_STATE_COUNT ((mach_msg_type_number_t) \
111 (sizeof (arm_thread_state_t)/sizeof(uint32_t)))
112 #define ARM_THREAD_STATE32_COUNT ((mach_msg_type_number_t) \
113 (sizeof (arm_thread_state32_t)/sizeof(uint32_t)))
114 #define ARM_THREAD_STATE64_COUNT ((mach_msg_type_number_t) \
115 (sizeof (arm_thread_state64_t)/sizeof(uint32_t)))
116 #define ARM_UNIFIED_THREAD_STATE_COUNT ((mach_msg_type_number_t) \
117 (sizeof (arm_unified_thread_state_t)/sizeof(uint32_t)))
120 typedef _STRUCT_ARM_VFP_STATE arm_vfp_state_t
;
121 typedef _STRUCT_ARM_NEON_STATE arm_neon_state_t
;
122 typedef _STRUCT_ARM_NEON_STATE arm_neon_state32_t
;
123 typedef _STRUCT_ARM_NEON_STATE64 arm_neon_state64_t
;
125 typedef _STRUCT_ARM_EXCEPTION_STATE arm_exception_state_t
;
126 typedef _STRUCT_ARM_EXCEPTION_STATE arm_exception_state32_t
;
127 typedef _STRUCT_ARM_EXCEPTION_STATE64 arm_exception_state64_t
;
129 typedef _STRUCT_ARM_DEBUG_STATE32 arm_debug_state32_t
;
130 typedef _STRUCT_ARM_DEBUG_STATE64 arm_debug_state64_t
;
132 #if defined(XNU_KERNEL_PRIVATE) && defined(__arm64__)
133 /* See below for ARM64 kernel structure definition for arm_debug_state. */
136 * Otherwise not ARM64 kernel and we must preserve legacy ARM definitions of
137 * arm_debug_state for binary compatability of userland consumers of this file.
140 typedef _STRUCT_ARM_DEBUG_STATE arm_debug_state_t
;
141 #elif defined(__arm64__)
142 typedef _STRUCT_ARM_LEGACY_DEBUG_STATE arm_debug_state_t
;
144 #error Undefined architecture
148 #define ARM_VFP_STATE_COUNT ((mach_msg_type_number_t) \
149 (sizeof (arm_vfp_state_t)/sizeof(uint32_t)))
151 #define ARM_EXCEPTION_STATE_COUNT ((mach_msg_type_number_t) \
152 (sizeof (arm_exception_state_t)/sizeof(uint32_t)))
154 #define ARM_EXCEPTION_STATE64_COUNT ((mach_msg_type_number_t) \
155 (sizeof (arm_exception_state64_t)/sizeof(uint32_t)))
157 #define ARM_DEBUG_STATE_COUNT ((mach_msg_type_number_t) \
158 (sizeof (arm_debug_state_t)/sizeof(uint32_t)))
160 #define ARM_DEBUG_STATE32_COUNT ((mach_msg_type_number_t) \
161 (sizeof (arm_debug_state32_t)/sizeof(uint32_t)))
163 #define ARM_DEBUG_STATE64_COUNT ((mach_msg_type_number_t) \
164 (sizeof (arm_debug_state64_t)/sizeof(uint32_t)))
166 #define ARM_NEON_STATE_COUNT ((mach_msg_type_number_t) \
167 (sizeof (arm_neon_state_t)/sizeof(uint32_t)))
169 #define ARM_NEON_STATE64_COUNT ((mach_msg_type_number_t) \
170 (sizeof (arm_neon_state64_t)/sizeof(uint32_t)))
172 #define MACHINE_THREAD_STATE ARM_THREAD_STATE
173 #define MACHINE_THREAD_STATE_COUNT ARM_UNIFIED_THREAD_STATE_COUNT
176 * Largest state on this machine:
178 #define THREAD_MACHINE_STATE_MAX THREAD_STATE_MAX
180 #ifdef XNU_KERNEL_PRIVATE
182 static inline boolean_t
183 is_thread_state32(const arm_unified_thread_state_t
*its
)
185 return (its
->ash
.flavor
== ARM_THREAD_STATE32
);
188 static inline boolean_t
189 is_thread_state64(const arm_unified_thread_state_t
*its
)
191 return (its
->ash
.flavor
== ARM_THREAD_STATE64
);
194 static inline arm_thread_state32_t
*
195 thread_state32(arm_unified_thread_state_t
*its
)
200 static inline arm_thread_state64_t
*
201 thread_state64(arm_unified_thread_state_t
*its
)
206 static inline const arm_thread_state32_t
*
207 const_thread_state32(const arm_unified_thread_state_t
*its
)
212 static inline const arm_thread_state64_t
*
213 const_thread_state64(const arm_unified_thread_state_t
*its
)
219 #include <arm/proc_reg.h>
221 #define ARM_SAVED_STATE THREAD_STATE_NONE + 1
223 struct arm_saved_state
{
224 uint32_t r
[13]; /* General purpose register r0-r12 */
225 uint32_t sp
; /* Stack pointer r13 */
226 uint32_t lr
; /* Link register r14 */
227 uint32_t pc
; /* Program counter r15 */
228 uint32_t cpsr
; /* Current program status register */
229 uint32_t fsr
; /* Fault status */
230 uint32_t far
; /* Virtual Fault Address */
231 uint32_t exception
; /* exception number */
233 typedef struct arm_saved_state arm_saved_state_t
;
236 * Just for coexistence with AArch64 code.
238 typedef struct arm_saved_state arm_saved_state32_t
;
240 static inline arm_saved_state32_t
*
241 saved_state32(arm_saved_state_t
*iss
)
246 static inline boolean_t
247 is_saved_state32(const arm_saved_state_t
*iss __unused
)
253 struct arm_saved_state_tagged
{
255 struct arm_saved_state state
;
257 typedef struct arm_saved_state_tagged arm_saved_state_tagged_t
;
259 #define ARM_SAVED_STATE32_COUNT ((mach_msg_type_number_t) \
260 (sizeof (arm_saved_state_t)/sizeof(unsigned int)))
263 static inline register_t
264 get_saved_state_pc(const arm_saved_state_t
*iss
)
270 set_saved_state_pc(arm_saved_state_t
*iss
, register_t pc
)
275 static inline register_t
276 get_saved_state_sp(const arm_saved_state_t
*iss
)
282 set_saved_state_sp(arm_saved_state_t
*iss
, register_t sp
)
287 static inline register_t
288 get_saved_state_fp(const arm_saved_state_t
*iss
)
294 set_saved_state_fp(arm_saved_state_t
*iss
, register_t fp
)
299 static inline register_t
300 get_saved_state_lr(const arm_saved_state_t
*iss
)
306 set_saved_state_lr(arm_saved_state_t
*iss
, register_t lr
)
311 static inline register_t
312 get_saved_state_cpsr(const arm_saved_state_t
*iss
)
318 set_saved_state_cpsr(arm_saved_state_t
*iss
, register_t cpsr
)
323 static inline register_t
324 get_saved_state_reg(const arm_saved_state_t
*iss
, unsigned regno
)
326 return iss
->r
[regno
];
330 set_saved_state_reg(arm_saved_state_t
*iss
, unsigned regno
, register_t val
)
335 #elif defined(__arm64__)
337 #include <kern/assert.h>
338 #include <arm64/proc_reg.h>
339 #define CAST_ASSERT_SAFE(type, val) (assert((val) == ((type)(val))), (type)(val))
345 struct arm_saved_state32
{
346 uint32_t r
[13]; /* General purpose register r0-r12 */
347 uint32_t sp
; /* Stack pointer r13 */
348 uint32_t lr
; /* Link register r14 */
349 uint32_t pc
; /* Program counter r15 */
350 uint32_t cpsr
; /* Current program status register */
351 uint32_t far
; /* Virtual fault address */
352 uint32_t esr
; /* Exception syndrome register */
353 uint32_t exception
; /* Exception number */
355 typedef struct arm_saved_state32 arm_saved_state32_t
;
357 struct arm_saved_state32_tagged
{
359 struct arm_saved_state32 state
;
361 typedef struct arm_saved_state32_tagged arm_saved_state32_tagged_t
;
363 #define ARM_SAVED_STATE32_COUNT ((mach_msg_type_number_t) \
364 (sizeof (arm_saved_state32_t)/sizeof(unsigned int)))
366 struct arm_saved_state64
{
367 uint64_t x
[29]; /* General purpose registers x0-x28 */
368 uint64_t fp
; /* Frame pointer x29 */
369 uint64_t lr
; /* Link register x30 */
370 uint64_t sp
; /* Stack pointer x31 */
371 uint64_t pc
; /* Program counter */
372 uint32_t cpsr
; /* Current program status register */
373 uint32_t reserved
; /* Reserved padding */
374 uint64_t far
; /* Virtual fault address */
375 uint32_t esr
; /* Exception syndrome register */
376 uint32_t exception
; /* Exception number */
378 typedef struct arm_saved_state64 arm_saved_state64_t
;
380 #define ARM_SAVED_STATE64_COUNT ((mach_msg_type_number_t) \
381 (sizeof (arm_saved_state64_t)/sizeof(unsigned int)))
383 struct arm_saved_state64_tagged
{
385 struct arm_saved_state64 state
;
387 typedef struct arm_saved_state64_tagged arm_saved_state64_tagged_t
;
389 struct arm_saved_state
{
392 struct arm_saved_state32 ss_32
;
393 struct arm_saved_state64 ss_64
;
395 } __attribute__((aligned(16)));
396 #define ss_32 uss.ss_32
397 #define ss_64 uss.ss_64
399 typedef struct arm_saved_state arm_saved_state_t
;
402 static inline boolean_t
403 is_saved_state32(const arm_saved_state_t
*iss
)
405 return (iss
->ash
.flavor
== ARM_SAVED_STATE32
);
408 static inline boolean_t
409 is_saved_state64(const arm_saved_state_t
*iss
)
411 return (iss
->ash
.flavor
== ARM_SAVED_STATE64
);
414 static inline arm_saved_state32_t
*
415 saved_state32(arm_saved_state_t
*iss
)
420 static inline const arm_saved_state32_t
*
421 const_saved_state32(const arm_saved_state_t
*iss
)
426 static inline arm_saved_state64_t
*
427 saved_state64(arm_saved_state_t
*iss
)
432 static inline const arm_saved_state64_t
*
433 const_saved_state64(const arm_saved_state_t
*iss
)
438 static inline register_t
439 get_saved_state_pc(const arm_saved_state_t
*iss
)
441 return (is_saved_state32(iss
) ? const_saved_state32(iss
)->pc
: const_saved_state64(iss
)->pc
);
445 set_saved_state_pc(arm_saved_state_t
*iss
, register_t pc
)
447 if (is_saved_state32(iss
)) {
448 saved_state32(iss
)->pc
= CAST_ASSERT_SAFE(uint32_t, pc
);
450 saved_state64(iss
)->pc
= pc
;
454 static inline register_t
455 get_saved_state_sp(const arm_saved_state_t
*iss
)
457 return (is_saved_state32(iss
) ? const_saved_state32(iss
)->sp
: const_saved_state64(iss
)->sp
);
461 set_saved_state_sp(arm_saved_state_t
*iss
, register_t sp
)
463 if (is_saved_state32(iss
)) {
464 saved_state32(iss
)->sp
= CAST_ASSERT_SAFE(uint32_t, sp
);
466 saved_state64(iss
)->sp
= sp
;
470 static inline register_t
471 get_saved_state_lr(const arm_saved_state_t
*iss
)
473 return (is_saved_state32(iss
) ? const_saved_state32(iss
)->lr
: const_saved_state64(iss
)->lr
);
477 set_saved_state_lr(arm_saved_state_t
*iss
, register_t lr
)
479 if (is_saved_state32(iss
)) {
480 saved_state32(iss
)->lr
= CAST_ASSERT_SAFE(uint32_t, lr
);
482 saved_state64(iss
)->lr
= lr
;
486 static inline register_t
487 get_saved_state_fp(const arm_saved_state_t
*iss
)
489 return (is_saved_state32(iss
) ? const_saved_state32(iss
)->r
[7] : const_saved_state64(iss
)->fp
);
493 set_saved_state_fp(arm_saved_state_t
*iss
, register_t fp
)
495 if (is_saved_state32(iss
)) {
496 saved_state32(iss
)->r
[7] = CAST_ASSERT_SAFE(uint32_t, fp
);
498 saved_state64(iss
)->fp
= fp
;
503 check_saved_state_reglimit(const arm_saved_state_t
*iss
, unsigned reg
)
505 return (is_saved_state32(iss
) ? (reg
< ARM_SAVED_STATE32_COUNT
) : (reg
< ARM_SAVED_STATE64_COUNT
));
508 static inline register_t
509 get_saved_state_reg(const arm_saved_state_t
*iss
, unsigned reg
)
511 if (!check_saved_state_reglimit(iss
, reg
)) return 0;
513 return (is_saved_state32(iss
) ? (const_saved_state32(iss
)->r
[reg
]) : (const_saved_state64(iss
)->x
[reg
]));
517 set_saved_state_reg(arm_saved_state_t
*iss
, unsigned reg
, register_t value
)
519 if (!check_saved_state_reglimit(iss
, reg
)) return;
521 if (is_saved_state32(iss
)) {
522 saved_state32(iss
)->r
[reg
] = CAST_ASSERT_SAFE(uint32_t, value
);
524 saved_state64(iss
)->x
[reg
] = value
;
528 static inline uint32_t
529 get_saved_state_cpsr(const arm_saved_state_t
*iss
)
531 return (is_saved_state32(iss
) ? const_saved_state32(iss
)->cpsr
: const_saved_state64(iss
)->cpsr
);
535 set_saved_state_cpsr(arm_saved_state_t
*iss
, uint32_t cpsr
)
537 if (is_saved_state32(iss
)) {
538 saved_state32(iss
)->cpsr
= cpsr
;
540 saved_state64(iss
)->cpsr
= cpsr
;
544 static inline register_t
545 get_saved_state_far(const arm_saved_state_t
*iss
)
547 return (is_saved_state32(iss
) ? const_saved_state32(iss
)->far
: const_saved_state64(iss
)->far
);
551 set_saved_state_far(arm_saved_state_t
*iss
, register_t far
)
553 if (is_saved_state32(iss
)) {
554 saved_state32(iss
)->far
= CAST_ASSERT_SAFE(uint32_t, far
);
556 saved_state64(iss
)->far
= far
;
560 static inline uint32_t
561 get_saved_state_esr(const arm_saved_state_t
*iss
)
563 return (is_saved_state32(iss
) ? const_saved_state32(iss
)->esr
: const_saved_state64(iss
)->esr
);
567 set_saved_state_esr(arm_saved_state_t
*iss
, uint32_t esr
)
569 if (is_saved_state32(iss
)) {
570 saved_state32(iss
)->esr
= esr
;
572 saved_state64(iss
)->esr
= esr
;
576 static inline uint32_t
577 get_saved_state_exc(const arm_saved_state_t
*iss
)
579 return (is_saved_state32(iss
) ? const_saved_state32(iss
)->exception
: const_saved_state64(iss
)->exception
);
583 set_saved_state_exc(arm_saved_state_t
*iss
, uint32_t exc
)
585 if (is_saved_state32(iss
)) {
586 saved_state32(iss
)->exception
= exc
;
588 saved_state64(iss
)->exception
= exc
;
592 extern void panic_unimplemented(void);
595 get_saved_state_svc_number(const arm_saved_state_t
*iss
)
597 return (is_saved_state32(iss
) ? (int)const_saved_state32(iss
)->r
[12] : (int)const_saved_state64(iss
)->x
[ARM64_SYSCALL_CODE_REG_NUM
]); /* Only first word counts here */
600 typedef _STRUCT_ARM_LEGACY_DEBUG_STATE arm_legacy_debug_state_t
;
602 struct arm_debug_aggregate_state
{
605 arm_debug_state32_t ds32
;
606 arm_debug_state64_t ds64
;
608 } __attribute__((aligned(16)));
610 typedef struct arm_debug_aggregate_state arm_debug_state_t
;
612 #define ARM_LEGACY_DEBUG_STATE_COUNT ((mach_msg_type_number_t) \
613 (sizeof (arm_legacy_debug_state_t)/sizeof(uint32_t)))
618 typedef __uint128_t uint128_t
;
619 typedef uint64_t uint64x2_t
__attribute__((ext_vector_type(2)));
620 typedef uint32_t uint32x4_t
__attribute__((ext_vector_type(4)));
622 struct arm_neon_saved_state32
{
631 typedef struct arm_neon_saved_state32 arm_neon_saved_state32_t
;
633 #define ARM_NEON_SAVED_STATE32_COUNT ((mach_msg_type_number_t) \
634 (sizeof (arm_neon_saved_state32_t)/sizeof(unsigned int)))
636 struct arm_neon_saved_state64
{
645 typedef struct arm_neon_saved_state64 arm_neon_saved_state64_t
;
647 #define ARM_NEON_SAVED_STATE64_COUNT ((mach_msg_type_number_t) \
648 (sizeof (arm_neon_saved_state64_t)/sizeof(unsigned int)))
650 struct arm_neon_saved_state
{
653 struct arm_neon_saved_state32 ns_32
;
654 struct arm_neon_saved_state64 ns_64
;
657 typedef struct arm_neon_saved_state arm_neon_saved_state_t
;
658 #define ns_32 uns.ns_32
659 #define ns_64 uns.ns_64
661 static inline boolean_t
662 is_neon_saved_state32(const arm_neon_saved_state_t
*state
)
664 return (state
->nsh
.flavor
== ARM_NEON_SAVED_STATE32
);
667 static inline boolean_t
668 is_neon_saved_state64(const arm_neon_saved_state_t
*state
)
670 return (state
->nsh
.flavor
== ARM_NEON_SAVED_STATE64
);
673 static inline arm_neon_saved_state32_t
*
674 neon_state32(arm_neon_saved_state_t
*state
)
676 return &state
->ns_32
;
679 static inline arm_neon_saved_state64_t
*
680 neon_state64(arm_neon_saved_state_t
*state
)
682 return &state
->ns_64
;
691 struct arm_saved_state ss
;
692 struct arm_neon_saved_state ns
;
694 typedef struct arm_context arm_context_t
;
696 extern void saved_state_to_thread_state64(const arm_saved_state_t
*, arm_thread_state64_t
*);
697 extern void thread_state64_to_saved_state(const arm_thread_state64_t
*, arm_saved_state_t
*);
703 extern void saved_state_to_thread_state32(const arm_saved_state_t
*, arm_thread_state32_t
*);
704 extern void thread_state32_to_saved_state(const arm_thread_state32_t
*, arm_saved_state_t
*);
706 #endif /* XNU_KERNEL_PRIVATE */
708 #endif /* _ARM_THREAD_STATUS_H_ */