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 <sys/cdefs.h>
  28 #include <Availability.h>
  29 #include <pthread/pthread.h>
  30 #include <pthread/qos.h>
  31 #ifndef _PTHREAD_BUILDING_PTHREAD_
  32 #include <pthread/qos_private.h>
  33 #endif
  34
  35 #define PTHREAD_WORKQUEUE_SPI_VERSION 20140730
  36
  37 /* Feature checking flags, returned by _pthread_workqueue_supported()
  38  *
  39  * Note: These bits should match the definition of PTHREAD_FEATURE_*
  40  * bits defined in libpthread/kern/kern_internal.h */
  41
  42 #define WORKQ_FEATURE_DISPATCHFUNC      0x01    // pthread_workqueue_setdispatch_np is supported (or not)
  43 #define WORKQ_FEATURE_FINEPRIO          0x02    // fine grained pthread workq priorities
  44 #define WORKQ_FEATURE_MAINTENANCE       0x10    // QOS class maintenance
  45
  46 /* Legacy dispatch priority bands */
  47
  48 #define WORKQ_NUM_PRIOQUEUE     4
  49
  50 #define WORKQ_HIGH_PRIOQUEUE    0       // high priority queue
  51 #define WORKQ_DEFAULT_PRIOQUEUE 1       // default priority queue
  52 #define WORKQ_LOW_PRIOQUEUE     2       // low priority queue
  53 #define WORKQ_BG_PRIOQUEUE      3       // background priority queue
  54 #define WORKQ_NON_INTERACTIVE_PRIOQUEUE 128 // libdispatch SPI level
  55
  56 /* Legacy dispatch workqueue function flags */
  57 #define WORKQ_ADDTHREADS_OPTION_OVERCOMMIT 0x00000001
  58
  59 __BEGIN_DECLS
  60
  61 // Legacy callback prototype, used with pthread_workqueue_setdispatch_np
  62 typedef void (*pthread_workqueue_function_t)(int queue_priority, int options, void *ctxt);
  63 // New callback prototype, used with pthread_workqueue_init
  64 typedef void (*pthread_workqueue_function2_t)(pthread_priority_t priority);
  65
  66 // Initialises the pthread workqueue subsystem, passing the new-style callback prototype,
  67 // the dispatchoffset and an unused flags field.
  68 __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0)
  69 int
  70 _pthread_workqueue_init(pthread_workqueue_function2_t func, int offset, int flags);
  71
  72 // Non-zero enables kill on current thread, zero disables it.
  73 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2)
  74 int
  75 __pthread_workqueue_setkill(int);
  76
  77 // Dispatch function to be called when new worker threads are created.
  78 __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0)
  79 int
  80 pthread_workqueue_setdispatch_np(pthread_workqueue_function_t worker_func);
  81
  82 // Dispatch offset to be set in the kernel.
  83 __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0)
  84 void
  85 pthread_workqueue_setdispatchoffset_np(int offset);
  86
  87 // Request additional worker threads.
  88 __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0)
  89 int
  90 pthread_workqueue_addthreads_np(int queue_priority, int options, int numthreads);
  91
  92 // Retrieve the supported pthread feature set
  93 __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0)
  94 int
  95 _pthread_workqueue_supported(void);
  96
  97 // Request worker threads (fine grained priority)
  98 __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0)
  99 int
 100 _pthread_workqueue_addthreads(int numthreads, pthread_priority_t priority);
 101
 102 // Apply a QoS override without allocating userspace memory
 103 __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0)
 104 int
 105 _pthread_override_qos_class_start_direct(mach_port_t thread, pthread_priority_t priority);
 106
 107 // Drop a corresponding QoS override made above.
 108 __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0)
 109 int
 110 _pthread_override_qos_class_end_direct(mach_port_t thread);
 111
 112 // Apply a QoS override on a given workqueue thread.
 113 __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0)
 114 int
 115 _pthread_workqueue_override_start_direct(mach_port_t thread, pthread_priority_t priority);
 116
 117 // Drop all QoS overrides on the current workqueue thread.
 118 __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0)
 119 int
 120 _pthread_workqueue_override_reset(void);
 121
 122 // Apply a QoS override on a given thread (can be non-workqueue as well) with a resource/queue token
 123 __OSX_AVAILABLE_STARTING(__MAC_10_10_2, __IPHONE_NA)
 124 int
 125 _pthread_workqueue_asynchronous_override_add(mach_port_t thread, pthread_priority_t priority, void *resource);
 126
 127 // Reset overrides for the given resource for the current thread
 128 __OSX_AVAILABLE_STARTING(__MAC_10_10_2, __IPHONE_NA)
 129 int
 130 _pthread_workqueue_asynchronous_override_reset_self(void *resource);
 131
 132 // Reset overrides for all resources for the current thread
 133 __OSX_AVAILABLE_STARTING(__MAC_10_10_2, __IPHONE_NA)
 134 int
 135 _pthread_workqueue_asynchronous_override_reset_all_self(void);
 136
 137 __END_DECLS
 138
 139 #endif // __PTHREAD_WORKQUEUE_H__