private/workqueue_private.h

   1 /*
   2  * Copyright (c) 2007, 2012 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef __PTHREAD_WORKQUEUE_H__
  25 #define __PTHREAD_WORKQUEUE_H__
  26
  27 #include <stdbool.h>
  28 #include <sys/cdefs.h>
  29 #include <sys/event.h>
  30 #include <Availability.h>
  31 #include <pthread/pthread.h>
  32 #include <pthread/qos.h>
  33 #ifndef _PTHREAD_BUILDING_PTHREAD_
  34 #include <pthread/qos_private.h>
  35 #endif
  36
  37 #define PTHREAD_WORKQUEUE_SPI_VERSION 20170201
  38
  39 /* Feature checking flags, returned by _pthread_workqueue_supported()
  40  *
  41  * Note: These bits should match the definition of PTHREAD_FEATURE_*
  42  * bits defined in libpthread/kern/kern_internal.h */
  43
  44 #define WORKQ_FEATURE_DISPATCHFUNC      0x01    // pthread_workqueue_setdispatch_np is supported (or not)
  45 #define WORKQ_FEATURE_FINEPRIO          0x02    // fine grained pthread workq priorities
  46 #define WORKQ_FEATURE_MAINTENANCE       0x10    // QOS class maintenance
  47 #define WORKQ_FEATURE_KEVENT        0x40    // Support for direct kevent delivery
  48 #define WORKQ_FEATURE_WORKLOOP      0x80    // Support for direct workloop requests
  49
  50 /* Legacy dispatch priority bands */
  51
  52 #define WORKQ_NUM_PRIOQUEUE     4
  53
  54 #define WORKQ_HIGH_PRIOQUEUE    0       // high priority queue
  55 #define WORKQ_DEFAULT_PRIOQUEUE 1       // default priority queue
  56 #define WORKQ_LOW_PRIOQUEUE     2       // low priority queue
  57 #define WORKQ_BG_PRIOQUEUE      3       // background priority queue
  58 #define WORKQ_NON_INTERACTIVE_PRIOQUEUE 128 // libdispatch SPI level
  59
  60 /* Legacy dispatch workqueue function flags */
  61 #define WORKQ_ADDTHREADS_OPTION_OVERCOMMIT 0x00000001
  62
  63 __BEGIN_DECLS
  64
  65 // Legacy callback prototype, used with pthread_workqueue_setdispatch_np
  66 typedef void (*pthread_workqueue_function_t)(int queue_priority, int options, void *ctxt);
  67 // New callback prototype, used with pthread_workqueue_init
  68 typedef void (*pthread_workqueue_function2_t)(pthread_priority_t priority);
  69
  70 // Newer callback prototype, used in conjection with function2 when there are kevents to deliver
  71 // both parameters are in/out parameters
  72 #define WORKQ_KEVENT_EVENT_BUFFER_LEN 16
  73 typedef void (*pthread_workqueue_function_kevent_t)(void **events, int *nevents);
  74
  75 typedef void (*pthread_workqueue_function_workloop_t)(uint64_t *workloop_id, void **events, int *nevents);
  76
  77 // Initialises the pthread workqueue subsystem, passing the new-style callback prototype,
  78 // the dispatchoffset and an unused flags field.
  79 __API_AVAILABLE(macos(10.10), ios(8.0))
  80 int
  81 _pthread_workqueue_init(pthread_workqueue_function2_t func, int offset, int flags);
  82
  83 __API_AVAILABLE(macos(10.11), ios(9.0))
  84 int
  85 _pthread_workqueue_init_with_kevent(pthread_workqueue_function2_t queue_func, pthread_workqueue_function_kevent_t kevent_func, int offset, int flags);
  86
  87 __API_AVAILABLE(macos(10.13), ios(11.0), tvos(11.0), watchos(4.0))
  88 int
  89 _pthread_workqueue_init_with_workloop(pthread_workqueue_function2_t queue_func, pthread_workqueue_function_kevent_t kevent_func, pthread_workqueue_function_workloop_t workloop_func, int offset, int flags);
  90
  91 // Non-zero enables kill on current thread, zero disables it.
  92 __API_AVAILABLE(macos(10.6), ios(3.2))
  93 int
  94 __pthread_workqueue_setkill(int);
  95
  96 // Dispatch function to be called when new worker threads are created.
  97 __API_AVAILABLE(macos(10.8), ios(6.0))
  98 int
  99 pthread_workqueue_setdispatch_np(pthread_workqueue_function_t worker_func);
 100
 101 // Dispatch offset to be set in the kernel.
 102 __API_AVAILABLE(macos(10.9), ios(7.0))
 103 void
 104 pthread_workqueue_setdispatchoffset_np(int offset);
 105
 106 // Request additional worker threads.
 107 __API_AVAILABLE(macos(10.8), ios(6.0))
 108 int
 109 pthread_workqueue_addthreads_np(int queue_priority, int options, int numthreads);
 110
 111 // Retrieve the supported pthread feature set
 112 __API_AVAILABLE(macos(10.10), ios(8.0))
 113 int
 114 _pthread_workqueue_supported(void);
 115
 116 // Request worker threads (fine grained priority)
 117 __API_AVAILABLE(macos(10.10), ios(8.0))
 118 int
 119 _pthread_workqueue_addthreads(int numthreads, pthread_priority_t priority);
 120
 121 // Should this thread return to the kernel?
 122 __API_AVAILABLE(macos(10.13), ios(11.0), tvos(11.0), watchos(4.0))
 123 bool
 124 _pthread_workqueue_should_narrow(pthread_priority_t priority);
 125
 126 __API_AVAILABLE(macos(10.11), ios(9.0))
 127 int
 128 _pthread_workqueue_set_event_manager_priority(pthread_priority_t priority);
 129
 130 // Apply a QoS override without allocating userspace memory
 131 __API_AVAILABLE(macos(10.12), ios(10.0), tvos(10.0), watchos(3.0))
 132 int
 133 _pthread_qos_override_start_direct(mach_port_t thread, pthread_priority_t priority, void *resource);
 134
 135 // Drop a corresponding QoS override made above, if the resource matches
 136 __API_AVAILABLE(macos(10.12), ios(10.0), tvos(10.0), watchos(3.0))
 137 int
 138 _pthread_qos_override_end_direct(mach_port_t thread, void *resource);
 139
 140 // Apply a QoS override without allocating userspace memory
 141 __API_DEPRECATED_WITH_REPLACEMENT("_pthread_qos_override_start_direct",
 142                 macos(10.10, 10.12), ios(8.0, 10.0), tvos(8.0, 10.0), watchos(1.0, 3.0))
 143 int
 144 _pthread_override_qos_class_start_direct(mach_port_t thread, pthread_priority_t priority);
 145
 146 // Drop a corresponding QoS override made above.
 147 __API_DEPRECATED_WITH_REPLACEMENT("_pthread_qos_override_end_direct",
 148                 macos(10.10, 10.12), ios(8.0, 10.0), tvos(8.0, 10.0), watchos(1.0, 3.0))
 149 int
 150 _pthread_override_qos_class_end_direct(mach_port_t thread);
 151
 152 // Apply a QoS override on a given workqueue thread.
 153 __API_AVAILABLE(macos(10.10), ios(8.0))
 154 int
 155 _pthread_workqueue_override_start_direct(mach_port_t thread, pthread_priority_t priority);
 156
 157 // Apply a QoS override on a given workqueue thread.
 158 __API_AVAILABLE(macos(10.12), ios(10.0), tvos(10.0), watchos(3.0))
 159 int
 160 _pthread_workqueue_override_start_direct_check_owner(mach_port_t thread, pthread_priority_t priority, mach_port_t *ulock_addr);
 161
 162 // Drop all QoS overrides on the current workqueue thread.
 163 __API_AVAILABLE(macos(10.10), ios(8.0))
 164 int
 165 _pthread_workqueue_override_reset(void);
 166
 167 // Apply a QoS override on a given thread (can be non-workqueue as well) with a resource/queue token
 168 __API_AVAILABLE(macos(10.10.2))
 169 int
 170 _pthread_workqueue_asynchronous_override_add(mach_port_t thread, pthread_priority_t priority, void *resource);
 171
 172 // Reset overrides for the given resource for the current thread
 173 __API_AVAILABLE(macos(10.10.2))
 174 int
 175 _pthread_workqueue_asynchronous_override_reset_self(void *resource);
 176
 177 // Reset overrides for all resources for the current thread
 178 __API_AVAILABLE(macos(10.10.2))
 179 int
 180 _pthread_workqueue_asynchronous_override_reset_all_self(void);
 181
 182 __API_AVAILABLE(macos(10.14), ios(12.0), tvos(12.0), watchos(5.0))
 183 int
 184 _pthread_workloop_create(uint64_t workloop_id, uint64_t options, pthread_attr_t *attr);
 185
 186 __API_AVAILABLE(macos(10.14), ios(12.0), tvos(12.0), watchos(5.0))
 187 int
 188 _pthread_workloop_destroy(uint64_t workloop_id);
 189
 190 __END_DECLS
 191
 192 #endif // __PTHREAD_WORKQUEUE_H__