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);
51 struct taskqueue *taskqueue_create(const char *name, int mflags,
52 taskqueue_enqueue_fn enqueue,
54 int taskqueue_start_threads(struct taskqueue **tqp, int count, int pri,
55 const char *name, ...) __printflike(4, 5);
56 int taskqueue_enqueue(struct taskqueue *queue, struct task *task);
57 void taskqueue_drain(struct taskqueue *queue, struct task *task);
58 struct taskqueue *taskqueue_find(const char *name);
59 void taskqueue_free(struct taskqueue *queue);
60 void taskqueue_run(struct taskqueue *queue);
61 void taskqueue_block(struct taskqueue *queue);
62 void taskqueue_unblock(struct taskqueue *queue);
65 * Functions for dedicated thread taskqueues
67 void taskqueue_thread_loop(void *arg);
68 void taskqueue_thread_enqueue(void *context);
71 * Initialise a task structure.
73 #define TASK_INIT(task, priority, func, context) do { \
74 (task)->ta_pending = 0; \
75 (task)->ta_priority = (priority); \
76 (task)->ta_func = (func); \
77 (task)->ta_context = (context); \
81 * Declare a reference to a taskqueue.
83 #define TASKQUEUE_DECLARE(name) \
84 extern struct taskqueue *taskqueue_##name
87 * Define and initialise a global taskqueue that uses sleep mutexes.
89 #define TASKQUEUE_DEFINE(name, enqueue, context, init) \
91 struct taskqueue *taskqueue_##name; \
94 taskqueue_define_##name(void *arg) \
97 taskqueue_create(#name, M_NOWAIT, (enqueue), (context)); \
101 SYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \
102 taskqueue_define_##name, NULL); \
105 #define TASKQUEUE_DEFINE_THREAD(name) \
106 TASKQUEUE_DEFINE(name, taskqueue_thread_enqueue, &taskqueue_##name, \
107 taskqueue_start_threads(&taskqueue_##name, 1, PWAIT, \
111 * Define and initialise a global taskqueue that uses spin mutexes.
113 #define TASKQUEUE_FAST_DEFINE(name, enqueue, context, init) \
115 struct taskqueue *taskqueue_##name; \
118 taskqueue_define_##name(void *arg) \
121 taskqueue_create_fast(#name, M_NOWAIT, (enqueue), \
126 SYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \
127 taskqueue_define_##name, NULL); \
130 #define TASKQUEUE_FAST_DEFINE_THREAD(name) \
131 TASKQUEUE_FAST_DEFINE(name, taskqueue_thread_enqueue, \
132 &taskqueue_##name, taskqueue_start_threads(&taskqueue_##name \
133 1, PWAIT, "%s taskq", #name))
136 * These queues are serviced by software interrupt handlers. To enqueue
137 * a task, call taskqueue_enqueue(taskqueue_swi, &task) or
138 * taskqueue_enqueue(taskqueue_swi_giant, &task).
140 TASKQUEUE_DECLARE(swi_giant);
141 TASKQUEUE_DECLARE(swi);
144 * This queue is serviced by a kernel thread. To enqueue a task, call
145 * taskqueue_enqueue(taskqueue_thread, &task).
147 TASKQUEUE_DECLARE(thread);
150 * Queue for swi handlers dispatched from fast interrupt handlers.
151 * These are necessarily different from the above because the queue
152 * must be locked with spinlocks since sleep mutex's cannot be used
153 * from a fast interrupt handler context.
155 TASKQUEUE_DECLARE(fast);
156 int taskqueue_enqueue_fast(struct taskqueue *queue, struct task *task);
157 struct taskqueue *taskqueue_create_fast(const char *name, int mflags,
158 taskqueue_enqueue_fn enqueue,
161 #endif /* !_SYS_TASKQUEUE_H_ */