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