1/* 2 * Copyright (c) 2012 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#ifdef KERNEL_PRIVATE 30 31#ifndef _PTHREAD_SHIMS_H_ 32#define _PTHREAD_SHIMS_H_ 33 34#ifndef ASSEMBLER 35 36#include <kern/clock.h> 37#include <kern/kern_types.h> 38#include <kern/locks.h> 39#include <sys/_types.h> 40#include <sys/_types/_sigset_t.h> 41#include <sys/kernel_types.h> 42#include <sys/proc_info.h> 43 44#ifndef PTHREAD_INTERNAL 45struct uthread; 46#define M_PROC 41 47#endif 48 49#ifdef NEEDS_SCHED_CALL_T 50typedef void (*sched_call_t)(int type, thread_t thread); 51#endif 52 53/* 54 * Increment each time new reserved slots are used. When the pthread 55 * kext registers this table, it will include the version of the xnu 56 * headers that it was built against. 57 */ 58#define PTHREAD_FUNCTIONS_TABLE_VERSION 1 59 60typedef struct pthread_functions_s { 61 int version; 62 63 /* internal calls, kernel core -> kext */ 64 void (*pthread_init)(void); 65 int (*fill_procworkqueue)(proc_t p, struct proc_workqueueinfo * pwqinfo); 66 void (*workqueue_init_lock)(proc_t p); 67 void (*workqueue_destroy_lock)(proc_t p); 68 void (*workqueue_exit)(struct proc *p); 69 void (*workqueue_mark_exiting)(struct proc *p); 70 void (*workqueue_thread_yielded)(void); 71 void (*pth_proc_hashinit)(proc_t p); 72 void (*pth_proc_hashdelete)(proc_t p); 73 74 /* syscall stubs */ 75 int (*bsdthread_create)(struct proc *p, user_addr_t user_func, user_addr_t user_funcarg, user_addr_t user_stack, user_addr_t user_pthread, uint32_t flags, user_addr_t *retval); 76 int (*bsdthread_register)(struct proc *p, user_addr_t threadstart, user_addr_t wqthread, int pthsize, user_addr_t dummy_value, user_addr_t targetconc_ptr, uint64_t dispatchqueue_offset, int32_t *retval); 77 int (*bsdthread_terminate)(struct proc *p, user_addr_t stackaddr, size_t size, uint32_t kthport, uint32_t sem, int32_t *retval); 78 int (*thread_selfid)(struct proc *p, uint64_t *retval); 79 int (*workq_kernreturn)(struct proc *p, int options, user_addr_t item, int affinity, int prio, int32_t *retval); 80 int (*workq_open)(struct proc *p, int32_t *retval); 81 82 /* psynch syscalls */ 83 int (*psynch_mutexwait)(proc_t p, user_addr_t mutex, uint32_t mgen, uint32_t ugen, uint64_t tid, uint32_t flags, uint32_t *retval); 84 int (*psynch_mutexdrop)(proc_t p, user_addr_t mutex, uint32_t mgen, uint32_t ugen, uint64_t tid, uint32_t flags, uint32_t *retval); 85 int (*psynch_cvbroad)(proc_t p, user_addr_t cv, uint64_t cvlsgen, uint64_t cvudgen, uint32_t flags, user_addr_t mutex, uint64_t mugen, uint64_t tid, uint32_t *retval); 86 int (*psynch_cvsignal)(proc_t p, user_addr_t cv, uint64_t cvlsgen, uint32_t cvugen, int thread_port, user_addr_t mutex, uint64_t mugen, uint64_t tid, uint32_t flags, uint32_t *retval); 87 int (*psynch_cvwait)(proc_t p, user_addr_t cv, uint64_t cvlsgen, uint32_t cvugen, user_addr_t mutex, uint64_t mugen, uint32_t flags, int64_t sec, uint32_t nsec, uint32_t * retval); 88 int (*psynch_cvclrprepost)(proc_t p, user_addr_t cv, uint32_t cvgen, uint32_t cvugen, uint32_t cvsgen, uint32_t prepocnt, uint32_t preposeq, uint32_t flags, int *retval); 89 int (*psynch_rw_longrdlock)(proc_t p, user_addr_t rwlock, uint32_t lgenval, uint32_t ugenval, uint32_t rw_wc, int flags, uint32_t *retval); 90 int (*psynch_rw_rdlock)(proc_t p, user_addr_t rwlock, uint32_t lgenval, uint32_t ugenval, uint32_t rw_wc, int flags, uint32_t *retval); 91 int (*psynch_rw_unlock)(proc_t p, user_addr_t rwlock, uint32_t lgenval, uint32_t ugenval, uint32_t rw_wc, int flags, uint32_t *retval); 92 int (*psynch_rw_wrlock)(proc_t p, user_addr_t rwlock, uint32_t lgenval, uint32_t ugenval, uint32_t rw_wc, int flags, uint32_t *retval); 93 int (*psynch_rw_yieldwrlock)(proc_t p, user_addr_t rwlock, uint32_t lgenval, uint32_t ugenval, uint32_t rw_wc, int flags, uint32_t *retval); 94 95 sched_call_t (*workqueue_get_sched_callback)(void); 96 97 /* New register function with TSD offset */ 98 int (*bsdthread_register2)(struct proc *p, user_addr_t threadstart, user_addr_t wqthread, uint32_t flags, user_addr_t stack_addr_hint, user_addr_t targetconc_ptr, uint32_t dispatchqueue_offset, uint32_t tsd_offset, int32_t *retval); 99 100 /* New pthreadctl system. */ 101 int (*bsdthread_ctl)(struct proc *p, user_addr_t cmd, user_addr_t arg1, user_addr_t arg2, user_addr_t arg3, int *retval); 102 103 /* padding for future */ 104 void* _pad[97]; 105} *pthread_functions_t; 106 107typedef struct pthread_callbacks_s { 108 int version; 109 110 /* config information */ 111 uint32_t config_thread_max; 112 uint32_t (*get_task_threadmax)(void); 113 114 /* proc.h accessors */ 115 uint64_t (*proc_get_register)(struct proc *t); 116 void (*proc_set_register)(struct proc *t); 117 118 user_addr_t (*proc_get_threadstart)(struct proc *t); 119 void (*proc_set_threadstart)(struct proc *t, user_addr_t addr); 120 user_addr_t (*proc_get_wqthread)(struct proc *t); 121 void (*proc_set_wqthread)(struct proc *t, user_addr_t addr); 122 int (*proc_get_pthsize)(struct proc *t); 123 void (*proc_set_pthsize)(struct proc *t, int size); 124 user_addr_t (*proc_get_targconc)(struct proc *t); 125 void (*proc_set_targconc)(struct proc *t, user_addr_t addr); 126 uint64_t (*proc_get_dispatchqueue_offset)(struct proc *t); 127 void (*proc_set_dispatchqueue_offset)(struct proc *t, uint64_t offset); 128 lck_spin_t* (*proc_get_wqlockptr)(struct proc *t); 129 boolean_t* (*proc_get_wqinitingptr)(struct proc *t); 130 void* (*proc_get_wqptr)(struct proc *t); 131 void (*proc_set_wqptr)(struct proc *t, void* ptr); 132 int (*proc_get_wqsize)(struct proc *t); 133 void (*proc_set_wqsize)(struct proc *t, int sz); 134 void (*proc_lock)(struct proc *t); 135 void (*proc_unlock)(struct proc *t); 136 task_t (*proc_get_task)(struct proc *t); 137 void* (*proc_get_pthhash)(struct proc *t); 138 void (*proc_set_pthhash)(struct proc *t, void* ptr); 139 140 /* bsd/sys/user.h */ 141 void* (*uthread_get_threadlist)(struct uthread *t); 142 void (*uthread_set_threadlist)(struct uthread *t, void* threadlist); 143 sigset_t (*uthread_get_sigmask)(struct uthread *t); 144 void (*uthread_set_sigmask)(struct uthread *t, sigset_t s); 145 void* (*uthread_get_uukwe)(struct uthread *t); 146 int (*uthread_get_returnval)(struct uthread *t); 147 void (*uthread_set_returnval)(struct uthread *t, int val); 148 int (*uthread_is_cancelled)(struct uthread *t); 149 150 /* vm_protos.h calls */ 151 ipc_space_t (*task_get_ipcspace)(task_t t); 152 mach_port_name_t (*ipc_port_copyout_send)(ipc_port_t sright, ipc_space_t space); 153 154 /* osfmk/vm/vm_map.h */ 155 kern_return_t (*vm_map_page_info)(vm_map_t map, vm_map_offset_t offset, vm_page_info_flavor_t flavor, vm_page_info_t info, mach_msg_type_number_t *count); 156 vm_map_t (*vm_map_switch)(vm_map_t map); 157 158 /* wq functions */ 159 kern_return_t (*thread_set_wq_state32)(thread_t thread, thread_state_t state); 160 kern_return_t (*thread_set_wq_state64)(thread_t thread, thread_state_t state); 161 162 /* sched_prim.h */ 163 void (*thread_exception_return)(); 164 void (*thread_bootstrap_return)(); 165 166 /* kern/clock.h */ 167 void (*absolutetime_to_microtime)(uint64_t abstime, clock_sec_t *secs, clock_usec_t *microsecs); 168 169 /* osfmk/kern/task.h */ 170 int (*proc_restore_workq_bgthreadpolicy)(thread_t t); 171 int (*proc_apply_workq_bgthreadpolicy)(thread_t t); 172 173 /* osfmk/kern/thread.h */ 174 struct uthread* (*get_bsdthread_info)(thread_t th); 175 void (*thread_sched_call)(thread_t t, sched_call_t call); 176 void (*thread_static_param)(thread_t t, boolean_t state); 177 kern_return_t (*thread_create_workq)(task_t t, thread_continue_t c, thread_t *new_t); 178 kern_return_t (*thread_policy_set_internal)(thread_t t, thread_policy_flavor_t flavour, thread_policy_t info, mach_msg_type_number_t count); 179 180 /* osfmk/kern/affinity.h */ 181 kern_return_t (*thread_affinity_set)(thread_t thread, uint32_t tag); 182 183 /* bsd/sys/systm.h */ 184 void (*unix_syscall_return)(int error); 185 186 /* osfmk/kern/zalloc.h */ 187 void* (*zalloc)(zone_t zone); 188 void (*zfree)(zone_t zone, void* ptr); 189 zone_t (*zinit)(vm_size_t, vm_size_t maxmem, vm_size_t alloc, const char *name); 190 191 /* bsd/kerb/kern_sig.c */ 192 void (*__pthread_testcancel)(int); 193 194 /* calls without portfolio */ 195 kern_return_t (*mach_port_deallocate)(ipc_space_t space, mach_port_name_t name); 196 kern_return_t (*semaphore_signal_internal_trap)(mach_port_name_t sema_name); 197 vm_map_t (*current_map)(void); 198 199 /* osfmk/kern/thread.h */ 200 ipc_port_t (*convert_thread_to_port)(thread_t th); 201 202 /* mach/task.h */ 203 kern_return_t (*thread_create)(task_t parent_task, thread_act_t *child_act); 204 205 /* mach/thread_act.h */ 206 kern_return_t (*thread_resume)(thread_act_t target_act); 207 208 /* osfmk/<arch>/machine_routines.h */ 209 int (*ml_get_max_cpus)(void); 210 211 212 /* <rdar://problem/12809089> xnu: struct proc p_dispatchqueue_serialno_offset additions */ 213 uint64_t (*proc_get_dispatchqueue_serialno_offset)(struct proc *p); 214 void (*proc_set_dispatchqueue_serialno_offset)(struct proc *p, uint64_t offset); 215 216 user_addr_t (*proc_get_stack_addr_hint)(struct proc *p); 217 void (*proc_set_stack_addr_hint)(struct proc *p, user_addr_t stack_addr_hint); 218 219 uint32_t (*proc_get_pthread_tsd_offset)(struct proc *p); 220 void (*proc_set_pthread_tsd_offset)(struct proc *p, uint32_t pthread_tsd_offset); 221 222 kern_return_t (*thread_set_tsd_base)(thread_t thread, mach_vm_offset_t tsd_base); 223 224 int (*proc_usynch_get_requested_thread_qos)(struct uthread *); 225 boolean_t (*proc_usynch_thread_qos_add_override)(struct uthread *, uint64_t tid, int override_qos, boolean_t first_override_for_resource); 226 boolean_t (*proc_usynch_thread_qos_remove_override)(struct uthread *, uint64_t tid); 227 228 kern_return_t (*thread_policy_get)(thread_t t, thread_policy_flavor_t flavor, thread_policy_t info, mach_msg_type_number_t *count, boolean_t *get_default); 229 boolean_t (*qos_main_thread_active)(void); 230 231 kern_return_t (*thread_set_voucher_name)(mach_port_name_t voucher_name); 232 233 /* padding for future */ 234 void* _pad[87]; 235 236} *pthread_callbacks_t; 237 238void 239pthread_kext_register(pthread_functions_t fns, pthread_callbacks_t *callbacks); 240 241#ifdef BSD_KERNEL_PRIVATE 242void workqueue_mark_exiting(struct proc *); 243void workqueue_exit(struct proc *); 244void workqueue_thread_yielded(void); 245sched_call_t workqueue_get_sched_callback(void); 246void pthread_init(void); 247 248extern pthread_callbacks_t pthread_kern; 249extern pthread_functions_t pthread_functions; 250#endif 251 252#endif /* ASSEMBLER */ 253#endif /* _PTHREAD_SHIMS_H_ */ 254#endif /* KERNEL_PRIVATE */ 255