linux_work.c revision 1.2 1 1.2 riastrad /* $NetBSD: linux_work.c,v 1.2 2018/08/27 06:55:23 riastradh Exp $ */
2 1.1 skrll
3 1.1 skrll /*-
4 1.1 skrll * Copyright (c) 2013 The NetBSD Foundation, Inc.
5 1.1 skrll * All rights reserved.
6 1.1 skrll *
7 1.1 skrll * This code is derived from software contributed to The NetBSD Foundation
8 1.1 skrll * by Taylor R. Campbell.
9 1.1 skrll *
10 1.1 skrll * Redistribution and use in source and binary forms, with or without
11 1.1 skrll * modification, are permitted provided that the following conditions
12 1.1 skrll * are met:
13 1.1 skrll * 1. Redistributions of source code must retain the above copyright
14 1.1 skrll * notice, this list of conditions and the following disclaimer.
15 1.1 skrll * 2. Redistributions in binary form must reproduce the above copyright
16 1.1 skrll * notice, this list of conditions and the following disclaimer in the
17 1.1 skrll * documentation and/or other materials provided with the distribution.
18 1.1 skrll *
19 1.1 skrll * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.1 skrll * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.1 skrll * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.1 skrll * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.1 skrll * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.1 skrll * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.1 skrll * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.1 skrll * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.1 skrll * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.1 skrll * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.1 skrll * POSSIBILITY OF SUCH DAMAGE.
30 1.1 skrll */
31 1.1 skrll
32 1.1 skrll #include <sys/cdefs.h>
33 1.2 riastrad __KERNEL_RCSID(0, "$NetBSD: linux_work.c,v 1.2 2018/08/27 06:55:23 riastradh Exp $");
34 1.1 skrll
35 1.1 skrll #include <sys/types.h>
36 1.1 skrll #include <sys/param.h>
37 1.1 skrll #include <sys/atomic.h>
38 1.1 skrll #include <sys/callout.h>
39 1.1 skrll #include <sys/condvar.h>
40 1.1 skrll #include <sys/errno.h>
41 1.1 skrll #include <sys/intr.h>
42 1.1 skrll #include <sys/kmem.h>
43 1.1 skrll #include <sys/mutex.h>
44 1.1 skrll #include <sys/queue.h>
45 1.1 skrll #include <sys/systm.h>
46 1.1 skrll #include <sys/workqueue.h>
47 1.1 skrll #include <sys/cpu.h>
48 1.1 skrll
49 1.1 skrll #include <machine/lock.h>
50 1.1 skrll
51 1.1 skrll #include <linux/workqueue.h>
52 1.1 skrll
53 1.1 skrll /* XXX Kludge until we sync with HEAD. */
54 1.1 skrll #if DIAGNOSTIC
55 1.1 skrll #define __diagused
56 1.1 skrll #else
57 1.1 skrll #define __diagused __unused
58 1.1 skrll #endif
59 1.1 skrll
60 1.1 skrll struct workqueue_struct {
61 1.1 skrll struct workqueue *wq_workqueue;
62 1.1 skrll
63 1.1 skrll /* XXX The following should all be per-CPU. */
64 1.1 skrll kmutex_t wq_lock;
65 1.1 skrll
66 1.1 skrll /*
67 1.1 skrll * Condvar for when any state related to this workqueue
68 1.1 skrll * changes. XXX Could split this into multiple condvars for
69 1.1 skrll * different purposes, but whatever...
70 1.1 skrll */
71 1.1 skrll kcondvar_t wq_cv;
72 1.1 skrll
73 1.1 skrll TAILQ_HEAD(, delayed_work) wq_delayed;
74 1.1 skrll struct work_struct *wq_current_work;
75 1.1 skrll };
76 1.1 skrll
77 1.1 skrll static void linux_work_lock_init(struct work_struct *);
78 1.1 skrll static void linux_work_lock(struct work_struct *);
79 1.1 skrll static void linux_work_unlock(struct work_struct *);
80 1.1 skrll static bool linux_work_locked(struct work_struct *) __diagused;
81 1.1 skrll
82 1.1 skrll static void linux_wq_barrier(struct work_struct *);
83 1.1 skrll
84 1.1 skrll static void linux_wait_for_cancelled_work(struct work_struct *);
85 1.1 skrll static void linux_wait_for_invoked_work(struct work_struct *);
86 1.1 skrll static void linux_worker(struct work *, void *);
87 1.1 skrll
88 1.1 skrll static void linux_cancel_delayed_work_callout(struct delayed_work *, bool);
89 1.1 skrll static void linux_wait_for_delayed_cancelled_work(struct delayed_work *);
90 1.1 skrll static void linux_worker_intr(void *);
91 1.1 skrll
92 1.1 skrll struct workqueue_struct *system_wq;
93 1.2 riastrad struct workqueue_struct *system_long_wq;
94 1.1 skrll
95 1.1 skrll int
96 1.1 skrll linux_workqueue_init(void)
97 1.1 skrll {
98 1.2 riastrad int error;
99 1.1 skrll
100 1.1 skrll system_wq = alloc_ordered_workqueue("lnxsyswq", 0);
101 1.1 skrll if (system_wq == NULL)
102 1.2 riastrad goto fail0;
103 1.2 riastrad
104 1.2 riastrad system_long_wq = alloc_ordered_workqueue("lnxlngwq", 0);
105 1.2 riastrad if (system_long_wq == NULL)
106 1.2 riastrad goto fail1;
107 1.1 skrll
108 1.1 skrll return 0;
109 1.2 riastrad
110 1.2 riastrad fail2: __unused
111 1.2 riastrad destroy_workqueue(system_long_wq);
112 1.2 riastrad fail1: destroy_workqueue(system_wq);
113 1.2 riastrad fail0: return ENOMEM;
114 1.1 skrll }
115 1.1 skrll
116 1.1 skrll void
117 1.1 skrll linux_workqueue_fini(void)
118 1.1 skrll {
119 1.2 riastrad
120 1.2 riastrad destroy_workqueue(system_long_wq);
121 1.2 riastrad system_long_wq = NULL;
122 1.1 skrll destroy_workqueue(system_wq);
123 1.1 skrll system_wq = NULL;
124 1.1 skrll }
125 1.1 skrll
126 1.1 skrll /*
128 1.1 skrll * Workqueues
129 1.1 skrll */
130 1.1 skrll
131 1.1 skrll struct workqueue_struct *
132 1.1 skrll alloc_ordered_workqueue(const char *name, int linux_flags)
133 1.1 skrll {
134 1.1 skrll struct workqueue_struct *wq;
135 1.1 skrll int flags = WQ_MPSAFE;
136 1.1 skrll int error;
137 1.1 skrll
138 1.1 skrll KASSERT(linux_flags == 0);
139 1.1 skrll
140 1.1 skrll wq = kmem_alloc(sizeof(*wq), KM_SLEEP);
141 1.1 skrll error = workqueue_create(&wq->wq_workqueue, name, &linux_worker,
142 1.1 skrll wq, PRI_NONE, IPL_VM, flags);
143 1.1 skrll if (error) {
144 1.1 skrll kmem_free(wq, sizeof(*wq));
145 1.1 skrll return NULL;
146 1.1 skrll }
147 1.1 skrll
148 1.1 skrll mutex_init(&wq->wq_lock, MUTEX_DEFAULT, IPL_VM);
149 1.1 skrll cv_init(&wq->wq_cv, name);
150 1.1 skrll TAILQ_INIT(&wq->wq_delayed);
151 1.1 skrll wq->wq_current_work = NULL;
152 1.1 skrll
153 1.1 skrll return wq;
154 1.1 skrll }
155 1.1 skrll
156 1.1 skrll void
157 1.1 skrll destroy_workqueue(struct workqueue_struct *wq)
158 1.1 skrll {
159 1.1 skrll
160 1.1 skrll /*
161 1.1 skrll * Cancel all delayed work.
162 1.1 skrll */
163 1.1 skrll for (;;) {
164 1.1 skrll struct delayed_work *dw;
165 1.1 skrll
166 1.1 skrll mutex_enter(&wq->wq_lock);
167 1.1 skrll if (TAILQ_EMPTY(&wq->wq_delayed)) {
168 1.1 skrll dw = NULL;
169 1.1 skrll } else {
170 1.1 skrll dw = TAILQ_FIRST(&wq->wq_delayed);
171 1.1 skrll TAILQ_REMOVE(&wq->wq_delayed, dw, dw_entry);
172 1.1 skrll }
173 1.1 skrll mutex_exit(&wq->wq_lock);
174 1.1 skrll
175 1.1 skrll if (dw == NULL)
176 1.1 skrll break;
177 1.1 skrll
178 1.1 skrll cancel_delayed_work_sync(dw);
179 1.1 skrll }
180 1.1 skrll
181 1.1 skrll /*
182 1.1 skrll * workqueue_destroy empties the queue; we need not wait for
183 1.1 skrll * completion explicitly. However, we can't destroy the
184 1.1 skrll * condvar or mutex until this is done.
185 1.1 skrll */
186 1.1 skrll workqueue_destroy(wq->wq_workqueue);
187 1.1 skrll KASSERT(wq->wq_current_work == NULL);
188 1.1 skrll wq->wq_workqueue = NULL;
189 1.1 skrll
190 1.1 skrll cv_destroy(&wq->wq_cv);
191 1.1 skrll mutex_destroy(&wq->wq_lock);
192 1.1 skrll
193 1.1 skrll kmem_free(wq, sizeof(*wq));
194 1.1 skrll }
195 1.1 skrll
196 1.1 skrll /*
198 1.1 skrll * Flush
199 1.1 skrll *
200 1.1 skrll * Note: This doesn't cancel or wait for delayed work. This seems to
201 1.1 skrll * match what Linux does (or, doesn't do).
202 1.1 skrll */
203 1.1 skrll
204 1.1 skrll void
205 1.1 skrll flush_scheduled_work(void)
206 1.1 skrll {
207 1.1 skrll flush_workqueue(system_wq);
208 1.1 skrll }
209 1.1 skrll
210 1.1 skrll struct wq_flush_work {
211 1.1 skrll struct work_struct wqfw_work;
212 1.1 skrll struct wq_flush *wqfw_flush;
213 1.1 skrll };
214 1.1 skrll
215 1.1 skrll struct wq_flush {
216 1.1 skrll kmutex_t wqf_lock;
217 1.1 skrll kcondvar_t wqf_cv;
218 1.1 skrll unsigned int wqf_n;
219 1.1 skrll };
220 1.1 skrll
221 1.1 skrll void
222 1.1 skrll flush_work(struct work_struct *work)
223 1.1 skrll {
224 1.1 skrll struct workqueue_struct *const wq = work->w_wq;
225 1.1 skrll
226 1.1 skrll if (wq != NULL)
227 1.1 skrll flush_workqueue(wq);
228 1.1 skrll }
229 1.1 skrll
230 1.1 skrll void
231 1.1 skrll flush_workqueue(struct workqueue_struct *wq)
232 1.1 skrll {
233 1.1 skrll static const struct wq_flush zero_wqf;
234 1.1 skrll struct wq_flush wqf = zero_wqf;
235 1.1 skrll
236 1.1 skrll mutex_init(&wqf.wqf_lock, MUTEX_DEFAULT, IPL_NONE);
237 1.1 skrll cv_init(&wqf.wqf_cv, "lnxwflsh");
238 1.1 skrll
239 1.1 skrll if (1) {
240 1.1 skrll struct wq_flush_work *const wqfw = kmem_zalloc(sizeof(*wqfw),
241 1.1 skrll KM_SLEEP);
242 1.1 skrll
243 1.1 skrll wqf.wqf_n = 1;
244 1.1 skrll wqfw->wqfw_flush = &wqf;
245 1.1 skrll INIT_WORK(&wqfw->wqfw_work, &linux_wq_barrier);
246 1.1 skrll wqfw->wqfw_work.w_wq = wq;
247 1.1 skrll wqfw->wqfw_work.w_state = WORK_PENDING;
248 1.1 skrll workqueue_enqueue(wq->wq_workqueue, &wqfw->wqfw_work.w_wk,
249 1.1 skrll NULL);
250 1.1 skrll } else {
251 1.1 skrll struct cpu_info *ci;
252 1.1 skrll CPU_INFO_ITERATOR cii;
253 1.1 skrll struct wq_flush_work *wqfw;
254 1.1 skrll
255 1.1 skrll panic("per-CPU Linux workqueues don't work yet!");
256 1.1 skrll
257 1.1 skrll wqf.wqf_n = 0;
258 1.1 skrll for (CPU_INFO_FOREACH(cii, ci)) {
259 1.1 skrll wqfw = kmem_zalloc(sizeof(*wqfw), KM_SLEEP);
260 1.1 skrll mutex_enter(&wqf.wqf_lock);
261 1.1 skrll wqf.wqf_n++;
262 1.1 skrll mutex_exit(&wqf.wqf_lock);
263 1.1 skrll wqfw->wqfw_flush = &wqf;
264 1.1 skrll INIT_WORK(&wqfw->wqfw_work, &linux_wq_barrier);
265 1.1 skrll wqfw->wqfw_work.w_state = WORK_PENDING;
266 1.1 skrll wqfw->wqfw_work.w_wq = wq;
267 1.1 skrll workqueue_enqueue(wq->wq_workqueue,
268 1.1 skrll &wqfw->wqfw_work.w_wk, ci);
269 1.1 skrll }
270 1.1 skrll }
271 1.1 skrll
272 1.1 skrll mutex_enter(&wqf.wqf_lock);
273 1.1 skrll while (0 < wqf.wqf_n)
274 1.1 skrll cv_wait(&wqf.wqf_cv, &wqf.wqf_lock);
275 1.1 skrll mutex_exit(&wqf.wqf_lock);
276 1.1 skrll
277 1.1 skrll cv_destroy(&wqf.wqf_cv);
278 1.1 skrll mutex_destroy(&wqf.wqf_lock);
279 1.1 skrll }
280 1.1 skrll
281 1.1 skrll static void
282 1.1 skrll linux_wq_barrier(struct work_struct *work)
283 1.1 skrll {
284 1.1 skrll struct wq_flush_work *const wqfw = container_of(work,
285 1.1 skrll struct wq_flush_work, wqfw_work);
286 1.1 skrll struct wq_flush *const wqf = wqfw->wqfw_flush;
287 1.1 skrll
288 1.1 skrll mutex_enter(&wqf->wqf_lock);
289 1.1 skrll if (--wqf->wqf_n == 0)
290 1.1 skrll cv_broadcast(&wqf->wqf_cv);
291 1.1 skrll mutex_exit(&wqf->wqf_lock);
292 1.1 skrll
293 1.1 skrll kmem_free(wqfw, sizeof(*wqfw));
294 1.1 skrll }
295 1.1 skrll
296 1.1 skrll /*
298 1.1 skrll * Work locking
299 1.1 skrll *
300 1.1 skrll * We use __cpu_simple_lock(9) rather than mutex(9) because Linux code
301 1.1 skrll * does not destroy work, so there is nowhere to call mutex_destroy.
302 1.1 skrll *
303 1.1 skrll * XXX This is getting out of hand... Really, work items shouldn't
304 1.1 skrll * have locks in them at all; instead the workqueues should.
305 1.1 skrll */
306 1.1 skrll
307 1.1 skrll static void
308 1.1 skrll linux_work_lock_init(struct work_struct *work)
309 1.1 skrll {
310 1.1 skrll
311 1.1 skrll __cpu_simple_lock_init(&work->w_lock);
312 1.1 skrll }
313 1.1 skrll
314 1.1 skrll static void
315 1.1 skrll linux_work_lock(struct work_struct *work)
316 1.1 skrll {
317 1.1 skrll struct cpu_info *ci;
318 1.1 skrll int cnt, s;
319 1.1 skrll
320 1.1 skrll /* XXX Copypasta of MUTEX_SPIN_SPLRAISE. */
321 1.1 skrll s = splvm();
322 1.1 skrll ci = curcpu();
323 1.1 skrll cnt = ci->ci_mtx_count--;
324 1.1 skrll __insn_barrier();
325 1.1 skrll if (cnt == 0)
326 1.1 skrll ci->ci_mtx_oldspl = s;
327 1.1 skrll
328 1.1 skrll __cpu_simple_lock(&work->w_lock);
329 1.1 skrll }
330 1.1 skrll
331 1.1 skrll static void
332 1.1 skrll linux_work_unlock(struct work_struct *work)
333 1.1 skrll {
334 1.1 skrll struct cpu_info *ci;
335 1.1 skrll int s;
336 1.1 skrll
337 1.1 skrll __cpu_simple_unlock(&work->w_lock);
338 1.1 skrll
339 1.1 skrll /* XXX Copypasta of MUTEX_SPIN_SPLRESTORE. */
340 1.1 skrll ci = curcpu();
341 1.1 skrll s = ci->ci_mtx_oldspl;
342 1.1 skrll __insn_barrier();
343 1.1 skrll if (++ci->ci_mtx_count == 0)
344 1.1 skrll splx(s);
345 1.1 skrll }
346 1.1 skrll
347 1.1 skrll static bool __diagused
348 1.1 skrll linux_work_locked(struct work_struct *work)
349 1.1 skrll {
350 1.1 skrll return __SIMPLELOCK_LOCKED_P(&work->w_lock);
351 1.1 skrll }
352 1.1 skrll
353 1.1 skrll /*
355 1.1 skrll * Work
356 1.1 skrll */
357 1.1 skrll
358 1.1 skrll void
359 1.1 skrll INIT_WORK(struct work_struct *work, void (*fn)(struct work_struct *))
360 1.1 skrll {
361 1.1 skrll
362 1.1 skrll linux_work_lock_init(work);
363 1.1 skrll work->w_state = WORK_IDLE;
364 1.1 skrll work->w_wq = NULL;
365 1.1 skrll work->w_fn = fn;
366 1.1 skrll }
367 1.1 skrll
368 1.1 skrll bool
369 1.1 skrll schedule_work(struct work_struct *work)
370 1.1 skrll {
371 1.1 skrll return queue_work(system_wq, work);
372 1.1 skrll }
373 1.1 skrll
374 1.1 skrll bool
375 1.1 skrll queue_work(struct workqueue_struct *wq, struct work_struct *work)
376 1.1 skrll {
377 1.1 skrll /* True if we put it on the queue, false if it was already there. */
378 1.1 skrll bool newly_queued;
379 1.1 skrll
380 1.1 skrll KASSERT(wq != NULL);
381 1.1 skrll
382 1.1 skrll linux_work_lock(work);
383 1.1 skrll switch (work->w_state) {
384 1.1 skrll case WORK_IDLE:
385 1.1 skrll case WORK_INVOKED:
386 1.1 skrll work->w_state = WORK_PENDING;
387 1.1 skrll work->w_wq = wq;
388 1.1 skrll workqueue_enqueue(wq->wq_workqueue, &work->w_wk, NULL);
389 1.1 skrll newly_queued = true;
390 1.1 skrll break;
391 1.1 skrll
392 1.1 skrll case WORK_DELAYED:
393 1.1 skrll panic("queue_work(delayed work %p)", work);
394 1.1 skrll break;
395 1.1 skrll
396 1.1 skrll case WORK_PENDING:
397 1.1 skrll KASSERT(work->w_wq == wq);
398 1.1 skrll newly_queued = false;
399 1.1 skrll break;
400 1.1 skrll
401 1.1 skrll case WORK_CANCELLED:
402 1.1 skrll newly_queued = false;
403 1.1 skrll break;
404 1.1 skrll
405 1.1 skrll case WORK_DELAYED_CANCELLED:
406 1.1 skrll panic("queue_work(delayed work %p)", work);
407 1.1 skrll break;
408 1.1 skrll
409 1.1 skrll default:
410 1.1 skrll panic("work %p in bad state: %d", work, (int)work->w_state);
411 1.1 skrll break;
412 1.1 skrll }
413 1.1 skrll linux_work_unlock(work);
414 1.1 skrll
415 1.1 skrll return newly_queued;
416 1.1 skrll }
417 1.1 skrll
418 1.1 skrll bool
419 1.1 skrll cancel_work_sync(struct work_struct *work)
420 1.1 skrll {
421 1.1 skrll bool cancelled_p = false;
422 1.1 skrll
423 1.1 skrll linux_work_lock(work);
424 1.1 skrll switch (work->w_state) {
425 1.1 skrll case WORK_IDLE: /* Nothing to do. */
426 1.1 skrll break;
427 1.1 skrll
428 1.1 skrll case WORK_DELAYED:
429 1.1 skrll panic("cancel_work_sync(delayed work %p)", work);
430 1.1 skrll break;
431 1.1 skrll
432 1.1 skrll case WORK_PENDING:
433 1.1 skrll work->w_state = WORK_CANCELLED;
434 1.1 skrll linux_wait_for_cancelled_work(work);
435 1.1 skrll cancelled_p = true;
436 1.1 skrll break;
437 1.1 skrll
438 1.1 skrll case WORK_INVOKED:
439 1.1 skrll linux_wait_for_invoked_work(work);
440 1.1 skrll break;
441 1.1 skrll
442 1.1 skrll case WORK_CANCELLED: /* Already done. */
443 1.1 skrll break;
444 1.1 skrll
445 1.1 skrll case WORK_DELAYED_CANCELLED:
446 1.1 skrll panic("cancel_work_sync(delayed work %p)", work);
447 1.1 skrll break;
448 1.1 skrll
449 1.1 skrll default:
450 1.1 skrll panic("work %p in bad state: %d", work, (int)work->w_state);
451 1.1 skrll break;
452 1.1 skrll }
453 1.1 skrll linux_work_unlock(work);
454 1.1 skrll
455 1.1 skrll return cancelled_p;
456 1.1 skrll }
457 1.1 skrll
458 1.1 skrll static void
459 1.1 skrll linux_wait_for_cancelled_work(struct work_struct *work)
460 1.1 skrll {
461 1.1 skrll struct workqueue_struct *wq;
462 1.1 skrll
463 1.1 skrll KASSERT(linux_work_locked(work));
464 1.1 skrll KASSERT(work->w_state == WORK_CANCELLED);
465 1.1 skrll
466 1.1 skrll wq = work->w_wq;
467 1.1 skrll do {
468 1.1 skrll mutex_enter(&wq->wq_lock);
469 1.1 skrll linux_work_unlock(work);
470 1.1 skrll cv_wait(&wq->wq_cv, &wq->wq_lock);
471 1.1 skrll mutex_exit(&wq->wq_lock);
472 1.1 skrll linux_work_lock(work);
473 1.1 skrll } while ((work->w_state == WORK_CANCELLED) && (work->w_wq == wq));
474 1.1 skrll }
475 1.1 skrll
476 1.1 skrll static void
477 1.1 skrll linux_wait_for_invoked_work(struct work_struct *work)
478 1.1 skrll {
479 1.1 skrll struct workqueue_struct *wq;
480 1.1 skrll
481 1.1 skrll KASSERT(linux_work_locked(work));
482 1.1 skrll KASSERT(work->w_state == WORK_INVOKED);
483 1.1 skrll
484 1.1 skrll wq = work->w_wq;
485 1.1 skrll mutex_enter(&wq->wq_lock);
486 1.1 skrll linux_work_unlock(work);
487 1.1 skrll while (wq->wq_current_work == work)
488 1.1 skrll cv_wait(&wq->wq_cv, &wq->wq_lock);
489 1.1 skrll mutex_exit(&wq->wq_lock);
490 1.1 skrll
491 1.1 skrll linux_work_lock(work); /* XXX needless relock */
492 1.1 skrll }
493 1.1 skrll
494 1.1 skrll static void
495 1.1 skrll linux_worker(struct work *wk, void *arg)
496 1.1 skrll {
497 1.1 skrll struct work_struct *const work = container_of(wk, struct work_struct,
498 1.1 skrll w_wk);
499 1.1 skrll struct workqueue_struct *const wq = arg;
500 1.1 skrll
501 1.1 skrll linux_work_lock(work);
502 1.1 skrll switch (work->w_state) {
503 1.1 skrll case WORK_IDLE:
504 1.1 skrll panic("idle work %p got queued: %p", work, wq);
505 1.1 skrll break;
506 1.1 skrll
507 1.1 skrll case WORK_DELAYED:
508 1.1 skrll panic("delayed work %p got queued: %p", work, wq);
509 1.1 skrll break;
510 1.1 skrll
511 1.1 skrll case WORK_PENDING:
512 1.1 skrll KASSERT(work->w_wq == wq);
513 1.1 skrll
514 1.1 skrll /* Get ready to invoke this one. */
515 1.1 skrll mutex_enter(&wq->wq_lock);
516 1.1 skrll work->w_state = WORK_INVOKED;
517 1.1 skrll KASSERT(wq->wq_current_work == NULL);
518 1.1 skrll wq->wq_current_work = work;
519 1.1 skrll mutex_exit(&wq->wq_lock);
520 1.1 skrll
521 1.1 skrll /* Unlock it and do it. Can't use work after this. */
522 1.1 skrll linux_work_unlock(work);
523 1.1 skrll (*work->w_fn)(work);
524 1.1 skrll
525 1.1 skrll /* All done. Notify anyone waiting for completion. */
526 1.1 skrll mutex_enter(&wq->wq_lock);
527 1.1 skrll KASSERT(wq->wq_current_work == work);
528 1.1 skrll wq->wq_current_work = NULL;
529 1.1 skrll cv_broadcast(&wq->wq_cv);
530 1.1 skrll mutex_exit(&wq->wq_lock);
531 1.1 skrll return;
532 1.1 skrll
533 1.1 skrll case WORK_INVOKED:
534 1.1 skrll panic("invoked work %p got requeued: %p", work, wq);
535 1.1 skrll break;
536 1.1 skrll
537 1.1 skrll case WORK_CANCELLED:
538 1.1 skrll KASSERT(work->w_wq == wq);
539 1.1 skrll
540 1.1 skrll /* Return to idle; notify anyone waiting for cancellation. */
541 1.1 skrll mutex_enter(&wq->wq_lock);
542 1.1 skrll work->w_state = WORK_IDLE;
543 1.1 skrll work->w_wq = NULL;
544 1.1 skrll cv_broadcast(&wq->wq_cv);
545 1.1 skrll mutex_exit(&wq->wq_lock);
546 1.1 skrll break;
547 1.1 skrll
548 1.1 skrll case WORK_DELAYED_CANCELLED:
549 1.1 skrll panic("cancelled delayed work %p got uqeued: %p", work, wq);
550 1.1 skrll break;
551 1.1 skrll
552 1.1 skrll default:
553 1.1 skrll panic("work %p in bad state: %d", work, (int)work->w_state);
554 1.1 skrll break;
555 1.1 skrll }
556 1.1 skrll linux_work_unlock(work);
557 1.1 skrll }
558 1.1 skrll
559 1.1 skrll /*
561 1.1 skrll * Delayed work
562 1.1 skrll */
563 1.1 skrll
564 1.1 skrll void
565 1.1 skrll INIT_DELAYED_WORK(struct delayed_work *dw, void (*fn)(struct work_struct *))
566 1.1 skrll {
567 1.1 skrll INIT_WORK(&dw->work, fn);
568 1.1 skrll }
569 1.1 skrll
570 1.1 skrll bool
571 1.1 skrll schedule_delayed_work(struct delayed_work *dw, unsigned long ticks)
572 1.1 skrll {
573 1.1 skrll return queue_delayed_work(system_wq, dw, ticks);
574 1.1 skrll }
575 1.1 skrll
576 1.1 skrll bool
577 1.1 skrll queue_delayed_work(struct workqueue_struct *wq, struct delayed_work *dw,
578 1.1 skrll unsigned long ticks)
579 1.1 skrll {
580 1.1 skrll bool newly_queued;
581 1.1 skrll
582 1.1 skrll KASSERT(wq != NULL);
583 1.1 skrll
584 1.1 skrll linux_work_lock(&dw->work);
585 1.1 skrll switch (dw->work.w_state) {
586 1.1 skrll case WORK_IDLE:
587 1.1 skrll case WORK_INVOKED:
588 1.1 skrll if (ticks == 0) {
589 1.1 skrll /* Skip the delay and queue it now. */
590 1.1 skrll dw->work.w_state = WORK_PENDING;
591 1.1 skrll dw->work.w_wq = wq;
592 1.1 skrll workqueue_enqueue(wq->wq_workqueue, &dw->work.w_wk,
593 1.1 skrll NULL);
594 1.1 skrll } else {
595 1.1 skrll callout_init(&dw->dw_callout, CALLOUT_MPSAFE);
596 1.1 skrll callout_reset(&dw->dw_callout, ticks,
597 1.1 skrll &linux_worker_intr, dw);
598 1.1 skrll dw->work.w_state = WORK_DELAYED;
599 1.1 skrll dw->work.w_wq = wq;
600 1.1 skrll mutex_enter(&wq->wq_lock);
601 1.1 skrll TAILQ_INSERT_HEAD(&wq->wq_delayed, dw, dw_entry);
602 1.1 skrll mutex_exit(&wq->wq_lock);
603 1.1 skrll }
604 1.1 skrll newly_queued = true;
605 1.1 skrll break;
606 1.1 skrll
607 1.1 skrll case WORK_DELAYED:
608 1.1 skrll /*
609 1.1 skrll * Timer is already ticking. Leave it to time out
610 1.1 skrll * whenever it was going to time out, as Linux does --
611 1.1 skrll * neither speed it up nor postpone it.
612 1.1 skrll */
613 1.1 skrll newly_queued = false;
614 1.1 skrll break;
615 1.1 skrll
616 1.1 skrll case WORK_PENDING:
617 1.1 skrll KASSERT(dw->work.w_wq == wq);
618 1.1 skrll newly_queued = false;
619 1.1 skrll break;
620 1.1 skrll
621 1.1 skrll case WORK_CANCELLED:
622 1.1 skrll case WORK_DELAYED_CANCELLED:
623 1.1 skrll /* XXX Wait for cancellation and then queue? */
624 1.1 skrll newly_queued = false;
625 1.1 skrll break;
626 1.1 skrll
627 1.1 skrll default:
628 1.1 skrll panic("delayed work %p in bad state: %d", dw,
629 1.1 skrll (int)dw->work.w_state);
630 1.1 skrll break;
631 1.1 skrll }
632 1.1 skrll linux_work_unlock(&dw->work);
633 1.1 skrll
634 1.1 skrll return newly_queued;
635 1.1 skrll }
636 1.1 skrll
637 1.1 skrll bool
638 1.1 skrll mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dw,
639 1.1 skrll unsigned long ticks)
640 1.1 skrll {
641 1.1 skrll bool timer_modified;
642 1.1 skrll
643 1.1 skrll KASSERT(wq != NULL);
644 1.1 skrll
645 1.1 skrll linux_work_lock(&dw->work);
646 1.1 skrll switch (dw->work.w_state) {
647 1.1 skrll case WORK_IDLE:
648 1.1 skrll case WORK_INVOKED:
649 1.1 skrll if (ticks == 0) {
650 1.1 skrll /* Skip the delay and queue it now. */
651 1.1 skrll dw->work.w_state = WORK_PENDING;
652 1.1 skrll dw->work.w_wq = wq;
653 1.1 skrll workqueue_enqueue(wq->wq_workqueue, &dw->work.w_wk,
654 1.1 skrll NULL);
655 1.1 skrll } else {
656 1.1 skrll callout_init(&dw->dw_callout, CALLOUT_MPSAFE);
657 1.1 skrll callout_reset(&dw->dw_callout, ticks,
658 1.1 skrll &linux_worker_intr, dw);
659 1.1 skrll dw->work.w_state = WORK_DELAYED;
660 1.1 skrll dw->work.w_wq = wq;
661 1.1 skrll mutex_enter(&wq->wq_lock);
662 1.1 skrll TAILQ_INSERT_HEAD(&wq->wq_delayed, dw, dw_entry);
663 1.1 skrll mutex_exit(&wq->wq_lock);
664 1.1 skrll }
665 1.1 skrll timer_modified = false;
666 1.1 skrll break;
667 1.1 skrll
668 1.1 skrll case WORK_DELAYED:
669 1.1 skrll /*
670 1.1 skrll * Timer is already ticking. Reschedule it.
671 1.1 skrll */
672 1.1 skrll callout_schedule(&dw->dw_callout, ticks);
673 1.1 skrll timer_modified = true;
674 1.1 skrll break;
675 1.1 skrll
676 1.1 skrll case WORK_PENDING:
677 1.1 skrll KASSERT(dw->work.w_wq == wq);
678 1.1 skrll timer_modified = false;
679 1.1 skrll break;
680 1.1 skrll
681 1.1 skrll case WORK_CANCELLED:
682 1.1 skrll case WORK_DELAYED_CANCELLED:
683 1.1 skrll /* XXX Wait for cancellation and then queue? */
684 1.1 skrll timer_modified = false;
685 1.1 skrll break;
686 1.1 skrll
687 1.1 skrll default:
688 1.1 skrll panic("delayed work %p in bad state: %d", dw,
689 1.1 skrll (int)dw->work.w_state);
690 1.1 skrll break;
691 1.1 skrll }
692 1.1 skrll linux_work_unlock(&dw->work);
693 1.1 skrll
694 1.1 skrll return timer_modified;
695 1.1 skrll }
696 1.1 skrll
697 1.1 skrll bool
698 1.1 skrll cancel_delayed_work(struct delayed_work *dw)
699 1.1 skrll {
700 1.1 skrll bool cancelled_p = false;
701 1.1 skrll
702 1.1 skrll linux_work_lock(&dw->work);
703 1.1 skrll switch (dw->work.w_state) {
704 1.1 skrll case WORK_IDLE: /* Nothing to do. */
705 1.1 skrll break;
706 1.1 skrll
707 1.1 skrll case WORK_DELAYED:
708 1.1 skrll dw->work.w_state = WORK_DELAYED_CANCELLED;
709 1.1 skrll linux_cancel_delayed_work_callout(dw, false);
710 1.1 skrll cancelled_p = true;
711 1.1 skrll break;
712 1.1 skrll
713 1.1 skrll case WORK_PENDING:
714 1.1 skrll dw->work.w_state = WORK_CANCELLED;
715 1.1 skrll cancelled_p = true;
716 1.1 skrll break;
717 1.1 skrll
718 1.1 skrll case WORK_INVOKED: /* Don't wait! */
719 1.1 skrll break;
720 1.1 skrll
721 1.1 skrll case WORK_CANCELLED: /* Already done. */
722 1.1 skrll case WORK_DELAYED_CANCELLED:
723 1.1 skrll break;
724 1.1 skrll
725 1.1 skrll default:
726 1.1 skrll panic("delayed work %p in bad state: %d", dw,
727 1.1 skrll (int)dw->work.w_state);
728 1.1 skrll break;
729 1.1 skrll }
730 1.1 skrll linux_work_unlock(&dw->work);
731 1.1 skrll
732 1.1 skrll return cancelled_p;
733 1.1 skrll }
734 1.1 skrll
735 1.1 skrll bool
736 1.1 skrll cancel_delayed_work_sync(struct delayed_work *dw)
737 1.1 skrll {
738 1.1 skrll bool cancelled_p = false;
739 1.1 skrll
740 1.1 skrll linux_work_lock(&dw->work);
741 1.1 skrll switch (dw->work.w_state) {
742 1.1 skrll case WORK_IDLE: /* Nothing to do. */
743 1.1 skrll break;
744 1.1 skrll
745 1.1 skrll case WORK_DELAYED:
746 1.1 skrll dw->work.w_state = WORK_DELAYED_CANCELLED;
747 1.1 skrll linux_cancel_delayed_work_callout(dw, true);
748 1.1 skrll cancelled_p = true;
749 1.1 skrll break;
750 1.1 skrll
751 1.1 skrll case WORK_PENDING:
752 1.1 skrll dw->work.w_state = WORK_CANCELLED;
753 1.1 skrll linux_wait_for_cancelled_work(&dw->work);
754 1.1 skrll cancelled_p = true;
755 1.1 skrll break;
756 1.1 skrll
757 1.1 skrll case WORK_INVOKED:
758 1.1 skrll linux_wait_for_invoked_work(&dw->work);
759 1.1 skrll break;
760 1.1 skrll
761 1.1 skrll case WORK_CANCELLED: /* Already done. */
762 1.1 skrll break;
763 1.1 skrll
764 1.1 skrll case WORK_DELAYED_CANCELLED:
765 1.1 skrll linux_wait_for_delayed_cancelled_work(dw);
766 1.1 skrll break;
767 1.1 skrll
768 1.1 skrll default:
769 1.1 skrll panic("delayed work %p in bad state: %d", dw,
770 1.1 skrll (int)dw->work.w_state);
771 1.1 skrll break;
772 1.1 skrll }
773 1.1 skrll linux_work_unlock(&dw->work);
774 1.1 skrll
775 1.1 skrll return cancelled_p;
776 1.1 skrll }
777 1.1 skrll
778 1.1 skrll static void
779 1.1 skrll linux_cancel_delayed_work_callout(struct delayed_work *dw, bool wait)
780 1.1 skrll {
781 1.1 skrll bool fired_p;
782 1.1 skrll
783 1.1 skrll KASSERT(linux_work_locked(&dw->work));
784 1.1 skrll KASSERT(dw->work.w_state == WORK_DELAYED_CANCELLED);
785 1.1 skrll
786 1.1 skrll if (wait) {
787 1.1 skrll /*
788 1.1 skrll * We unlock, halt, and then relock, rather than
789 1.1 skrll * passing an interlock to callout_halt, for two
790 1.1 skrll * reasons:
791 1.1 skrll *
792 1.1 skrll * (1) The work lock is not a mutex(9), so we can't use it.
793 1.1 skrll * (2) The WORK_DELAYED_CANCELLED state serves as an interlock.
794 1.1 skrll */
795 1.1 skrll linux_work_unlock(&dw->work);
796 1.1 skrll fired_p = callout_halt(&dw->dw_callout, NULL);
797 1.1 skrll linux_work_lock(&dw->work);
798 1.1 skrll } else {
799 1.1 skrll fired_p = callout_stop(&dw->dw_callout);
800 1.1 skrll }
801 1.1 skrll
802 1.1 skrll /*
803 1.1 skrll * fired_p means we didn't cancel the callout, so it must have
804 1.1 skrll * already begun and will clean up after itself.
805 1.1 skrll *
806 1.1 skrll * !fired_p means we cancelled it so we have to clean up after
807 1.1 skrll * it. Nobody else should have changed the state in that case.
808 1.1 skrll */
809 1.1 skrll if (!fired_p) {
810 1.1 skrll struct workqueue_struct *wq;
811 1.1 skrll
812 1.1 skrll KASSERT(linux_work_locked(&dw->work));
813 1.1 skrll KASSERT(dw->work.w_state == WORK_DELAYED_CANCELLED);
814 1.1 skrll
815 1.1 skrll wq = dw->work.w_wq;
816 1.1 skrll mutex_enter(&wq->wq_lock);
817 1.1 skrll TAILQ_REMOVE(&wq->wq_delayed, dw, dw_entry);
818 1.1 skrll callout_destroy(&dw->dw_callout);
819 1.1 skrll dw->work.w_state = WORK_IDLE;
820 1.1 skrll dw->work.w_wq = NULL;
821 1.1 skrll cv_broadcast(&wq->wq_cv);
822 1.1 skrll mutex_exit(&wq->wq_lock);
823 1.1 skrll }
824 1.1 skrll }
825 1.1 skrll
826 1.1 skrll static void
827 1.1 skrll linux_wait_for_delayed_cancelled_work(struct delayed_work *dw)
828 1.1 skrll {
829 1.1 skrll struct workqueue_struct *wq;
830 1.1 skrll
831 1.1 skrll KASSERT(linux_work_locked(&dw->work));
832 1.1 skrll KASSERT(dw->work.w_state == WORK_DELAYED_CANCELLED);
833 1.1 skrll
834 1.1 skrll wq = dw->work.w_wq;
835 1.1 skrll do {
836 1.1 skrll mutex_enter(&wq->wq_lock);
837 1.1 skrll linux_work_unlock(&dw->work);
838 1.1 skrll cv_wait(&wq->wq_cv, &wq->wq_lock);
839 1.1 skrll mutex_exit(&wq->wq_lock);
840 1.1 skrll linux_work_lock(&dw->work);
841 1.1 skrll } while ((dw->work.w_state == WORK_DELAYED_CANCELLED) &&
842 1.1 skrll (dw->work.w_wq == wq));
843 1.1 skrll }
844 1.1 skrll
845 1.1 skrll static void
846 1.1 skrll linux_worker_intr(void *arg)
847 1.1 skrll {
848 1.1 skrll struct delayed_work *dw = arg;
849 1.1 skrll struct workqueue_struct *wq;
850 1.1 skrll
851 1.1 skrll linux_work_lock(&dw->work);
852 1.1 skrll
853 1.1 skrll KASSERT((dw->work.w_state == WORK_DELAYED) ||
854 1.1 skrll (dw->work.w_state == WORK_DELAYED_CANCELLED));
855 1.1 skrll
856 1.1 skrll wq = dw->work.w_wq;
857 1.1 skrll mutex_enter(&wq->wq_lock);
858 1.1 skrll
859 1.1 skrll /* Queue the work, or return it to idle and alert any cancellers. */
860 1.1 skrll if (__predict_true(dw->work.w_state == WORK_DELAYED)) {
861 1.1 skrll dw->work.w_state = WORK_PENDING;
862 1.1 skrll workqueue_enqueue(dw->work.w_wq->wq_workqueue, &dw->work.w_wk,
863 1.1 skrll NULL);
864 1.1 skrll } else {
865 1.1 skrll KASSERT(dw->work.w_state == WORK_DELAYED_CANCELLED);
866 1.1 skrll dw->work.w_state = WORK_IDLE;
867 1.1 skrll dw->work.w_wq = NULL;
868 1.1 skrll cv_broadcast(&wq->wq_cv);
869 1.1 skrll }
870 1.1 skrll
871 1.1 skrll /* Either way, the callout is done. */
872 1.1 skrll TAILQ_REMOVE(&wq->wq_delayed, dw, dw_entry);
873 callout_destroy(&dw->dw_callout);
874
875 mutex_exit(&wq->wq_lock);
876 linux_work_unlock(&dw->work);
877 }
878