xref: /freebsd/sys/sys/_task.h (revision 38069501)
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__TASK_H_
30 #define _SYS__TASK_H_
31 
32 #include <sys/queue.h>
33 
34 /*
35  * Each task includes a function which is called from
36  * taskqueue_run().  The first argument is taken from the 'ta_context'
37  * field of struct task and the second argument is a count of how many
38  * times the task was enqueued before the call to taskqueue_run().
39  *
40  * List of locks
41  * (c)	const after init
42  * (q)	taskqueue lock
43  */
44 typedef void task_fn_t(void *context, int pending);
45 typedef void gtask_fn_t(void *context);
46 
47 struct task {
48 	STAILQ_ENTRY(task) ta_link;	/* (q) link for queue */
49 	uint16_t ta_pending;		/* (q) count times queued */
50 	u_short	ta_priority;		/* (c) Priority */
51 	task_fn_t *ta_func;		/* (c) task handler */
52 	void	*ta_context;		/* (c) argument for handler */
53 };
54 
55 struct gtask {
56 	STAILQ_ENTRY(gtask) ta_link;	/* (q) link for queue */
57 	uint16_t ta_flags;		/* (q) state flags */
58 	u_short	ta_priority;		/* (c) Priority */
59 	gtask_fn_t *ta_func;		/* (c) task handler */
60 	void	*ta_context;		/* (c) argument for handler */
61 };
62 
63 struct grouptask {
64 	struct	gtask		gt_task;
65 	void			*gt_taskqueue;
66 	LIST_ENTRY(grouptask)	gt_list;
67 	void			*gt_uniq;
68 #define GROUPTASK_NAMELEN	32
69 	char			gt_name[GROUPTASK_NAMELEN];
70 	int16_t			gt_irq;
71 	int16_t			gt_cpu;
72 };
73 
74 #endif /* !_SYS__TASK_H_ */
75