1/*
2 * Copyright (c) 2007-2021 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 * @OSF_COPYRIGHT@
30 */
31/*
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989 Carnegie Mellon University
34 * All Rights Reserved.
35 *
36 * Permission to use, copy, modify and distribute this software and its
37 * documentation is hereby granted, provided that both the copyright
38 * notice and this permission notice appear in all copies of the
39 * software, derivative works or modified versions, and any portions
40 * thereof, and that both notices appear in supporting documentation.
41 *
42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45 *
46 * Carnegie Mellon requests users of this software to return to
47 *
48 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
52 *
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
55 */
56/*
57 */
58
59#ifndef _ARM_THREAD_H_
60#define _ARM_THREAD_H_
61
62#include <mach/mach_types.h>
63#include <mach/boolean.h>
64#include <mach/arm/vm_types.h>
65#include <mach/thread_status.h>
66
67#ifdef MACH_KERNEL_PRIVATE
68#include <arm/cpu_data.h>
69#include <arm64/proc_reg.h>
70#include <os/base.h>
71#endif
72
73struct perfcontrol_state {
74 uint64_t opaque[8] __attribute__((aligned(8)));
75};
76
77/*
78 * Maps state flavor to number of words in the state:
79 */
80extern unsigned int _MachineStateCount[];
81
82#ifdef MACH_KERNEL_PRIVATE
83typedef arm_kernel_context_t machine_thread_kernel_state;
84#include <kern/thread_kernel_state.h>
85
86#if (!__arm64__)
87#error Unknown arch
88#endif
89
90
91
92/*
93 * Machine Thread Structure
94 */
95struct machine_thread {
96#if __ARM_USER_PROTECT__
97 unsigned int uptw_ttb;
98 unsigned int kptw_ttb;
99 unsigned int asid;
100#else
101 unsigned int reserved0;
102 unsigned int reserved1;
103 unsigned int reserved2;
104#endif
105
106 arm_context_t * contextData; /* allocated user context */
107 arm_saved_state_t * XNU_PTRAUTH_SIGNED_PTR("machine_thread.upcb") upcb; /* pointer to user GPR state */
108 arm_neon_saved_state_t * uNeon; /* pointer to user VFP state */
109 arm_saved_state_t * kpcb; /* pointer to kernel GPR state */
110
111 void * reserved3;
112
113 long reserved4;
114 uint64_t recover_far;
115
116 arm_debug_state_t *DebugData;
117 vm_address_t cthread_self; /* for use of cthread package */
118
119 uint32_t recover_esr;
120 uint32_t arm_machine_flags; /* thread flags (arm64/machine_machdep.h) */
121
122 void * XNU_PTRAUTH_SIGNED_PTR("machine_thread.kstackptr") kstackptr; /* top of kernel stack */
123 struct perfcontrol_state perfctrl_state;
124 uint64_t reserved5;
125
126#if SCHED_HYGIENE_DEBUG
127 uint64_t intmask_timestamp; /* timestamp of when interrupts were manually masked */
128 uint64_t inthandler_timestamp; /* timestamp of when interrupt handler started */
129 uint64_t intmask_cycles; /* cycle count snapshot of when interrupts were masked */
130 uint64_t intmask_instr; /* instruction count snapshot of when interrupts were masked */
131 bool inthandler_abandon; /* whether to abandon the current measurement */
132
133 unsigned int int_type; /* interrupt type of the interrupt that was processed */
134 uintptr_t int_handler_addr; /* slid, ptrauth-stripped virtual address of the interrupt handler */
135 uintptr_t int_vector; /* IOInterruptVector */
136 uint64_t int_time_mt; /* total time spent in interrupt context */
137#endif /* SCHED_HYGIENE_DEBUG */
138
139#if defined(CONFIG_XNUPOST)
140 volatile expected_fault_handler_t expected_fault_handler;
141 volatile uintptr_t expected_fault_addr;
142 volatile uintptr_t expected_fault_pc; /* PC at which an exception is expected to be thrown (i.e. ELR_ELx) */
143#endif
144
145 uint64_t reserved6;
146 vm_offset_t pcpu_data_base;
147 struct cpu_data * CpuDatap; /* current per cpu data */
148 unsigned int preemption_count; /* preemption count */
149 uint16_t exception_trace_code;
150 uint8_t reserved7;
151 bool reserved8;
152#if defined(HAS_APPLE_PAC)
153 uint64_t rop_pid;
154 uint64_t jop_pid;
155#else
156 uint64_t reserved9;
157 uint64_t reserved10;
158#endif
159
160 uint64_t reserved11;
161
162};
163#endif
164
165extern struct arm_saved_state * get_user_regs(thread_t);
166extern struct arm_saved_state * find_user_regs(thread_t);
167extern struct arm_saved_state * find_kern_regs(thread_t);
168extern struct arm_vfpsaved_state * find_user_vfp(thread_t);
169extern arm_debug_state32_t * find_debug_state32(thread_t);
170extern arm_debug_state32_t * find_or_allocate_debug_state32(thread_t);
171extern arm_debug_state64_t * find_debug_state64(thread_t);
172extern arm_debug_state64_t * find_or_allocate_debug_state64(thread_t);
173extern arm_neon_saved_state_t * get_user_neon_regs(thread_t);
174
175#define FIND_PERFCONTROL_STATE(th) (&th->machine.perfctrl_state)
176
177#ifdef MACH_KERNEL_PRIVATE
178#if __ARM_VFP__
179extern void vfp_state_initialize(struct arm_vfpsaved_state *vfp_state);
180extern void vfp_save(struct arm_vfpsaved_state *vfp_ss);
181extern void vfp_load(struct arm_vfpsaved_state *vfp_ss);
182#endif /* __ARM_VFP__ */
183extern void arm_debug_set(arm_debug_state_t *debug_state);
184extern void arm_debug_set32(arm_debug_state_t *debug_state);
185extern void arm_debug_set64(arm_debug_state_t *debug_state);
186#endif /* MACH_KERNEL_PRIVATE */
187
188extern void *act_thread_csave(void);
189extern void act_thread_catt(void *ctx);
190extern void act_thread_cfree(void *ctx);
191
192#if MACH_KERNEL_PRIVATE
193
194
195#endif /* MACH_KERNEL_PRIVATE */
196
197/*
198 * Return address of the function that called current function, given
199 * address of the first parameter of current function.
200 */
201#define GET_RETURN_PC(addr) (__builtin_return_address(0))
202
203#endif /* _ARM_THREAD_H_ */
204