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: releng/7.3/sys/sys/taskqueue.h 201633 2010-01-06 08:18:49Z netchild $
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
39 struct taskqueue;
40 struct thread;
41
42 /*
43 * A notification callback function which is called from
44 * taskqueue_enqueue(). The context argument is given in the call to
45 * taskqueue_create(). This function would normally be used to allow the
46 * queue to arrange to run itself later (e.g., by scheduling a software
47 * interrupt or waking a kernel thread).
48 */
49 typedef void (*taskqueue_enqueue_fn)(void *context);
50
51 struct proc;
52 struct taskqueue *taskqueue_create(const char *name, int mflags,
53 taskqueue_enqueue_fn enqueue,
54 void *context);
55 int taskqueue_start_threads(struct taskqueue **tqp, int count, int pri,
56 const char *name, ...) __printflike(4, 5);
57 int taskqueue_enqueue(struct taskqueue *queue, struct task *task);
58 void taskqueue_drain(struct taskqueue *queue, struct task *task);
59 struct taskqueue *taskqueue_find(const char *name);
60 void taskqueue_free(struct taskqueue *queue);
61 void taskqueue_run(struct taskqueue *queue);
62 void taskqueue_block(struct taskqueue *queue);
63 void taskqueue_unblock(struct taskqueue *queue);
64 int taskqueue_member(struct taskqueue *queue, struct thread *td);
65
66 /*
67 * Functions for dedicated thread taskqueues
68 */
69 void taskqueue_thread_loop(void *arg);
70 void taskqueue_thread_enqueue(void *context);
71
72 /*
73 * Initialise a task structure.
74 */
75 #define TASK_INIT(task, priority, func, context) do { \
76 (task)->ta_pending = 0; \
77 (task)->ta_priority = (priority); \
78 (task)->ta_func = (func); \
79 (task)->ta_context = (context); \
80 } while (0)
81
82 /*
83 * Declare a reference to a taskqueue.
84 */
85 #define TASKQUEUE_DECLARE(name) \
86 extern struct taskqueue *taskqueue_##name
87
88 /*
89 * Define and initialise a global taskqueue that uses sleep mutexes.
90 */
91 #define TASKQUEUE_DEFINE(name, enqueue, context, init) \
92 \
93 struct taskqueue *taskqueue_##name; \
94 \
95 static void \
96 taskqueue_define_##name(void *arg) \
97 { \
98 taskqueue_##name = \
99 taskqueue_create(#name, M_NOWAIT, (enqueue), (context)); \
100 init; \
101 } \
102 \
103 SYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \
104 taskqueue_define_##name, NULL); \
105 \
106 struct __hack
107 #define TASKQUEUE_DEFINE_THREAD(name) \
108 TASKQUEUE_DEFINE(name, taskqueue_thread_enqueue, &taskqueue_##name, \
109 taskqueue_start_threads(&taskqueue_##name, 1, PWAIT, \
110 "%s taskq", #name))
111
112 /*
113 * Define and initialise a global taskqueue that uses spin mutexes.
114 */
115 #define TASKQUEUE_FAST_DEFINE(name, enqueue, context, init) \
116 \
117 struct taskqueue *taskqueue_##name; \
118 \
119 static void \
120 taskqueue_define_##name(void *arg) \
121 { \
122 taskqueue_##name = \
123 taskqueue_create_fast(#name, M_NOWAIT, (enqueue), \
124 (context)); \
125 init; \
126 } \
127 \
128 SYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \
129 taskqueue_define_##name, NULL); \
130 \
131 struct __hack
132 #define TASKQUEUE_FAST_DEFINE_THREAD(name) \
133 TASKQUEUE_FAST_DEFINE(name, taskqueue_thread_enqueue, \
134 &taskqueue_##name, taskqueue_start_threads(&taskqueue_##name \
135 1, PWAIT, "%s taskq", #name))
136
137 /*
138 * These queues are serviced by software interrupt handlers. To enqueue
139 * a task, call taskqueue_enqueue(taskqueue_swi, &task) or
140 * taskqueue_enqueue(taskqueue_swi_giant, &task).
141 */
142 TASKQUEUE_DECLARE(swi_giant);
143 TASKQUEUE_DECLARE(swi);
144
145 /*
146 * This queue is serviced by a kernel thread. To enqueue a task, call
147 * taskqueue_enqueue(taskqueue_thread, &task).
148 */
149 TASKQUEUE_DECLARE(thread);
150
151 /*
152 * Queue for swi handlers dispatched from fast interrupt handlers.
153 * These are necessarily different from the above because the queue
154 * must be locked with spinlocks since sleep mutex's cannot be used
155 * from a fast interrupt handler context.
156 */
157 TASKQUEUE_DECLARE(fast);
158 int taskqueue_enqueue_fast(struct taskqueue *queue, struct task *task);
159 struct taskqueue *taskqueue_create_fast(const char *name, int mflags,
160 taskqueue_enqueue_fn enqueue,
161 void *context);
162
163 #endif /* !_SYS_TASKQUEUE_H_ */
Cache object: 99702182448b30b65849319a35ab95f1
|