bsd/sys/pthread_shims.h

   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/kcdata.h>
  39 #include <kern/locks.h>
  40 #include <sys/_types.h>
  41 #include <sys/_types/_sigset_t.h>
  42 #include <sys/kernel_types.h>
  43 #include <sys/proc_info.h>
  44
  45 #ifndef PTHREAD_INTERNAL
  46 struct uthread;
  47 #define M_PROC 41
  48 #endif
  49
  50 #ifdef NEEDS_SCHED_CALL_T
  51 typedef void (*sched_call_t)(int type, thread_t thread);
  52 #endif
  53
  54 typedef struct workq_reqthreads_req_s {unsigned long priority; int count;} *workq_reqthreads_req_t;
  55
  56 /*
  57  * Increment each time new reserved slots are used. When the pthread
  58  * kext registers this table, it will include the version of the xnu
  59  * headers that it was built against.
  60  */
  61 #define PTHREAD_FUNCTIONS_TABLE_VERSION 1
  62
  63 typedef const struct pthread_functions_s {
  64         int version;
  65
  66         /* internal calls, kernel core -> kext */
  67         void (*pthread_init)(void);
  68         int (*fill_procworkqueue)(proc_t p, struct proc_workqueueinfo * pwqinfo);
  69
  70         // UNUSED - TO BE DELETED
  71         void (*workqueue_init_lock)(proc_t p);
  72         void (*workqueue_destroy_lock)(proc_t p);
  73
  74         void (*workqueue_exit)(struct proc *p);
  75         void (*workqueue_mark_exiting)(struct proc *p);
  76         void (*workqueue_thread_yielded)(void);
  77         void (*pth_proc_hashinit)(proc_t p);
  78         void (*pth_proc_hashdelete)(proc_t p);
  79
  80         /* syscall stubs */
  81         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);
  82         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);
  83         int (*bsdthread_terminate)(struct proc *p, user_addr_t stackaddr, size_t size, uint32_t kthport, uint32_t sem, int32_t *retval);
  84         int (*thread_selfid)(struct proc *p, uint64_t *retval);
  85         int (*workq_kernreturn)(struct proc *p, int options, user_addr_t item, int affinity, int prio, int32_t *retval);
  86         int (*workq_open)(struct proc *p, int32_t *retval);
  87
  88         /* psynch syscalls */
  89         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);
  90         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);
  91         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);
  92         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);
  93         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);
  94         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);
  95         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);
  96         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);
  97         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);
  98         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);
  99         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);
 100
 101         sched_call_t (*workqueue_get_sched_callback)(void);
 102
 103         /* New register function with TSD offset */
 104         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);
 105
 106         /* New pthreadctl system. */
 107         int (*bsdthread_ctl)(struct proc *p, user_addr_t cmd, user_addr_t arg1, user_addr_t arg2, user_addr_t arg3, int *retval);
 108
 109     /* Request threads to deliver kevents */
 110     thread_t (*workq_reqthreads)(struct proc *p, int requests_count, workq_reqthreads_req_t requests);
 111
 112     /* Resolve a pthread_priority_t to a QoS/relative pri */
 113     integer_t (*thread_qos_from_pthread_priority)(unsigned long pthread_priority, unsigned long *flags);
 114
 115         /* try to get wq flags in debugger context */
 116         uint32_t (*get_pwq_state_kdp)(proc_t p);
 117
 118         unsigned long (*pthread_priority_canonicalize)(unsigned long pthread_priority);
 119         unsigned long (*pthread_priority_canonicalize2)(unsigned long pthread_priority, boolean_t propagation);
 120
 121         void (*pthread_find_owner)(thread_t thread, struct stackshot_thread_waitinfo *waitinfo);
 122         void *(*pthread_get_thread_kwq)(thread_t thread);
 123
 124         /* padding for future */
 125         void * _pad[90];
 126 } * pthread_functions_t;
 127
 128 typedef const struct pthread_callbacks_s {
 129         int version;
 130
 131         /* config information */
 132         uint32_t config_thread_max;
 133         uint32_t (*get_task_threadmax)(void);
 134
 135         /* proc.h accessors */
 136         uint64_t (*proc_get_register)(struct proc *t);
 137         void (*proc_set_register)(struct proc *t);
 138
 139         user_addr_t (*proc_get_threadstart)(struct proc *t);
 140         void (*proc_set_threadstart)(struct proc *t, user_addr_t addr);
 141         user_addr_t (*proc_get_wqthread)(struct proc *t);
 142         void (*proc_set_wqthread)(struct proc *t, user_addr_t addr);
 143         int (*proc_get_pthsize)(struct proc *t);
 144         void (*proc_set_pthsize)(struct proc *t, int size);
 145         void *unused_was_proc_get_targconc;
 146         void *unused_was_proc_set_targconc;
 147         uint64_t (*proc_get_dispatchqueue_offset)(struct proc *t);
 148         void (*proc_set_dispatchqueue_offset)(struct proc *t, uint64_t offset);
 149         void *unused_was_proc_get_wqlockptr;
 150         void *unused_was_proc_get_wqinitingptr;
 151         void* (*proc_get_wqptr)(struct proc *t);
 152         void (*proc_set_wqptr)(struct proc *t, void* ptr);
 153         void *unused_was_proc_get_wqsize;
 154         void *unused_was_proc_set_wqsize;
 155         void (*proc_lock)(struct proc *t);
 156         void (*proc_unlock)(struct proc *t);
 157         task_t (*proc_get_task)(struct proc *t);
 158         void* (*proc_get_pthhash)(struct proc *t);
 159         void (*proc_set_pthhash)(struct proc *t, void* ptr);
 160
 161         /* bsd/sys/user.h */
 162         void* (*uthread_get_threadlist)(struct uthread *t);
 163         void (*uthread_set_threadlist)(struct uthread *t, void* threadlist);
 164         sigset_t (*uthread_get_sigmask)(struct uthread *t);
 165         void (*uthread_set_sigmask)(struct uthread *t, sigset_t s);
 166         void* (*uthread_get_uukwe)(struct uthread *t);
 167         int (*uthread_get_returnval)(struct uthread *t);
 168         void (*uthread_set_returnval)(struct uthread *t, int val);
 169         int (*uthread_is_cancelled)(struct uthread *t);
 170
 171         /* vm_protos.h calls */
 172         ipc_space_t (*task_get_ipcspace)(task_t t);
 173         mach_port_name_t (*ipc_port_copyout_send)(ipc_port_t sright, ipc_space_t space);
 174
 175         /* osfmk/vm/vm_map.h */
 176         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);
 177         vm_map_t (*vm_map_switch)(vm_map_t map);
 178
 179         /* wq functions */
 180         kern_return_t (*thread_set_wq_state32)(thread_t thread, thread_state_t state);
 181         kern_return_t (*thread_set_wq_state64)(thread_t thread, thread_state_t state);
 182
 183         /* sched_prim.h */
 184         void (*thread_exception_return)();
 185         void (*thread_bootstrap_return)();
 186
 187         /* kern/clock.h */
 188         void (*absolutetime_to_microtime)(uint64_t abstime, clock_sec_t *secs, clock_usec_t *microsecs);
 189
 190         kern_return_t (*thread_set_workq_pri)(thread_t thread, integer_t priority, integer_t policy);
 191         kern_return_t (*thread_set_workq_qos)(thread_t thread, int qos_tier, int relprio);
 192
 193         /* osfmk/kern/thread.h */
 194         struct uthread* (*get_bsdthread_info)(thread_t th);
 195         void (*thread_sched_call)(thread_t t, sched_call_t call);
 196         void (*thread_static_param)(thread_t t, boolean_t state);
 197         kern_return_t (*thread_create_workq)(task_t t, thread_continue_t c, thread_t *new_t);
 198         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);
 199
 200         /* osfmk/kern/affinity.h */
 201         kern_return_t (*thread_affinity_set)(thread_t thread, uint32_t tag);
 202
 203         /* bsd/sys/systm.h */
 204         void (*unix_syscall_return)(int error);
 205
 206         /* osfmk/kern/zalloc.h */
 207         void* (*zalloc)(zone_t zone);
 208         void (*zfree)(zone_t zone, void* ptr);
 209         zone_t (*zinit)(vm_size_t, vm_size_t maxmem, vm_size_t alloc, const char *name);
 210
 211         /* bsd/kerb/kern_sig.c */
 212         void (*__pthread_testcancel)(int);
 213
 214         /* calls without portfolio */
 215         kern_return_t (*mach_port_deallocate)(ipc_space_t space, mach_port_name_t name);
 216         kern_return_t (*semaphore_signal_internal_trap)(mach_port_name_t sema_name);
 217         vm_map_t (*current_map)(void);
 218
 219         /* osfmk/kern/thread.h */
 220         ipc_port_t (*convert_thread_to_port)(thread_t th);
 221
 222         /* mach/task.h */
 223         kern_return_t (*thread_create)(task_t parent_task, thread_act_t *child_act);
 224
 225         /* mach/thread_act.h */
 226         kern_return_t (*thread_resume)(thread_act_t target_act);
 227
 228         /* osfmk/<arch>/machine_routines.h */
 229         int (*ml_get_max_cpus)(void);
 230
 231
 232         /* <rdar://problem/12809089> xnu: struct proc p_dispatchqueue_serialno_offset additions */
 233         uint64_t (*proc_get_dispatchqueue_serialno_offset)(struct proc *p);
 234         void (*proc_set_dispatchqueue_serialno_offset)(struct proc *p, uint64_t offset);
 235
 236         int (*proc_usynch_thread_qos_add_override_for_resource_check_owner)(thread_t thread, int override_qos, boolean_t first_override_for_resource,
 237                         user_addr_t resource, int resource_type, user_addr_t user_lock_addr, mach_port_name_t user_lock_owner);
 238         void *unused_was_proc_set_stack_addr_hint;
 239
 240         uint32_t (*proc_get_pthread_tsd_offset)(struct proc *p);
 241         void (*proc_set_pthread_tsd_offset)(struct proc *p, uint32_t pthread_tsd_offset);
 242
 243         kern_return_t (*thread_set_tsd_base)(thread_t thread, mach_vm_offset_t tsd_base);
 244
 245         int     (*proc_usynch_get_requested_thread_qos)(struct uthread *);
 246         void *unused_was_proc_usynch_thread_qos_add_override;
 247         void *unused_was_proc_usynch_thread_qos_remove_override;
 248
 249         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);
 250         boolean_t (*qos_main_thread_active)(void);
 251
 252         kern_return_t (*thread_set_voucher_name)(mach_port_name_t voucher_name);
 253
 254         boolean_t (*proc_usynch_thread_qos_add_override_for_resource)(task_t task, struct uthread *, uint64_t tid, int override_qos, boolean_t first_override_for_resource, user_addr_t resource, int resource_type);
 255         boolean_t (*proc_usynch_thread_qos_remove_override_for_resource)(task_t task, struct uthread *, uint64_t tid, user_addr_t resource, int resource_type);
 256         boolean_t (*proc_usynch_thread_qos_reset_override_for_resource)(task_t task, struct uthread *, uint64_t tid, user_addr_t resource, int resource_type);
 257
 258         boolean_t (*proc_init_wqptr_or_wait)(proc_t proc);
 259
 260         uint16_t (*thread_set_tag)(thread_t thread, uint16_t tag);
 261         uint16_t (*thread_get_tag)(thread_t thread);
 262
 263         int (*proc_usynch_thread_qos_squash_override_for_resource)(thread_t thread, user_addr_t resource, int resource_type);
 264         int (*task_get_default_manager_qos)(task_t task);
 265
 266         int (*thread_create_workq_waiting)(task_t task, thread_continue_t thread_return, event_t event, thread_t *new_thread);
 267
 268         user_addr_t (*proc_get_stack_addr_hint)(struct proc *p);
 269         void (*proc_set_stack_addr_hint)(struct proc *p, user_addr_t stack_addr_hint);
 270
 271         /* padding for future */
 272         void* _pad[76];
 273
 274 } *pthread_callbacks_t;
 275
 276 void
 277 pthread_kext_register(pthread_functions_t fns, pthread_callbacks_t *callbacks);
 278
 279 #ifdef BSD_KERNEL_PRIVATE
 280 void workqueue_mark_exiting(struct proc *);
 281 void workqueue_exit(struct proc *);
 282 void workqueue_thread_yielded(void);
 283 sched_call_t workqueue_get_sched_callback(void);
 284 void pthread_init(void);
 285
 286 extern pthread_callbacks_t pthread_kern;
 287 extern pthread_functions_t pthread_functions;
 288 #endif
 289
 290 #endif /* ASSEMBLER */
 291 #endif /* _PTHREAD_SHIMS_H_ */
 292 #endif /* KERNEL_PRIVATE */