1/* 2 * Copyright (c) 2014 Apple Computer, 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 _WORKQUEUE_INTERNAL_H_ 30#define _WORKQUEUE_INTERNAL_H_ 31 32/* These definitions are shared between the kext and userspace inside the pthread project. Consolidating 33 * duplicate definitions that used to exist in both projects, when separate. 34 */ 35 36/* workq_kernreturn commands */ 37#define WQOPS_THREAD_RETURN 4 38#define WQOPS_QUEUE_NEWSPISUPP 0x10 /* this is to check for newer SPI support */ 39#define WQOPS_QUEUE_REQTHREADS 0x20 /* request number of threads of a prio */ 40#define WQOPS_QUEUE_REQTHREADS2 0x30 /* request a number of threads in a given priority bucket */ 41 42/* flag values for reuse field in the libc side _pthread_wqthread */ 43#define WQ_FLAG_THREAD_PRIOMASK 0x0000ffff 44#define WQ_FLAG_THREAD_PRIOSHIFT (8ull) 45#define WQ_FLAG_THREAD_OVERCOMMIT 0x00010000 /* thread is with overcommit prio */ 46#define WQ_FLAG_THREAD_REUSE 0x00020000 /* thread is being reused */ 47#define WQ_FLAG_THREAD_NEWSPI 0x00040000 /* the call is with new SPIs */ 48 49/* These definitions are only available to the kext, to avoid bleeding constants and types across the boundary to 50 * the userspace library. 51 */ 52#ifdef KERNEL 53 54/* These defines come from kern/thread.h but are XNU_KERNEL_PRIVATE so do not get 55 * exported to kernel extensions. 56 */ 57#define SCHED_CALL_BLOCK 0x1 58#define SCHED_CALL_UNBLOCK 0x2 59 60// kwe_state 61enum { 62 KWE_THREAD_INWAIT = 1, 63 KWE_THREAD_PREPOST, 64 KWE_THREAD_BROADCAST, 65}; 66 67/* old workq priority scheme */ 68 69#define WORKQUEUE_HIGH_PRIOQUEUE 0 /* high priority queue */ 70#define WORKQUEUE_DEFAULT_PRIOQUEUE 1 /* default priority queue */ 71#define WORKQUEUE_LOW_PRIOQUEUE 2 /* low priority queue */ 72#define WORKQUEUE_BG_PRIOQUEUE 3 /* background priority queue */ 73 74#define WORKQUEUE_NUM_BUCKETS 6 75 76/* wq_max_constrained_threads = max(64, N_CPU * WORKQUEUE_CONSTRAINED_FACTOR) 77 * This used to be WORKQUEUE_NUM_BUCKETS + 1 when NUM_BUCKETS was 4, yielding 78 * N_CPU * 5. When NUM_BUCKETS changed, we decided that the limit should 79 * not change. So the factor is now always 5. 80 */ 81#define WORKQUEUE_CONSTRAINED_FACTOR 5 82 83#define WORKQUEUE_OVERCOMMIT 0x10000 84 85struct threadlist { 86 TAILQ_ENTRY(threadlist) th_entry; 87 thread_t th_thread; 88 int th_flags; 89 uint8_t th_priority; 90 uint8_t th_policy; 91 struct workqueue *th_workq; 92 mach_vm_size_t th_stacksize; 93 mach_vm_size_t th_allocsize; 94 mach_vm_offset_t th_stackaddr; 95 mach_port_name_t th_thport; 96 uint32_t th_override_count; 97 uint32_t th_dispatch_override_count; 98}; 99#define TH_LIST_INITED 0x01 100#define TH_LIST_RUNNING 0x02 101#define TH_LIST_BLOCKED 0x04 102#define TH_LIST_SUSPENDED 0x08 103#define TH_LIST_BUSY 0x10 104#define TH_LIST_NEED_WAKEUP 0x20 105#define TH_LIST_CONSTRAINED 0x40 106 107 108struct workqueue { 109 proc_t wq_proc; 110 vm_map_t wq_map; 111 task_t wq_task; 112 thread_call_t wq_atimer_call; 113 int wq_flags; 114 int wq_lflags; 115 uint64_t wq_thread_yielded_timestamp; 116 uint32_t wq_thread_yielded_count; 117 uint32_t wq_timer_interval; 118 uint32_t wq_max_concurrency; 119 uint32_t wq_threads_scheduled; 120 uint32_t wq_constrained_threads_scheduled; 121 uint32_t wq_nthreads; 122 uint32_t wq_thidlecount; 123 uint32_t wq_reqcount; 124 TAILQ_HEAD(, threadlist) wq_thrunlist; 125 TAILQ_HEAD(, threadlist) wq_thidlelist; 126 uint16_t wq_requests[WORKQUEUE_NUM_BUCKETS]; 127 uint16_t wq_ocrequests[WORKQUEUE_NUM_BUCKETS]; 128 uint16_t wq_reqconc[WORKQUEUE_NUM_BUCKETS]; /* requested concurrency for each priority level */ 129 uint16_t wq_thscheduled_count[WORKQUEUE_NUM_BUCKETS]; 130 uint32_t wq_thactive_count[WORKQUEUE_NUM_BUCKETS] __attribute__((aligned(4))); /* must be uint32_t since we OSAddAtomic on these */ 131 uint64_t wq_lastblocked_ts[WORKQUEUE_NUM_BUCKETS] __attribute__((aligned(8))); 132}; 133#define WQ_LIST_INITED 0x01 134#define WQ_ATIMER_RUNNING 0x02 135#define WQ_EXITING 0x04 136 137#define WQL_ATIMER_BUSY 0x01 138#define WQL_ATIMER_WAITING 0x02 139#define WQL_EXCEEDED_CONSTRAINED_THREAD_LIMIT 0x04 140#define WQL_EXCEEDED_TOTAL_THREAD_LIMIT 0x08 141 142 143#define WQ_VECT_SET_BIT(vector, bit) \ 144 vector[(bit) / 32] |= (1 << ((bit) % 32)) 145 146#define WQ_VECT_CLEAR_BIT(vector, bit) \ 147 vector[(bit) / 32] &= ~(1 << ((bit) % 32)) 148 149#define WQ_VECT_TEST_BIT(vector, bit) \ 150 vector[(bit) / 32] & (1 << ((bit) % 32)) 151 152#define WORKQUEUE_MAXTHREADS 512 153#define WQ_YIELDED_THRESHOLD 2000 154#define WQ_YIELDED_WINDOW_USECS 30000 155#define WQ_STALLED_WINDOW_USECS 200 156#define WQ_REDUCE_POOL_WINDOW_USECS 5000000 157#define WQ_MAX_TIMER_INTERVAL_USECS 50000 158 159#endif // KERNEL 160 161#endif // _WORKQUEUE_INTERNAL_H_ 162