xref: /xnu-11215/bsd/pthread/bsdthread_private.h (revision 94d3b452)
1 /*
2  * Copyright (c) 2017 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 #ifndef _PTHREAD_BSDTHREAD_PRIVATE_H_
30 #define _PTHREAD_BSDTHREAD_PRIVATE_H_
31 
32 #if XNU_KERNEL_PRIVATE && !defined(__PTHREAD_EXPOSE_INTERNALS__)
33 #define __PTHREAD_EXPOSE_INTERNALS__ 1
34 #endif // XNU_KERNEL_PRIVATE
35 
36 #ifdef __PTHREAD_EXPOSE_INTERNALS__
37 
38 /* pthread bsdthread_ctl sysctl commands */
39 /* bsdthread_ctl(BSDTHREAD_CTL_SET_QOS, thread_port, tsd_entry_addr, 0) */
40 #define BSDTHREAD_CTL_SET_QOS                           0x10
41 /* bsdthread_ctl(BSDTHREAD_CTL_GET_QOS, thread_port, 0, 0) */
42 #define BSDTHREAD_CTL_GET_QOS                           0x20
43 /* bsdthread_ctl(BSDTHREAD_CTL_QOS_OVERRIDE_START, thread_port, priority, 0) */
44 #define BSDTHREAD_CTL_QOS_OVERRIDE_START        0x40
45 /* bsdthread_ctl(BSDTHREAD_CTL_QOS_OVERRIDE_END, thread_port, 0, 0) */
46 #define BSDTHREAD_CTL_QOS_OVERRIDE_END          0x80
47 /* bsdthread_ctl(BSDTHREAD_CTL_SET_SELF, priority, voucher, flags) */
48 #define BSDTHREAD_CTL_SET_SELF                          0x100
49 /* bsdthread_ctl(BSDTHREAD_CTL_QOS_OVERRIDE_RESET, 0, 0, 0) */
50 #define BSDTHREAD_CTL_QOS_OVERRIDE_RESET        0x200
51 /* bsdthread_ctl(BSDTHREAD_CTL_QOS_OVERRIDE_DISPATCH, thread_port, priority, 0) */
52 #define BSDTHREAD_CTL_QOS_OVERRIDE_DISPATCH     0x400
53 /* bsdthread_ctl(BSDTHREAD_CTL_QOS_DISPATCH_ASYNCHRONOUS_OVERRIDE_ADD, thread_port, priority, resource) */
54 #define BSDTHREAD_CTL_QOS_DISPATCH_ASYNCHRONOUS_OVERRIDE_ADD            0x401
55 /* bsdthread_ctl(BSDTHREAD_CTL_QOS_DISPATCH_ASYNCHRONOUS_OVERRIDE_RESET, 0|1 (?reset_all), resource, 0) */
56 #define BSDTHREAD_CTL_QOS_DISPATCH_ASYNCHRONOUS_OVERRIDE_RESET          0x402
57 /* bsdthread_ctl(BSDTHREAD_CTL_QOS_MAX_PARALLELISM, priority, flags, 0) */
58 #define BSDTHREAD_CTL_QOS_MAX_PARALLELISM       0x800
59 /*
60  * bsdthread_ctl(BSDTHREAD_CTL_WORKQ_ALLOW_KILL, enable, 0, 0)
61  * It only affects the calling thread. Regular UNIX calls still need to be
62  * used to manipulate signal mask of the calling thread to allow delivery
63  * of a specific signal to it.
64  * It is typically used in abort paths so it does not need to worry about
65  * preserving sigmask across the thread's re-use. See workq_thread_return.
66  */
67 #define BSDTHREAD_CTL_WORKQ_ALLOW_KILL 0x1000
68 /* bsdthread_ctl(BSDTHREAD_CTL_DISPATCH_APPLY_ATTR, flags, val1, val2) */
69 #define BSDTHREAD_CTL_DISPATCH_APPLY_ATTR 0x2000
70 /*
71  * bsdthread_ctl(BSDTHREAD_CTL_WORKQ_ALLOW_SIGMASK, sigmask, 0, 0)
72  * This is a process wide configuration (as opposed to ALLOW_KILL) that
73  * provides the calling process an ability to send signals to all its
74  * pthread workqueue threads.
75  * Regular UNIX calls still need to be used to manipulate signal mask of
76  * each individual pthread worker thread to allow delivery of a specific
77  * signal to that thread.
78  * The @sigmask specified here is used internally by workqueue subsystem
79  * to preserve sigmask of pthread workqueue threads across their re-use.
80  * See workq_thread_return.
81  */
82 
83 #define BSDTHREAD_CTL_WORKQ_ALLOW_SIGMASK 0x4000
84 
85 /* Flags for BSDTHREAD_CTL_QOS_MAX_PARALLELISM */
86 #define _PTHREAD_QOS_PARALLELISM_COUNT_LOGICAL 0x1
87 #define _PTHREAD_QOS_PARALLELISM_REALTIME      0x2
88 #define _PTHREAD_QOS_PARALLELISM_CLUSTER_SHARED_RSRC      0x4
89 
90 
91 /* Flags for BSDTHREAD_CTL_DISPATCH_APPLY_ATTR */
92 #define _PTHREAD_DISPATCH_APPLY_ATTR_CLUSTER_SHARED_RSRC_SET    0x1
93 #define _PTHREAD_DISPATCH_APPLY_ATTR_CLUSTER_SHARED_RSRC_CLEAR  0x2
94 
95 
96 #endif // __PTHREAD_EXPOSE_INTERNALS__
97 #endif // _PTHREAD_BSDTHREAD_PRIVATE_H_
98