linux_work.c revision 1.47 1 1.47 riastrad /* $NetBSD: linux_work.c,v 1.47 2021/12/19 00:49:00 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.47 riastrad __KERNEL_RCSID(0, "$NetBSD: linux_work.c,v 1.47 2021/12/19 00:49:00 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.44 ryo #ifndef _MODULE
45 1.44 ryo #include <sys/once.h>
46 1.44 ryo #endif
47 1.1 skrll #include <sys/queue.h>
48 1.41 riastrad #include <sys/sdt.h>
49 1.1 skrll
50 1.1 skrll #include <linux/workqueue.h>
51 1.1 skrll
52 1.39 riastrad TAILQ_HEAD(work_head, work_struct);
53 1.39 riastrad TAILQ_HEAD(dwork_head, delayed_work);
54 1.39 riastrad
55 1.1 skrll struct workqueue_struct {
56 1.39 riastrad kmutex_t wq_lock;
57 1.39 riastrad kcondvar_t wq_cv;
58 1.39 riastrad struct dwork_head wq_delayed; /* delayed work scheduled */
59 1.39 riastrad struct work_head wq_queue; /* work to run */
60 1.39 riastrad struct work_head wq_dqueue; /* delayed work to run now */
61 1.39 riastrad struct work_struct *wq_current_work;
62 1.39 riastrad int wq_flags;
63 1.39 riastrad bool wq_dying;
64 1.39 riastrad uint64_t wq_gen;
65 1.39 riastrad struct lwp *wq_lwp;
66 1.1 skrll };
67 1.1 skrll
68 1.12 riastrad static void __dead linux_workqueue_thread(void *);
69 1.12 riastrad static void linux_workqueue_timeout(void *);
70 1.39 riastrad static bool work_claimed(struct work_struct *,
71 1.39 riastrad struct workqueue_struct *);
72 1.17 riastrad static struct workqueue_struct *
73 1.39 riastrad work_queue(struct work_struct *);
74 1.39 riastrad static bool acquire_work(struct work_struct *,
75 1.17 riastrad struct workqueue_struct *);
76 1.17 riastrad static void release_work(struct work_struct *,
77 1.17 riastrad struct workqueue_struct *);
78 1.33 riastrad static void wait_for_current_work(struct work_struct *,
79 1.33 riastrad struct workqueue_struct *);
80 1.30 riastrad static void dw_callout_init(struct workqueue_struct *,
81 1.30 riastrad struct delayed_work *);
82 1.31 riastrad static void dw_callout_destroy(struct workqueue_struct *,
83 1.31 riastrad struct delayed_work *);
84 1.23 riastrad static void cancel_delayed_work_done(struct workqueue_struct *,
85 1.23 riastrad struct delayed_work *);
86 1.12 riastrad
87 1.41 riastrad SDT_PROBE_DEFINE2(sdt, linux, work, acquire,
88 1.41 riastrad "struct work_struct *"/*work*/, "struct workqueue_struct *"/*wq*/);
89 1.41 riastrad SDT_PROBE_DEFINE2(sdt, linux, work, release,
90 1.41 riastrad "struct work_struct *"/*work*/, "struct workqueue_struct *"/*wq*/);
91 1.41 riastrad SDT_PROBE_DEFINE2(sdt, linux, work, queue,
92 1.41 riastrad "struct work_struct *"/*work*/, "struct workqueue_struct *"/*wq*/);
93 1.41 riastrad SDT_PROBE_DEFINE2(sdt, linux, work, cancel,
94 1.41 riastrad "struct work_struct *"/*work*/, "struct workqueue_struct *"/*wq*/);
95 1.41 riastrad SDT_PROBE_DEFINE3(sdt, linux, work, schedule,
96 1.41 riastrad "struct delayed_work *"/*dw*/, "struct workqueue_struct *"/*wq*/,
97 1.41 riastrad "unsigned long"/*ticks*/);
98 1.41 riastrad SDT_PROBE_DEFINE2(sdt, linux, work, timer,
99 1.41 riastrad "struct delayed_work *"/*dw*/, "struct workqueue_struct *"/*wq*/);
100 1.41 riastrad SDT_PROBE_DEFINE2(sdt, linux, work, wait__start,
101 1.41 riastrad "struct delayed_work *"/*dw*/, "struct workqueue_struct *"/*wq*/);
102 1.41 riastrad SDT_PROBE_DEFINE2(sdt, linux, work, wait__done,
103 1.41 riastrad "struct delayed_work *"/*dw*/, "struct workqueue_struct *"/*wq*/);
104 1.41 riastrad SDT_PROBE_DEFINE2(sdt, linux, work, run,
105 1.41 riastrad "struct work_struct *"/*work*/, "struct workqueue_struct *"/*wq*/);
106 1.41 riastrad SDT_PROBE_DEFINE2(sdt, linux, work, done,
107 1.41 riastrad "struct work_struct *"/*work*/, "struct workqueue_struct *"/*wq*/);
108 1.41 riastrad SDT_PROBE_DEFINE1(sdt, linux, work, batch__start,
109 1.41 riastrad "struct workqueue_struct *"/*wq*/);
110 1.41 riastrad SDT_PROBE_DEFINE1(sdt, linux, work, batch__done,
111 1.41 riastrad "struct workqueue_struct *"/*wq*/);
112 1.41 riastrad SDT_PROBE_DEFINE1(sdt, linux, work, flush__start,
113 1.41 riastrad "struct workqueue_struct *"/*wq*/);
114 1.41 riastrad SDT_PROBE_DEFINE1(sdt, linux, work, flush__done,
115 1.41 riastrad "struct workqueue_struct *"/*wq*/);
116 1.41 riastrad
117 1.12 riastrad static specificdata_key_t workqueue_key __read_mostly;
118 1.12 riastrad
119 1.12 riastrad struct workqueue_struct *system_wq __read_mostly;
120 1.12 riastrad struct workqueue_struct *system_long_wq __read_mostly;
121 1.12 riastrad struct workqueue_struct *system_power_efficient_wq __read_mostly;
122 1.47 riastrad struct workqueue_struct *system_unbound_wq __read_mostly;
123 1.3 riastrad
124 1.39 riastrad static inline uintptr_t
125 1.39 riastrad atomic_cas_uintptr(volatile uintptr_t *p, uintptr_t old, uintptr_t new)
126 1.39 riastrad {
127 1.39 riastrad
128 1.39 riastrad return (uintptr_t)atomic_cas_ptr(p, (void *)old, (void *)new);
129 1.39 riastrad }
130 1.39 riastrad
131 1.36 riastrad /*
132 1.36 riastrad * linux_workqueue_init()
133 1.36 riastrad *
134 1.36 riastrad * Initialize the Linux workqueue subsystem. Return 0 on success,
135 1.36 riastrad * NetBSD error on failure.
136 1.36 riastrad */
137 1.44 ryo static int
138 1.44 ryo linux_workqueue_init0(void)
139 1.1 skrll {
140 1.12 riastrad int error;
141 1.3 riastrad
142 1.12 riastrad error = lwp_specific_key_create(&workqueue_key, NULL);
143 1.12 riastrad if (error)
144 1.12 riastrad goto fail0;
145 1.1 skrll
146 1.1 skrll system_wq = alloc_ordered_workqueue("lnxsyswq", 0);
147 1.12 riastrad if (system_wq == NULL) {
148 1.12 riastrad error = ENOMEM;
149 1.12 riastrad goto fail1;
150 1.12 riastrad }
151 1.2 riastrad
152 1.2 riastrad system_long_wq = alloc_ordered_workqueue("lnxlngwq", 0);
153 1.12 riastrad if (system_long_wq == NULL) {
154 1.12 riastrad error = ENOMEM;
155 1.12 riastrad goto fail2;
156 1.12 riastrad }
157 1.1 skrll
158 1.6 riastrad system_power_efficient_wq = alloc_ordered_workqueue("lnxpwrwq", 0);
159 1.46 riastrad if (system_power_efficient_wq == NULL) {
160 1.12 riastrad error = ENOMEM;
161 1.12 riastrad goto fail3;
162 1.12 riastrad }
163 1.6 riastrad
164 1.47 riastrad system_unbound_wq = alloc_ordered_workqueue("lnxubdwq", 0);
165 1.47 riastrad if (system_unbound_wq == NULL) {
166 1.47 riastrad error = ENOMEM;
167 1.47 riastrad goto fail4;
168 1.47 riastrad }
169 1.47 riastrad
170 1.1 skrll return 0;
171 1.2 riastrad
172 1.47 riastrad fail5: __unused
173 1.47 riastrad destroy_workqueue(system_unbound_wq);
174 1.47 riastrad fail4: destroy_workqueue(system_power_efficient_wq);
175 1.12 riastrad fail3: destroy_workqueue(system_long_wq);
176 1.12 riastrad fail2: destroy_workqueue(system_wq);
177 1.12 riastrad fail1: lwp_specific_key_delete(workqueue_key);
178 1.12 riastrad fail0: KASSERT(error);
179 1.12 riastrad return error;
180 1.1 skrll }
181 1.1 skrll
182 1.36 riastrad /*
183 1.36 riastrad * linux_workqueue_fini()
184 1.36 riastrad *
185 1.36 riastrad * Destroy the Linux workqueue subsystem. Never fails.
186 1.36 riastrad */
187 1.44 ryo static void
188 1.44 ryo linux_workqueue_fini0(void)
189 1.1 skrll {
190 1.2 riastrad
191 1.12 riastrad destroy_workqueue(system_power_efficient_wq);
192 1.2 riastrad destroy_workqueue(system_long_wq);
193 1.1 skrll destroy_workqueue(system_wq);
194 1.12 riastrad lwp_specific_key_delete(workqueue_key);
195 1.1 skrll }
196 1.44 ryo
197 1.44 ryo #ifndef _MODULE
198 1.44 ryo static ONCE_DECL(linux_workqueue_init_once);
199 1.44 ryo #endif
200 1.44 ryo
201 1.44 ryo int
202 1.44 ryo linux_workqueue_init(void)
203 1.44 ryo {
204 1.44 ryo #ifdef _MODULE
205 1.44 ryo return linux_workqueue_init0();
206 1.44 ryo #else
207 1.44 ryo return INIT_ONCE(&linux_workqueue_init_once, &linux_workqueue_init0);
208 1.44 ryo #endif
209 1.44 ryo }
210 1.44 ryo
211 1.44 ryo void
212 1.44 ryo linux_workqueue_fini(void)
213 1.44 ryo {
214 1.44 ryo #ifdef _MODULE
215 1.44 ryo return linux_workqueue_fini0();
216 1.44 ryo #else
217 1.44 ryo return FINI_ONCE(&linux_workqueue_init_once, &linux_workqueue_fini0);
218 1.44 ryo #endif
219 1.44 ryo }
220 1.1 skrll
221 1.1 skrll /*
223 1.1 skrll * Workqueues
224 1.1 skrll */
225 1.36 riastrad
226 1.36 riastrad /*
227 1.36 riastrad * alloc_ordered_workqueue(name, flags)
228 1.36 riastrad *
229 1.36 riastrad * Create a workqueue of the given name. No flags are currently
230 1.36 riastrad * defined. Return NULL on failure, pointer to struct
231 1.36 riastrad * workqueue_struct object on success.
232 1.1 skrll */
233 1.12 riastrad struct workqueue_struct *
234 1.1 skrll alloc_ordered_workqueue(const char *name, int flags)
235 1.1 skrll {
236 1.1 skrll struct workqueue_struct *wq;
237 1.1 skrll int error;
238 1.12 riastrad
239 1.1 skrll KASSERT(flags == 0);
240 1.25 riastrad
241 1.1 skrll wq = kmem_zalloc(sizeof(*wq), KM_SLEEP);
242 1.43 riastrad
243 1.1 skrll mutex_init(&wq->wq_lock, MUTEX_DEFAULT, IPL_VM);
244 1.1 skrll cv_init(&wq->wq_cv, name);
245 1.12 riastrad TAILQ_INIT(&wq->wq_delayed);
246 1.39 riastrad TAILQ_INIT(&wq->wq_queue);
247 1.1 skrll TAILQ_INIT(&wq->wq_dqueue);
248 1.25 riastrad wq->wq_current_work = NULL;
249 1.25 riastrad wq->wq_flags = 0;
250 1.37 riastrad wq->wq_dying = false;
251 1.37 riastrad wq->wq_gen = 0;
252 1.1 skrll wq->wq_lwp = NULL;
253 1.12 riastrad
254 1.12 riastrad error = kthread_create(PRI_NONE,
255 1.12 riastrad KTHREAD_MPSAFE|KTHREAD_TS|KTHREAD_MUSTJOIN, NULL,
256 1.12 riastrad &linux_workqueue_thread, wq, &wq->wq_lwp, "%s", name);
257 1.12 riastrad if (error)
258 1.3 riastrad goto fail0;
259 1.1 skrll
260 1.12 riastrad return wq;
261 1.39 riastrad
262 1.39 riastrad fail0: KASSERT(TAILQ_EMPTY(&wq->wq_dqueue));
263 1.12 riastrad KASSERT(TAILQ_EMPTY(&wq->wq_queue));
264 1.12 riastrad KASSERT(TAILQ_EMPTY(&wq->wq_delayed));
265 1.12 riastrad cv_destroy(&wq->wq_cv);
266 1.12 riastrad mutex_destroy(&wq->wq_lock);
267 1.12 riastrad kmem_free(wq, sizeof(*wq));
268 1.1 skrll return NULL;
269 1.1 skrll }
270 1.36 riastrad
271 1.36 riastrad /*
272 1.36 riastrad * destroy_workqueue(wq)
273 1.36 riastrad *
274 1.36 riastrad * Destroy a workqueue created with wq. Cancel any pending
275 1.36 riastrad * delayed work. Wait for all queued work to complete.
276 1.36 riastrad *
277 1.36 riastrad * May sleep.
278 1.1 skrll */
279 1.1 skrll void
280 1.1 skrll destroy_workqueue(struct workqueue_struct *wq)
281 1.1 skrll {
282 1.1 skrll
283 1.12 riastrad /*
284 1.12 riastrad * Cancel all delayed work. We do this first because any
285 1.12 riastrad * delayed work that that has already timed out, which we can't
286 1.1 skrll * cancel, may have queued new work.
287 1.26 riastrad */
288 1.26 riastrad mutex_enter(&wq->wq_lock);
289 1.26 riastrad while (!TAILQ_EMPTY(&wq->wq_delayed)) {
290 1.1 skrll struct delayed_work *const dw = TAILQ_FIRST(&wq->wq_delayed);
291 1.39 riastrad
292 1.26 riastrad KASSERT(work_queue(&dw->work) == wq);
293 1.26 riastrad KASSERTMSG((dw->dw_state == DELAYED_WORK_SCHEDULED ||
294 1.26 riastrad dw->dw_state == DELAYED_WORK_RESCHEDULED ||
295 1.26 riastrad dw->dw_state == DELAYED_WORK_CANCELLED),
296 1.26 riastrad "delayed work %p in bad state: %d",
297 1.26 riastrad dw, dw->dw_state);
298 1.26 riastrad
299 1.26 riastrad /*
300 1.26 riastrad * Mark it cancelled and try to stop the callout before
301 1.26 riastrad * it starts.
302 1.26 riastrad *
303 1.26 riastrad * If it's too late and the callout has already begun
304 1.26 riastrad * to execute, then it will notice that we asked to
305 1.26 riastrad * cancel it and remove itself from the queue before
306 1.26 riastrad * returning.
307 1.26 riastrad *
308 1.26 riastrad * If we stopped the callout before it started,
309 1.26 riastrad * however, then we can safely destroy the callout and
310 1.26 riastrad * dissociate it from the workqueue ourselves.
311 1.41 riastrad */
312 1.26 riastrad SDT_PROBE2(sdt, linux, work, cancel, &dw->work, wq);
313 1.26 riastrad dw->dw_state = DELAYED_WORK_CANCELLED;
314 1.26 riastrad if (!callout_halt(&dw->dw_callout, &wq->wq_lock))
315 1.26 riastrad cancel_delayed_work_done(wq, dw);
316 1.26 riastrad }
317 1.1 skrll mutex_exit(&wq->wq_lock);
318 1.26 riastrad
319 1.26 riastrad /*
320 1.26 riastrad * At this point, no new work can be put on the queue.
321 1.1 skrll */
322 1.12 riastrad
323 1.12 riastrad /* Tell the thread to exit. */
324 1.12 riastrad mutex_enter(&wq->wq_lock);
325 1.12 riastrad wq->wq_dying = true;
326 1.12 riastrad cv_broadcast(&wq->wq_cv);
327 1.12 riastrad mutex_exit(&wq->wq_lock);
328 1.12 riastrad
329 1.12 riastrad /* Wait for it to exit. */
330 1.12 riastrad (void)kthread_join(wq->wq_lwp);
331 1.25 riastrad
332 1.25 riastrad KASSERT(wq->wq_dying);
333 1.1 skrll KASSERT(wq->wq_flags == 0);
334 1.39 riastrad KASSERT(wq->wq_current_work == NULL);
335 1.12 riastrad KASSERT(TAILQ_EMPTY(&wq->wq_dqueue));
336 1.12 riastrad KASSERT(TAILQ_EMPTY(&wq->wq_queue));
337 1.1 skrll KASSERT(TAILQ_EMPTY(&wq->wq_delayed));
338 1.1 skrll cv_destroy(&wq->wq_cv);
339 1.1 skrll mutex_destroy(&wq->wq_lock);
340 1.1 skrll
341 1.1 skrll kmem_free(wq, sizeof(*wq));
342 1.1 skrll }
343 1.1 skrll
344 1.12 riastrad /*
346 1.1 skrll * Work thread and callout
347 1.36 riastrad */
348 1.36 riastrad
349 1.36 riastrad /*
350 1.36 riastrad * linux_workqueue_thread(cookie)
351 1.36 riastrad *
352 1.36 riastrad * Main function for a workqueue's worker thread. Waits until
353 1.36 riastrad * there is work queued, grabs a batch of work off the queue,
354 1.36 riastrad * executes it all, bumps the generation number, and repeats,
355 1.12 riastrad * until dying.
356 1.12 riastrad */
357 1.1 skrll static void __dead
358 1.12 riastrad linux_workqueue_thread(void *cookie)
359 1.45 riastrad {
360 1.45 riastrad struct workqueue_struct *const wq = cookie;
361 1.39 riastrad struct work_head *const q[2] = { &wq->wq_queue, &wq->wq_dqueue };
362 1.1 skrll struct work_struct marker, *work;
363 1.12 riastrad unsigned i;
364 1.1 skrll
365 1.12 riastrad lwp_setspecific(workqueue_key, wq);
366 1.12 riastrad
367 1.26 riastrad mutex_enter(&wq->wq_lock);
368 1.26 riastrad for (;;) {
369 1.26 riastrad /*
370 1.26 riastrad * Wait until there's activity. If there's no work and
371 1.42 riastrad * we're dying, stop here.
372 1.42 riastrad */
373 1.42 riastrad if (TAILQ_EMPTY(&wq->wq_queue) &&
374 1.42 riastrad TAILQ_EMPTY(&wq->wq_dqueue)) {
375 1.12 riastrad if (wq->wq_dying)
376 1.42 riastrad break;
377 1.26 riastrad cv_wait(&wq->wq_cv, &wq->wq_lock);
378 1.1 skrll continue;
379 1.45 riastrad }
380 1.45 riastrad
381 1.45 riastrad /*
382 1.45 riastrad * Start a batch of work. Use a marker to delimit when
383 1.45 riastrad * the batch ends so we can advance the generation
384 1.41 riastrad * after the batch.
385 1.39 riastrad */
386 1.45 riastrad SDT_PROBE1(sdt, linux, work, batch__start, wq);
387 1.45 riastrad for (i = 0; i < 2; i++) {
388 1.45 riastrad if (TAILQ_EMPTY(q[i]))
389 1.45 riastrad continue;
390 1.39 riastrad TAILQ_INSERT_TAIL(q[i], &marker, work_entry);
391 1.39 riastrad while ((work = TAILQ_FIRST(q[i])) != &marker) {
392 1.39 riastrad void (*func)(struct work_struct *);
393 1.39 riastrad
394 1.45 riastrad KASSERT(work_queue(work) == wq);
395 1.39 riastrad KASSERT(work_claimed(work, wq));
396 1.39 riastrad KASSERTMSG((q[i] != &wq->wq_dqueue ||
397 1.39 riastrad container_of(work, struct delayed_work,
398 1.39 riastrad work)->dw_state ==
399 1.39 riastrad DELAYED_WORK_IDLE),
400 1.39 riastrad "delayed work %p queued and scheduled",
401 1.39 riastrad work);
402 1.39 riastrad
403 1.39 riastrad TAILQ_REMOVE(q[i], work, work_entry);
404 1.39 riastrad KASSERT(wq->wq_current_work == NULL);
405 1.39 riastrad wq->wq_current_work = work;
406 1.39 riastrad func = work->func;
407 1.12 riastrad release_work(work, wq);
408 1.39 riastrad /* Can't dereference work after this point. */
409 1.41 riastrad
410 1.39 riastrad mutex_exit(&wq->wq_lock);
411 1.41 riastrad SDT_PROBE2(sdt, linux, work, run, work, wq);
412 1.39 riastrad (*func)(work);
413 1.39 riastrad SDT_PROBE2(sdt, linux, work, done, work, wq);
414 1.39 riastrad mutex_enter(&wq->wq_lock);
415 1.39 riastrad
416 1.39 riastrad KASSERT(wq->wq_current_work == work);
417 1.39 riastrad wq->wq_current_work = NULL;
418 1.45 riastrad cv_broadcast(&wq->wq_cv);
419 1.12 riastrad }
420 1.1 skrll TAILQ_REMOVE(q[i], &marker, work_entry);
421 1.12 riastrad }
422 1.12 riastrad
423 1.12 riastrad /* Notify flush that we've completed a batch of work. */
424 1.41 riastrad wq->wq_gen++;
425 1.1 skrll cv_broadcast(&wq->wq_cv);
426 1.12 riastrad SDT_PROBE1(sdt, linux, work, batch__done, wq);
427 1.1 skrll }
428 1.12 riastrad mutex_exit(&wq->wq_lock);
429 1.1 skrll
430 1.1 skrll kthread_exit(0);
431 1.36 riastrad }
432 1.36 riastrad
433 1.36 riastrad /*
434 1.36 riastrad * linux_workqueue_timeout(cookie)
435 1.36 riastrad *
436 1.36 riastrad * Delayed work timeout callback.
437 1.36 riastrad *
438 1.36 riastrad * - If scheduled, queue it.
439 1.36 riastrad * - If rescheduled, callout_schedule ourselves again.
440 1.36 riastrad * - If cancelled, destroy the callout and release the work from
441 1.1 skrll * the workqueue.
442 1.12 riastrad */
443 1.1 skrll static void
444 1.12 riastrad linux_workqueue_timeout(void *cookie)
445 1.39 riastrad {
446 1.1 skrll struct delayed_work *const dw = cookie;
447 1.39 riastrad struct workqueue_struct *const wq = work_queue(&dw->work);
448 1.39 riastrad
449 1.39 riastrad KASSERTMSG(wq != NULL,
450 1.14 riastrad "delayed work %p state %d resched %d",
451 1.41 riastrad dw, dw->dw_state, dw->dw_resched);
452 1.41 riastrad
453 1.12 riastrad SDT_PROBE2(sdt, linux, work, timer, dw, wq);
454 1.39 riastrad
455 1.12 riastrad mutex_enter(&wq->wq_lock);
456 1.12 riastrad KASSERT(work_queue(&dw->work) == wq);
457 1.12 riastrad switch (dw->dw_state) {
458 1.12 riastrad case DELAYED_WORK_IDLE:
459 1.31 riastrad panic("delayed work callout uninitialized: %p", dw);
460 1.39 riastrad case DELAYED_WORK_SCHEDULED:
461 1.12 riastrad dw_callout_destroy(wq, dw);
462 1.41 riastrad TAILQ_INSERT_TAIL(&wq->wq_dqueue, &dw->work, work_entry);
463 1.12 riastrad cv_broadcast(&wq->wq_cv);
464 1.12 riastrad SDT_PROBE2(sdt, linux, work, queue, &dw->work, wq);
465 1.35 riastrad break;
466 1.35 riastrad case DELAYED_WORK_RESCHEDULED:
467 1.12 riastrad KASSERT(dw->dw_resched >= 0);
468 1.35 riastrad callout_schedule(&dw->dw_callout, dw->dw_resched);
469 1.12 riastrad dw->dw_state = DELAYED_WORK_SCHEDULED;
470 1.12 riastrad dw->dw_resched = -1;
471 1.23 riastrad break;
472 1.39 riastrad case DELAYED_WORK_CANCELLED:
473 1.22 riastrad cancel_delayed_work_done(wq, dw);
474 1.12 riastrad /* Can't dereference dw after this point. */
475 1.12 riastrad goto out;
476 1.12 riastrad default:
477 1.15 riastrad panic("delayed work callout in bad state: %p", dw);
478 1.15 riastrad }
479 1.22 riastrad KASSERT(dw->dw_state == DELAYED_WORK_IDLE ||
480 1.1 skrll dw->dw_state == DELAYED_WORK_SCHEDULED);
481 1.1 skrll out: mutex_exit(&wq->wq_lock);
482 1.36 riastrad }
483 1.36 riastrad
484 1.36 riastrad /*
485 1.36 riastrad * current_work()
486 1.36 riastrad *
487 1.36 riastrad * If in a workqueue worker thread, return the work it is
488 1.12 riastrad * currently executing. Otherwise return NULL.
489 1.12 riastrad */
490 1.1 skrll struct work_struct *
491 1.12 riastrad current_work(void)
492 1.1 skrll {
493 1.12 riastrad struct workqueue_struct *wq = lwp_getspecific(workqueue_key);
494 1.12 riastrad
495 1.12 riastrad /* If we're not a workqueue thread, then there's no work. */
496 1.1 skrll if (wq == NULL)
497 1.12 riastrad return NULL;
498 1.12 riastrad
499 1.12 riastrad /*
500 1.12 riastrad * Otherwise, this should be possible only while work is in
501 1.12 riastrad * progress. Return the current work item.
502 1.12 riastrad */
503 1.1 skrll KASSERT(wq->wq_current_work != NULL);
504 1.1 skrll return wq->wq_current_work;
505 1.1 skrll }
506 1.1 skrll
507 1.1 skrll /*
509 1.36 riastrad * Work
510 1.36 riastrad */
511 1.36 riastrad
512 1.36 riastrad /*
513 1.36 riastrad * INIT_WORK(work, fn)
514 1.36 riastrad *
515 1.1 skrll * Initialize work for use with a workqueue to call fn in a worker
516 1.1 skrll * thread. There is no corresponding destruction operation.
517 1.1 skrll */
518 1.1 skrll void
519 1.39 riastrad INIT_WORK(struct work_struct *work, void (*fn)(struct work_struct *))
520 1.4 riastrad {
521 1.1 skrll
522 1.1 skrll work->work_owner = 0;
523 1.36 riastrad work->func = fn;
524 1.39 riastrad }
525 1.39 riastrad
526 1.39 riastrad /*
527 1.39 riastrad * work_claimed(work, wq)
528 1.39 riastrad *
529 1.39 riastrad * True if work is currently claimed by a workqueue, meaning it is
530 1.39 riastrad * either on the queue or scheduled in a callout. The workqueue
531 1.39 riastrad * must be wq, and caller must hold wq's lock.
532 1.39 riastrad */
533 1.39 riastrad static bool
534 1.39 riastrad work_claimed(struct work_struct *work, struct workqueue_struct *wq)
535 1.39 riastrad {
536 1.39 riastrad
537 1.39 riastrad KASSERT(work_queue(work) == wq);
538 1.39 riastrad KASSERT(mutex_owned(&wq->wq_lock));
539 1.39 riastrad
540 1.39 riastrad return work->work_owner & 1;
541 1.39 riastrad }
542 1.39 riastrad
543 1.39 riastrad /*
544 1.39 riastrad * work_queue(work)
545 1.39 riastrad *
546 1.39 riastrad * Return the last queue that work was queued on, or NULL if it
547 1.39 riastrad * was never queued.
548 1.39 riastrad */
549 1.39 riastrad static struct workqueue_struct *
550 1.39 riastrad work_queue(struct work_struct *work)
551 1.39 riastrad {
552 1.39 riastrad
553 1.39 riastrad return (struct workqueue_struct *)(work->work_owner & ~(uintptr_t)1);
554 1.36 riastrad }
555 1.36 riastrad
556 1.39 riastrad /*
557 1.39 riastrad * acquire_work(work, wq)
558 1.39 riastrad *
559 1.39 riastrad * Try to claim work for wq. If work is already claimed, it must
560 1.36 riastrad * be claimed by wq; return false. If work is not already
561 1.36 riastrad * claimed, claim it, issue a memory barrier to match any prior
562 1.36 riastrad * release_work, and return true.
563 1.39 riastrad *
564 1.17 riastrad * Caller must hold wq's lock.
565 1.17 riastrad */
566 1.39 riastrad static bool
567 1.17 riastrad acquire_work(struct work_struct *work, struct workqueue_struct *wq)
568 1.17 riastrad {
569 1.39 riastrad uintptr_t owner0, owner;
570 1.17 riastrad
571 1.39 riastrad KASSERT(mutex_owned(&wq->wq_lock));
572 1.39 riastrad KASSERT(((uintptr_t)wq & 1) == 0);
573 1.39 riastrad
574 1.39 riastrad owner = (uintptr_t)wq | 1;
575 1.39 riastrad do {
576 1.39 riastrad owner0 = work->work_owner;
577 1.39 riastrad if (owner0 & 1) {
578 1.39 riastrad KASSERT((owner0 & ~(uintptr_t)1) == (uintptr_t)wq);
579 1.39 riastrad return false;
580 1.39 riastrad }
581 1.39 riastrad KASSERT(owner0 == (uintptr_t)NULL || owner0 == (uintptr_t)wq);
582 1.39 riastrad } while (atomic_cas_uintptr(&work->work_owner, owner0, owner) !=
583 1.39 riastrad owner0);
584 1.41 riastrad
585 1.39 riastrad KASSERT(work_queue(work) == wq);
586 1.17 riastrad membar_enter();
587 1.17 riastrad SDT_PROBE2(sdt, linux, work, acquire, work, wq);
588 1.36 riastrad return true;
589 1.36 riastrad }
590 1.36 riastrad
591 1.36 riastrad /*
592 1.36 riastrad * release_work(work, wq)
593 1.36 riastrad *
594 1.36 riastrad * Issue a memory barrier to match any subsequent acquire_work and
595 1.36 riastrad * dissociate work from wq.
596 1.17 riastrad *
597 1.17 riastrad * Caller must hold wq's lock and work must be associated with wq.
598 1.17 riastrad */
599 1.17 riastrad static void
600 1.39 riastrad release_work(struct work_struct *work, struct workqueue_struct *wq)
601 1.17 riastrad {
602 1.17 riastrad
603 1.41 riastrad KASSERT(work_queue(work) == wq);
604 1.17 riastrad KASSERT(mutex_owned(&wq->wq_lock));
605 1.39 riastrad
606 1.39 riastrad SDT_PROBE2(sdt, linux, work, release, work, wq);
607 1.39 riastrad membar_exit();
608 1.39 riastrad
609 1.39 riastrad /*
610 1.39 riastrad * Non-interlocked r/m/w is safe here because nobody else can
611 1.39 riastrad * write to this while the claimed bit is setand the workqueue
612 1.17 riastrad * lock is held.
613 1.17 riastrad */
614 1.36 riastrad work->work_owner &= ~(uintptr_t)1;
615 1.36 riastrad }
616 1.36 riastrad
617 1.36 riastrad /*
618 1.36 riastrad * schedule_work(work)
619 1.36 riastrad *
620 1.36 riastrad * If work is not already queued on system_wq, queue it to be run
621 1.36 riastrad * by system_wq's worker thread when it next can. True if it was
622 1.36 riastrad * newly queued, false if it was already queued. If the work was
623 1.36 riastrad * already running, queue it to run again.
624 1.36 riastrad *
625 1.1 skrll * Caller must ensure work is not queued to run on a different
626 1.1 skrll * workqueue.
627 1.1 skrll */
628 1.12 riastrad bool
629 1.1 skrll schedule_work(struct work_struct *work)
630 1.1 skrll {
631 1.1 skrll
632 1.36 riastrad return queue_work(system_wq, work);
633 1.36 riastrad }
634 1.36 riastrad
635 1.36 riastrad /*
636 1.36 riastrad * queue_work(wq, work)
637 1.36 riastrad *
638 1.36 riastrad * If work is not already queued on wq, queue it to be run by wq's
639 1.36 riastrad * worker thread when it next can. True if it was newly queued,
640 1.36 riastrad * false if it was already queued. If the work was already
641 1.36 riastrad * running, queue it to run again.
642 1.36 riastrad *
643 1.1 skrll * Caller must ensure work is not queued to run on a different
644 1.1 skrll * workqueue.
645 1.1 skrll */
646 1.1 skrll bool
647 1.1 skrll queue_work(struct workqueue_struct *wq, struct work_struct *work)
648 1.1 skrll {
649 1.1 skrll bool newly_queued;
650 1.12 riastrad
651 1.39 riastrad KASSERT(wq != NULL);
652 1.29 riastrad
653 1.29 riastrad mutex_enter(&wq->wq_lock);
654 1.29 riastrad if (__predict_true(acquire_work(work, wq))) {
655 1.29 riastrad /*
656 1.29 riastrad * It wasn't on any workqueue at all. Put it on this
657 1.12 riastrad * one, and signal the worker thread that there is work
658 1.39 riastrad * to do.
659 1.41 riastrad */
660 1.1 skrll TAILQ_INSERT_TAIL(&wq->wq_queue, work, work_entry);
661 1.12 riastrad cv_broadcast(&wq->wq_cv);
662 1.29 riastrad SDT_PROBE2(sdt, linux, work, queue, work, wq);
663 1.39 riastrad newly_queued = true;
664 1.39 riastrad } else {
665 1.29 riastrad /*
666 1.39 riastrad * It was already on this workqueue. Nothing to do
667 1.1 skrll * since it is already queued.
668 1.12 riastrad */
669 1.1 skrll newly_queued = false;
670 1.1 skrll }
671 1.1 skrll mutex_exit(&wq->wq_lock);
672 1.1 skrll
673 1.36 riastrad return newly_queued;
674 1.36 riastrad }
675 1.36 riastrad
676 1.36 riastrad /*
677 1.39 riastrad * cancel_work(work)
678 1.39 riastrad *
679 1.36 riastrad * If work was queued, remove it from the queue and return true.
680 1.1 skrll * If work was not queued, return false. Work may still be
681 1.12 riastrad * running when this returns.
682 1.1 skrll */
683 1.12 riastrad bool
684 1.1 skrll cancel_work(struct work_struct *work)
685 1.1 skrll {
686 1.13 riastrad struct workqueue_struct *wq;
687 1.39 riastrad bool cancelled_p = false;
688 1.13 riastrad
689 1.13 riastrad /* If there's no workqueue, nothing to cancel. */
690 1.12 riastrad if ((wq = work_queue(work)) == NULL)
691 1.39 riastrad goto out;
692 1.29 riastrad
693 1.29 riastrad mutex_enter(&wq->wq_lock);
694 1.29 riastrad if (__predict_false(work_queue(work) != wq)) {
695 1.29 riastrad /*
696 1.29 riastrad * It has finished execution or been cancelled by
697 1.12 riastrad * another thread, and has been moved off the
698 1.12 riastrad * workqueue, so it's too to cancel.
699 1.39 riastrad */
700 1.39 riastrad cancelled_p = false;
701 1.39 riastrad } else {
702 1.39 riastrad /* Check whether it's on the queue. */
703 1.39 riastrad if (work_claimed(work, wq)) {
704 1.39 riastrad /*
705 1.39 riastrad * It is still on the queue. Take it off the
706 1.41 riastrad * queue and report successful cancellation.
707 1.39 riastrad */
708 1.39 riastrad TAILQ_REMOVE(&wq->wq_queue, work, work_entry);
709 1.39 riastrad SDT_PROBE2(sdt, linux, work, cancel, work, wq);
710 1.39 riastrad release_work(work, wq);
711 1.39 riastrad /* Can't dereference work after this point. */
712 1.39 riastrad cancelled_p = true;
713 1.39 riastrad } else {
714 1.1 skrll /* Not on the queue. Couldn't cancel it. */
715 1.12 riastrad cancelled_p = false;
716 1.1 skrll }
717 1.13 riastrad }
718 1.1 skrll mutex_exit(&wq->wq_lock);
719 1.1 skrll
720 1.36 riastrad out: return cancelled_p;
721 1.36 riastrad }
722 1.36 riastrad
723 1.36 riastrad /*
724 1.39 riastrad * cancel_work_sync(work)
725 1.36 riastrad *
726 1.36 riastrad * If work was queued, remove it from the queue and return true.
727 1.36 riastrad * If work was not queued, return false. Either way, if work is
728 1.36 riastrad * currently running, wait for it to complete.
729 1.12 riastrad *
730 1.12 riastrad * May sleep.
731 1.1 skrll */
732 1.1 skrll bool
733 1.12 riastrad cancel_work_sync(struct work_struct *work)
734 1.1 skrll {
735 1.13 riastrad struct workqueue_struct *wq;
736 1.39 riastrad bool cancelled_p = false;
737 1.13 riastrad
738 1.13 riastrad /* If there's no workqueue, nothing to cancel. */
739 1.1 skrll if ((wq = work_queue(work)) == NULL)
740 1.39 riastrad goto out;
741 1.29 riastrad
742 1.29 riastrad mutex_enter(&wq->wq_lock);
743 1.29 riastrad if (__predict_false(work_queue(work) != wq)) {
744 1.39 riastrad /*
745 1.29 riastrad * It has finished execution or been cancelled by
746 1.12 riastrad * another thread, and has been moved off the
747 1.12 riastrad * workqueue, so it's too late to cancel.
748 1.39 riastrad */
749 1.39 riastrad cancelled_p = false;
750 1.39 riastrad } else {
751 1.39 riastrad /* Check whether it's on the queue. */
752 1.39 riastrad if (work_claimed(work, wq)) {
753 1.39 riastrad /*
754 1.39 riastrad * It is still on the queue. Take it off the
755 1.41 riastrad * queue and report successful cancellation.
756 1.39 riastrad */
757 1.39 riastrad TAILQ_REMOVE(&wq->wq_queue, work, work_entry);
758 1.39 riastrad SDT_PROBE2(sdt, linux, work, cancel, work, wq);
759 1.39 riastrad release_work(work, wq);
760 1.39 riastrad /* Can't dereference work after this point. */
761 1.39 riastrad cancelled_p = true;
762 1.39 riastrad } else {
763 1.39 riastrad /* Not on the queue. Couldn't cancel it. */
764 1.39 riastrad cancelled_p = false;
765 1.39 riastrad }
766 1.12 riastrad /* If it's still running, wait for it to complete. */
767 1.1 skrll if (wq->wq_current_work == work)
768 1.1 skrll wait_for_current_work(work, wq);
769 1.13 riastrad }
770 1.1 skrll mutex_exit(&wq->wq_lock);
771 1.33 riastrad
772 1.33 riastrad out: return cancelled_p;
773 1.33 riastrad }
774 1.33 riastrad
775 1.33 riastrad /*
776 1.39 riastrad * wait_for_current_work(work, wq)
777 1.39 riastrad *
778 1.33 riastrad * wq must be currently executing work. Wait for it to finish.
779 1.33 riastrad *
780 1.33 riastrad * Does not dereference work.
781 1.33 riastrad */
782 1.33 riastrad static void
783 1.33 riastrad wait_for_current_work(struct work_struct *work, struct workqueue_struct *wq)
784 1.33 riastrad {
785 1.33 riastrad uint64_t gen;
786 1.33 riastrad
787 1.33 riastrad KASSERT(mutex_owned(&wq->wq_lock));
788 1.41 riastrad KASSERT(wq->wq_current_work == work);
789 1.33 riastrad
790 1.33 riastrad /* Wait only one generation in case it gets requeued quickly. */
791 1.33 riastrad SDT_PROBE2(sdt, linux, work, wait__start, work, wq);
792 1.33 riastrad gen = wq->wq_gen;
793 1.41 riastrad do {
794 1.33 riastrad cv_wait(&wq->wq_cv, &wq->wq_lock);
795 1.1 skrll } while (wq->wq_current_work == work && wq->wq_gen == gen);
796 1.1 skrll SDT_PROBE2(sdt, linux, work, wait__done, work, wq);
797 1.1 skrll }
798 1.1 skrll
799 1.1 skrll /*
801 1.36 riastrad * Delayed work
802 1.36 riastrad */
803 1.36 riastrad
804 1.36 riastrad /*
805 1.36 riastrad * INIT_DELAYED_WORK(dw, fn)
806 1.36 riastrad *
807 1.1 skrll * Initialize dw for use with a workqueue to call fn in a worker
808 1.1 skrll * thread after a delay. There is no corresponding destruction
809 1.1 skrll * operation.
810 1.12 riastrad */
811 1.1 skrll void
812 1.12 riastrad INIT_DELAYED_WORK(struct delayed_work *dw, void (*fn)(struct work_struct *))
813 1.35 riastrad {
814 1.12 riastrad
815 1.12 riastrad INIT_WORK(&dw->work, fn);
816 1.12 riastrad dw->dw_state = DELAYED_WORK_IDLE;
817 1.12 riastrad dw->dw_resched = -1;
818 1.12 riastrad
819 1.12 riastrad /*
820 1.12 riastrad * Defer callout_init until we are going to schedule the
821 1.1 skrll * callout, which can then callout_destroy it, because
822 1.1 skrll * otherwise since there's no DESTROY_DELAYED_WORK or anything
823 1.36 riastrad * we have no opportunity to call callout_destroy.
824 1.36 riastrad */
825 1.36 riastrad }
826 1.36 riastrad
827 1.36 riastrad /*
828 1.36 riastrad * schedule_delayed_work(dw, ticks)
829 1.36 riastrad *
830 1.36 riastrad * If it is not currently scheduled, schedule dw to run after
831 1.36 riastrad * ticks on system_wq. If currently executing and not already
832 1.36 riastrad * rescheduled, reschedule it. True if it was newly scheduled,
833 1.36 riastrad * false if it was already scheduled.
834 1.1 skrll *
835 1.1 skrll * If ticks == 0, queue it to run as soon as the worker can,
836 1.1 skrll * without waiting for the next callout tick to run.
837 1.12 riastrad */
838 1.1 skrll bool
839 1.1 skrll schedule_delayed_work(struct delayed_work *dw, unsigned long ticks)
840 1.1 skrll {
841 1.29 riastrad
842 1.30 riastrad return queue_delayed_work(system_wq, dw, ticks);
843 1.30 riastrad }
844 1.30 riastrad
845 1.30 riastrad /*
846 1.30 riastrad * dw_callout_init(wq, dw)
847 1.30 riastrad *
848 1.30 riastrad * Initialize the callout of dw and transition to
849 1.30 riastrad * DELAYED_WORK_SCHEDULED. Caller must use callout_schedule.
850 1.30 riastrad */
851 1.30 riastrad static void
852 1.39 riastrad dw_callout_init(struct workqueue_struct *wq, struct delayed_work *dw)
853 1.30 riastrad {
854 1.30 riastrad
855 1.30 riastrad KASSERT(mutex_owned(&wq->wq_lock));
856 1.30 riastrad KASSERT(work_queue(&dw->work) == wq);
857 1.30 riastrad KASSERT(dw->dw_state == DELAYED_WORK_IDLE);
858 1.30 riastrad
859 1.30 riastrad callout_init(&dw->dw_callout, CALLOUT_MPSAFE);
860 1.30 riastrad callout_setfunc(&dw->dw_callout, &linux_workqueue_timeout, dw);
861 1.30 riastrad TAILQ_INSERT_HEAD(&wq->wq_delayed, dw, dw_entry);
862 1.31 riastrad dw->dw_state = DELAYED_WORK_SCHEDULED;
863 1.31 riastrad }
864 1.31 riastrad
865 1.31 riastrad /*
866 1.31 riastrad * dw_callout_destroy(wq, dw)
867 1.31 riastrad *
868 1.31 riastrad * Destroy the callout of dw and transition to DELAYED_WORK_IDLE.
869 1.31 riastrad */
870 1.31 riastrad static void
871 1.39 riastrad dw_callout_destroy(struct workqueue_struct *wq, struct delayed_work *dw)
872 1.31 riastrad {
873 1.31 riastrad
874 1.31 riastrad KASSERT(mutex_owned(&wq->wq_lock));
875 1.31 riastrad KASSERT(work_queue(&dw->work) == wq);
876 1.31 riastrad KASSERT(dw->dw_state == DELAYED_WORK_SCHEDULED ||
877 1.31 riastrad dw->dw_state == DELAYED_WORK_RESCHEDULED ||
878 1.35 riastrad dw->dw_state == DELAYED_WORK_CANCELLED);
879 1.31 riastrad
880 1.31 riastrad TAILQ_REMOVE(&wq->wq_delayed, dw, dw_entry);
881 1.31 riastrad callout_destroy(&dw->dw_callout);
882 1.31 riastrad dw->dw_resched = -1;
883 1.29 riastrad dw->dw_state = DELAYED_WORK_IDLE;
884 1.29 riastrad }
885 1.29 riastrad
886 1.29 riastrad /*
887 1.39 riastrad * cancel_delayed_work_done(wq, dw)
888 1.29 riastrad *
889 1.23 riastrad * Complete cancellation of a delayed work: transition from
890 1.23 riastrad * DELAYED_WORK_CANCELLED to DELAYED_WORK_IDLE and off the
891 1.23 riastrad * workqueue. Caller must not dereference dw after this returns.
892 1.23 riastrad */
893 1.23 riastrad static void
894 1.39 riastrad cancel_delayed_work_done(struct workqueue_struct *wq, struct delayed_work *dw)
895 1.23 riastrad {
896 1.31 riastrad
897 1.31 riastrad KASSERT(mutex_owned(&wq->wq_lock));
898 1.23 riastrad KASSERT(work_queue(&dw->work) == wq);
899 1.39 riastrad KASSERT(dw->dw_state == DELAYED_WORK_CANCELLED);
900 1.23 riastrad
901 1.23 riastrad dw_callout_destroy(wq, dw);
902 1.29 riastrad release_work(&dw->work, wq);
903 1.29 riastrad /* Can't dereference dw after this point. */
904 1.29 riastrad }
905 1.29 riastrad
906 1.39 riastrad /*
907 1.39 riastrad * queue_delayed_work(wq, dw, ticks)
908 1.36 riastrad *
909 1.36 riastrad * If it is not currently scheduled, schedule dw to run after
910 1.36 riastrad * ticks on wq. If currently queued, remove it from the queue
911 1.29 riastrad * first.
912 1.12 riastrad *
913 1.12 riastrad * If ticks == 0, queue it to run as soon as the worker can,
914 1.12 riastrad * without waiting for the next callout tick to run.
915 1.12 riastrad */
916 1.12 riastrad bool
917 1.1 skrll queue_delayed_work(struct workqueue_struct *wq, struct delayed_work *dw,
918 1.12 riastrad unsigned long ticks)
919 1.39 riastrad {
920 1.29 riastrad bool newly_queued;
921 1.29 riastrad
922 1.29 riastrad mutex_enter(&wq->wq_lock);
923 1.29 riastrad if (__predict_true(acquire_work(&dw->work, wq))) {
924 1.12 riastrad /*
925 1.29 riastrad * It wasn't on any workqueue at all. Schedule it to
926 1.39 riastrad * run on this one.
927 1.29 riastrad */
928 1.29 riastrad KASSERT(dw->dw_state == DELAYED_WORK_IDLE);
929 1.41 riastrad if (ticks == 0) {
930 1.29 riastrad TAILQ_INSERT_TAIL(&wq->wq_dqueue, &dw->work,
931 1.29 riastrad work_entry);
932 1.29 riastrad cv_broadcast(&wq->wq_cv);
933 1.29 riastrad SDT_PROBE2(sdt, linux, work, queue, &dw->work, wq);
934 1.29 riastrad } else {
935 1.30 riastrad /*
936 1.29 riastrad * Initialize a callout and schedule to run
937 1.41 riastrad * after a delay.
938 1.29 riastrad */
939 1.12 riastrad dw_callout_init(wq, dw);
940 1.12 riastrad callout_schedule(&dw->dw_callout, MIN(INT_MAX, ticks));
941 1.39 riastrad SDT_PROBE3(sdt, linux, work, schedule, dw, wq, ticks);
942 1.39 riastrad }
943 1.39 riastrad newly_queued = true;
944 1.39 riastrad } else {
945 1.39 riastrad /* It was already on this workqueue. */
946 1.39 riastrad switch (dw->dw_state) {
947 1.39 riastrad case DELAYED_WORK_IDLE:
948 1.39 riastrad case DELAYED_WORK_SCHEDULED:
949 1.39 riastrad case DELAYED_WORK_RESCHEDULED:
950 1.29 riastrad /* On the queue or already scheduled. Leave it. */
951 1.39 riastrad newly_queued = false;
952 1.39 riastrad break;
953 1.29 riastrad case DELAYED_WORK_CANCELLED:
954 1.40 riastrad /*
955 1.40 riastrad * Scheduled and the callout began, but it was
956 1.41 riastrad * cancelled. Reschedule it.
957 1.41 riastrad */
958 1.40 riastrad if (ticks == 0) {
959 1.40 riastrad dw->dw_state = DELAYED_WORK_SCHEDULED;
960 1.40 riastrad SDT_PROBE2(sdt, linux, work, queue,
961 1.41 riastrad &dw->work, wq);
962 1.41 riastrad } else {
963 1.40 riastrad dw->dw_state = DELAYED_WORK_RESCHEDULED;
964 1.39 riastrad dw->dw_resched = MIN(INT_MAX, ticks);
965 1.39 riastrad SDT_PROBE3(sdt, linux, work, schedule,
966 1.39 riastrad dw, wq, ticks);
967 1.39 riastrad }
968 1.39 riastrad newly_queued = true;
969 1.29 riastrad break;
970 1.1 skrll default:
971 1.12 riastrad panic("invalid delayed work state: %d",
972 1.1 skrll dw->dw_state);
973 1.1 skrll }
974 1.1 skrll }
975 1.1 skrll mutex_exit(&wq->wq_lock);
976 1.29 riastrad
977 1.29 riastrad return newly_queued;
978 1.29 riastrad }
979 1.39 riastrad
980 1.39 riastrad /*
981 1.36 riastrad * mod_delayed_work(wq, dw, ticks)
982 1.36 riastrad *
983 1.36 riastrad * Schedule dw to run after ticks. If scheduled or queued,
984 1.29 riastrad * reschedule. If ticks == 0, run without delay.
985 1.1 skrll *
986 1.1 skrll * True if it modified the timer of an already scheduled work,
987 1.1 skrll * false if it newly scheduled the work.
988 1.1 skrll */
989 1.1 skrll bool
990 1.1 skrll mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dw,
991 1.12 riastrad unsigned long ticks)
992 1.39 riastrad {
993 1.29 riastrad bool timer_modified;
994 1.29 riastrad
995 1.29 riastrad mutex_enter(&wq->wq_lock);
996 1.29 riastrad if (acquire_work(&dw->work, wq)) {
997 1.12 riastrad /*
998 1.29 riastrad * It wasn't on any workqueue at all. Schedule it to
999 1.29 riastrad * run on this one.
1000 1.29 riastrad */
1001 1.29 riastrad KASSERT(dw->dw_state == DELAYED_WORK_IDLE);
1002 1.29 riastrad if (ticks == 0) {
1003 1.39 riastrad /*
1004 1.29 riastrad * Run immediately: put it on the queue and
1005 1.29 riastrad * signal the worker thread.
1006 1.41 riastrad */
1007 1.29 riastrad TAILQ_INSERT_TAIL(&wq->wq_dqueue, &dw->work,
1008 1.29 riastrad work_entry);
1009 1.29 riastrad cv_broadcast(&wq->wq_cv);
1010 1.29 riastrad SDT_PROBE2(sdt, linux, work, queue, &dw->work, wq);
1011 1.29 riastrad } else {
1012 1.30 riastrad /*
1013 1.30 riastrad * Initialize a callout and schedule to run
1014 1.41 riastrad * after a delay.
1015 1.29 riastrad */
1016 1.12 riastrad dw_callout_init(wq, dw);
1017 1.12 riastrad callout_schedule(&dw->dw_callout, MIN(INT_MAX, ticks));
1018 1.39 riastrad SDT_PROBE3(sdt, linux, work, schedule, dw, wq, ticks);
1019 1.12 riastrad }
1020 1.12 riastrad timer_modified = false;
1021 1.39 riastrad } else {
1022 1.39 riastrad /* It was already on this workqueue. */
1023 1.39 riastrad switch (dw->dw_state) {
1024 1.41 riastrad case DELAYED_WORK_IDLE:
1025 1.41 riastrad /* On the queue. */
1026 1.41 riastrad if (ticks == 0) {
1027 1.41 riastrad /* Leave it be. */
1028 1.29 riastrad SDT_PROBE2(sdt, linux, work, cancel,
1029 1.39 riastrad &dw->work, wq);
1030 1.39 riastrad SDT_PROBE2(sdt, linux, work, queue,
1031 1.39 riastrad &dw->work, wq);
1032 1.39 riastrad } else {
1033 1.39 riastrad /* Remove from the queue and schedule. */
1034 1.39 riastrad TAILQ_REMOVE(&wq->wq_dqueue, &dw->work,
1035 1.41 riastrad work_entry);
1036 1.41 riastrad dw_callout_init(wq, dw);
1037 1.41 riastrad callout_schedule(&dw->dw_callout,
1038 1.41 riastrad MIN(INT_MAX, ticks));
1039 1.12 riastrad SDT_PROBE2(sdt, linux, work, cancel,
1040 1.39 riastrad &dw->work, wq);
1041 1.12 riastrad SDT_PROBE3(sdt, linux, work, schedule,
1042 1.12 riastrad dw, wq, ticks);
1043 1.29 riastrad }
1044 1.29 riastrad timer_modified = true;
1045 1.29 riastrad break;
1046 1.29 riastrad case DELAYED_WORK_SCHEDULED:
1047 1.29 riastrad /*
1048 1.29 riastrad * It is scheduled to run after a delay. Try
1049 1.12 riastrad * to stop it and reschedule it; if we can't,
1050 1.29 riastrad * either reschedule it or cancel it to put it
1051 1.29 riastrad * on the queue, and inform the callout.
1052 1.29 riastrad */
1053 1.29 riastrad if (callout_stop(&dw->dw_callout)) {
1054 1.29 riastrad /* Can't stop, callout has begun. */
1055 1.29 riastrad if (ticks == 0) {
1056 1.29 riastrad /*
1057 1.29 riastrad * We don't actually need to do
1058 1.41 riastrad * anything. The callout will
1059 1.41 riastrad * queue it as soon as it gets
1060 1.41 riastrad * the lock.
1061 1.41 riastrad */
1062 1.29 riastrad SDT_PROBE2(sdt, linux, work, cancel,
1063 1.35 riastrad &dw->work, wq);
1064 1.29 riastrad SDT_PROBE2(sdt, linux, work, queue,
1065 1.35 riastrad &dw->work, wq);
1066 1.41 riastrad } else {
1067 1.41 riastrad /* Ask the callout to reschedule. */
1068 1.41 riastrad dw->dw_state = DELAYED_WORK_RESCHEDULED;
1069 1.41 riastrad dw->dw_resched = MIN(INT_MAX, ticks);
1070 1.29 riastrad SDT_PROBE2(sdt, linux, work, cancel,
1071 1.12 riastrad &dw->work, wq);
1072 1.35 riastrad SDT_PROBE3(sdt, linux, work, schedule,
1073 1.29 riastrad dw, wq, ticks);
1074 1.29 riastrad }
1075 1.29 riastrad } else {
1076 1.29 riastrad /* We stopped the callout before it began. */
1077 1.29 riastrad if (ticks == 0) {
1078 1.29 riastrad /*
1079 1.29 riastrad * Run immediately: destroy the
1080 1.31 riastrad * callout, put it on the
1081 1.39 riastrad * queue, and signal the worker
1082 1.29 riastrad * thread.
1083 1.29 riastrad */
1084 1.41 riastrad dw_callout_destroy(wq, dw);
1085 1.41 riastrad TAILQ_INSERT_TAIL(&wq->wq_dqueue,
1086 1.41 riastrad &dw->work, work_entry);
1087 1.41 riastrad cv_broadcast(&wq->wq_cv);
1088 1.29 riastrad SDT_PROBE2(sdt, linux, work, cancel,
1089 1.29 riastrad &dw->work, wq);
1090 1.29 riastrad SDT_PROBE2(sdt, linux, work, queue,
1091 1.29 riastrad &dw->work, wq);
1092 1.29 riastrad } else {
1093 1.29 riastrad /*
1094 1.29 riastrad * Reschedule the callout. No
1095 1.41 riastrad * state change.
1096 1.41 riastrad */
1097 1.41 riastrad callout_schedule(&dw->dw_callout,
1098 1.41 riastrad MIN(INT_MAX, ticks));
1099 1.29 riastrad SDT_PROBE2(sdt, linux, work, cancel,
1100 1.12 riastrad &dw->work, wq);
1101 1.12 riastrad SDT_PROBE3(sdt, linux, work, schedule,
1102 1.12 riastrad dw, wq, ticks);
1103 1.12 riastrad }
1104 1.35 riastrad }
1105 1.35 riastrad timer_modified = true;
1106 1.35 riastrad break;
1107 1.35 riastrad case DELAYED_WORK_RESCHEDULED:
1108 1.35 riastrad /*
1109 1.35 riastrad * Someone rescheduled it after the callout
1110 1.35 riastrad * started but before the poor thing even had a
1111 1.35 riastrad * chance to acquire the lock.
1112 1.35 riastrad */
1113 1.35 riastrad if (ticks == 0) {
1114 1.35 riastrad /*
1115 1.35 riastrad * We can just switch back to
1116 1.35 riastrad * DELAYED_WORK_SCHEDULED so that the
1117 1.35 riastrad * callout will queue the work as soon
1118 1.41 riastrad * as it gets the lock.
1119 1.41 riastrad */
1120 1.41 riastrad dw->dw_state = DELAYED_WORK_SCHEDULED;
1121 1.41 riastrad dw->dw_resched = -1;
1122 1.35 riastrad SDT_PROBE2(sdt, linux, work, cancel,
1123 1.35 riastrad &dw->work, wq);
1124 1.35 riastrad SDT_PROBE2(sdt, linux, work, queue,
1125 1.41 riastrad &dw->work, wq);
1126 1.41 riastrad } else {
1127 1.41 riastrad /* Change the rescheduled time. */
1128 1.41 riastrad dw->dw_resched = ticks;
1129 1.35 riastrad SDT_PROBE2(sdt, linux, work, cancel,
1130 1.35 riastrad &dw->work, wq);
1131 1.35 riastrad SDT_PROBE3(sdt, linux, work, schedule,
1132 1.12 riastrad dw, wq, ticks);
1133 1.12 riastrad }
1134 1.35 riastrad timer_modified = true;
1135 1.35 riastrad break;
1136 1.35 riastrad case DELAYED_WORK_CANCELLED:
1137 1.12 riastrad /*
1138 1.29 riastrad * Someone cancelled it after the callout
1139 1.29 riastrad * started but before the poor thing even had a
1140 1.29 riastrad * chance to acquire the lock.
1141 1.29 riastrad */
1142 1.29 riastrad if (ticks == 0) {
1143 1.29 riastrad /*
1144 1.29 riastrad * We can just switch back to
1145 1.29 riastrad * DELAYED_WORK_SCHEDULED so that the
1146 1.41 riastrad * callout will queue the work as soon
1147 1.41 riastrad * as it gets the lock.
1148 1.29 riastrad */
1149 1.39 riastrad dw->dw_state = DELAYED_WORK_SCHEDULED;
1150 1.29 riastrad SDT_PROBE2(sdt, linux, work, queue,
1151 1.35 riastrad &dw->work, wq);
1152 1.41 riastrad } else {
1153 1.41 riastrad /* Ask it to reschedule. */
1154 1.29 riastrad dw->dw_state = DELAYED_WORK_RESCHEDULED;
1155 1.39 riastrad dw->dw_resched = MIN(INT_MAX, ticks);
1156 1.12 riastrad SDT_PROBE3(sdt, linux, work, schedule,
1157 1.12 riastrad dw, wq, ticks);
1158 1.29 riastrad }
1159 1.1 skrll timer_modified = false;
1160 1.1 skrll break;
1161 1.12 riastrad default:
1162 1.1 skrll panic("invalid delayed work state: %d", dw->dw_state);
1163 1.1 skrll }
1164 1.1 skrll }
1165 1.1 skrll mutex_exit(&wq->wq_lock);
1166 1.36 riastrad
1167 1.36 riastrad return timer_modified;
1168 1.36 riastrad }
1169 1.36 riastrad
1170 1.36 riastrad /*
1171 1.36 riastrad * cancel_delayed_work(dw)
1172 1.36 riastrad *
1173 1.36 riastrad * If work was scheduled or queued, remove it from the schedule or
1174 1.36 riastrad * queue and return true. If work was not scheduled or queued,
1175 1.36 riastrad * return false. Note that work may already be running; if it
1176 1.1 skrll * hasn't been rescheduled or requeued, then cancel_delayed_work
1177 1.1 skrll * will return false, and either way, cancel_delayed_work will NOT
1178 1.1 skrll * wait for the work to complete.
1179 1.12 riastrad */
1180 1.12 riastrad bool
1181 1.1 skrll cancel_delayed_work(struct delayed_work *dw)
1182 1.14 riastrad {
1183 1.39 riastrad struct workqueue_struct *wq;
1184 1.14 riastrad bool cancelled_p;
1185 1.14 riastrad
1186 1.12 riastrad /* If there's no workqueue, nothing to cancel. */
1187 1.39 riastrad if ((wq = work_queue(&dw->work)) == NULL)
1188 1.12 riastrad return false;
1189 1.12 riastrad
1190 1.12 riastrad mutex_enter(&wq->wq_lock);
1191 1.12 riastrad if (__predict_false(work_queue(&dw->work) != wq)) {
1192 1.35 riastrad cancelled_p = false;
1193 1.35 riastrad } else {
1194 1.35 riastrad switch (dw->dw_state) {
1195 1.35 riastrad case DELAYED_WORK_IDLE:
1196 1.39 riastrad /*
1197 1.39 riastrad * It is either on the queue or already running
1198 1.39 riastrad * or both.
1199 1.12 riastrad */
1200 1.41 riastrad if (work_claimed(&dw->work, wq)) {
1201 1.41 riastrad /* On the queue. Remove and release. */
1202 1.39 riastrad TAILQ_REMOVE(&wq->wq_dqueue, &dw->work,
1203 1.39 riastrad work_entry);
1204 1.12 riastrad SDT_PROBE2(sdt, linux, work, cancel,
1205 1.35 riastrad &dw->work, wq);
1206 1.39 riastrad release_work(&dw->work, wq);
1207 1.35 riastrad /* Can't dereference dw after this point. */
1208 1.12 riastrad cancelled_p = true;
1209 1.12 riastrad } else {
1210 1.12 riastrad /* Not on the queue, so didn't cancel. */
1211 1.21 riastrad cancelled_p = false;
1212 1.21 riastrad }
1213 1.21 riastrad break;
1214 1.21 riastrad case DELAYED_WORK_SCHEDULED:
1215 1.21 riastrad /*
1216 1.21 riastrad * If it is scheduled, mark it cancelled and
1217 1.21 riastrad * try to stop the callout before it starts.
1218 1.21 riastrad *
1219 1.21 riastrad * If it's too late and the callout has already
1220 1.21 riastrad * begun to execute, tough.
1221 1.21 riastrad *
1222 1.21 riastrad * If we stopped the callout before it started,
1223 1.12 riastrad * however, then destroy the callout and
1224 1.41 riastrad * dissociate it from the workqueue ourselves.
1225 1.27 riastrad */
1226 1.27 riastrad dw->dw_state = DELAYED_WORK_CANCELLED;
1227 1.16 riastrad cancelled_p = true;
1228 1.34 riastrad SDT_PROBE2(sdt, linux, work, cancel, &dw->work, wq);
1229 1.34 riastrad if (!callout_stop(&dw->dw_callout))
1230 1.34 riastrad cancel_delayed_work_done(wq, dw);
1231 1.34 riastrad break;
1232 1.34 riastrad case DELAYED_WORK_RESCHEDULED:
1233 1.34 riastrad /*
1234 1.35 riastrad * If it is being rescheduled, the callout has
1235 1.34 riastrad * already fired. We must ask it to cancel.
1236 1.41 riastrad */
1237 1.34 riastrad dw->dw_state = DELAYED_WORK_CANCELLED;
1238 1.34 riastrad dw->dw_resched = -1;
1239 1.34 riastrad cancelled_p = true;
1240 1.34 riastrad SDT_PROBE2(sdt, linux, work, cancel, &dw->work, wq);
1241 1.34 riastrad break;
1242 1.34 riastrad case DELAYED_WORK_CANCELLED:
1243 1.34 riastrad /*
1244 1.34 riastrad * If it is being cancelled, the callout has
1245 1.34 riastrad * already fired. There is nothing more for us
1246 1.34 riastrad * to do. Someone else claims credit for
1247 1.12 riastrad * cancelling it.
1248 1.12 riastrad */
1249 1.12 riastrad cancelled_p = false;
1250 1.12 riastrad break;
1251 1.1 skrll default:
1252 1.12 riastrad panic("invalid delayed work state: %d",
1253 1.1 skrll dw->dw_state);
1254 1.1 skrll }
1255 1.1 skrll }
1256 1.1 skrll mutex_exit(&wq->wq_lock);
1257 1.36 riastrad
1258 1.36 riastrad return cancelled_p;
1259 1.36 riastrad }
1260 1.36 riastrad
1261 1.36 riastrad /*
1262 1.36 riastrad * cancel_delayed_work_sync(dw)
1263 1.36 riastrad *
1264 1.36 riastrad * If work was scheduled or queued, remove it from the schedule or
1265 1.36 riastrad * queue and return true. If work was not scheduled or queued,
1266 1.1 skrll * return false. Note that work may already be running; if it
1267 1.1 skrll * hasn't been rescheduled or requeued, then cancel_delayed_work
1268 1.1 skrll * will return false; either way, wait for it to complete.
1269 1.12 riastrad */
1270 1.24 riastrad bool
1271 1.1 skrll cancel_delayed_work_sync(struct delayed_work *dw)
1272 1.24 riastrad {
1273 1.39 riastrad struct workqueue_struct *wq;
1274 1.24 riastrad bool cancelled_p;
1275 1.14 riastrad
1276 1.12 riastrad /* If there's no workqueue, nothing to cancel. */
1277 1.39 riastrad if ((wq = work_queue(&dw->work)) == NULL)
1278 1.12 riastrad return false;
1279 1.12 riastrad
1280 1.20 riastrad mutex_enter(&wq->wq_lock);
1281 1.12 riastrad if (__predict_false(work_queue(&dw->work) != wq)) {
1282 1.35 riastrad cancelled_p = false;
1283 1.35 riastrad } else {
1284 1.35 riastrad switch (dw->dw_state) {
1285 1.35 riastrad case DELAYED_WORK_IDLE:
1286 1.39 riastrad /*
1287 1.39 riastrad * It is either on the queue or already running
1288 1.39 riastrad * or both.
1289 1.12 riastrad */
1290 1.41 riastrad if (work_claimed(&dw->work, wq)) {
1291 1.41 riastrad /* On the queue. Remove and release. */
1292 1.39 riastrad TAILQ_REMOVE(&wq->wq_dqueue, &dw->work,
1293 1.39 riastrad work_entry);
1294 1.12 riastrad SDT_PROBE2(sdt, linux, work, cancel,
1295 1.39 riastrad &dw->work, wq);
1296 1.39 riastrad release_work(&dw->work, wq);
1297 1.39 riastrad /* Can't dereference dw after this point. */
1298 1.12 riastrad cancelled_p = true;
1299 1.39 riastrad } else {
1300 1.39 riastrad /* Not on the queue, so didn't cancel. */
1301 1.39 riastrad cancelled_p = false;
1302 1.12 riastrad }
1303 1.12 riastrad /* If it's still running, wait for it to complete. */
1304 1.12 riastrad if (wq->wq_current_work == &dw->work)
1305 1.20 riastrad wait_for_current_work(&dw->work, wq);
1306 1.20 riastrad break;
1307 1.20 riastrad case DELAYED_WORK_SCHEDULED:
1308 1.20 riastrad /*
1309 1.20 riastrad * If it is scheduled, mark it cancelled and
1310 1.24 riastrad * try to stop the callout before it starts.
1311 1.24 riastrad *
1312 1.24 riastrad * If it's too late and the callout has already
1313 1.20 riastrad * begun to execute, we must wait for it to
1314 1.20 riastrad * complete. But we got in soon enough to ask
1315 1.35 riastrad * the callout not to run, so we successfully
1316 1.20 riastrad * cancelled it in that case.
1317 1.12 riastrad *
1318 1.12 riastrad * If we stopped the callout before it started,
1319 1.41 riastrad * then we must destroy the callout and
1320 1.27 riastrad * dissociate it from the workqueue ourselves.
1321 1.27 riastrad */
1322 1.34 riastrad dw->dw_state = DELAYED_WORK_CANCELLED;
1323 1.34 riastrad SDT_PROBE2(sdt, linux, work, cancel, &dw->work, wq);
1324 1.34 riastrad if (!callout_halt(&dw->dw_callout, &wq->wq_lock))
1325 1.34 riastrad cancel_delayed_work_done(wq, dw);
1326 1.34 riastrad cancelled_p = true;
1327 1.34 riastrad break;
1328 1.34 riastrad case DELAYED_WORK_RESCHEDULED:
1329 1.34 riastrad /*
1330 1.34 riastrad * If it is being rescheduled, the callout has
1331 1.35 riastrad * already fired. We must ask it to cancel and
1332 1.41 riastrad * wait for it to complete.
1333 1.34 riastrad */
1334 1.34 riastrad dw->dw_state = DELAYED_WORK_CANCELLED;
1335 1.34 riastrad dw->dw_resched = -1;
1336 1.34 riastrad SDT_PROBE2(sdt, linux, work, cancel, &dw->work, wq);
1337 1.34 riastrad (void)callout_halt(&dw->dw_callout, &wq->wq_lock);
1338 1.34 riastrad cancelled_p = true;
1339 1.34 riastrad break;
1340 1.34 riastrad case DELAYED_WORK_CANCELLED:
1341 1.34 riastrad /*
1342 1.34 riastrad * If it is being cancelled, the callout has
1343 1.34 riastrad * already fired. We need only wait for it to
1344 1.34 riastrad * complete. Someone else, however, claims
1345 1.20 riastrad * credit for cancelling it.
1346 1.12 riastrad */
1347 1.12 riastrad (void)callout_halt(&dw->dw_callout, &wq->wq_lock);
1348 1.12 riastrad cancelled_p = false;
1349 1.12 riastrad break;
1350 1.1 skrll default:
1351 1.12 riastrad panic("invalid delayed work state: %d",
1352 1.1 skrll dw->dw_state);
1353 1.1 skrll }
1354 1.1 skrll }
1355 1.12 riastrad mutex_exit(&wq->wq_lock);
1356 1.12 riastrad
1357 1.12 riastrad return cancelled_p;
1358 1.12 riastrad }
1359 1.1 skrll
1360 1.36 riastrad /*
1362 1.36 riastrad * Flush
1363 1.36 riastrad */
1364 1.36 riastrad
1365 1.36 riastrad /*
1366 1.5 riastrad * flush_scheduled_work()
1367 1.12 riastrad *
1368 1.5 riastrad * Wait for all work queued on system_wq to complete. This does
1369 1.5 riastrad * not include delayed work.
1370 1.12 riastrad */
1371 1.5 riastrad void
1372 1.5 riastrad flush_scheduled_work(void)
1373 1.36 riastrad {
1374 1.36 riastrad
1375 1.36 riastrad flush_workqueue(system_wq);
1376 1.36 riastrad }
1377 1.36 riastrad
1378 1.36 riastrad /*
1379 1.36 riastrad * flush_workqueue_locked(wq)
1380 1.36 riastrad *
1381 1.28 riastrad * Wait for all work queued on wq to complete. This does not
1382 1.28 riastrad * include delayed work.
1383 1.28 riastrad *
1384 1.28 riastrad * Caller must hold wq's lock.
1385 1.28 riastrad */
1386 1.28 riastrad static void
1387 1.28 riastrad flush_workqueue_locked(struct workqueue_struct *wq)
1388 1.28 riastrad {
1389 1.28 riastrad uint64_t gen;
1390 1.28 riastrad
1391 1.28 riastrad KASSERT(mutex_owned(&wq->wq_lock));
1392 1.28 riastrad
1393 1.28 riastrad /* Get the current generation number. */
1394 1.28 riastrad gen = wq->wq_gen;
1395 1.28 riastrad
1396 1.28 riastrad /*
1397 1.28 riastrad * If there's a batch of work in progress, we must wait for the
1398 1.28 riastrad * worker thread to finish that batch.
1399 1.28 riastrad */
1400 1.28 riastrad if (wq->wq_current_work != NULL)
1401 1.28 riastrad gen++;
1402 1.28 riastrad
1403 1.39 riastrad /*
1404 1.28 riastrad * If there's any work yet to be claimed from the queue by the
1405 1.28 riastrad * worker thread, we must wait for it to finish one more batch
1406 1.28 riastrad * too.
1407 1.41 riastrad */
1408 1.28 riastrad if (!TAILQ_EMPTY(&wq->wq_queue) || !TAILQ_EMPTY(&wq->wq_dqueue))
1409 1.28 riastrad gen++;
1410 1.41 riastrad
1411 1.28 riastrad /* Wait until the generation number has caught up. */
1412 1.28 riastrad SDT_PROBE1(sdt, linux, work, flush__start, wq);
1413 1.36 riastrad while (wq->wq_gen < gen)
1414 1.36 riastrad cv_wait(&wq->wq_cv, &wq->wq_lock);
1415 1.36 riastrad SDT_PROBE1(sdt, linux, work, flush__done, wq);
1416 1.36 riastrad }
1417 1.36 riastrad
1418 1.36 riastrad /*
1419 1.12 riastrad * flush_workqueue(wq)
1420 1.12 riastrad *
1421 1.1 skrll * Wait for all work queued on wq to complete. This does not
1422 1.1 skrll * include delayed work.
1423 1.12 riastrad */
1424 1.28 riastrad void
1425 1.12 riastrad flush_workqueue(struct workqueue_struct *wq)
1426 1.1 skrll {
1427 1.1 skrll
1428 1.36 riastrad mutex_enter(&wq->wq_lock);
1429 1.36 riastrad flush_workqueue_locked(wq);
1430 1.36 riastrad mutex_exit(&wq->wq_lock);
1431 1.36 riastrad }
1432 1.36 riastrad
1433 1.36 riastrad /*
1434 1.28 riastrad * flush_work(work)
1435 1.12 riastrad *
1436 1.1 skrll * If work is queued or currently executing, wait for it to
1437 1.14 riastrad * complete.
1438 1.1 skrll */
1439 1.14 riastrad void
1440 1.39 riastrad flush_work(struct work_struct *work)
1441 1.28 riastrad {
1442 1.1 skrll struct workqueue_struct *wq;
1443 1.12 riastrad
1444 1.1 skrll /* If there's no workqueue, nothing to flush. */
1445 1.1 skrll if ((wq = work_queue(work)) == NULL)
1446 1.36 riastrad return;
1447 1.36 riastrad
1448 1.36 riastrad flush_workqueue(wq);
1449 1.38 riastrad }
1450 1.38 riastrad
1451 1.38 riastrad /*
1452 1.36 riastrad * flush_delayed_work(dw)
1453 1.28 riastrad *
1454 1.12 riastrad * If dw is scheduled to run after a delay, queue it immediately
1455 1.1 skrll * instead. Then, if dw is queued or currently executing, wait
1456 1.14 riastrad * for it to complete.
1457 1.1 skrll */
1458 1.14 riastrad void
1459 1.39 riastrad flush_delayed_work(struct delayed_work *dw)
1460 1.28 riastrad {
1461 1.1 skrll struct workqueue_struct *wq;
1462 1.1 skrll
1463 1.39 riastrad /* If there's no workqueue, nothing to flush. */
1464 1.38 riastrad if ((wq = work_queue(&dw->work)) == NULL)
1465 1.38 riastrad return;
1466 1.38 riastrad
1467 1.38 riastrad mutex_enter(&wq->wq_lock);
1468 1.38 riastrad if (__predict_false(work_queue(&dw->work) != wq)) {
1469 1.38 riastrad /*
1470 1.28 riastrad * Moved off the queue already (and possibly to another
1471 1.12 riastrad * queue, though that would be ill-advised), so it must
1472 1.28 riastrad * have completed, and we have nothing more to do.
1473 1.28 riastrad */
1474 1.28 riastrad } else {
1475 1.38 riastrad switch (dw->dw_state) {
1476 1.38 riastrad case DELAYED_WORK_IDLE:
1477 1.28 riastrad /*
1478 1.12 riastrad * It has a workqueue assigned and the callout
1479 1.12 riastrad * is idle, so it must be in progress or on the
1480 1.35 riastrad * queue. In that case, we'll wait for it to
1481 1.35 riastrad * complete.
1482 1.35 riastrad */
1483 1.38 riastrad break;
1484 1.38 riastrad case DELAYED_WORK_SCHEDULED:
1485 1.38 riastrad case DELAYED_WORK_RESCHEDULED:
1486 1.38 riastrad case DELAYED_WORK_CANCELLED:
1487 1.38 riastrad /*
1488 1.38 riastrad * The callout is scheduled, and may have even
1489 1.38 riastrad * started. Mark it as scheduled so that if
1490 1.35 riastrad * the callout has fired it will queue the work
1491 1.38 riastrad * itself. Try to stop the callout -- if we
1492 1.38 riastrad * can, queue the work now; if we can't, wait
1493 1.38 riastrad * for the callout to complete, which entails
1494 1.38 riastrad * queueing it.
1495 1.38 riastrad */
1496 1.38 riastrad dw->dw_state = DELAYED_WORK_SCHEDULED;
1497 1.38 riastrad if (!callout_halt(&dw->dw_callout, &wq->wq_lock)) {
1498 1.38 riastrad /*
1499 1.38 riastrad * We stopped it before it ran. No
1500 1.38 riastrad * state change in the interim is
1501 1.38 riastrad * possible. Destroy the callout and
1502 1.39 riastrad * queue it ourselves.
1503 1.38 riastrad */
1504 1.38 riastrad KASSERT(dw->dw_state ==
1505 1.41 riastrad DELAYED_WORK_SCHEDULED);
1506 1.41 riastrad dw_callout_destroy(wq, dw);
1507 1.38 riastrad TAILQ_INSERT_TAIL(&wq->wq_dqueue, &dw->work,
1508 1.35 riastrad work_entry);
1509 1.12 riastrad cv_broadcast(&wq->wq_cv);
1510 1.38 riastrad SDT_PROBE2(sdt, linux, work, queue,
1511 1.12 riastrad &dw->work, wq);
1512 1.38 riastrad }
1513 1.38 riastrad break;
1514 1.38 riastrad default:
1515 1.38 riastrad panic("invalid delayed work state: %d", dw->dw_state);
1516 1.38 riastrad }
1517 1.1 skrll /*
1518 1.12 riastrad * Waiting for the whole queue to flush is overkill,
1519 1.1 skrll * but doesn't hurt.
1520 */
1521 flush_workqueue_locked(wq);
1522 }
1523 mutex_exit(&wq->wq_lock);
1524 }
1525