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