1 /* 2 * Copyright (c) 2007 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 [email protected] 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 <arm/proc_reg.h> 70 #include <os/base.h> 71 #endif 72 73 struct 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 */ 80 extern unsigned int _MachineStateCount[]; 81 82 #ifdef MACH_KERNEL_PRIVATE 83 #if __arm64__ 84 typedef arm_kernel_context_t machine_thread_kernel_state; 85 #else 86 typedef struct arm_saved_state machine_thread_kernel_state; 87 #endif 88 #include <kern/thread_kernel_state.h> 89 90 struct machine_thread { 91 #if __ARM_USER_PROTECT__ 92 unsigned int uptw_ttb; 93 unsigned int kptw_ttb; 94 unsigned int asid; 95 #else 96 unsigned int reserved0; 97 unsigned int reserved1; 98 unsigned int reserved2; 99 #endif 100 101 #if __arm64__ 102 arm_context_t * contextData; /* allocated user context */ 103 arm_saved_state_t * XNU_PTRAUTH_SIGNED_PTR("machine_thread.upcb") upcb; /* pointer to user GPR state */ 104 arm_neon_saved_state_t * uNeon; /* pointer to user VFP state */ 105 arm_saved_state_t * kpcb; /* pointer to kernel GPR state */ 106 void * reserved3; 107 long reserved4; 108 uint64_t recover_far; 109 #elif __arm__ 110 struct arm_saved_state PcbData; 111 vm_offset_t recover; /* page fault recover(copyin/out) */ 112 #else 113 #error Unknown arch 114 #endif 115 116 #if defined(__arm__) && defined(__ARM_VFP__) 117 // for packing reasons chtread_self and DebugData 118 // are inside the the PcbData when __ARM_VFP__ is set 119 #define DebugData PcbData.VFPpadding_DebugData 120 #define cthread_self PcbData.VFPpadding_cthread_self 121 #else 122 arm_debug_state_t *DebugData; 123 vm_address_t cthread_self; /* for use of cthread package */ 124 #endif 125 126 #if __arm64__ 127 uint32_t recover_esr; 128 #endif /* __arm64__ */ 129 130 vm_offset_t kstackptr; /* top of kernel stack */ 131 struct perfcontrol_state perfctrl_state; 132 #if __arm64__ 133 uint64_t energy_estimate_nj; 134 #endif 135 uint64_t reserved5; 136 137 #if SCHED_PREEMPTION_DISABLE_DEBUG 138 /* 139 * Preemption disable timestamp, adjusted to 140 * exclude duration of any interrupts that happened. 141 */ 142 uint64_t preemption_disable_adj_mt; 143 #endif /* SCHED_PREEMPTION_DISABLE_DEBUG */ 144 145 #if INTERRUPT_MASKED_DEBUG 146 uint64_t intmask_timestamp; /* timestamp of when interrupts were manually masked */ 147 uint64_t inthandler_timestamp; /* timestamp of when interrupt handler started */ 148 uint64_t intmask_cycles; /* cycle count snapshot of when interrupts were masked */ 149 uint64_t intmask_instr; /* instruction count snapshot of when interrupts were masked */ 150 unsigned int int_type; /* interrupt type of the interrupt that was processed */ 151 uintptr_t int_handler_addr; /* slid, ptrauth-stripped virtual address of the interrupt handler */ 152 uintptr_t int_vector; /* IOInterruptVector */ 153 uint64_t int_time_mt; /* total time spent in interrupt context */ 154 #endif 155 156 #if __arm64__ && defined(CONFIG_XNUPOST) 157 volatile expected_fault_handler_t expected_fault_handler; 158 volatile uintptr_t expected_fault_addr; 159 #endif 160 161 uint64_t reserved6; 162 vm_offset_t pcpu_data_base; 163 struct cpu_data * CpuDatap; /* current per cpu data */ 164 unsigned int preemption_count; /* preemption count */ 165 #if __arm64__ 166 uint16_t exception_trace_code; 167 #endif 168 uint8_t reserved7; 169 #if defined(HAS_APPLE_PAC) 170 uint8_t disable_user_jop; 171 uint64_t rop_pid; 172 uint64_t jop_pid; 173 #else 174 uint8_t reserved8; 175 uint64_t reserved9; 176 uint64_t reserved10; 177 #endif 178 }; 179 #endif 180 181 extern struct arm_saved_state * get_user_regs(thread_t); 182 extern struct arm_saved_state * find_user_regs(thread_t); 183 extern struct arm_saved_state * find_kern_regs(thread_t); 184 extern struct arm_vfpsaved_state * find_user_vfp(thread_t); 185 #if defined(__arm__) 186 extern arm_debug_state_t * find_debug_state(thread_t); 187 #elif defined(__arm64__) 188 extern arm_debug_state32_t * find_debug_state32(thread_t); 189 extern arm_debug_state32_t * find_or_allocate_debug_state32(thread_t); 190 extern arm_debug_state64_t * find_debug_state64(thread_t); 191 extern arm_debug_state64_t * find_or_allocate_debug_state64(thread_t); 192 extern arm_neon_saved_state_t * get_user_neon_regs(thread_t); 193 #else 194 #error unknown arch 195 #endif 196 197 #define FIND_PERFCONTROL_STATE(th) (&th->machine.perfctrl_state) 198 199 #ifdef MACH_KERNEL_PRIVATE 200 #if __ARM_VFP__ 201 extern void vfp_state_initialize(struct arm_vfpsaved_state *vfp_state); 202 extern void vfp_save(struct arm_vfpsaved_state *vfp_ss); 203 extern void vfp_load(struct arm_vfpsaved_state *vfp_ss); 204 #endif /* __ARM_VFP__ */ 205 extern void arm_debug_set(arm_debug_state_t *debug_state); 206 #if defined(__arm64__) 207 extern void arm_debug_set32(arm_debug_state_t *debug_state); 208 extern void arm_debug_set64(arm_debug_state_t *debug_state); 209 #endif 210 #endif /* MACH_KERNEL_PRIVATE */ 211 212 extern void *act_thread_csave(void); 213 extern void act_thread_catt(void *ctx); 214 extern void act_thread_cfree(void *ctx); 215 216 217 /* 218 * Return address of the function that called current function, given 219 * address of the first parameter of current function. 220 */ 221 #define GET_RETURN_PC(addr) (__builtin_return_address(0)) 222 223 #endif /* _ARM_THREAD_H_ */ 224