xref: /dragonfly/sys/kern/subr_taskqueue.c (revision b40e316c)
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: src/sys/kern/subr_taskqueue.c,v 1.1.2.3 2003/09/10 00:40:39 ken Exp $
27  *	$DragonFly: src/sys/kern/subr_taskqueue.c,v 1.4 2003/12/29 06:42:06 dillon Exp $
28  */
29 
30 #include <sys/param.h>
31 #include <sys/queue.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
34 #include <sys/taskqueue.h>
35 #include <sys/interrupt.h>
36 #include <sys/malloc.h>
37 #include <sys/kthread.h>
38 
39 #include <machine/ipl.h>
40 
41 MALLOC_DEFINE(M_TASKQUEUE, "taskqueue", "Task Queues");
42 
43 static STAILQ_HEAD(taskqueue_list, taskqueue) taskqueue_queues;
44 static struct thread *taskqueue_thread_td;
45 
46 struct taskqueue {
47 	STAILQ_ENTRY(taskqueue)	tq_link;
48 	STAILQ_HEAD(, task)	tq_queue;
49 	const char		*tq_name;
50 	taskqueue_enqueue_fn	tq_enqueue;
51 	void			*tq_context;
52 	int			tq_draining;
53 };
54 
55 struct taskqueue *
56 taskqueue_create(const char *name, int mflags,
57 		 taskqueue_enqueue_fn enqueue, void *context)
58 {
59 	struct taskqueue *queue;
60 	static int once = 1;
61 	int s;
62 
63 	queue = malloc(sizeof(struct taskqueue), M_TASKQUEUE, mflags);
64 	if (!queue)
65 		return 0;
66 	STAILQ_INIT(&queue->tq_queue);
67 	queue->tq_name = name;
68 	queue->tq_enqueue = enqueue;
69 	queue->tq_context = context;
70 	queue->tq_draining = 0;
71 
72 	s = splhigh();
73 	if (once) {
74 		STAILQ_INIT(&taskqueue_queues);
75 		once = 0;
76 	}
77 	STAILQ_INSERT_TAIL(&taskqueue_queues, queue, tq_link);
78 	splx(s);
79 
80 	return queue;
81 }
82 
83 void
84 taskqueue_free(struct taskqueue *queue)
85 {
86 	int s = splhigh();
87 	queue->tq_draining = 1;
88 	splx(s);
89 
90 	taskqueue_run(queue);
91 
92 	s = splhigh();
93 	STAILQ_REMOVE(&taskqueue_queues, queue, taskqueue, tq_link);
94 	splx(s);
95 
96 	free(queue, M_TASKQUEUE);
97 }
98 
99 struct taskqueue *
100 taskqueue_find(const char *name)
101 {
102 	struct taskqueue *queue;
103 	int s;
104 
105 	s = splhigh();
106 	STAILQ_FOREACH(queue, &taskqueue_queues, tq_link)
107 		if (!strcmp(queue->tq_name, name)) {
108 			splx(s);
109 			return queue;
110 		}
111 	splx(s);
112 	return 0;
113 }
114 
115 int
116 taskqueue_enqueue(struct taskqueue *queue, struct task *task)
117 {
118 	struct task *ins;
119 	struct task *prev;
120 
121 	int s = splhigh();
122 
123 	/*
124 	 * Don't allow new tasks on a queue which is being freed.
125 	 */
126 	if (queue->tq_draining) {
127 		splx(s);
128 		return EPIPE;
129 	}
130 
131 	/*
132 	 * Count multiple enqueues.
133 	 */
134 	if (task->ta_pending) {
135 		task->ta_pending++;
136 		splx(s);
137 		return 0;
138 	}
139 
140 	/*
141 	 * Optimise the case when all tasks have the same priority.
142 	 */
143 	prev = STAILQ_LAST(&queue->tq_queue, task, ta_link);
144 	if (!prev || prev->ta_priority >= task->ta_priority) {
145 		STAILQ_INSERT_TAIL(&queue->tq_queue, task, ta_link);
146 	} else {
147 		prev = 0;
148 		for (ins = STAILQ_FIRST(&queue->tq_queue); ins;
149 		     prev = ins, ins = STAILQ_NEXT(ins, ta_link))
150 			if (ins->ta_priority < task->ta_priority)
151 				break;
152 
153 		if (prev)
154 			STAILQ_INSERT_AFTER(&queue->tq_queue, prev, task, ta_link);
155 		else
156 			STAILQ_INSERT_HEAD(&queue->tq_queue, task, ta_link);
157 	}
158 
159 	task->ta_pending = 1;
160 	if (queue->tq_enqueue)
161 		queue->tq_enqueue(queue->tq_context);
162 
163 	splx(s);
164 
165 	return 0;
166 }
167 
168 void
169 taskqueue_run(struct taskqueue *queue)
170 {
171 	int s;
172 	struct task *task;
173 	int pending;
174 
175 	s = splhigh();
176 	while (STAILQ_FIRST(&queue->tq_queue)) {
177 		/*
178 		 * Carefully remove the first task from the queue and
179 		 * zero its pending count.
180 		 */
181 		task = STAILQ_FIRST(&queue->tq_queue);
182 		STAILQ_REMOVE_HEAD(&queue->tq_queue, ta_link);
183 		pending = task->ta_pending;
184 		task->ta_pending = 0;
185 		splx(s);
186 
187 		task->ta_func(task->ta_context, pending);
188 
189 		s = splhigh();
190 	}
191 	splx(s);
192 }
193 
194 static void
195 taskqueue_swi_enqueue(void *context)
196 {
197 	setsofttq();
198 }
199 
200 static void
201 taskqueue_swi_run(void *arg)
202 {
203 	taskqueue_run(taskqueue_swi);
204 }
205 
206 static void
207 taskqueue_kthread(void *arg)
208 {
209 	int s;
210 
211 	for (;;) {
212 		taskqueue_run(taskqueue_thread);
213 		s = splhigh();
214 		if (STAILQ_EMPTY(&taskqueue_thread->tq_queue))
215 			tsleep(&taskqueue_thread, 0, "tqthr", 0);
216 		splx(s);
217 	}
218 }
219 
220 static void
221 taskqueue_thread_enqueue(void *context)
222 {
223 	wakeup(&taskqueue_thread);
224 }
225 
226 TASKQUEUE_DEFINE(swi, taskqueue_swi_enqueue, 0,
227 		 register_swi(SWI_TQ, taskqueue_swi_run, NULL, "swi_taskq"));
228 TASKQUEUE_DEFINE(thread, taskqueue_thread_enqueue, 0,
229 		 kthread_create(taskqueue_kthread, NULL,
230 		 &taskqueue_thread_td, "taskqueue"));
231