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 thread; 43 44 struct timeout_task { 45 struct taskqueue *q; 46 struct task t; 47 struct callout c; 48 int f; 49 }; 50 51 enum taskqueue_callback_type { 52 TASKQUEUE_CALLBACK_TYPE_INIT, 53 TASKQUEUE_CALLBACK_TYPE_SHUTDOWN, 54 }; 55 #define TASKQUEUE_CALLBACK_TYPE_MIN TASKQUEUE_CALLBACK_TYPE_INIT 56 #define TASKQUEUE_CALLBACK_TYPE_MAX TASKQUEUE_CALLBACK_TYPE_SHUTDOWN 57 #define TASKQUEUE_NUM_CALLBACKS TASKQUEUE_CALLBACK_TYPE_MAX + 1 58 59 typedef void (*taskqueue_callback_fn)(void *context); 60 61 /* 62 * A notification callback function which is called from 63 * taskqueue_enqueue(). The context argument is given in the call to 64 * taskqueue_create(). This function would normally be used to allow the 65 * queue to arrange to run itself later (e.g., by scheduling a software 66 * interrupt or waking a kernel thread). 67 */ 68 typedef void (*taskqueue_enqueue_fn)(void *context); 69 70 struct taskqueue *taskqueue_create(const char *name, int mflags, 71 taskqueue_enqueue_fn enqueue, 72 void *context); 73 int taskqueue_start_threads(struct taskqueue **tqp, int count, int pri, 74 const char *name, ...) __printflike(4, 5); 75 int taskqueue_start_threads_cpuset(struct taskqueue **tqp, int count, 76 int pri, cpuset_t *mask, const char *name, ...) __printflike(5, 6); 77 int taskqueue_enqueue(struct taskqueue *queue, struct task *task); 78 int taskqueue_enqueue_timeout(struct taskqueue *queue, 79 struct timeout_task *timeout_task, int ticks); 80 int taskqueue_cancel(struct taskqueue *queue, struct task *task, 81 u_int *pendp); 82 int taskqueue_cancel_timeout(struct taskqueue *queue, 83 struct timeout_task *timeout_task, u_int *pendp); 84 void taskqueue_drain(struct taskqueue *queue, struct task *task); 85 void taskqueue_drain_timeout(struct taskqueue *queue, 86 struct timeout_task *timeout_task); 87 void taskqueue_drain_all(struct taskqueue *queue); 88 void taskqueue_free(struct taskqueue *queue); 89 void taskqueue_run(struct taskqueue *queue); 90 void taskqueue_block(struct taskqueue *queue); 91 void taskqueue_unblock(struct taskqueue *queue); 92 int taskqueue_member(struct taskqueue *queue, struct thread *td); 93 void taskqueue_set_callback(struct taskqueue *queue, 94 enum taskqueue_callback_type cb_type, 95 taskqueue_callback_fn callback, void *context); 96 97 #define TASK_INITIALIZER(priority, func, context) \ 98 { .ta_pending = 0, \ 99 .ta_priority = (priority), \ 100 .ta_func = (func), \ 101 .ta_context = (context) } 102 103 /* 104 * Functions for dedicated thread taskqueues 105 */ 106 void taskqueue_thread_loop(void *arg); 107 void taskqueue_thread_enqueue(void *context); 108 109 /* 110 * Initialise a task structure. 111 */ 112 #define TASK_INIT(task, priority, func, context) do { \ 113 (task)->ta_pending = 0; \ 114 (task)->ta_priority = (priority); \ 115 (task)->ta_func = (func); \ 116 (task)->ta_context = (context); \ 117 } while (0) 118 119 void _timeout_task_init(struct taskqueue *queue, 120 struct timeout_task *timeout_task, int priority, task_fn_t func, 121 void *context); 122 #define TIMEOUT_TASK_INIT(queue, timeout_task, priority, func, context) \ 123 _timeout_task_init(queue, timeout_task, priority, func, context); 124 125 /* 126 * Declare a reference to a taskqueue. 127 */ 128 #define TASKQUEUE_DECLARE(name) \ 129 extern struct taskqueue *taskqueue_##name 130 131 /* 132 * Define and initialise a global taskqueue that uses sleep mutexes. 133 */ 134 #define TASKQUEUE_DEFINE(name, enqueue, context, init) \ 135 \ 136 struct taskqueue *taskqueue_##name; \ 137 \ 138 static void \ 139 taskqueue_define_##name(void *arg) \ 140 { \ 141 taskqueue_##name = \ 142 taskqueue_create(#name, M_WAITOK, (enqueue), (context)); \ 143 init; \ 144 } \ 145 \ 146 SYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \ 147 taskqueue_define_##name, NULL); \ 148 \ 149 struct __hack 150 #define TASKQUEUE_DEFINE_THREAD(name) \ 151 TASKQUEUE_DEFINE(name, taskqueue_thread_enqueue, &taskqueue_##name, \ 152 taskqueue_start_threads(&taskqueue_##name, 1, PWAIT, \ 153 "%s taskq", #name)) 154 155 /* 156 * Define and initialise a global taskqueue that uses spin mutexes. 157 */ 158 #define TASKQUEUE_FAST_DEFINE(name, enqueue, context, init) \ 159 \ 160 struct taskqueue *taskqueue_##name; \ 161 \ 162 static void \ 163 taskqueue_define_##name(void *arg) \ 164 { \ 165 taskqueue_##name = \ 166 taskqueue_create_fast(#name, M_WAITOK, (enqueue), \ 167 (context)); \ 168 init; \ 169 } \ 170 \ 171 SYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \ 172 taskqueue_define_##name, NULL); \ 173 \ 174 struct __hack 175 #define TASKQUEUE_FAST_DEFINE_THREAD(name) \ 176 TASKQUEUE_FAST_DEFINE(name, taskqueue_thread_enqueue, \ 177 &taskqueue_##name, taskqueue_start_threads(&taskqueue_##name \ 178 1, PWAIT, "%s taskq", #name)) 179 180 /* 181 * These queues are serviced by software interrupt handlers. To enqueue 182 * a task, call taskqueue_enqueue(taskqueue_swi, &task) or 183 * taskqueue_enqueue(taskqueue_swi_giant, &task). 184 */ 185 TASKQUEUE_DECLARE(swi_giant); 186 TASKQUEUE_DECLARE(swi); 187 188 /* 189 * This queue is serviced by a kernel thread. To enqueue a task, call 190 * taskqueue_enqueue(taskqueue_thread, &task). 191 */ 192 TASKQUEUE_DECLARE(thread); 193 194 /* 195 * Queue for swi handlers dispatched from fast interrupt handlers. 196 * These are necessarily different from the above because the queue 197 * must be locked with spinlocks since sleep mutex's cannot be used 198 * from a fast interrupt handler context. 199 */ 200 TASKQUEUE_DECLARE(fast); 201 int taskqueue_enqueue_fast(struct taskqueue *queue, struct task *task); 202 struct taskqueue *taskqueue_create_fast(const char *name, int mflags, 203 taskqueue_enqueue_fn enqueue, 204 void *context); 205 206 #endif /* !_SYS_TASKQUEUE_H_ */ 207