taskqueue.h revision 154167
161033Sdfr/*- 261033Sdfr * Copyright (c) 2000 Doug Rabson 361033Sdfr * All rights reserved. 461033Sdfr * 561033Sdfr * Redistribution and use in source and binary forms, with or without 661033Sdfr * modification, are permitted provided that the following conditions 761033Sdfr * are met: 861033Sdfr * 1. Redistributions of source code must retain the above copyright 961033Sdfr * notice, this list of conditions and the following disclaimer. 1061033Sdfr * 2. Redistributions in binary form must reproduce the above copyright 1161033Sdfr * notice, this list of conditions and the following disclaimer in the 1261033Sdfr * documentation and/or other materials provided with the distribution. 1361033Sdfr * 1461033Sdfr * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1561033Sdfr * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1661033Sdfr * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1761033Sdfr * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1861033Sdfr * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1961033Sdfr * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2061033Sdfr * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2161033Sdfr * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2261033Sdfr * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2361033Sdfr * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2461033Sdfr * SUCH DAMAGE. 2561033Sdfr * 2661086Sdfr * $FreeBSD: head/sys/sys/taskqueue.h 154167 2006-01-10 06:31:12Z scottl $ 2761033Sdfr */ 2861033Sdfr 2961033Sdfr#ifndef _SYS_TASKQUEUE_H_ 3061033Sdfr#define _SYS_TASKQUEUE_H_ 3161033Sdfr 3261086Sdfr#ifndef _KERNEL 3361086Sdfr#error "no user-servicable parts inside" 3461086Sdfr#endif 3561033Sdfr 3661086Sdfr#include <sys/queue.h> 37124882Srwatson#include <sys/_task.h> 3861086Sdfr 3961033Sdfrstruct taskqueue; 4061033Sdfr 4161033Sdfr/* 4261033Sdfr * A notification callback function which is called from 4361086Sdfr * taskqueue_enqueue(). The context argument is given in the call to 4461086Sdfr * taskqueue_create(). This function would normally be used to allow the 4561086Sdfr * queue to arrange to run itself later (e.g., by scheduling a software 4661033Sdfr * interrupt or waking a kernel thread). 4761033Sdfr */ 4861033Sdfrtypedef void (*taskqueue_enqueue_fn)(void *context); 4961033Sdfr 50145729Ssamstruct proc; 5161086Sdfrstruct taskqueue *taskqueue_create(const char *name, int mflags, 5261086Sdfr taskqueue_enqueue_fn enqueue, 53145729Ssam void *context, struct proc **); 5461086Sdfrint taskqueue_enqueue(struct taskqueue *queue, struct task *task); 55136131Simpvoid taskqueue_drain(struct taskqueue *queue, struct task *task); 5661086Sdfrstruct taskqueue *taskqueue_find(const char *name); 5761086Sdfrvoid taskqueue_free(struct taskqueue *queue); 5861086Sdfrvoid taskqueue_run(struct taskqueue *queue); 5961033Sdfr 6061033Sdfr/* 61133305Sjmg * Functions for dedicated thread taskqueues 62133305Sjmg */ 63133305Sjmgvoid taskqueue_thread_loop(void *arg); 64133305Sjmgvoid taskqueue_thread_enqueue(void *context); 65133305Sjmg 66133305Sjmg/* 6761033Sdfr * Initialise a task structure. 6861033Sdfr */ 6985560Sjhb#define TASK_INIT(task, priority, func, context) do { \ 7085560Sjhb (task)->ta_pending = 0; \ 7185560Sjhb (task)->ta_priority = (priority); \ 7285560Sjhb (task)->ta_func = (func); \ 7385560Sjhb (task)->ta_context = (context); \ 7485560Sjhb} while (0) 7561033Sdfr 7661033Sdfr/* 7761033Sdfr * Declare a reference to a taskqueue. 7861033Sdfr */ 7961033Sdfr#define TASKQUEUE_DECLARE(name) \ 8061033Sdfrextern struct taskqueue *taskqueue_##name 8161033Sdfr 8261033Sdfr/* 83154167Sscottl * Define and initialise a global taskqueue that uses sleep mutexes. 8461033Sdfr */ 8561086Sdfr#define TASKQUEUE_DEFINE(name, enqueue, context, init) \ 8661033Sdfr \ 8761033Sdfrstruct taskqueue *taskqueue_##name; \ 8861033Sdfr \ 8961033Sdfrstatic void \ 9061033Sdfrtaskqueue_define_##name(void *arg) \ 9161033Sdfr{ \ 92145729Ssam static struct proc *taskqueue_##name##_proc; \ 9361033Sdfr taskqueue_##name = \ 94145729Ssam taskqueue_create(#name, M_NOWAIT, (enqueue), (context), \ 95145729Ssam &taskqueue_##name##_proc); \ 9661033Sdfr init; \ 9761033Sdfr} \ 9861033Sdfr \ 9961033SdfrSYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \ 10061086Sdfr taskqueue_define_##name, NULL) \ 10161086Sdfr \ 10261086Sdfrstruct __hack 103133305Sjmg#define TASKQUEUE_DEFINE_THREAD(name) \ 104133305SjmgTASKQUEUE_DEFINE(name, taskqueue_thread_enqueue, &taskqueue_##name, \ 105133305Sjmg kthread_create(taskqueue_thread_loop, &taskqueue_##name, \ 106133305Sjmg &taskqueue_##name##_proc, 0, 0, #name " taskq")) 10761033Sdfr 10861033Sdfr/* 109154167Sscottl * Define and initialise a global taskqueue that uses spin mutexes. 110154167Sscottl */ 111154167Sscottl#define TASKQUEUE_FAST_DEFINE(name, enqueue, context, init) \ 112154167Sscottl \ 113154167Sscottlstruct taskqueue *taskqueue_##name; \ 114154167Sscottl \ 115154167Sscottlstatic void \ 116154167Sscottltaskqueue_define_##name(void *arg) \ 117154167Sscottl{ \ 118154167Sscottl static struct proc *taskqueue_##name##_proc; \ 119154167Sscottl taskqueue_##name = \ 120154167Sscottl taskqueue_create_fast(#name, M_NOWAIT, (enqueue), (context),\ 121154167Sscottl &taskqueue_##name##_proc); \ 122154167Sscottl init; \ 123154167Sscottl} \ 124154167Sscottl \ 125154167SscottlSYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \ 126154167Sscottl taskqueue_define_##name, NULL) \ 127154167Sscottl \ 128154167Sscottlstruct __hack 129154167Sscottl#define TASKQUEUE_FAST_DEFINE_THREAD(name) \ 130154167SscottlTASKQUEUE_FAST_DEFINE(name, taskqueue_thread_enqueue, \ 131154167Sscottl &taskqueue_##name, kthread_create(taskqueue_thread_loop, \ 132154167Sscottl &taskqueue_##name, &taskqueue_##name##_proc, 0, 0, \ 133154167Sscottl #name " fast taskq")) 134154167Sscottl 135154167Sscottl/* 136119708Sken * These queues are serviced by software interrupt handlers. To enqueue 137119708Sken * a task, call taskqueue_enqueue(taskqueue_swi, &task) or 138119708Sken * taskqueue_enqueue(taskqueue_swi_giant, &task). 13961033Sdfr */ 140111528SscottlTASKQUEUE_DECLARE(swi_giant); 14161033SdfrTASKQUEUE_DECLARE(swi); 14261033Sdfr 143119708Sken/* 144119708Sken * This queue is serviced by a kernel thread. To enqueue a task, call 145119708Sken * taskqueue_enqueue(taskqueue_thread, &task). 146119708Sken */ 147119708SkenTASKQUEUE_DECLARE(thread); 148119708Sken 149119789Ssam/* 150119789Ssam * Queue for swi handlers dispatched from fast interrupt handlers. 151119789Ssam * These are necessarily different from the above because the queue 152119789Ssam * must be locked with spinlocks since sleep mutex's cannot be used 153119789Ssam * from a fast interrupt handler context. 154119789Ssam */ 155119789SsamTASKQUEUE_DECLARE(fast); 156119789Ssamint taskqueue_enqueue_fast(struct taskqueue *queue, struct task *task); 157154167Sscottlstruct taskqueue *taskqueue_create_fast(const char *name, int mflags, 158154167Sscottl taskqueue_enqueue_fn enqueue, 159154167Sscottl void *context, struct proc **); 160119789Ssam 16161033Sdfr#endif /* !_SYS_TASKQUEUE_H_ */ 162