xref: /f-stack/freebsd/sys/_task.h (revision 22ce4aff)
1a9643ea8Slogwang /*-
2*22ce4affSfengbojiang  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3*22ce4affSfengbojiang  *
4a9643ea8Slogwang  * Copyright (c) 2000 Doug Rabson
5a9643ea8Slogwang  * All rights reserved.
6a9643ea8Slogwang  *
7a9643ea8Slogwang  * Redistribution and use in source and binary forms, with or without
8a9643ea8Slogwang  * modification, are permitted provided that the following conditions
9a9643ea8Slogwang  * are met:
10a9643ea8Slogwang  * 1. Redistributions of source code must retain the above copyright
11a9643ea8Slogwang  *    notice, this list of conditions and the following disclaimer.
12a9643ea8Slogwang  * 2. Redistributions in binary form must reproduce the above copyright
13a9643ea8Slogwang  *    notice, this list of conditions and the following disclaimer in the
14a9643ea8Slogwang  *    documentation and/or other materials provided with the distribution.
15a9643ea8Slogwang  *
16a9643ea8Slogwang  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17a9643ea8Slogwang  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18a9643ea8Slogwang  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19a9643ea8Slogwang  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20a9643ea8Slogwang  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21a9643ea8Slogwang  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22a9643ea8Slogwang  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23a9643ea8Slogwang  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24a9643ea8Slogwang  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25a9643ea8Slogwang  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26a9643ea8Slogwang  * SUCH DAMAGE.
27a9643ea8Slogwang  *
28a9643ea8Slogwang  * $FreeBSD$
29a9643ea8Slogwang  */
30a9643ea8Slogwang 
31a9643ea8Slogwang #ifndef _SYS__TASK_H_
32a9643ea8Slogwang #define _SYS__TASK_H_
33a9643ea8Slogwang 
34a9643ea8Slogwang #include <sys/queue.h>
35a9643ea8Slogwang 
36a9643ea8Slogwang /*
37a9643ea8Slogwang  * Each task includes a function which is called from
38a9643ea8Slogwang  * taskqueue_run().  The first argument is taken from the 'ta_context'
39a9643ea8Slogwang  * field of struct task and the second argument is a count of how many
40a9643ea8Slogwang  * times the task was enqueued before the call to taskqueue_run().
41a9643ea8Slogwang  *
42a9643ea8Slogwang  * List of locks
43a9643ea8Slogwang  * (c)	const after init
44a9643ea8Slogwang  * (q)	taskqueue lock
45a9643ea8Slogwang  */
46a9643ea8Slogwang typedef void task_fn_t(void *context, int pending);
47a9643ea8Slogwang 
48a9643ea8Slogwang struct task {
49a9643ea8Slogwang 	STAILQ_ENTRY(task) ta_link;	/* (q) link for queue */
50a9643ea8Slogwang 	uint16_t ta_pending;		/* (q) count times queued */
51*22ce4affSfengbojiang 	uint8_t	ta_priority;		/* (c) Priority */
52*22ce4affSfengbojiang 	uint8_t	ta_flags;		/* (c) Flags */
53a9643ea8Slogwang 	task_fn_t *ta_func;		/* (c) task handler */
54a9643ea8Slogwang 	void	*ta_context;		/* (c) argument for handler */
55a9643ea8Slogwang };
56a9643ea8Slogwang 
57*22ce4affSfengbojiang #define	TASK_ENQUEUED		0x1
58*22ce4affSfengbojiang #define	TASK_NOENQUEUE		0x2
59*22ce4affSfengbojiang #define	TASK_NETWORK		0x4
60*22ce4affSfengbojiang 
61*22ce4affSfengbojiang #define	TASK_IS_NET(ta)		((ta)->ta_flags & TASK_NETWORK)
62*22ce4affSfengbojiang 
63*22ce4affSfengbojiang #ifdef _KERNEL
64*22ce4affSfengbojiang 
65*22ce4affSfengbojiang typedef void gtask_fn_t(void *context);
66*22ce4affSfengbojiang 
67a9643ea8Slogwang struct gtask {
68a9643ea8Slogwang 	STAILQ_ENTRY(gtask) ta_link;	/* (q) link for queue */
69a9643ea8Slogwang 	uint16_t ta_flags;		/* (q) state flags */
70a9643ea8Slogwang 	u_short	ta_priority;		/* (c) Priority */
71a9643ea8Slogwang 	gtask_fn_t *ta_func;		/* (c) task handler */
72a9643ea8Slogwang 	void	*ta_context;		/* (c) argument for handler */
73a9643ea8Slogwang };
74a9643ea8Slogwang 
75*22ce4affSfengbojiang #endif /* _KERNEL */
76a9643ea8Slogwang 
77a9643ea8Slogwang #endif /* !_SYS__TASK_H_ */
78