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