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