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