osfmk/arm/thread.h

   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  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 <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 #endif
  96
  97 #if __arm64__
  98         arm_context_t *           contextData;             /* allocated user context */
  99         arm_saved_state_t *       XNU_PTRAUTH_SIGNED_PTR("machine_thread.upcb") upcb;   /* pointer to user GPR state */
 100         arm_neon_saved_state_t *  uNeon;                   /* pointer to user VFP state */
 101         arm_saved_state_t *       kpcb;                    /* pointer to kernel GPR state */
 102         uint64_t                  recover_far;
 103 #elif __arm__
 104         struct arm_saved_state    PcbData;
 105 #else
 106 #error Unknown arch
 107 #endif
 108
 109 #if defined(__arm__) && defined(__ARM_VFP__)
 110         // for packing reasons chtread_self and DebugData
 111         // are inside the the PcbData when __ARM_VFP__ is set
 112 #define DebugData    PcbData.VFPpadding_DebugData
 113 #define cthread_self PcbData.VFPpadding_cthread_self
 114 #else
 115         arm_debug_state_t        *DebugData;
 116         vm_address_t              cthread_self;               /* for use of cthread package */
 117 #endif
 118
 119 #if __arm64__
 120         uint32_t                  recover_esr;
 121 #endif /* __arm64__ */
 122
 123         vm_offset_t               kstackptr;                  /* top of kernel stack */
 124         struct perfcontrol_state  perfctrl_state;
 125 #if __arm64__
 126         uint64_t                  energy_estimate_nj;
 127 #endif
 128
 129 #if INTERRUPT_MASKED_DEBUG
 130         uint64_t                  intmask_timestamp;          /* timestamp of when interrupts were manually masked */
 131         uint64_t                  inthandler_timestamp;       /* timestamp of when interrupt handler started */
 132         unsigned int              int_type;                   /* interrupt type of the interrupt that was processed */
 133         uintptr_t                 int_handler_addr;           /* slid, ptrauth-stripped virtual address of the interrupt handler */
 134         uintptr_t                 int_vector;                 /* IOInterruptVector */
 135 #endif
 136
 137 #if __arm64__ && defined(CONFIG_XNUPOST)
 138         volatile expected_fault_handler_t  expected_fault_handler;
 139         volatile uintptr_t                 expected_fault_addr;
 140 #endif
 141
 142         vm_offset_t               pcpu_data_base;
 143         struct cpu_data *         CpuDatap;               /* current per cpu data */
 144         unsigned int              preemption_count;       /* preemption count */
 145 #if __arm64__
 146         uint16_t                  exception_trace_code;
 147 #endif
 148 #if defined(HAS_APPLE_PAC)
 149         uint8_t                   disable_user_jop;
 150         uint64_t                  rop_pid;
 151         uint64_t                  jop_pid;
 152 #endif
 153 };
 154 #endif
 155
 156 extern struct arm_saved_state *    get_user_regs(thread_t);
 157 extern struct arm_saved_state *    find_user_regs(thread_t);
 158 extern struct arm_saved_state *    find_kern_regs(thread_t);
 159 extern struct arm_vfpsaved_state * find_user_vfp(thread_t);
 160 #if defined(__arm__)
 161 extern arm_debug_state_t *         find_debug_state(thread_t);
 162 #elif defined(__arm64__)
 163 extern arm_debug_state32_t *       find_debug_state32(thread_t);
 164 extern arm_debug_state32_t *       find_or_allocate_debug_state32(thread_t);
 165 extern arm_debug_state64_t *       find_debug_state64(thread_t);
 166 extern arm_debug_state64_t *       find_or_allocate_debug_state64(thread_t);
 167 extern arm_neon_saved_state_t *    get_user_neon_regs(thread_t);
 168 #else
 169 #error unknown arch
 170 #endif
 171
 172 #define FIND_PERFCONTROL_STATE(th) (&th->machine.perfctrl_state)
 173
 174 #ifdef MACH_KERNEL_PRIVATE
 175 #if __ARM_VFP__
 176 extern void vfp_state_initialize(struct arm_vfpsaved_state *vfp_state);
 177 extern void vfp_save(struct arm_vfpsaved_state *vfp_ss);
 178 extern void vfp_load(struct arm_vfpsaved_state *vfp_ss);
 179 #endif /* __ARM_VFP__ */
 180 extern void arm_debug_set(arm_debug_state_t *debug_state);
 181 #if defined(__arm64__)
 182 extern void arm_debug_set32(arm_debug_state_t *debug_state);
 183 extern void arm_debug_set64(arm_debug_state_t *debug_state);
 184 #endif
 185 #endif /* MACH_KERNEL_PRIVATE */
 186
 187 extern void *act_thread_csave(void);
 188 extern void act_thread_catt(void *ctx);
 189 extern void act_thread_cfree(void *ctx);
 190
 191
 192 /*
 193  * Return address of the function that called current function, given
 194  * address of the first parameter of current function.
 195  */
 196 #define GET_RETURN_PC(addr) (__builtin_return_address(0))
 197
 198 #endif /* _ARM_THREAD_H_ */