1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2000 Doug Rabson 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _SYS_TASKQUEUE_H_ 32 #define _SYS_TASKQUEUE_H_ 33 34 #ifndef _KERNEL 35 #error "no user-serviceable parts inside" 36 #endif 37 38 #include <sys/queue.h> 39 #include <sys/_task.h> 40 #include <sys/_callout.h> 41 #include <sys/_cpuset.h> 42 43 struct taskqueue; 44 struct taskqgroup; 45 struct proc; 46 struct thread; 47 48 struct timeout_task { 49 struct taskqueue *q; 50 struct task t; 51 struct callout c; 52 int f; 53 }; 54 55 enum taskqueue_callback_type { 56 TASKQUEUE_CALLBACK_TYPE_INIT, 57 TASKQUEUE_CALLBACK_TYPE_SHUTDOWN, 58 }; 59 #define TASKQUEUE_CALLBACK_TYPE_MIN TASKQUEUE_CALLBACK_TYPE_INIT 60 #define TASKQUEUE_CALLBACK_TYPE_MAX TASKQUEUE_CALLBACK_TYPE_SHUTDOWN 61 #define TASKQUEUE_NUM_CALLBACKS TASKQUEUE_CALLBACK_TYPE_MAX + 1 62 #define TASKQUEUE_NAMELEN 32 63 64 typedef void (*taskqueue_callback_fn)(void *context); 65 66 /* 67 * A notification callback function which is called from 68 * taskqueue_enqueue(). The context argument is given in the call to 69 * taskqueue_create(). This function would normally be used to allow the 70 * queue to arrange to run itself later (e.g., by scheduling a software 71 * interrupt or waking a kernel thread). 72 */ 73 typedef void (*taskqueue_enqueue_fn)(void *context); 74 75 struct taskqueue *taskqueue_create(const char *name, int mflags, 76 taskqueue_enqueue_fn enqueue, 77 void *context); 78 int taskqueue_start_threads(struct taskqueue **tqp, int count, int pri, 79 const char *name, ...) __printflike(4, 5); 80 int taskqueue_start_threads_in_proc(struct taskqueue **tqp, int count, 81 int pri, struct proc *p, const char *name, ...) __printflike(5, 6); 82 int taskqueue_start_threads_cpuset(struct taskqueue **tqp, int count, 83 int pri, cpuset_t *mask, const char *name, ...) __printflike(5, 6); 84 int taskqueue_enqueue(struct taskqueue *queue, struct task *task); 85 int taskqueue_enqueue_timeout(struct taskqueue *queue, 86 struct timeout_task *timeout_task, int ticks); 87 int taskqueue_enqueue_timeout_sbt(struct taskqueue *queue, 88 struct timeout_task *timeout_task, sbintime_t sbt, sbintime_t pr, 89 int flags); 90 int taskqueue_poll_is_busy(struct taskqueue *queue, struct task *task); 91 int taskqueue_cancel(struct taskqueue *queue, struct task *task, 92 u_int *pendp); 93 int taskqueue_cancel_timeout(struct taskqueue *queue, 94 struct timeout_task *timeout_task, u_int *pendp); 95 void taskqueue_drain(struct taskqueue *queue, struct task *task); 96 void taskqueue_drain_timeout(struct taskqueue *queue, 97 struct timeout_task *timeout_task); 98 void taskqueue_drain_all(struct taskqueue *queue); 99 void taskqueue_quiesce(struct taskqueue *queue); 100 void taskqueue_free(struct taskqueue *queue); 101 void taskqueue_run(struct taskqueue *queue); 102 void taskqueue_block(struct taskqueue *queue); 103 void taskqueue_unblock(struct taskqueue *queue); 104 int taskqueue_member(struct taskqueue *queue, struct thread *td); 105 void taskqueue_set_callback(struct taskqueue *queue, 106 enum taskqueue_callback_type cb_type, 107 taskqueue_callback_fn callback, void *context); 108 109 #define TASK_INITIALIZER(priority, func, context) \ 110 { .ta_priority = (priority), \ 111 .ta_func = (func), \ 112 .ta_context = (context) } 113 114 /* 115 * Functions for dedicated thread taskqueues 116 */ 117 void taskqueue_thread_loop(void *arg); 118 void taskqueue_thread_enqueue(void *context); 119 120 /* 121 * Initialise a task structure. 122 */ 123 #define TASK_INIT_FLAGS(task, priority, func, context, flags) do { \ 124 (task)->ta_pending = 0; \ 125 (task)->ta_priority = (priority); \ 126 (task)->ta_flags = (flags); \ 127 (task)->ta_func = (func); \ 128 (task)->ta_context = (context); \ 129 } while (0) 130 131 #define TASK_INIT(t, p, f, c) TASK_INIT_FLAGS(t, p, f, c, 0) 132 133 void _timeout_task_init(struct taskqueue *queue, 134 struct timeout_task *timeout_task, int priority, task_fn_t func, 135 void *context); 136 #define TIMEOUT_TASK_INIT(queue, timeout_task, priority, func, context) do { \ 137 _Static_assert((priority) >= 0 && (priority) <= 255, \ 138 "struct task priority is 8 bit in size"); \ 139 _timeout_task_init(queue, timeout_task, priority, func, context); \ 140 } while (0) 141 142 /* 143 * Declare a reference to a taskqueue. 144 */ 145 #define TASKQUEUE_DECLARE(name) \ 146 extern struct taskqueue *taskqueue_##name 147 148 /* 149 * Define and initialise a global taskqueue that uses sleep mutexes. 150 */ 151 #define TASKQUEUE_DEFINE(name, enqueue, context, init) \ 152 \ 153 struct taskqueue *taskqueue_##name; \ 154 \ 155 static void \ 156 taskqueue_define_##name(void *arg) \ 157 { \ 158 taskqueue_##name = \ 159 taskqueue_create(#name, M_WAITOK, (enqueue), (context)); \ 160 init; \ 161 } \ 162 \ 163 SYSINIT(taskqueue_##name, SI_SUB_TASKQ, SI_ORDER_SECOND, \ 164 taskqueue_define_##name, NULL); \ 165 \ 166 struct __hack 167 #define TASKQUEUE_DEFINE_THREAD(name) \ 168 TASKQUEUE_DEFINE(name, taskqueue_thread_enqueue, &taskqueue_##name, \ 169 taskqueue_start_threads(&taskqueue_##name, 1, PWAIT, \ 170 "%s taskq", #name)) 171 172 /* 173 * Define and initialise a global taskqueue that uses spin mutexes. 174 */ 175 #define TASKQUEUE_FAST_DEFINE(name, enqueue, context, init) \ 176 \ 177 struct taskqueue *taskqueue_##name; \ 178 \ 179 static void \ 180 taskqueue_define_##name(void *arg) \ 181 { \ 182 taskqueue_##name = \ 183 taskqueue_create_fast(#name, M_WAITOK, (enqueue), \ 184 (context)); \ 185 init; \ 186 } \ 187 \ 188 SYSINIT(taskqueue_##name, SI_SUB_TASKQ, SI_ORDER_SECOND, \ 189 taskqueue_define_##name, NULL); \ 190 \ 191 struct __hack 192 #define TASKQUEUE_FAST_DEFINE_THREAD(name) \ 193 TASKQUEUE_FAST_DEFINE(name, taskqueue_thread_enqueue, \ 194 &taskqueue_##name, taskqueue_start_threads(&taskqueue_##name \ 195 1, PWAIT, "%s taskq", #name)) 196 197 /* 198 * These queues are serviced by software interrupt handlers. To enqueue 199 * a task, call taskqueue_enqueue(taskqueue_swi, &task) or 200 * taskqueue_enqueue(taskqueue_swi_giant, &task). 201 */ 202 TASKQUEUE_DECLARE(swi_giant); 203 TASKQUEUE_DECLARE(swi); 204 205 /* 206 * This queue is serviced by a kernel thread. To enqueue a task, call 207 * taskqueue_enqueue(taskqueue_thread, &task). 208 */ 209 TASKQUEUE_DECLARE(thread); 210 211 /* 212 * Queue for swi handlers dispatched from fast interrupt handlers. 213 * These are necessarily different from the above because the queue 214 * must be locked with spinlocks since sleep mutex's cannot be used 215 * from a fast interrupt handler context. 216 */ 217 TASKQUEUE_DECLARE(fast); 218 struct taskqueue *taskqueue_create_fast(const char *name, int mflags, 219 taskqueue_enqueue_fn enqueue, 220 void *context); 221 222 #endif /* !_SYS_TASKQUEUE_H_ */ 223