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#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/* workq_kernreturn commands */
38#define WQOPS_THREAD_RETURN 0x04 /* parks the thread back into the kernel */
39#define WQOPS_QUEUE_NEWSPISUPP 0x10 /* this is to check for newer SPI support */
40#define WQOPS_QUEUE_REQTHREADS 0x20 /* request number of threads of a prio */
41#define WQOPS_QUEUE_REQTHREADS2 0x30 /* request a number of threads in a given priority bucket */
42#define WQOPS_THREAD_KEVENT_RETURN 0x40 /* parks the thread after delivering the passed kevent array */
43#define WQOPS_SET_EVENT_MANAGER_PRIORITY 0x80 /* max() in the provided priority in the the priority of the event manager */
44#define WQOPS_THREAD_WORKLOOP_RETURN 0x100 /* parks the thread after delivering the passed kevent array */
45#define WQOPS_SHOULD_NARROW 0x200 /* checks whether we should narrow our concurrency */
46
47/* flag values for upcall flags field, only 8 bits per struct threadlist */
48#define WQ_FLAG_THREAD_PRIO_SCHED 0x00008000
49#define WQ_FLAG_THREAD_PRIO_QOS 0x00004000
50#define WQ_FLAG_THREAD_PRIO_MASK 0x00000fff
51
52#define WQ_FLAG_THREAD_OVERCOMMIT 0x00010000 /* thread is with overcommit prio */
53#define WQ_FLAG_THREAD_REUSE 0x00020000 /* thread is being reused */
54#define WQ_FLAG_THREAD_NEWSPI 0x00040000 /* the call is with new SPIs */
55#define WQ_FLAG_THREAD_KEVENT 0x00080000 /* thread is response to kevent req */
56#define WQ_FLAG_THREAD_EVENT_MANAGER 0x00100000 /* event manager thread */
57#define WQ_FLAG_THREAD_TSD_BASE_SET 0x00200000 /* tsd base has already been set */
58#define WQ_FLAG_THREAD_WORKLOOP 0x00400000 /* workloop thread */
59#define WQ_FLAG_THREAD_OUTSIDEQOS 0x00800000 /* thread qos changes should not be sent to kernel */
60
61#define WQ_KEVENT_LIST_LEN 16 // WORKQ_KEVENT_EVENT_BUFFER_LEN
62#define WQ_KEVENT_DATA_SIZE (32 * 1024)
63
64/* kqueue_workloop_ctl commands */
65#define KQ_WORKLOOP_CREATE 0x01
66#define KQ_WORKLOOP_DESTROY 0x02
67
68/* indicate which fields of kq_workloop_create params are valid */
69#define KQ_WORKLOOP_CREATE_SCHED_PRI 0x01
70#define KQ_WORKLOOP_CREATE_SCHED_POL 0x02
71#define KQ_WORKLOOP_CREATE_CPU_PERCENT 0x04
72
73struct kqueue_workloop_params {
74 int kqwlp_version;
75 int kqwlp_flags;
76 uint64_t kqwlp_id;
77 int kqwlp_sched_pri;
78 int kqwlp_sched_pol;
79 int kqwlp_cpu_percent;
80 int kqwlp_cpu_refillms;
81} __attribute__((packed));
82
83_Static_assert(offsetof(struct kqueue_workloop_params, kqwlp_version) == 0,
84 "kqwlp_version should be first");
85
86int
87__workq_open(void);
88
89int
90__workq_kernreturn(int op, void *arg2, int arg3, int arg4);
91
92int
93__kqueue_workloop_ctl(uintptr_t cmd, uint64_t options, void *addr, size_t sz);
94
95/* SPI flags between WQ and workq_setup_thread in pthread.kext */
96#define WQ_SETUP_FIRST_USE 1
97#define WQ_SETUP_CLEAR_VOUCHER 2
98// was WQ_SETUP_SET_SCHED_CALL 4
99#define WQ_SETUP_EXIT_THREAD 8
100
101#endif // __PTHREAD_EXPOSE_INTERNALS__
102#endif // _PTHREAD_WORKQUEUE_PRIVATE_H_
103