xref: /freebsd/sys/sys/gtaskqueue.h (revision 74d9553e43cfafc29448d0bb836916aa21dea0de)
1 /*-
2  * Copyright (c) 2014 Jeffrey Roberson <jeff@freebsd.org>
3  * Copyright (c) 2016 Matthew Macy <mmacy@nextbsd.org>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 
30 #ifndef _SYS_GTASKQUEUE_H_
31 #define _SYS_GTASKQUEUE_H_
32 #include <sys/taskqueue.h>
33 
34 #ifndef _KERNEL
35 #error "no user-serviceable parts inside"
36 #endif
37 
38 struct gtaskqueue;
39 typedef void (*gtaskqueue_enqueue_fn)(void *context);
40 
41 /*
42  * Taskqueue groups.  Manages dynamic thread groups and irq binding for
43  * device and other tasks.
44  */
45 
46 void	gtaskqueue_block(struct gtaskqueue *queue);
47 void	gtaskqueue_unblock(struct gtaskqueue *queue);
48 
49 int	gtaskqueue_cancel(struct gtaskqueue *queue, struct gtask *gtask);
50 void	gtaskqueue_drain(struct gtaskqueue *queue, struct gtask *task);
51 void	gtaskqueue_drain_all(struct gtaskqueue *queue);
52 
53 int grouptaskqueue_enqueue(struct gtaskqueue *queue, struct gtask *task);
54 void	taskqgroup_attach(struct taskqgroup *qgroup, struct grouptask *grptask,
55 	    void *uniq, int irq, char *name);
56 int		taskqgroup_attach_cpu(struct taskqgroup *qgroup, struct grouptask *grptask,
57 		void *uniq, int cpu, int irq, char *name);
58 void	taskqgroup_detach(struct taskqgroup *qgroup, struct grouptask *gtask);
59 struct taskqgroup *taskqgroup_create(char *name);
60 void	taskqgroup_destroy(struct taskqgroup *qgroup);
61 int	taskqgroup_adjust(struct taskqgroup *qgroup, int cnt, int stride);
62 
63 #define TASK_ENQUEUED			0x1
64 #define TASK_SKIP_WAKEUP		0x2
65 
66 
67 #define GTASK_INIT(task, flags, priority, func, context) do {	\
68 	(task)->ta_flags = flags;				\
69 	(task)->ta_priority = (priority);		\
70 	(task)->ta_func = (func);			\
71 	(task)->ta_context = (context);			\
72 } while (0)
73 
74 #define	GROUPTASK_INIT(gtask, priority, func, context)	\
75 	GTASK_INIT(&(gtask)->gt_task, TASK_SKIP_WAKEUP, priority, func, context)
76 
77 #define	GROUPTASK_ENQUEUE(gtask)			\
78 	grouptaskqueue_enqueue((gtask)->gt_taskqueue, &(gtask)->gt_task)
79 
80 #define TASKQGROUP_DECLARE(name)			\
81 extern struct taskqgroup *qgroup_##name
82 
83 #ifdef EARLY_AP_STARTUP
84 #define TASKQGROUP_DEFINE(name, cnt, stride)				\
85 									\
86 struct taskqgroup *qgroup_##name;					\
87 									\
88 static void								\
89 taskqgroup_define_##name(void *arg)					\
90 {									\
91 	qgroup_##name = taskqgroup_create(#name);			\
92 	taskqgroup_adjust(qgroup_##name, (cnt), (stride));		\
93 }									\
94 									\
95 SYSINIT(taskqgroup_##name, SI_SUB_INIT_IF, SI_ORDER_FIRST,		\
96 	taskqgroup_define_##name, NULL)
97 #else /* !EARLY_AP_STARTUP */
98 #define TASKQGROUP_DEFINE(name, cnt, stride)				\
99 									\
100 struct taskqgroup *qgroup_##name;					\
101 									\
102 static void								\
103 taskqgroup_define_##name(void *arg)					\
104 {									\
105 	qgroup_##name = taskqgroup_create(#name);			\
106 }									\
107 									\
108 SYSINIT(taskqgroup_##name, SI_SUB_INIT_IF, SI_ORDER_FIRST,		\
109 	taskqgroup_define_##name, NULL);				\
110 									\
111 static void								\
112 taskqgroup_adjust_##name(void *arg)					\
113 {									\
114 	taskqgroup_adjust(qgroup_##name, (cnt), (stride));		\
115 }									\
116 									\
117 SYSINIT(taskqgroup_adj_##name, SI_SUB_SMP, SI_ORDER_ANY,		\
118 	taskqgroup_adjust_##name, NULL)
119 #endif /* EARLY_AP_STARTUP */
120 
121 TASKQGROUP_DECLARE(net);
122 
123 #endif /* !_SYS_GTASKQUEUE_H_ */
124