3 .\" Copyright (c) 2000 Doug Rabson
5 .\" All rights reserved.
7 .\" This program is free software.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\" notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\" notice, this list of conditions and the following disclaimer in the
16 .\" documentation and/or other materials provided with the distribution.
18 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 .Nd asynchronous task execution
44 typedef void (*task_fn_t)(void *context, int pending);
46 typedef void (*taskqueue_enqueue_fn)(void *context);
49 STAILQ_ENTRY(task) ta_link; /* link for queue */
50 u_short ta_pending; /* count times queued */
51 u_short ta_priority; /* priority of task in queue */
52 task_fn_t ta_func; /* task handler */
53 void *ta_context; /* argument for handler */
56 .Ft struct taskqueue *
57 .Fn taskqueue_create "const char *name" "int mflags" "taskqueue_enqueue_fn enqueue" "void *context" "struct proc **"
59 .Fn taskqueue_free "struct taskqueue *queue"
60 .Ft struct taskqueue *
61 .Fn taskqueue_find "const char *name"
63 .Fn taskqueue_enqueue "struct taskqueue *queue" "struct task *task"
65 .Fn taskqueue_enqueue_fast "struct taskqueue *queue" "struct task *task"
67 .Fn taskqueue_run "struct taskqueue *queue"
69 .Fn taskqueue_run_fast "struct taskqueue *queue"
71 .Fn taskqueue_drain "struct taskqueue *queue" "struct task *task"
72 .Fn TASK_INIT "struct task *task" "int priority" "task_fn_t *func" "void *context"
73 .Fn TASKQUEUE_DECLARE "name"
74 .Fn TASKQUEUE_DEFINE "name" "taskqueue_enqueue_fn enqueue" "void *context" "init"
75 .Fn TASKQUEUE_DEFINE_THREAD "name"
77 These functions provide a simple interface for asynchronous execution
82 is used to create new queues.
85 include a name that should be unique,
88 flags that specify whether the call to
91 a function that is called from
93 when a task is added to the queue,
94 and a pointer to the memory location where the identity of the
95 thread that services the queue is recorded.
96 .\" XXX The rest of the sentence gets lots in relation to the first part.
97 The function called from
99 must arrange for the queue to be processed
100 (for instance by scheduling a software interrupt or waking a kernel
102 The memory location where the thread identity is recorded is used
103 to signal the service thread(s) to terminate--when this value is set to
104 zero and the thread is signaled it will terminate.
108 should be used to remove the queue from the global list of queues
109 and free the memory used by the queue.
110 Any tasks that are on the queue will be executed at this time after
111 which the thread servicing the queue will be signaled that it should exit.
113 The system maintains a list of all queues which can be searched using
115 The first queue whose name matches is returned, otherwise
118 To add a task to the list of tasks queued on a taskqueue, call
119 .Fn taskqueue_enqueue
120 with pointers to the queue and task.
124 then it is simply incremented to reflect the number of times the task
127 the task is added to the list before the first task which has a lower
129 value or at the end of the list if no tasks have a lower priority.
130 Enqueueing a task does not perform any memory allocation which makes
131 it suitable for calling from an interrupt handler.
132 This function will return
134 if the queue is being freed.
137 .Fn taskqueue_enqueue_fast
138 should be used in place of
139 .Fn taskqueue_enqueue
140 when the enqueuing must happen from a fast interrupt handler.
141 This method uses spin locks to avoid the possibility of sleeping in the fast
144 To execute all the tasks on a queue,
148 .Fn taskqueue_run_fast
149 depending on the flavour of the queue.
150 When a task is executed,
151 first it is removed from the queue,
154 is recorded and then the field is zeroed.
157 from the task structure is called with the value of the field
159 as its first argument
162 as its second argument.
166 function is used to wait for the task to finish.
167 There is no guarantee that the task will not be
168 enqueued after call to
169 .Fn taskqueue_drain .
172 .Fn TASK_INIT "task" "priority" "func" "context"
173 is provided to initialise a
181 are simply copied into the task structure fields and the
186 .Fn TASKQUEUE_DECLARE "name" ,
187 .Fn TASKQUEUE_DEFINE "name" "enqueue" "context" "init" ,
189 .Fn TASKQUEUE_DEFINE_THREAD "name"
190 are used to declare a reference to a global queue, to define the
191 implementation of the queue, and declare a queue that uses its own thread.
194 macro arranges to call
196 with the values of its
201 arguments during system initialisation.
203 .Fn taskqueue_create ,
206 argument to the macro is executed as a C statement,
207 allowing any further initialisation to be performed
208 (such as registering an interrupt handler etc.)
211 .Fn TASKQUEUE_DEFINE_THREAD
212 macro defines a new taskqueue with its own kernel thread to serve tasks.
214 .Vt struct proc *taskqueue_name_proc
215 is defined which contains the kernel thread serving the tasks.
217 .Vt struct taskqueue *taskqueue_name
218 is used to enqueue tasks onto the queue.
219 .Ss Predefined Task Queues
220 The system provides four global taskqueues,
223 .Va taskqueue_swi_giant ,
225 .Va taskqueue_thread .
228 queue is for swi handlers dispatched from fast interrupt handlers,
229 where sleep mutexes cannot be used.
230 The swi taskqueues are run via a software interrupt mechanism.
233 queue runs without the protection of the
236 .Va taskqueue_swi_giant
237 queue runs with the protection of the
242 runs in a kernel thread context, and tasks run from this thread do
246 If the caller wants to run under
248 he should explicitly acquire and release
250 in his taskqueue handler routine.
254 .Fn taskqueue_enqueue
255 with the value of the global taskqueue variable for the queue you wish to
257 .Va ( taskqueue_swi ,
258 .Va taskqueue_swi_giant ,
260 .Va taskqueue_thread ) .
262 .Fn taskqueue_enqueue_fast
263 for the global taskqueue variable
266 The software interrupt queues can be used,
267 for instance, for implementing interrupt handlers which must perform a
268 significant amount of processing in the handler.
269 The hardware interrupt handler would perform minimal processing of the
270 interrupt and then enqueue a task to finish the work.
271 This reduces to a minimum
272 the amount of time spent with interrupts disabled.
274 The thread queue can be used, for instance, by interrupt level routines
275 that need to call kernel functions that do things that can only be done
276 from a thread context.
277 (e.g., call malloc with the M_WAITOK flag.)
279 Note that tasks queued on shared taskqueues such as
281 may be delayed an indeterminate amount of time before execution.
282 If queueing delays cannot be tolerated then a private taskqueue should
283 be created with a dedicated processing thread.
289 This interface first appeared in
291 There is a similar facility called tqueue in the Linux kernel.
293 This man page was written by
297 .Fn taskqueue_create_fast .