[apple/xnu.git] / osfmk / arm64 / exception_asm.h

/*
 * Copyright (c) 2018 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

#ifndef _PEXPERT_ARM_BOARD_CONFIG_H
#include <pexpert/arm64/board_config.h>
#endif

#if XNU_MONITOR
/* Exit path defines; for controlling PPL -> kernel transitions. */
#define PPL_EXIT_DISPATCH   0 /* This is a clean exit after a PPL request. */
#define PPL_EXIT_PANIC_CALL 1 /* The PPL has called panic. */
#define PPL_EXIT_BAD_CALL   2 /* The PPL request failed. */
#define PPL_EXIT_EXCEPTION  3 /* The PPL took an exception. */

#define KERNEL_MODE_ELR      ELR_GL11
#define KERNEL_MODE_FAR      FAR_GL11
#define KERNEL_MODE_ESR      ESR_GL11
#define KERNEL_MODE_SPSR     SPSR_GL11
#define KERNEL_MODE_ASPSR    ASPSR_GL11
#define KERNEL_MODE_VBAR     VBAR_GL11
#define KERNEL_MODE_TPIDR    TPIDR_GL11

#define GUARDED_MODE_ELR     ELR_EL1
#define GUARDED_MODE_FAR     FAR_EL1
#define GUARDED_MODE_ESR     ESR_EL1
#define GUARDED_MODE_SPSR    SPSR_EL1
#define GUARDED_MODE_ASPSR   ASPSR_EL1
#define GUARDED_MODE_VBAR    VBAR_EL1
#define GUARDED_MODE_TPIDR   TPIDR_EL1

/*
 * GET_PMAP_CPU_DATA
 *
 * Retrieves the PPL per-CPU data for the current CPU.
 *   arg0 - Address of the PPL per-CPU data is returned through this
 *   arg1 - Scratch register
 *   arg2 - Scratch register
 *
 */
