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_WORKQUEUE_PRIVATE_H_ |
30 | #define _PTHREAD_WORKQUEUE_PRIVATE_H_ |
31 | |
32 | #include <stdint.h> |
33 | |
34 | #if XNU_KERNEL_PRIVATE && !defined(__PTHREAD_EXPOSE_INTERNALS__) |
35 | #define __PTHREAD_EXPOSE_INTERNALS__ 1 |
36 | #endif // XNU_KERNEL_PRIVATE |
37 | |
38 | #ifdef __PTHREAD_EXPOSE_INTERNALS__ |
39 | /* workq_kernreturn commands */ |
40 | #define WQOPS_THREAD_RETURN 0x004 /* parks the thread back into the kernel */ |
41 | #define WQOPS_QUEUE_NEWSPISUPP 0x010 /* this is to check for newer SPI support */ |
42 | #define WQOPS_QUEUE_REQTHREADS 0x020 /* request number of threads of a prio */ |
43 | #define WQOPS_QUEUE_REQTHREADS2 0x030 /* request a number of threads in a given priority bucket */ |
44 | #define WQOPS_THREAD_KEVENT_RETURN 0x040 /* parks the thread after delivering the passed kevent array */ |
45 | #define WQOPS_SET_EVENT_MANAGER_PRIORITY 0x080 /* max() in the provided priority in the the priority of the event manager */ |
46 | #define WQOPS_THREAD_WORKLOOP_RETURN 0x100 /* parks the thread after delivering the passed kevent array */ |
47 | #define WQOPS_SHOULD_NARROW 0x200 /* checks whether we should narrow our concurrency */ |
48 | #define WQOPS_SETUP_DISPATCH 0x400 /* setup pthread workqueue-related operations */ |
49 | |
50 | /* flag values for upcall flags field, only 8 bits per struct threadlist */ |
51 | #define WQ_FLAG_THREAD_PRIO_SCHED 0x00008000 |
52 | #define WQ_FLAG_THREAD_PRIO_QOS 0x00004000 |
53 | #define WQ_FLAG_THREAD_PRIO_MASK 0x00000fff |
54 | |
55 | #define WQ_FLAG_THREAD_OVERCOMMIT 0x00010000 /* thread is with overcommit prio */ |
56 | #define WQ_FLAG_THREAD_REUSE 0x00020000 /* thread is being reused */ |
57 | #define WQ_FLAG_THREAD_NEWSPI 0x00040000 /* the call is with new SPIs */ |
58 | #define WQ_FLAG_THREAD_KEVENT 0x00080000 /* thread is response to kevent req */ |
59 | #define WQ_FLAG_THREAD_EVENT_MANAGER 0x00100000 /* event manager thread */ |
60 | #define WQ_FLAG_THREAD_TSD_BASE_SET 0x00200000 /* tsd base has already been set */ |
61 | #define WQ_FLAG_THREAD_WORKLOOP 0x00400000 /* workloop thread */ |
62 | #define WQ_FLAG_THREAD_OUTSIDEQOS 0x00800000 /* thread qos changes should not be sent to kernel */ |
63 | #define WQ_FLAG_THREAD_COOPERATIVE 0x01000000 /* thread is part of cooperative thread pool */ |
64 | |
65 | #define WQ_KEVENT_LIST_LEN 16 // WORKQ_KEVENT_EVENT_BUFFER_LEN |
66 | #define WQ_KEVENT_DATA_SIZE (32 * 1024) |
67 | |
68 | /* kqueue_workloop_ctl commands */ |
69 | #define KQ_WORKLOOP_CREATE 0x01 |
70 | #define KQ_WORKLOOP_DESTROY 0x02 |
71 | |
72 | /* indicate which fields of kq_workloop_create params are valid */ |
73 | #define KQ_WORKLOOP_CREATE_SCHED_PRI 0x01 |
74 | #define KQ_WORKLOOP_CREATE_SCHED_POL 0x02 |
75 | #define KQ_WORKLOOP_CREATE_CPU_PERCENT 0x04 |
76 | #define KQ_WORKLOOP_CREATE_WORK_INTERVAL 0x08 |
77 | |
78 | struct kqueue_workloop_params { |
79 | int kqwlp_version; |
80 | int kqwlp_flags; |
81 | uint64_t kqwlp_id; |
82 | int kqwlp_sched_pri; |
83 | int kqwlp_sched_pol; |
84 | int kqwlp_cpu_percent; |
85 | int kqwlp_cpu_refillms; |
86 | mach_port_name_t kqwl_wi_port; |
87 | } __attribute__((packed)); |
88 | |
89 | _Static_assert(offsetof(struct kqueue_workloop_params, kqwlp_version) == 0, |
90 | "kqwlp_version should be first" ); |
91 | |
92 | int |
93 | __workq_open(void); |
94 | |
95 | int |
96 | __workq_kernreturn(int op, void *arg2, int arg3, int arg4); |
97 | |
98 | int |
99 | __kqueue_workloop_ctl(uintptr_t cmd, uint64_t options, void *addr, size_t sz); |
100 | |
101 | /* SPI flags between WQ and workq_setup_thread in pthread.kext */ |
102 | #define WQ_SETUP_NONE 0 |
103 | #define WQ_SETUP_FIRST_USE 1 |
104 | #define WQ_SETUP_CLEAR_VOUCHER 2 |
105 | // was WQ_SETUP_SET_SCHED_CALL 4 |
106 | #define WQ_SETUP_EXIT_THREAD 8 |
107 | |
108 | #endif // __PTHREAD_EXPOSE_INTERNALS__ |
109 | |
110 | #define WORKQ_DISPATCH_CONFIG_VERSION 2 |
111 | #define WORKQ_DISPATCH_MIN_SUPPORTED_VERSION 1 |
112 | #define WORKQ_DISPATCH_SUPPORTED_FLAGS 0 |
113 | struct workq_dispatch_config { |
114 | uint32_t wdc_version; |
115 | uint32_t wdc_flags; |
116 | uint64_t wdc_queue_serialno_offs; |
117 | uint64_t wdc_queue_label_offs; |
118 | } __attribute__((packed, aligned(4))); |
119 | |
120 | #endif // _PTHREAD_WORKQUEUE_PRIVATE_H_ |
121 | |