2 * Copyright (c) 2000 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
33 #include <sys/interrupt.h>
34 #include <sys/kernel.h>
35 #include <sys/kthread.h>
36 #include <sys/limits.h>
38 #include <sys/malloc.h>
39 #include <sys/mutex.h>
41 #include <sys/sched.h>
42 #include <sys/taskqueue.h>
43 #include <sys/unistd.h>
44 #include <machine/stdarg.h>
46 static MALLOC_DEFINE(M_TASKQUEUE, "taskqueue", "Task Queues");
47 static void *taskqueue_giant_ih;
48 static void *taskqueue_ih;
50 struct taskqueue_busy {
51 struct task *tb_running;
52 TAILQ_ENTRY(taskqueue_busy) tb_link;
56 STAILQ_HEAD(, task) tq_queue;
57 taskqueue_enqueue_fn tq_enqueue;
59 TAILQ_HEAD(, taskqueue_busy) tq_active;
61 struct thread **tq_threads;
67 #define TQ_FLAGS_ACTIVE (1 << 0)
68 #define TQ_FLAGS_BLOCKED (1 << 1)
69 #define TQ_FLAGS_PENDING (1 << 2)
71 static void taskqueue_run_locked(struct taskqueue *);
74 TQ_LOCK(struct taskqueue *tq)
77 mtx_lock_spin(&tq->tq_mutex);
79 mtx_lock(&tq->tq_mutex);
83 TQ_UNLOCK(struct taskqueue *tq)
86 mtx_unlock_spin(&tq->tq_mutex);
88 mtx_unlock(&tq->tq_mutex);
92 TQ_SLEEP(struct taskqueue *tq, void *p, struct mtx *m, int pri, const char *wm,
96 return (msleep_spin(p, m, wm, t));
97 return (msleep(p, m, pri, wm, t));
100 static struct taskqueue *
101 _taskqueue_create(const char *name __unused, int mflags,
102 taskqueue_enqueue_fn enqueue, void *context,
103 int mtxflags, const char *mtxname)
105 struct taskqueue *queue;
107 queue = malloc(sizeof(struct taskqueue), M_TASKQUEUE, mflags | M_ZERO);
111 STAILQ_INIT(&queue->tq_queue);
112 TAILQ_INIT(&queue->tq_active);
113 queue->tq_enqueue = enqueue;
114 queue->tq_context = context;
115 queue->tq_spin = (mtxflags & MTX_SPIN) != 0;
116 queue->tq_flags |= TQ_FLAGS_ACTIVE;
117 mtx_init(&queue->tq_mutex, mtxname, NULL, mtxflags);
123 taskqueue_create(const char *name, int mflags,
124 taskqueue_enqueue_fn enqueue, void *context)
126 return _taskqueue_create(name, mflags, enqueue, context,
127 MTX_DEF, "taskqueue");
131 * Signal a taskqueue thread to terminate.
134 taskqueue_terminate(struct thread **pp, struct taskqueue *tq)
137 while (tq->tq_tcount > 0) {
139 TQ_SLEEP(tq, pp, &tq->tq_mutex, PWAIT, "taskqueue_destroy", 0);
144 taskqueue_free(struct taskqueue *queue)
148 queue->tq_flags &= ~TQ_FLAGS_ACTIVE;
149 taskqueue_run_locked(queue);
150 taskqueue_terminate(queue->tq_threads, queue);
151 KASSERT(TAILQ_EMPTY(&queue->tq_active), ("Tasks still running?"));
152 mtx_destroy(&queue->tq_mutex);
153 free(queue->tq_threads, M_TASKQUEUE);
154 free(queue, M_TASKQUEUE);
158 taskqueue_enqueue(struct taskqueue *queue, struct task *task)
166 * Count multiple enqueues.
168 if (task->ta_pending) {
169 if (task->ta_pending < USHRT_MAX)
176 * Optimise the case when all tasks have the same priority.
178 prev = STAILQ_LAST(&queue->tq_queue, task, ta_link);
179 if (!prev || prev->ta_priority >= task->ta_priority) {
180 STAILQ_INSERT_TAIL(&queue->tq_queue, task, ta_link);
183 for (ins = STAILQ_FIRST(&queue->tq_queue); ins;
184 prev = ins, ins = STAILQ_NEXT(ins, ta_link))
185 if (ins->ta_priority < task->ta_priority)
189 STAILQ_INSERT_AFTER(&queue->tq_queue, prev, task, ta_link);
191 STAILQ_INSERT_HEAD(&queue->tq_queue, task, ta_link);
194 task->ta_pending = 1;
195 if ((queue->tq_flags & TQ_FLAGS_BLOCKED) == 0)
196 queue->tq_enqueue(queue->tq_context);
198 queue->tq_flags |= TQ_FLAGS_PENDING;
206 taskqueue_drain_running(struct taskqueue *queue)
209 while (!TAILQ_EMPTY(&queue->tq_active))
210 TQ_SLEEP(queue, &queue->tq_active, &queue->tq_mutex,
215 taskqueue_block(struct taskqueue *queue)
219 queue->tq_flags |= TQ_FLAGS_BLOCKED;
224 taskqueue_unblock(struct taskqueue *queue)
228 queue->tq_flags &= ~TQ_FLAGS_BLOCKED;
229 if (queue->tq_flags & TQ_FLAGS_PENDING) {
230 queue->tq_flags &= ~TQ_FLAGS_PENDING;
231 queue->tq_enqueue(queue->tq_context);
237 taskqueue_run_locked(struct taskqueue *queue)
239 struct taskqueue_busy tb;
243 mtx_assert(&queue->tq_mutex, MA_OWNED);
244 tb.tb_running = NULL;
245 TAILQ_INSERT_TAIL(&queue->tq_active, &tb, tb_link);
247 while (STAILQ_FIRST(&queue->tq_queue)) {
249 * Carefully remove the first task from the queue and
250 * zero its pending count.
252 task = STAILQ_FIRST(&queue->tq_queue);
253 STAILQ_REMOVE_HEAD(&queue->tq_queue, ta_link);
254 pending = task->ta_pending;
255 task->ta_pending = 0;
256 tb.tb_running = task;
259 task->ta_func(task->ta_context, pending);
262 tb.tb_running = NULL;
265 TAILQ_REMOVE(&queue->tq_active, &tb, tb_link);
266 if (TAILQ_EMPTY(&queue->tq_active))
267 wakeup(&queue->tq_active);
271 taskqueue_run(struct taskqueue *queue)
275 taskqueue_run_locked(queue);
280 task_is_running(struct taskqueue *queue, struct task *task)
282 struct taskqueue_busy *tb;
284 mtx_assert(&queue->tq_mutex, MA_OWNED);
285 TAILQ_FOREACH(tb, &queue->tq_active, tb_link) {
286 if (tb->tb_running == task)
293 taskqueue_drain(struct taskqueue *queue, struct task *task)
295 if (queue->tq_spin) { /* XXX */
296 mtx_lock_spin(&queue->tq_mutex);
297 while (task->ta_pending != 0 || task_is_running(queue, task))
298 msleep_spin(task, &queue->tq_mutex, "-", 0);
299 mtx_unlock_spin(&queue->tq_mutex);
301 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, __func__);
303 mtx_lock(&queue->tq_mutex);
304 while (task->ta_pending != 0 || task_is_running(queue, task))
305 msleep(task, &queue->tq_mutex, PWAIT, "-", 0);
306 mtx_unlock(&queue->tq_mutex);
311 taskqueue_drain_all(struct taskqueue *queue)
316 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, __func__);
319 task = STAILQ_LAST(&queue->tq_queue, task, ta_link);
321 while (task->ta_pending != 0)
322 TQ_SLEEP(queue, task, &queue->tq_mutex, PWAIT, "-", 0);
323 taskqueue_drain_running(queue);
324 KASSERT(STAILQ_EMPTY(&queue->tq_queue),
325 ("taskqueue queue is not empty after draining"));
330 taskqueue_swi_enqueue(void *context)
332 swi_sched(taskqueue_ih, 0);
336 taskqueue_swi_run(void *dummy)
338 taskqueue_run(taskqueue_swi);
342 taskqueue_swi_giant_enqueue(void *context)
344 swi_sched(taskqueue_giant_ih, 0);
348 taskqueue_swi_giant_run(void *dummy)
350 taskqueue_run(taskqueue_swi_giant);
354 taskqueue_start_threads(struct taskqueue **tqp, int count, int pri,
355 const char *name, ...)
359 struct taskqueue *tq;
361 char ktname[MAXCOMLEN + 1];
369 vsnprintf(ktname, sizeof(ktname), name, ap);
372 tq->tq_threads = malloc(sizeof(struct thread *) * count, M_TASKQUEUE,
374 if (tq->tq_threads == NULL) {
375 printf("%s: no memory for %s threads\n", __func__, ktname);
379 for (i = 0; i < count; i++) {
381 error = kthread_add(taskqueue_thread_loop, tqp, NULL,
382 &tq->tq_threads[i], RFSTOPPED, 0, "%s", ktname);
384 error = kthread_add(taskqueue_thread_loop, tqp, NULL,
385 &tq->tq_threads[i], RFSTOPPED, 0,
388 /* should be ok to continue, taskqueue_free will dtrt */
389 printf("%s: kthread_add(%s): error %d", __func__,
391 tq->tq_threads[i] = NULL; /* paranoid */
395 for (i = 0; i < count; i++) {
396 if (tq->tq_threads[i] == NULL)
398 td = tq->tq_threads[i];
401 sched_add(td, SRQ_BORING);
409 taskqueue_thread_loop(void *arg)
411 struct taskqueue **tqp, *tq;
416 while ((tq->tq_flags & TQ_FLAGS_ACTIVE) != 0) {
417 taskqueue_run_locked(tq);
419 * Because taskqueue_run() can drop tq_mutex, we need to
420 * check if the TQ_FLAGS_ACTIVE flag wasn't removed in the
421 * meantime, which means we missed a wakeup.
423 if ((tq->tq_flags & TQ_FLAGS_ACTIVE) == 0)
425 TQ_SLEEP(tq, tq, &tq->tq_mutex, 0, "-", 0);
428 /* rendezvous with thread that asked us to terminate */
430 wakeup_one(tq->tq_threads);
436 taskqueue_thread_enqueue(void *context)
438 struct taskqueue **tqp, *tq;
443 mtx_assert(&tq->tq_mutex, MA_OWNED);
447 TASKQUEUE_DEFINE(swi, taskqueue_swi_enqueue, NULL,
448 swi_add(NULL, "task queue", taskqueue_swi_run, NULL, SWI_TQ,
449 INTR_MPSAFE, &taskqueue_ih));
451 TASKQUEUE_DEFINE(swi_giant, taskqueue_swi_giant_enqueue, NULL,
452 swi_add(NULL, "Giant taskq", taskqueue_swi_giant_run,
453 NULL, SWI_TQ_GIANT, 0, &taskqueue_giant_ih));
455 TASKQUEUE_DEFINE_THREAD(thread);
458 taskqueue_create_fast(const char *name, int mflags,
459 taskqueue_enqueue_fn enqueue, void *context)
461 return _taskqueue_create(name, mflags, enqueue, context,
462 MTX_SPIN, "fast_taskqueue");
465 /* NB: for backwards compatibility */
467 taskqueue_enqueue_fast(struct taskqueue *queue, struct task *task)
469 return taskqueue_enqueue(queue, task);
472 static void *taskqueue_fast_ih;
475 taskqueue_fast_enqueue(void *context)
477 swi_sched(taskqueue_fast_ih, 0);
481 taskqueue_fast_run(void *dummy)
483 taskqueue_run(taskqueue_fast);
486 TASKQUEUE_FAST_DEFINE(fast, taskqueue_fast_enqueue, NULL,
487 swi_add(NULL, "fast taskq", taskqueue_fast_run, NULL,
488 SWI_TQ_FAST, INTR_MPSAFE, &taskqueue_fast_ih));
491 taskqueue_member(struct taskqueue *queue, struct thread *td)
496 for (i = 0, j = 0; ; i++) {
497 if (queue->tq_threads[i] == NULL)
499 if (queue->tq_threads[i] == td) {
503 if (++j >= queue->tq_tcount)