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
39 struct taskqueue;
40
41 /*
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).
47 */
48 typedef void (*taskqueue_enqueue_fn)(void *context);
49
50 struct taskqueue *taskqueue_create(const char *name, int mflags,
51 taskqueue_enqueue_fn enqueue,
52 void *context);
53 int taskqueue_enqueue(struct taskqueue *queue, struct task *task);
54 struct taskqueue *taskqueue_find(const char *name);
55 void taskqueue_free(struct taskqueue *queue);
56 void taskqueue_run(struct taskqueue *queue);
57
58 /*
59 * Functions for dedicated thread taskqueues
60 */
61 void taskqueue_thread_loop(void *arg);
62 void taskqueue_thread_enqueue(void *context);
63
64 /*
65 * Initialise a task structure.
66 */
67 #define TASK_INIT(task, priority, func, context) do { \
68 (task)->ta_pending = 0; \
69 (task)->ta_priority = (priority); \
70 (task)->ta_func = (func); \
71 (task)->ta_context = (context); \
72 } while (0)
73
74 /*
75 * Declare a reference to a taskqueue.
76 */
77 #define TASKQUEUE_DECLARE(name) \
78 extern struct taskqueue *taskqueue_##name
79
80 /*
81 * Define and initialise a taskqueue.
82 */
83 #define TASKQUEUE_DEFINE(name, enqueue, context, init) \
84 \
85 struct taskqueue *taskqueue_##name; \
86 \
87 static void \
88 taskqueue_define_##name(void *arg) \
89 { \
90 taskqueue_##name = \
91 taskqueue_create(#name, M_NOWAIT, (enqueue), (context)); \
92 init; \
93 } \
94 \
95 SYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \
96 taskqueue_define_##name, NULL) \
97 \
98 struct __hack
99 #define TASKQUEUE_DEFINE_THREAD(name) \
100 static struct proc *taskqueue_##name##_proc; \
101 TASKQUEUE_DEFINE(name, taskqueue_thread_enqueue, &taskqueue_##name, \
102 kthread_create(taskqueue_thread_loop, &taskqueue_##name, \
103 &taskqueue_##name##_proc, 0, 0, #name " taskq"))
104
105 /*
106 * These queues are serviced by software interrupt handlers. To enqueue
107 * a task, call taskqueue_enqueue(taskqueue_swi, &task) or
108 * taskqueue_enqueue(taskqueue_swi_giant, &task).
109 */
110 TASKQUEUE_DECLARE(swi_giant);
111 TASKQUEUE_DECLARE(swi);
112
113 /*
114 * This queue is serviced by a kernel thread. To enqueue a task, call
115 * taskqueue_enqueue(taskqueue_thread, &task).
116 */
117 TASKQUEUE_DECLARE(thread);
118
119 /*
120 * Queue for swi handlers dispatched from fast interrupt handlers.
121 * These are necessarily different from the above because the queue
122 * must be locked with spinlocks since sleep mutex's cannot be used
123 * from a fast interrupt handler context.
124 */
125 TASKQUEUE_DECLARE(fast);
126 int taskqueue_enqueue_fast(struct taskqueue *queue, struct task *task);
127
128 #endif /* !_SYS_TASKQUEUE_H_ */
Cache object: 55ee3165e0da1daaf8c75c72fefcba91
|