.macro GET_PMAP_CPU_DATA
/* Get the CPU ID. */
mrs		$0, MPIDR_EL1
#ifdef CPU_CLUSTER_OFFSETS
ubfx		$1, $0, MPIDR_AFF1_SHIFT, MPIDR_AFF1_WIDTH
cmp		$1, __ARM_CLUSTER_COUNT__
b.hs	.
adrp	$2, EXT(pmap_cluster_offsets)@page
add		$2, $2, EXT(pmap_cluster_offsets)@pageoff
ldr		$1, [$2, $1, lsl #3]
and		$0, $0, MPIDR_AFF0_MASK
add		$0, $0, $1
#else
and		$0, $0, MPIDR_AFF0_MASK
#endif

/* Get the PPL CPU data array. */
adrp	$1, EXT(pmap_cpu_data_array)@page
add		$1, $1, EXT(pmap_cpu_data_array)@pageoff

/*
 * Sanity check the CPU ID (this is not a panic because this pertains to
 * the hardware configuration; this should only fail if our
 * understanding of the hardware is incorrect).
 */
cmp		$0, MAX_CPUS
b.hs	.

mov		$2, PMAP_CPU_DATA_ARRAY_ENTRY_SIZE
/* Get the PPL per-CPU data. */
madd	$0, $0, $2, $1
.endmacro
#endif /* XNU_MONITOR */

/*
 * INIT_SAVED_STATE_FLAVORS
 *
 * Initializes the saved state flavors of a new saved state structure
 *  arg0 - saved state pointer
 *  arg1 - 32-bit scratch reg
 *  arg2 - 32-bit scratch reg
 */
.macro INIT_SAVED_STATE_FLAVORS
mov		$1, ARM_SAVED_STATE64                                   // Set saved state to 64-bit flavor
mov		$2, ARM_SAVED_STATE64_COUNT
stp		$1, $2, [$0, SS_FLAVOR]
mov		$1, ARM_NEON_SAVED_STATE64                              // Set neon state to 64-bit flavor
str		$1, [$0, NS_FLAVOR]
mov		$1, ARM_NEON_SAVED_STATE64_COUNT
str		$1, [$0, NS_COUNT]
.endmacro

/*
 * SPILL_REGISTERS
 *
 * Spills the current set of registers (excluding x0, x1, sp, fp) to the specified
 * save area.
 *   x0 - Address of the save area
 */

.macro SPILL_REGISTERS
stp		x2, x3, [x0, SS64_X2]                                   // Save remaining GPRs
stp		x4, x5, [x0, SS64_X4]
stp		x6, x7, [x0, SS64_X6]
stp		x8, x9, [x0, SS64_X8]
stp		x10, x11, [x0, SS64_X10]
stp		x12, x13, [x0, SS64_X12]
stp		x14, x15, [x0, SS64_X14]
stp		x16, x17, [x0, SS64_X16]
stp		x18, x19, [x0, SS64_X18]
stp		x20, x21, [x0, SS64_X20]
stp		x22, x23, [x0, SS64_X22]
stp		x24, x25, [x0, SS64_X24]
stp		x26, x27, [x0, SS64_X26]
str		x28, [x0, SS64_X28]

/* Save arm_neon_saved_state64 */

stp		q0, q1, [x0, NS64_Q0]
stp		q2, q3, [x0, NS64_Q2]
stp		q4, q5, [x0, NS64_Q4]
stp		q6, q7, [x0, NS64_Q6]
stp		q8, q9, [x0, NS64_Q8]
stp		q10, q11, [x0, NS64_Q10]
stp		q12, q13, [x0, NS64_Q12]
stp		q14, q15, [x0, NS64_Q14]
stp		q16, q17, [x0, NS64_Q16]
stp		q18, q19, [x0, NS64_Q18]
stp		q20, q21, [x0, NS64_Q20]
stp		q22, q23, [x0, NS64_Q22]
stp		q24, q25, [x0, NS64_Q24]
stp		q26, q27, [x0, NS64_Q26]
stp		q28, q29, [x0, NS64_Q28]
stp		q30, q31, [x0, NS64_Q30]

mrs		lr, ELR_EL1                                                     // Get exception link register
mrs		x23, SPSR_EL1                                                   // Load CPSR into var reg x23
mrs		x24, FPSR
mrs		x25, FPCR

#if defined(HAS_APPLE_PAC)
/* Save x1 and LR to preserve across call */
mov		x21, x1
mov		x20, lr

/*
 * Create thread state signature
 *
 * Arg0: The ARM context pointer
 * Arg1: The PC value to sign
 * Arg2: The CPSR value to sign
 * Arg3: The LR value to sign
 * Arg4: The X16 value to sign
 * Arg5: The X17 value to sign
 */
mov		x1, lr
mov		w2, w23
ldr		x3, [x0, SS64_LR]
mov		x4, x16
mov		x5, x17
bl		_ml_sign_thread_state

mov		lr, x20
mov		x1, x21
#endif /* defined(HAS_APPLE_PAC) */

str		lr, [x0, SS64_PC]                                               // Save ELR to PCB
str		w23, [x0, SS64_CPSR]                                    // Save CPSR to PCB
str		w24, [x0, NS64_FPSR]
str		w25, [x0, NS64_FPCR]

mrs		x20, FAR_EL1
mrs		x21, ESR_EL1

str		x20, [x0, SS64_FAR]
str		w21, [x0, SS64_ESR]
.endmacro

.macro DEADLOOP
b	.
.endmacro
Commit	Line	Data
cb323159 A	1	/*
	2	* Copyright (c) 2018 Apple Inc. All rights reserved.
	3	*
	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
	5	*
	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.
	14	*
	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	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.
	25	*
	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
	27	*/
	28
	29	#ifndef _PEXPERT_ARM_BOARD_CONFIG_H
	30	#include <pexpert/arm64/board_config.h>
	31	#endif
	32
c6bf4f31 A	33	#if XNU_MONITOR
	34	/* Exit path defines; for controlling PPL -> kernel transitions. */
	35	#define PPL_EXIT_DISPATCH 0 /* This is a clean exit after a PPL request. */
	36	#define PPL_EXIT_PANIC_CALL 1 /* The PPL has called panic. */
	37	#define PPL_EXIT_BAD_CALL 2 /* The PPL request failed. */
	38	#define PPL_EXIT_EXCEPTION 3 /* The PPL took an exception. */
	39
	40	#define KERNEL_MODE_ELR ELR_GL11
	41	#define KERNEL_MODE_FAR FAR_GL11
	42	#define KERNEL_MODE_ESR ESR_GL11
	43	#define KERNEL_MODE_SPSR SPSR_GL11
	44	#define KERNEL_MODE_ASPSR ASPSR_GL11
	45	#define KERNEL_MODE_VBAR VBAR_GL11
	46	#define KERNEL_MODE_TPIDR TPIDR_GL11
	47
	48	#define GUARDED_MODE_ELR ELR_EL1
	49	#define GUARDED_MODE_FAR FAR_EL1
	50	#define GUARDED_MODE_ESR ESR_EL1
	51	#define GUARDED_MODE_SPSR SPSR_EL1
	52	#define GUARDED_MODE_ASPSR ASPSR_EL1
	53	#define GUARDED_MODE_VBAR VBAR_EL1
	54	#define GUARDED_MODE_TPIDR TPIDR_EL1
	55
	56	/*
	57	* GET_PMAP_CPU_DATA
	58	*
	59	* Retrieves the PPL per-CPU data for the current CPU.
	60	* arg0 - Address of the PPL per-CPU data is returned through this
	61	* arg1 - Scratch register
	62	* arg2 - Scratch register
	63	*
	64	*/
	65	.macro GET_PMAP_CPU_DATA
	66	/* Get the CPU ID. */
	67	mrs $0, MPIDR_EL1
	68	#ifdef CPU_CLUSTER_OFFSETS
	69	ubfx $1, $0, MPIDR_AFF1_SHIFT, MPIDR_AFF1_WIDTH
	70	cmp $1, __ARM_CLUSTER_COUNT__
	71	b.hs .
	72	adrp $2, EXT(pmap_cluster_offsets)@page
	73	add $2, $2, EXT(pmap_cluster_offsets)@pageoff
	74	ldr $1, [$2, $1, lsl #3]
	75	and $0, $0, MPIDR_AFF0_MASK
	76	add $0, $0, $1
	77	#else
	78	and $0, $0, MPIDR_AFF0_MASK
	79	#endif
	80
	81	/* Get the PPL CPU data array. */
	82	adrp $1, EXT(pmap_cpu_data_array)@page
	83	add $1, $1, EXT(pmap_cpu_data_array)@pageoff
	84
	85	/*
	86	* Sanity check the CPU ID (this is not a panic because this pertains to
	87	* the hardware configuration; this should only fail if our
	88	* understanding of the hardware is incorrect).
	89	*/
	90	cmp $0, MAX_CPUS
	91	b.hs .
	92
	93	mov $2, PMAP_CPU_DATA_ARRAY_ENTRY_SIZE
	94	/* Get the PPL per-CPU data. */
	95	madd $0, $0, $2, $1
	96	.endmacro
97	#endif /* XNU_MONITOR */
cb323159 A	98
	99	/*
	100	* INIT_SAVED_STATE_FLAVORS
	101	*
	102	* Initializes the saved state flavors of a new saved state structure
	103	* arg0 - saved state pointer
	104	* arg1 - 32-bit scratch reg
	105	* arg2 - 32-bit scratch reg
	106	*/
	107	.macro INIT_SAVED_STATE_FLAVORS
	108	mov $1, ARM_SAVED_STATE64 // Set saved state to 64-bit flavor
	109	mov $2, ARM_SAVED_STATE64_COUNT
	110	stp $1, $2, [$0, SS_FLAVOR]
	111	mov $1, ARM_NEON_SAVED_STATE64 // Set neon state to 64-bit flavor
	112	str $1, [$0, NS_FLAVOR]
	113	mov $1, ARM_NEON_SAVED_STATE64_COUNT
	114	str $1, [$0, NS_COUNT]
	115	.endmacro
	116
	117	/*
	118	* SPILL_REGISTERS
	119	*
	120	* Spills the current set of registers (excluding x0, x1, sp, fp) to the specified
	121	* save area.
	122	* x0 - Address of the save area
	123	*/
	124
	125	.macro SPILL_REGISTERS
	126	stp x2, x3, [x0, SS64_X2] // Save remaining GPRs
	127	stp x4, x5, [x0, SS64_X4]
	128	stp x6, x7, [x0, SS64_X6]
	129	stp x8, x9, [x0, SS64_X8]
	130	stp x10, x11, [x0, SS64_X10]
	131	stp x12, x13, [x0, SS64_X12]
	132	stp x14, x15, [x0, SS64_X14]
	133	stp x16, x17, [x0, SS64_X16]
	134	stp x18, x19, [x0, SS64_X18]
	135	stp x20, x21, [x0, SS64_X20]
	136	stp x22, x23, [x0, SS64_X22]
	137	stp x24, x25, [x0, SS64_X24]
	138	stp x26, x27, [x0, SS64_X26]
	139	str x28, [x0, SS64_X28]
	140
	141	/* Save arm_neon_saved_state64 */
	142
	143	stp q0, q1, [x0, NS64_Q0]
	144	stp q2, q3, [x0, NS64_Q2]
	145	stp q4, q5, [x0, NS64_Q4]
	146	stp q6, q7, [x0, NS64_Q6]
	147	stp q8, q9, [x0, NS64_Q8]
	148	stp q10, q11, [x0, NS64_Q10]
	149	stp q12, q13, [x0, NS64_Q12]
	150	stp q14, q15, [x0, NS64_Q14]
	151	stp q16, q17, [x0, NS64_Q16]
	152	stp q18, q19, [x0, NS64_Q18]
	153	stp q20, q21, [x0, NS64_Q20]
	154	stp q22, q23, [x0, NS64_Q22]
	155	stp q24, q25, [x0, NS64_Q24]
	156	stp q26, q27, [x0, NS64_Q26]
	157	stp q28, q29, [x0, NS64_Q28]
	158	stp q30, q31, [x0, NS64_Q30]
	159
	160	mrs lr, ELR_EL1 // Get exception link register
	161	mrs x23, SPSR_EL1 // Load CPSR into var reg x23
162	mrs x24, FPSR
163	mrs x25, FPCR
164
165	#if defined(HAS_APPLE_PAC)
166	/* Save x1 and LR to preserve across call */
167	mov x21, x1
168	mov x20, lr
169
170	/*
171	* Create thread state signature
172	*
173	* Arg0: The ARM context pointer
174	* Arg1: The PC value to sign
175	* Arg2: The CPSR value to sign
176	* Arg3: The LR value to sign
177	* Arg4: The X16 value to sign
178	* Arg5: The X17 value to sign
179	*/
180	mov x1, lr
181	mov w2, w23
182	ldr x3, [x0, SS64_LR]
183	mov x4, x16
184	mov x5, x17
185	bl _ml_sign_thread_state
186
187	mov lr, x20
188	mov x1, x21
189	#endif /* defined(HAS_APPLE_PAC) */
190
191	str lr, [x0, SS64_PC] // Save ELR to PCB
192	str w23, [x0, SS64_CPSR] // Save CPSR to PCB
193	str w24, [x0, NS64_FPSR]
194	str w25, [x0, NS64_FPCR]
195
196	mrs x20, FAR_EL1
197	mrs x21, ESR_EL1
198
199	str x20, [x0, SS64_FAR]
200	str w21, [x0, SS64_ESR]
201	.endmacro
202
203	.macro DEADLOOP
204	b .
205	.endmacro