xref: /dragonfly/sys/dev/drm/include/linux/workqueue.h (revision 030b3383)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013, 2014 Mellanox Technologies, Ltd.
6  * Copyright (c) 2014-2015 François Tigeot
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice unmodified, this list of conditions, and the following
14  *    disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 #ifndef	_LINUX_WORKQUEUE_H_
31 #define	_LINUX_WORKQUEUE_H_
32 
33 #include <sys/types.h>
34 #include <sys/malloc.h>
35 #include <sys/proc.h>
36 #include <linux/types.h>
37 #include <linux/kernel.h>
38 #include <linux/timer.h>
39 #include <linux/lockdep.h>
40 
41 #include <sys/taskqueue.h>
42 
43 struct workqueue_struct {
44 	struct taskqueue	*taskqueue;
45 };
46 
47 struct work_struct {
48 	struct	task 		work_task;
49 	struct	taskqueue	*taskqueue;
50 	void			(*fn)(struct work_struct *);
51 };
52 
53 struct delayed_work {
54 	struct work_struct	work;
55 	struct callout		timer;
56 	struct lwkt_token	token;
57 };
58 
59 static inline struct delayed_work *
60 to_delayed_work(struct work_struct *work)
61 {
62 
63 	return container_of(work, struct delayed_work, work);
64 }
65 
66 
67 static inline void
68 _work_fn(void *context, int pending)
69 {
70 	struct work_struct *work;
71 
72 	work = context;
73 	work->fn(work);
74 }
75 
76 #define	INIT_WORK(work, func) 	 					\
77 do {									\
78 	(work)->fn = (func);						\
79 	(work)->taskqueue = NULL;					\
80 	TASK_INIT(&(work)->work_task, 0, _work_fn, (work));		\
81 } while (0)
82 
83 #define	INIT_DELAYED_WORK(_work, func)					\
84 do {									\
85 	INIT_WORK(&(_work)->work, func);				\
86 	lwkt_token_init(&(_work)->token, "workqueue token");		\
87 	callout_init_mp(&(_work)->timer);				\
88 } while (0)
89 
90 #define	INIT_DEFERRABLE_WORK	INIT_DELAYED_WORK
91 
92 #define	schedule_work(work)						\
93 do {									\
94 	(work)->taskqueue = taskqueue_thread[mycpuid];				\
95 	taskqueue_enqueue(taskqueue_thread[mycpuid], &(work)->work_task);	\
96 } while (0)
97 
98 #define	flush_scheduled_work()	flush_taskqueue(taskqueue_thread[mycpuid])
99 
100 static inline int queue_work(struct workqueue_struct *q, struct work_struct *work)
101 {
102 	(work)->taskqueue = (q)->taskqueue;
103 	/* Return opposite val to align with Linux logic */
104 	return !taskqueue_enqueue((q)->taskqueue, &(work)->work_task);
105 }
106 
107 static inline void
108 _delayed_work_fn(void *arg)
109 {
110 	struct delayed_work *work;
111 
112 	work = arg;
113 	taskqueue_enqueue(work->work.taskqueue, &work->work.work_task);
114 }
115 
116 static inline int
117 queue_delayed_work(struct workqueue_struct *wq, struct delayed_work *work,
118     unsigned long delay)
119 {
120 	int pending;
121 
122 	pending = work->work.work_task.ta_pending;
123 	work->work.taskqueue = wq->taskqueue;
124 	if (delay != 0) {
125 		lwkt_gettoken(&work->token);
126 		callout_reset(&work->timer, delay, _delayed_work_fn, work);
127 		lwkt_reltoken(&work->token);
128 	} else {
129 		_delayed_work_fn((void *)work);
130 	}
131 
132 	return (!pending);
133 }
134 
135 static inline bool schedule_delayed_work(struct delayed_work *dwork,
136                                          unsigned long delay)
137 {
138         struct workqueue_struct wq;
139         wq.taskqueue = taskqueue_thread[mycpuid];
140         return queue_delayed_work(&wq, dwork, delay);
141 }
142 
143 static inline struct workqueue_struct *
144 _create_workqueue_common(char *name, int cpus)
145 {
146 	struct workqueue_struct *wq;
147 
148 	wq = kmalloc(sizeof(*wq), M_DRM, M_WAITOK);
149 	wq->taskqueue = taskqueue_create((name), M_WAITOK,
150 	    taskqueue_thread_enqueue,  &wq->taskqueue);
151 	taskqueue_start_threads(&wq->taskqueue, cpus, 0, -1, "%s", name);
152 
153 	return (wq);
154 }
155 
156 
157 #define	create_singlethread_workqueue(name)				\
158 	_create_workqueue_common(name, 1)
159 
160 #define	create_workqueue(name)						\
161 	_create_workqueue_common(name, MAXCPU)
162 
163 #define alloc_ordered_workqueue(name, flags)				\
164 	_create_workqueue_common(name, 1)
165 
166 #define alloc_workqueue(name, flags, max_active)			\
167 	_create_workqueue_common(name, max_active)
168 
169 static inline void
170 destroy_workqueue(struct workqueue_struct *wq)
171 {
172 	taskqueue_free(wq->taskqueue);
173 	kfree(wq);
174 }
175 
176 #define	flush_workqueue(wq)	flush_taskqueue((wq)->taskqueue)
177 
178 static inline void
179 _flush_fn(void *context, int pending)
180 {
181 }
182 
183 static inline void
184 flush_taskqueue(struct taskqueue *tq)
185 {
186 	struct task flushtask;
187 
188 	PHOLD(curproc);
189 	TASK_INIT(&flushtask, 0, _flush_fn, NULL);
190 	taskqueue_enqueue(tq, &flushtask);
191 	taskqueue_drain(tq, &flushtask);
192 	PRELE(curproc);
193 }
194 
195 static inline int
196 cancel_work_sync(struct work_struct *work)
197 {
198 	if (work->taskqueue &&
199 	    taskqueue_cancel(work->taskqueue, &work->work_task, NULL))
200 		taskqueue_drain(work->taskqueue, &work->work_task);
201 	return 0;
202 }
203 
204 /*
205  * This may leave work running on another CPU as it does on Linux.
206  */
207 static inline int
208 cancel_delayed_work(struct delayed_work *work)
209 {
210 
211 	lwkt_gettoken(&work->token);
212 	callout_stop(&work->timer);
213 	lwkt_reltoken(&work->token);
214 	if (work->work.taskqueue)
215 		return (taskqueue_cancel(work->work.taskqueue,
216 		    &work->work.work_task, NULL) == 0);
217 	return 0;
218 }
219 
220 static inline int
221 cancel_delayed_work_sync(struct delayed_work *work)
222 {
223 
224 	lwkt_gettoken(&work->token);
225 	callout_drain(&work->timer);
226 	lwkt_reltoken(&work->token);
227 	if (work->work.taskqueue &&
228 	    taskqueue_cancel(work->work.taskqueue, &work->work.work_task, NULL))
229 		taskqueue_drain(work->work.taskqueue, &work->work.work_task);
230 	return 0;
231 }
232 
233 static inline bool
234 mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
235 		                      unsigned long delay)
236 {
237 	cancel_delayed_work(dwork);
238 	queue_delayed_work(wq, dwork, delay);
239 	return false;
240 }
241 
242 /* System-wide workqueues */
243 extern struct workqueue_struct *system_wq;
244 extern struct workqueue_struct *system_long_wq;
245 extern struct workqueue_struct *system_power_efficient_wq;
246 
247 #endif	/* _LINUX_WORKQUEUE_H_ */
248