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