linux_work.c revision 1.25 1 1.2 riastrad /* $NetBSD: linux_work.c,v 1.25 2018/08/27 15:02:38 riastradh Exp $ */
2 1.1 skrll
3 1.1 skrll /*-
4 1.12 riastrad * Copyright (c) 2018 The NetBSD Foundation, Inc.
5 1.1 skrll * All rights reserved.
6 1.1 skrll *
7 1.1 skrll * This code is derived from software contributed to The NetBSD Foundation
8 1.1 skrll * by Taylor R. Campbell.
9 1.1 skrll *
10 1.1 skrll * Redistribution and use in source and binary forms, with or without
11 1.1 skrll * modification, are permitted provided that the following conditions
12 1.1 skrll * are met:
13 1.1 skrll * 1. Redistributions of source code must retain the above copyright
14 1.1 skrll * notice, this list of conditions and the following disclaimer.
15 1.1 skrll * 2. Redistributions in binary form must reproduce the above copyright
16 1.1 skrll * notice, this list of conditions and the following disclaimer in the
17 1.1 skrll * documentation and/or other materials provided with the distribution.
18 1.1 skrll *
19 1.1 skrll * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.1 skrll * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.1 skrll * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.1 skrll * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.1 skrll * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.1 skrll * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.1 skrll * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.1 skrll * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.1 skrll * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.1 skrll * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.1 skrll * POSSIBILITY OF SUCH DAMAGE.
30 1.1 skrll */
31 1.1 skrll
32 1.1 skrll #include <sys/cdefs.h>
33 1.2 riastrad __KERNEL_RCSID(0, "$NetBSD: linux_work.c,v 1.25 2018/08/27 15:02:38 riastradh Exp $");
34 1.1 skrll
35 1.1 skrll #include <sys/types.h>
36 1.1 skrll #include <sys/atomic.h>
37 1.1 skrll #include <sys/callout.h>
38 1.1 skrll #include <sys/condvar.h>
39 1.1 skrll #include <sys/errno.h>
40 1.1 skrll #include <sys/kmem.h>
41 1.12 riastrad #include <sys/kthread.h>
42 1.12 riastrad #include <sys/lwp.h>
43 1.1 skrll #include <sys/mutex.h>
44 1.1 skrll #include <sys/queue.h>
45 1.1 skrll
46 1.1 skrll #include <linux/workqueue.h>
47 1.1 skrll
48 1.1 skrll struct workqueue_struct {
49 1.1 skrll kmutex_t wq_lock;
50 1.1 skrll kcondvar_t wq_cv;
51 1.1 skrll TAILQ_HEAD(, delayed_work) wq_delayed;
52 1.12 riastrad TAILQ_HEAD(, work_struct) wq_queue;
53 1.1 skrll struct work_struct *wq_current_work;
54 1.12 riastrad int wq_flags;
55 1.12 riastrad struct lwp *wq_lwp;
56 1.12 riastrad uint64_t wq_gen;
57 1.12 riastrad bool wq_requeued:1;
58 1.12 riastrad bool wq_dying:1;
59 1.1 skrll };
60 1.1 skrll
61 1.12 riastrad static void __dead linux_workqueue_thread(void *);
62 1.12 riastrad static void linux_workqueue_timeout(void *);
63 1.17 riastrad static struct workqueue_struct *
64 1.17 riastrad acquire_work(struct work_struct *,
65 1.17 riastrad struct workqueue_struct *);
66 1.17 riastrad static void release_work(struct work_struct *,
67 1.17 riastrad struct workqueue_struct *);
68 1.12 riastrad static void queue_delayed_work_anew(struct workqueue_struct *,
69 1.12 riastrad struct delayed_work *, unsigned long);
70 1.23 riastrad static void cancel_delayed_work_done(struct workqueue_struct *,
71 1.23 riastrad struct delayed_work *);
72 1.12 riastrad
73 1.12 riastrad static specificdata_key_t workqueue_key __read_mostly;
74 1.12 riastrad
75 1.12 riastrad struct workqueue_struct *system_wq __read_mostly;
76 1.12 riastrad struct workqueue_struct *system_long_wq __read_mostly;
77 1.12 riastrad struct workqueue_struct *system_power_efficient_wq __read_mostly;
78 1.3 riastrad
79 1.1 skrll int
80 1.1 skrll linux_workqueue_init(void)
81 1.1 skrll {
82 1.12 riastrad int error;
83 1.3 riastrad
84 1.12 riastrad error = lwp_specific_key_create(&workqueue_key, NULL);
85 1.12 riastrad if (error)
86 1.12 riastrad goto fail0;
87 1.1 skrll
88 1.1 skrll system_wq = alloc_ordered_workqueue("lnxsyswq", 0);
89 1.12 riastrad if (system_wq == NULL) {
90 1.12 riastrad error = ENOMEM;
91 1.12 riastrad goto fail1;
92 1.12 riastrad }
93 1.2 riastrad
94 1.2 riastrad system_long_wq = alloc_ordered_workqueue("lnxlngwq", 0);
95 1.12 riastrad if (system_long_wq == NULL) {
96 1.12 riastrad error = ENOMEM;
97 1.12 riastrad goto fail2;
98 1.12 riastrad }
99 1.1 skrll
100 1.6 riastrad system_power_efficient_wq = alloc_ordered_workqueue("lnxpwrwq", 0);
101 1.12 riastrad if (system_long_wq == NULL) {
102 1.12 riastrad error = ENOMEM;
103 1.12 riastrad goto fail3;
104 1.12 riastrad }
105 1.6 riastrad
106 1.1 skrll return 0;
107 1.2 riastrad
108 1.12 riastrad fail4: __unused
109 1.6 riastrad destroy_workqueue(system_power_efficient_wq);
110 1.12 riastrad fail3: destroy_workqueue(system_long_wq);
111 1.12 riastrad fail2: destroy_workqueue(system_wq);
112 1.12 riastrad fail1: lwp_specific_key_delete(workqueue_key);
113 1.12 riastrad fail0: KASSERT(error);
114 1.12 riastrad return error;
115 1.1 skrll }
116 1.1 skrll
117 1.1 skrll void
118 1.1 skrll linux_workqueue_fini(void)
119 1.1 skrll {
120 1.2 riastrad
121 1.12 riastrad destroy_workqueue(system_power_efficient_wq);
122 1.2 riastrad destroy_workqueue(system_long_wq);
123 1.1 skrll destroy_workqueue(system_wq);
124 1.12 riastrad lwp_specific_key_delete(workqueue_key);
125 1.1 skrll }
126 1.1 skrll
127 1.1 skrll /*
129 1.1 skrll * Workqueues
130 1.1 skrll */
131 1.1 skrll
132 1.12 riastrad struct workqueue_struct *
133 1.1 skrll alloc_ordered_workqueue(const char *name, int flags)
134 1.1 skrll {
135 1.1 skrll struct workqueue_struct *wq;
136 1.1 skrll int error;
137 1.12 riastrad
138 1.1 skrll KASSERT(flags == 0);
139 1.25 riastrad
140 1.1 skrll wq = kmem_zalloc(sizeof(*wq), KM_SLEEP);
141 1.12 riastrad
142 1.1 skrll mutex_init(&wq->wq_lock, MUTEX_DEFAULT, IPL_NONE);
143 1.1 skrll cv_init(&wq->wq_cv, name);
144 1.12 riastrad TAILQ_INIT(&wq->wq_delayed);
145 1.1 skrll TAILQ_INIT(&wq->wq_queue);
146 1.25 riastrad wq->wq_current_work = NULL;
147 1.25 riastrad wq->wq_flags = 0;
148 1.25 riastrad wq->wq_lwp = NULL;
149 1.25 riastrad wq->wq_gen = 0;
150 1.25 riastrad wq->wq_requeued = false;
151 1.1 skrll wq->wq_dying = false;
152 1.12 riastrad
153 1.12 riastrad error = kthread_create(PRI_NONE,
154 1.12 riastrad KTHREAD_MPSAFE|KTHREAD_TS|KTHREAD_MUSTJOIN, NULL,
155 1.12 riastrad &linux_workqueue_thread, wq, &wq->wq_lwp, "%s", name);
156 1.12 riastrad if (error)
157 1.3 riastrad goto fail0;
158 1.1 skrll
159 1.12 riastrad return wq;
160 1.12 riastrad
161 1.12 riastrad fail0: KASSERT(TAILQ_EMPTY(&wq->wq_queue));
162 1.12 riastrad KASSERT(TAILQ_EMPTY(&wq->wq_delayed));
163 1.12 riastrad cv_destroy(&wq->wq_cv);
164 1.12 riastrad mutex_destroy(&wq->wq_lock);
165 1.12 riastrad kmem_free(wq, sizeof(*wq));
166 1.1 skrll return NULL;
167 1.1 skrll }
168 1.1 skrll
169 1.1 skrll void
170 1.1 skrll destroy_workqueue(struct workqueue_struct *wq)
171 1.1 skrll {
172 1.1 skrll
173 1.12 riastrad /*
174 1.12 riastrad * Cancel all delayed work. We do this first because any
175 1.12 riastrad * delayed work that that has already timed out, which we can't
176 1.1 skrll * cancel, may have queued new work.
177 1.1 skrll */
178 1.12 riastrad for (;;) {
179 1.1 skrll struct delayed_work *dw = NULL;
180 1.1 skrll
181 1.12 riastrad mutex_enter(&wq->wq_lock);
182 1.1 skrll if (!TAILQ_EMPTY(&wq->wq_delayed)) {
183 1.12 riastrad dw = TAILQ_FIRST(&wq->wq_delayed);
184 1.12 riastrad if (!callout_halt(&dw->dw_callout, &wq->wq_lock))
185 1.1 skrll TAILQ_REMOVE(&wq->wq_delayed, dw, dw_entry);
186 1.1 skrll }
187 1.1 skrll mutex_exit(&wq->wq_lock);
188 1.1 skrll
189 1.1 skrll if (dw == NULL)
190 1.1 skrll break;
191 1.1 skrll cancel_delayed_work_sync(dw);
192 1.1 skrll }
193 1.12 riastrad
194 1.12 riastrad /* Tell the thread to exit. */
195 1.12 riastrad mutex_enter(&wq->wq_lock);
196 1.12 riastrad wq->wq_dying = true;
197 1.12 riastrad cv_broadcast(&wq->wq_cv);
198 1.12 riastrad mutex_exit(&wq->wq_lock);
199 1.12 riastrad
200 1.12 riastrad /* Wait for it to exit. */
201 1.12 riastrad (void)kthread_join(wq->wq_lwp);
202 1.25 riastrad
203 1.25 riastrad KASSERT(wq->wq_dying);
204 1.25 riastrad KASSERT(!wq->wq_requeued);
205 1.1 skrll KASSERT(wq->wq_flags == 0);
206 1.12 riastrad KASSERT(wq->wq_current_work == NULL);
207 1.12 riastrad KASSERT(TAILQ_EMPTY(&wq->wq_queue));
208 1.1 skrll KASSERT(TAILQ_EMPTY(&wq->wq_delayed));
209 1.1 skrll cv_destroy(&wq->wq_cv);
210 1.1 skrll mutex_destroy(&wq->wq_lock);
211 1.1 skrll
212 1.1 skrll kmem_free(wq, sizeof(*wq));
213 1.1 skrll }
214 1.1 skrll
215 1.12 riastrad /*
217 1.1 skrll * Work thread and callout
218 1.12 riastrad */
219 1.12 riastrad
220 1.1 skrll static void __dead
221 1.12 riastrad linux_workqueue_thread(void *cookie)
222 1.12 riastrad {
223 1.1 skrll struct workqueue_struct *const wq = cookie;
224 1.12 riastrad TAILQ_HEAD(, work_struct) tmp;
225 1.1 skrll
226 1.12 riastrad lwp_setspecific(workqueue_key, wq);
227 1.12 riastrad
228 1.12 riastrad mutex_enter(&wq->wq_lock);
229 1.12 riastrad for (;;) {
230 1.12 riastrad /* Wait until there's activity. If we're dying, stop. */
231 1.12 riastrad while (TAILQ_EMPTY(&wq->wq_queue) && !wq->wq_dying)
232 1.12 riastrad cv_wait(&wq->wq_cv, &wq->wq_lock);
233 1.1 skrll if (wq->wq_dying)
234 1.12 riastrad break;
235 1.12 riastrad
236 1.12 riastrad /* Grab a batch of work off the queue. */
237 1.12 riastrad KASSERT(!TAILQ_EMPTY(&wq->wq_queue));
238 1.12 riastrad TAILQ_INIT(&tmp);
239 1.12 riastrad TAILQ_CONCAT(&tmp, &wq->wq_queue, work_entry);
240 1.12 riastrad
241 1.12 riastrad /* Process each work item in the batch. */
242 1.12 riastrad while (!TAILQ_EMPTY(&tmp)) {
243 1.18 riastrad struct work_struct *const work = TAILQ_FIRST(&tmp);
244 1.12 riastrad
245 1.12 riastrad KASSERT(work->work_queue == wq);
246 1.12 riastrad TAILQ_REMOVE(&tmp, work, work_entry);
247 1.1 skrll KASSERT(wq->wq_current_work == NULL);
248 1.12 riastrad wq->wq_current_work = work;
249 1.12 riastrad
250 1.12 riastrad mutex_exit(&wq->wq_lock);
251 1.1 skrll (*work->func)(work);
252 1.12 riastrad mutex_enter(&wq->wq_lock);
253 1.12 riastrad
254 1.12 riastrad KASSERT(wq->wq_current_work == work);
255 1.12 riastrad KASSERT(work->work_queue == wq);
256 1.12 riastrad if (wq->wq_requeued)
257 1.17 riastrad wq->wq_requeued = false;
258 1.12 riastrad else
259 1.12 riastrad release_work(work, wq);
260 1.12 riastrad wq->wq_current_work = NULL;
261 1.1 skrll cv_broadcast(&wq->wq_cv);
262 1.12 riastrad }
263 1.12 riastrad
264 1.12 riastrad /* Notify flush that we've completed a batch of work. */
265 1.1 skrll wq->wq_gen++;
266 1.12 riastrad cv_broadcast(&wq->wq_cv);
267 1.1 skrll }
268 1.12 riastrad mutex_exit(&wq->wq_lock);
269 1.1 skrll
270 1.1 skrll kthread_exit(0);
271 1.1 skrll }
272 1.12 riastrad
273 1.1 skrll static void
274 1.12 riastrad linux_workqueue_timeout(void *cookie)
275 1.12 riastrad {
276 1.1 skrll struct delayed_work *const dw = cookie;
277 1.12 riastrad struct workqueue_struct *const wq = dw->work.work_queue;
278 1.14 riastrad
279 1.12 riastrad KASSERT(wq != NULL);
280 1.18 riastrad
281 1.12 riastrad mutex_enter(&wq->wq_lock);
282 1.12 riastrad KASSERT(dw->work.work_queue == wq);
283 1.12 riastrad switch (dw->dw_state) {
284 1.12 riastrad case DELAYED_WORK_IDLE:
285 1.12 riastrad panic("delayed work callout uninitialized: %p", dw);
286 1.12 riastrad case DELAYED_WORK_SCHEDULED:
287 1.12 riastrad dw->dw_state = DELAYED_WORK_IDLE;
288 1.12 riastrad callout_destroy(&dw->dw_callout);
289 1.12 riastrad TAILQ_REMOVE(&wq->wq_delayed, dw, dw_entry);
290 1.12 riastrad TAILQ_INSERT_TAIL(&wq->wq_queue, &dw->work, work_entry);
291 1.12 riastrad cv_broadcast(&wq->wq_cv);
292 1.12 riastrad break;
293 1.12 riastrad case DELAYED_WORK_RESCHEDULED:
294 1.12 riastrad dw->dw_state = DELAYED_WORK_SCHEDULED;
295 1.23 riastrad break;
296 1.22 riastrad case DELAYED_WORK_CANCELLED:
297 1.22 riastrad cancel_delayed_work_done(wq, dw);
298 1.12 riastrad /* Can't touch dw any more. */
299 1.12 riastrad goto out;
300 1.12 riastrad default:
301 1.15 riastrad panic("delayed work callout in bad state: %p", dw);
302 1.15 riastrad }
303 1.22 riastrad KASSERT(dw->dw_state == DELAYED_WORK_IDLE ||
304 1.1 skrll dw->dw_state == DELAYED_WORK_SCHEDULED);
305 1.1 skrll out: mutex_exit(&wq->wq_lock);
306 1.12 riastrad }
307 1.12 riastrad
308 1.1 skrll struct work_struct *
309 1.12 riastrad current_work(void)
310 1.1 skrll {
311 1.12 riastrad struct workqueue_struct *wq = lwp_getspecific(workqueue_key);
312 1.12 riastrad
313 1.12 riastrad /* If we're not a workqueue thread, then there's no work. */
314 1.1 skrll if (wq == NULL)
315 1.12 riastrad return NULL;
316 1.12 riastrad
317 1.12 riastrad /*
318 1.12 riastrad * Otherwise, this should be possible only while work is in
319 1.12 riastrad * progress. Return the current work item.
320 1.12 riastrad */
321 1.1 skrll KASSERT(wq->wq_current_work != NULL);
322 1.1 skrll return wq->wq_current_work;
323 1.1 skrll }
324 1.1 skrll
325 1.1 skrll /*
327 1.1 skrll * Work
328 1.1 skrll */
329 1.1 skrll
330 1.1 skrll void
331 1.12 riastrad INIT_WORK(struct work_struct *work, void (*fn)(struct work_struct *))
332 1.4 riastrad {
333 1.1 skrll
334 1.1 skrll work->work_queue = NULL;
335 1.17 riastrad work->func = fn;
336 1.17 riastrad }
337 1.17 riastrad
338 1.17 riastrad static struct workqueue_struct *
339 1.17 riastrad acquire_work(struct work_struct *work, struct workqueue_struct *wq)
340 1.17 riastrad {
341 1.17 riastrad struct workqueue_struct *wq0;
342 1.17 riastrad
343 1.17 riastrad KASSERT(mutex_owned(&wq->wq_lock));
344 1.17 riastrad
345 1.17 riastrad wq0 = atomic_cas_ptr(&work->work_queue, NULL, wq);
346 1.17 riastrad if (wq0 == NULL) {
347 1.17 riastrad membar_enter();
348 1.17 riastrad KASSERT(work->work_queue == wq);
349 1.17 riastrad }
350 1.17 riastrad
351 1.17 riastrad return wq0;
352 1.17 riastrad }
353 1.17 riastrad
354 1.17 riastrad static void
355 1.17 riastrad release_work(struct work_struct *work, struct workqueue_struct *wq)
356 1.17 riastrad {
357 1.17 riastrad
358 1.17 riastrad KASSERT(work->work_queue == wq);
359 1.17 riastrad KASSERT(mutex_owned(&wq->wq_lock));
360 1.17 riastrad
361 1.17 riastrad membar_exit();
362 1.1 skrll work->work_queue = NULL;
363 1.1 skrll }
364 1.1 skrll
365 1.12 riastrad bool
366 1.1 skrll schedule_work(struct work_struct *work)
367 1.1 skrll {
368 1.1 skrll
369 1.1 skrll return queue_work(system_wq, work);
370 1.1 skrll }
371 1.1 skrll
372 1.12 riastrad bool
373 1.1 skrll queue_work(struct workqueue_struct *wq, struct work_struct *work)
374 1.1 skrll {
375 1.1 skrll struct workqueue_struct *wq0;
376 1.1 skrll bool newly_queued;
377 1.12 riastrad
378 1.17 riastrad KASSERT(wq != NULL);
379 1.12 riastrad
380 1.1 skrll mutex_enter(&wq->wq_lock);
381 1.12 riastrad if (__predict_true((wq0 = acquire_work(work, wq)) == NULL)) {
382 1.12 riastrad TAILQ_INSERT_TAIL(&wq->wq_queue, work, work_entry);
383 1.1 skrll newly_queued = true;
384 1.1 skrll } else {
385 1.12 riastrad KASSERT(wq0 == wq);
386 1.1 skrll newly_queued = false;
387 1.1 skrll }
388 1.1 skrll mutex_exit(&wq->wq_lock);
389 1.1 skrll
390 1.1 skrll return newly_queued;
391 1.12 riastrad }
392 1.1 skrll
393 1.12 riastrad bool
394 1.1 skrll cancel_work(struct work_struct *work)
395 1.1 skrll {
396 1.13 riastrad struct workqueue_struct *wq;
397 1.13 riastrad bool cancelled_p = false;
398 1.13 riastrad
399 1.13 riastrad /* If there's no workqueue, nothing to cancel. */
400 1.12 riastrad if ((wq = work->work_queue) == NULL)
401 1.12 riastrad goto out;
402 1.12 riastrad
403 1.12 riastrad mutex_enter(&wq->wq_lock);
404 1.12 riastrad if (__predict_false(work->work_queue != wq)) {
405 1.12 riastrad cancelled_p = false;
406 1.12 riastrad } else if (wq->wq_current_work == work) {
407 1.1 skrll cancelled_p = false;
408 1.1 skrll } else {
409 1.12 riastrad TAILQ_REMOVE(&wq->wq_queue, work, work_entry);
410 1.1 skrll cancelled_p = true;
411 1.13 riastrad }
412 1.1 skrll mutex_exit(&wq->wq_lock);
413 1.1 skrll
414 1.12 riastrad out: return cancelled_p;
415 1.12 riastrad }
416 1.1 skrll
417 1.1 skrll bool
418 1.12 riastrad cancel_work_sync(struct work_struct *work)
419 1.1 skrll {
420 1.13 riastrad struct workqueue_struct *wq;
421 1.13 riastrad bool cancelled_p = false;
422 1.13 riastrad
423 1.13 riastrad /* If there's no workqueue, nothing to cancel. */
424 1.1 skrll if ((wq = work->work_queue) == NULL)
425 1.12 riastrad goto out;
426 1.12 riastrad
427 1.12 riastrad mutex_enter(&wq->wq_lock);
428 1.12 riastrad if (__predict_false(work->work_queue != wq)) {
429 1.12 riastrad cancelled_p = false;
430 1.12 riastrad } else if (wq->wq_current_work == work) {
431 1.12 riastrad do {
432 1.12 riastrad cv_wait(&wq->wq_cv, &wq->wq_lock);
433 1.12 riastrad } while (wq->wq_current_work == work);
434 1.12 riastrad cancelled_p = false;
435 1.12 riastrad } else {
436 1.1 skrll TAILQ_REMOVE(&wq->wq_queue, work, work_entry);
437 1.1 skrll cancelled_p = true;
438 1.13 riastrad }
439 1.1 skrll mutex_exit(&wq->wq_lock);
440 1.1 skrll
441 1.1 skrll out: return cancelled_p;
442 1.1 skrll }
443 1.1 skrll
444 1.1 skrll /*
446 1.1 skrll * Delayed work
447 1.1 skrll */
448 1.12 riastrad
449 1.1 skrll void
450 1.12 riastrad INIT_DELAYED_WORK(struct delayed_work *dw, void (*fn)(struct work_struct *))
451 1.12 riastrad {
452 1.12 riastrad
453 1.12 riastrad INIT_WORK(&dw->work, fn);
454 1.12 riastrad dw->dw_state = DELAYED_WORK_IDLE;
455 1.12 riastrad
456 1.12 riastrad /*
457 1.12 riastrad * Defer callout_init until we are going to schedule the
458 1.1 skrll * callout, which can then callout_destroy it, because
459 1.1 skrll * otherwise since there's no DESTROY_DELAYED_WORK or anything
460 1.1 skrll * we have no opportunity to call callout_destroy.
461 1.1 skrll */
462 1.1 skrll }
463 1.12 riastrad
464 1.1 skrll bool
465 1.1 skrll schedule_delayed_work(struct delayed_work *dw, unsigned long ticks)
466 1.1 skrll {
467 1.12 riastrad
468 1.12 riastrad return queue_delayed_work(system_wq, dw, ticks);
469 1.1 skrll }
470 1.1 skrll
471 1.1 skrll static void
472 1.12 riastrad queue_delayed_work_anew(struct workqueue_struct *wq, struct delayed_work *dw,
473 1.12 riastrad unsigned long ticks)
474 1.12 riastrad {
475 1.12 riastrad
476 1.12 riastrad KASSERT(mutex_owned(&wq->wq_lock));
477 1.12 riastrad KASSERT(dw->work.work_queue == wq);
478 1.12 riastrad KASSERT((dw->dw_state == DELAYED_WORK_IDLE) ||
479 1.12 riastrad (dw->dw_state == DELAYED_WORK_SCHEDULED));
480 1.12 riastrad
481 1.1 skrll if (ticks == 0) {
482 1.12 riastrad if (dw->dw_state == DELAYED_WORK_SCHEDULED) {
483 1.12 riastrad callout_destroy(&dw->dw_callout);
484 1.12 riastrad TAILQ_REMOVE(&wq->wq_delayed, dw, dw_entry);
485 1.12 riastrad } else {
486 1.12 riastrad KASSERT(dw->dw_state == DELAYED_WORK_IDLE);
487 1.12 riastrad }
488 1.1 skrll TAILQ_INSERT_TAIL(&wq->wq_queue, &dw->work, work_entry);
489 1.12 riastrad dw->dw_state = DELAYED_WORK_IDLE;
490 1.12 riastrad } else {
491 1.1 skrll if (dw->dw_state == DELAYED_WORK_IDLE) {
492 1.12 riastrad callout_init(&dw->dw_callout, CALLOUT_MPSAFE);
493 1.12 riastrad callout_reset(&dw->dw_callout, MIN(INT_MAX, ticks),
494 1.1 skrll &linux_workqueue_timeout, dw);
495 1.12 riastrad TAILQ_INSERT_HEAD(&wq->wq_delayed, dw, dw_entry);
496 1.12 riastrad } else {
497 1.12 riastrad KASSERT(dw->dw_state == DELAYED_WORK_SCHEDULED);
498 1.1 skrll }
499 1.23 riastrad dw->dw_state = DELAYED_WORK_SCHEDULED;
500 1.23 riastrad }
501 1.23 riastrad }
502 1.23 riastrad
503 1.23 riastrad static void
504 1.23 riastrad cancel_delayed_work_done(struct workqueue_struct *wq, struct delayed_work *dw)
505 1.23 riastrad {
506 1.23 riastrad
507 1.23 riastrad KASSERT(mutex_owned(&wq->wq_lock));
508 1.23 riastrad KASSERT(dw->work.work_queue == wq);
509 1.23 riastrad KASSERT(dw->dw_state == DELAYED_WORK_CANCELLED);
510 1.23 riastrad dw->dw_state = DELAYED_WORK_IDLE;
511 1.23 riastrad callout_destroy(&dw->dw_callout);
512 1.23 riastrad TAILQ_REMOVE(&wq->wq_delayed, dw, dw_entry);
513 1.12 riastrad release_work(&dw->work, wq);
514 1.12 riastrad /* Can't touch dw after this point. */
515 1.12 riastrad }
516 1.12 riastrad
517 1.12 riastrad bool
518 1.12 riastrad queue_delayed_work(struct workqueue_struct *wq, struct delayed_work *dw,
519 1.1 skrll unsigned long ticks)
520 1.12 riastrad {
521 1.17 riastrad struct workqueue_struct *wq0;
522 1.12 riastrad bool newly_queued;
523 1.12 riastrad
524 1.12 riastrad mutex_enter(&wq->wq_lock);
525 1.12 riastrad if (__predict_true((wq0 = acquire_work(&dw->work, wq)) == NULL)) {
526 1.12 riastrad KASSERT(dw->dw_state == DELAYED_WORK_IDLE);
527 1.1 skrll queue_delayed_work_anew(wq, dw, ticks);
528 1.1 skrll newly_queued = true;
529 1.12 riastrad } else {
530 1.1 skrll KASSERT(wq0 == wq);
531 1.1 skrll newly_queued = false;
532 1.1 skrll }
533 1.1 skrll mutex_exit(&wq->wq_lock);
534 1.1 skrll
535 1.1 skrll return newly_queued;
536 1.1 skrll }
537 1.1 skrll
538 1.12 riastrad bool
539 1.1 skrll mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dw,
540 1.1 skrll unsigned long ticks)
541 1.12 riastrad {
542 1.17 riastrad struct workqueue_struct *wq0;
543 1.12 riastrad bool timer_modified;
544 1.12 riastrad
545 1.12 riastrad mutex_enter(&wq->wq_lock);
546 1.12 riastrad if ((wq0 = acquire_work(&dw->work, wq)) == NULL) {
547 1.12 riastrad KASSERT(dw->dw_state == DELAYED_WORK_IDLE);
548 1.12 riastrad queue_delayed_work_anew(wq, dw, ticks);
549 1.12 riastrad timer_modified = false;
550 1.12 riastrad } else {
551 1.12 riastrad KASSERT(wq0 == wq);
552 1.12 riastrad switch (dw->dw_state) {
553 1.12 riastrad case DELAYED_WORK_IDLE:
554 1.12 riastrad if (wq->wq_current_work != &dw->work) {
555 1.12 riastrad /* Work is queued, but hasn't started yet. */
556 1.12 riastrad TAILQ_REMOVE(&wq->wq_queue, &dw->work,
557 1.12 riastrad work_entry);
558 1.12 riastrad queue_delayed_work_anew(wq, dw, ticks);
559 1.12 riastrad timer_modified = true;
560 1.12 riastrad } else {
561 1.12 riastrad /*
562 1.12 riastrad * Too late. Queue it anew. If that
563 1.12 riastrad * would skip the callout because it's
564 1.12 riastrad * immediate, notify the workqueue.
565 1.12 riastrad */
566 1.12 riastrad wq->wq_requeued = ticks == 0;
567 1.12 riastrad queue_delayed_work_anew(wq, dw, ticks);
568 1.12 riastrad timer_modified = false;
569 1.12 riastrad }
570 1.12 riastrad break;
571 1.12 riastrad case DELAYED_WORK_SCHEDULED:
572 1.12 riastrad if (callout_stop(&dw->dw_callout)) {
573 1.12 riastrad /*
574 1.12 riastrad * Too late to stop, but we got in
575 1.12 riastrad * before the callout acquired the
576 1.12 riastrad * lock. Reschedule it and tell it
577 1.12 riastrad * we've done so.
578 1.12 riastrad */
579 1.12 riastrad dw->dw_state = DELAYED_WORK_RESCHEDULED;
580 1.12 riastrad callout_schedule(&dw->dw_callout,
581 1.12 riastrad MIN(INT_MAX, ticks));
582 1.12 riastrad } else {
583 1.12 riastrad /* Stopped it. Queue it anew. */
584 1.12 riastrad queue_delayed_work_anew(wq, dw, ticks);
585 1.12 riastrad }
586 1.12 riastrad timer_modified = true;
587 1.12 riastrad break;
588 1.12 riastrad case DELAYED_WORK_RESCHEDULED:
589 1.12 riastrad case DELAYED_WORK_CANCELLED:
590 1.12 riastrad /*
591 1.12 riastrad * Someone modified the timer _again_, or
592 1.12 riastrad * cancelled it, after the callout started but
593 1.12 riastrad * before the poor thing even had a chance to
594 1.12 riastrad * acquire the lock. Just reschedule it once
595 1.12 riastrad * more.
596 1.12 riastrad */
597 1.12 riastrad callout_schedule(&dw->dw_callout, MIN(INT_MAX, ticks));
598 1.12 riastrad dw->dw_state = DELAYED_WORK_RESCHEDULED;
599 1.12 riastrad timer_modified = true;
600 1.1 skrll break;
601 1.1 skrll default:
602 1.12 riastrad panic("invalid delayed work state: %d",
603 1.1 skrll dw->dw_state);
604 1.1 skrll }
605 1.1 skrll }
606 1.1 skrll mutex_exit(&wq->wq_lock);
607 1.1 skrll
608 1.1 skrll return timer_modified;
609 1.1 skrll }
610 1.12 riastrad
611 1.12 riastrad bool
612 1.1 skrll cancel_delayed_work(struct delayed_work *dw)
613 1.14 riastrad {
614 1.14 riastrad struct workqueue_struct *wq;
615 1.14 riastrad bool cancelled_p;
616 1.14 riastrad
617 1.12 riastrad /* If there's no workqueue, nothing to cancel. */
618 1.12 riastrad if ((wq = dw->work.work_queue) == NULL)
619 1.12 riastrad return false;
620 1.12 riastrad
621 1.12 riastrad mutex_enter(&wq->wq_lock);
622 1.12 riastrad if (__predict_false(dw->work.work_queue != wq)) {
623 1.12 riastrad cancelled_p = false;
624 1.12 riastrad } else {
625 1.12 riastrad switch (dw->dw_state) {
626 1.12 riastrad case DELAYED_WORK_IDLE:
627 1.12 riastrad if (wq->wq_current_work == &dw->work) {
628 1.12 riastrad /* Too late, it's already running. */
629 1.12 riastrad cancelled_p = false;
630 1.12 riastrad } else {
631 1.12 riastrad /* Got in before it started. Remove it. */
632 1.12 riastrad TAILQ_REMOVE(&wq->wq_queue, &dw->work,
633 1.12 riastrad work_entry);
634 1.12 riastrad cancelled_p = true;
635 1.12 riastrad }
636 1.21 riastrad break;
637 1.21 riastrad case DELAYED_WORK_SCHEDULED:
638 1.21 riastrad case DELAYED_WORK_RESCHEDULED:
639 1.21 riastrad case DELAYED_WORK_CANCELLED:
640 1.21 riastrad /*
641 1.21 riastrad * If it is scheduled, mark it cancelled and
642 1.21 riastrad * try to stop the callout before it starts.
643 1.21 riastrad *
644 1.21 riastrad * If it's too late and the callout has already
645 1.21 riastrad * begun to execute, tough.
646 1.21 riastrad *
647 1.21 riastrad * If we stopped the callout before it started,
648 1.12 riastrad * however, then destroy the callout and
649 1.21 riastrad * dissociate it from the workqueue ourselves.
650 1.21 riastrad */
651 1.23 riastrad dw->dw_state = DELAYED_WORK_CANCELLED;
652 1.16 riastrad cancelled_p = true;
653 1.12 riastrad if (callout_stop(&dw->dw_callout))
654 1.12 riastrad break;
655 1.12 riastrad cancel_delayed_work_done(wq, dw);
656 1.12 riastrad break;
657 1.1 skrll default:
658 1.12 riastrad panic("invalid delayed work state: %d",
659 1.1 skrll dw->dw_state);
660 1.1 skrll }
661 1.1 skrll }
662 1.1 skrll mutex_exit(&wq->wq_lock);
663 1.1 skrll
664 1.1 skrll return cancelled_p;
665 1.1 skrll }
666 1.12 riastrad
667 1.24 riastrad bool
668 1.1 skrll cancel_delayed_work_sync(struct delayed_work *dw)
669 1.24 riastrad {
670 1.14 riastrad struct workqueue_struct *wq;
671 1.24 riastrad bool cancelled_p;
672 1.14 riastrad
673 1.12 riastrad /* If there's no workqueue, nothing to cancel. */
674 1.12 riastrad if ((wq = dw->work.work_queue) == NULL)
675 1.12 riastrad return false;
676 1.12 riastrad
677 1.20 riastrad mutex_enter(&wq->wq_lock);
678 1.12 riastrad if (__predict_false(dw->work.work_queue != wq)) {
679 1.12 riastrad cancelled_p = false;
680 1.12 riastrad } else {
681 1.12 riastrad switch (dw->dw_state) {
682 1.12 riastrad case DELAYED_WORK_IDLE:
683 1.12 riastrad if (wq->wq_current_work == &dw->work) {
684 1.12 riastrad /* Too late, it's already running. Wait. */
685 1.12 riastrad do {
686 1.12 riastrad cv_wait(&wq->wq_cv, &wq->wq_lock);
687 1.12 riastrad } while (wq->wq_current_work == &dw->work);
688 1.12 riastrad cancelled_p = false;
689 1.12 riastrad } else {
690 1.12 riastrad /* Got in before it started. Remove it. */
691 1.12 riastrad TAILQ_REMOVE(&wq->wq_queue, &dw->work,
692 1.12 riastrad work_entry);
693 1.12 riastrad cancelled_p = true;
694 1.12 riastrad }
695 1.12 riastrad break;
696 1.20 riastrad case DELAYED_WORK_SCHEDULED:
697 1.20 riastrad case DELAYED_WORK_RESCHEDULED:
698 1.20 riastrad case DELAYED_WORK_CANCELLED:
699 1.20 riastrad /*
700 1.20 riastrad * If it is scheduled, mark it cancelled and
701 1.24 riastrad * try to stop the callout before it starts.
702 1.24 riastrad *
703 1.24 riastrad * If it's too late and the callout has already
704 1.20 riastrad * begun to execute, we must wait for it to
705 1.20 riastrad * complete. But we got in soon enough to ask
706 1.20 riastrad * the callout not to run, so we successfully
707 1.20 riastrad * cancelled it in that case.
708 1.12 riastrad *
709 1.12 riastrad * If we stopped the callout before it started,
710 1.20 riastrad * however, then destroy the callout and
711 1.20 riastrad * dissociate it from the workqueue ourselves.
712 1.24 riastrad */
713 1.23 riastrad dw->dw_state = DELAYED_WORK_CANCELLED;
714 1.20 riastrad cancelled_p = true;
715 1.12 riastrad if (callout_halt(&dw->dw_callout, &wq->wq_lock))
716 1.12 riastrad break;
717 1.12 riastrad cancel_delayed_work_done(wq, dw);
718 1.12 riastrad break;
719 1.1 skrll default:
720 1.12 riastrad panic("invalid delayed work state: %d",
721 1.1 skrll dw->dw_state);
722 1.1 skrll }
723 1.1 skrll }
724 1.12 riastrad mutex_exit(&wq->wq_lock);
725 1.12 riastrad
726 1.12 riastrad return cancelled_p;
727 1.12 riastrad }
728 1.1 skrll
729 1.5 riastrad /*
731 1.5 riastrad * Flush
732 1.5 riastrad */
733 1.12 riastrad
734 1.5 riastrad void
735 1.5 riastrad flush_scheduled_work(void)
736 1.12 riastrad {
737 1.12 riastrad
738 1.1 skrll flush_workqueue(system_wq);
739 1.12 riastrad }
740 1.1 skrll
741 1.12 riastrad void
742 1.19 riastrad flush_workqueue(struct workqueue_struct *wq)
743 1.19 riastrad {
744 1.19 riastrad uint64_t gen;
745 1.19 riastrad
746 1.19 riastrad mutex_enter(&wq->wq_lock);
747 1.19 riastrad if (wq->wq_current_work || !TAILQ_EMPTY(&wq->wq_queue)) {
748 1.12 riastrad gen = wq->wq_gen;
749 1.1 skrll do {
750 1.1 skrll cv_wait(&wq->wq_cv, &wq->wq_lock);
751 1.12 riastrad } while (gen == wq->wq_gen);
752 1.12 riastrad }
753 1.1 skrll mutex_exit(&wq->wq_lock);
754 1.14 riastrad }
755 1.1 skrll
756 1.14 riastrad bool
757 1.14 riastrad flush_work(struct work_struct *work)
758 1.12 riastrad {
759 1.1 skrll struct workqueue_struct *wq;
760 1.12 riastrad
761 1.12 riastrad /* If there's no workqueue, nothing to flush. */
762 1.1 skrll if ((wq = work->work_queue) == NULL)
763 1.1 skrll return false;
764 1.12 riastrad
765 1.12 riastrad flush_workqueue(wq);
766 1.1 skrll return true;
767 1.14 riastrad }
768 1.12 riastrad
769 1.1 skrll bool
770 1.14 riastrad flush_delayed_work(struct delayed_work *dw)
771 1.14 riastrad {
772 1.12 riastrad struct workqueue_struct *wq;
773 1.1 skrll bool do_flush = false;
774 1.1 skrll
775 1.12 riastrad /* If there's no workqueue, nothing to flush. */
776 1.12 riastrad if ((wq = dw->work.work_queue) == NULL)
777 1.1 skrll return false;
778 1.12 riastrad
779 1.12 riastrad mutex_enter(&wq->wq_lock);
780 1.12 riastrad if (__predict_false(dw->work.work_queue != wq)) {
781 1.12 riastrad do_flush = true;
782 1.12 riastrad } else {
783 1.12 riastrad retry: switch (dw->dw_state) {
784 1.12 riastrad case DELAYED_WORK_IDLE:
785 1.12 riastrad if (wq->wq_current_work != &dw->work) {
786 1.12 riastrad TAILQ_REMOVE(&wq->wq_queue, &dw->work,
787 1.12 riastrad work_entry);
788 1.12 riastrad } else {
789 1.12 riastrad do_flush = true;
790 1.12 riastrad }
791 1.12 riastrad break;
792 1.12 riastrad case DELAYED_WORK_SCHEDULED:
793 1.12 riastrad case DELAYED_WORK_RESCHEDULED:
794 1.12 riastrad case DELAYED_WORK_CANCELLED:
795 1.12 riastrad dw->dw_state = DELAYED_WORK_CANCELLED;
796 1.12 riastrad callout_halt(&dw->dw_callout, &wq->wq_lock);
797 1.1 skrll goto retry;
798 1.12 riastrad default:
799 1.1 skrll panic("invalid delayed work state: %d",
800 1.12 riastrad dw->dw_state);
801 1.12 riastrad }
802 1.1 skrll }
803 1.12 riastrad mutex_exit(&wq->wq_lock);
804 1.1 skrll
805 if (do_flush)
806 flush_workqueue(wq);
807
808 return true;
809 }
810