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
29 #ifndef _SYS_TASKQUEUE_H_
30 #define _SYS_TASKQUEUE_H_
33 #error "no user-servicable parts inside"
36 #include <sys/queue.h>
37 #include <sys/_task.h>
42 * A notification callback function which is called from
43 * taskqueue_enqueue(). The context argument is given in the call to
44 * taskqueue_create(). This function would normally be used to allow the
45 * queue to arrange to run itself later (e.g., by scheduling a software
46 * interrupt or waking a kernel thread).
48 typedef void (*taskqueue_enqueue_fn)(void *context);
50 struct taskqueue *taskqueue_create(const char *name, int mflags,
51 taskqueue_enqueue_fn enqueue,
53 int taskqueue_enqueue(struct taskqueue *queue, struct task *task);
54 void taskqueue_drain(struct taskqueue *queue, struct task *task);
55 struct taskqueue *taskqueue_find(const char *name);
56 void taskqueue_free(struct taskqueue *queue);
57 void taskqueue_run(struct taskqueue *queue);
60 * Functions for dedicated thread taskqueues
62 void taskqueue_thread_loop(void *arg);
63 void taskqueue_thread_enqueue(void *context);
66 * Initialise a task structure.
68 #define TASK_INIT(task, priority, func, context) do { \
69 (task)->ta_pending = 0; \
70 (task)->ta_priority = (priority); \
71 (task)->ta_func = (func); \
72 (task)->ta_context = (context); \
76 * Declare a reference to a taskqueue.
78 #define TASKQUEUE_DECLARE(name) \
79 extern struct taskqueue *taskqueue_##name
82 * Define and initialise a taskqueue.
84 #define TASKQUEUE_DEFINE(name, enqueue, context, init) \
86 struct taskqueue *taskqueue_##name; \
89 taskqueue_define_##name(void *arg) \
92 taskqueue_create(#name, M_NOWAIT, (enqueue), (context)); \
96 SYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \
97 taskqueue_define_##name, NULL) \
100 #define TASKQUEUE_DEFINE_THREAD(name) \
101 static struct proc *taskqueue_##name##_proc; \
102 TASKQUEUE_DEFINE(name, taskqueue_thread_enqueue, &taskqueue_##name, \
103 kthread_create(taskqueue_thread_loop, &taskqueue_##name, \
104 &taskqueue_##name##_proc, 0, 0, #name " taskq"))
107 * These queues are serviced by software interrupt handlers. To enqueue
108 * a task, call taskqueue_enqueue(taskqueue_swi, &task) or
109 * taskqueue_enqueue(taskqueue_swi_giant, &task).
111 TASKQUEUE_DECLARE(swi_giant);
112 TASKQUEUE_DECLARE(swi);
115 * This queue is serviced by a kernel thread. To enqueue a task, call
116 * taskqueue_enqueue(taskqueue_thread, &task).
118 TASKQUEUE_DECLARE(thread);
121 * Queue for swi handlers dispatched from fast interrupt handlers.
122 * These are necessarily different from the above because the queue
123 * must be locked with spinlocks since sleep mutex's cannot be used
124 * from a fast interrupt handler context.
126 TASKQUEUE_DECLARE(fast);
127 int taskqueue_enqueue_fast(struct taskqueue *queue, struct task *task);
129 #endif /* !_SYS_TASKQUEUE_H_ */