]> Git Repo - linux.git/blame - fs/io-wq.c
af_unix: Add OOB support
[linux.git] / fs / io-wq.c
CommitLineData
771b53d0
JA
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Basic worker thread pool for io_uring
4 *
5 * Copyright (C) 2019 Jens Axboe
6 *
7 */
8#include <linux/kernel.h>
9#include <linux/init.h>
10#include <linux/errno.h>
11#include <linux/sched/signal.h>
771b53d0
JA
12#include <linux/percpu.h>
13#include <linux/slab.h>
771b53d0 14#include <linux/rculist_nulls.h>
43c01fbe 15#include <linux/cpu.h>
3bfe6106 16#include <linux/tracehook.h>
771b53d0
JA
17
18#include "io-wq.h"
19
20#define WORKER_IDLE_TIMEOUT (5 * HZ)
21
22enum {
23 IO_WORKER_F_UP = 1, /* up and active */
24 IO_WORKER_F_RUNNING = 2, /* account as running */
25 IO_WORKER_F_FREE = 4, /* worker on free list */
145cc8c6
JA
26 IO_WORKER_F_FIXED = 8, /* static idle worker */
27 IO_WORKER_F_BOUND = 16, /* is doing bounded work */
771b53d0
JA
28};
29
30enum {
31 IO_WQ_BIT_EXIT = 0, /* wq exiting */
771b53d0
JA
32};
33
34enum {
35 IO_WQE_FLAG_STALLED = 1, /* stalled on hash */
36};
37
38/*
39 * One for each thread in a wqe pool
40 */
41struct io_worker {
42 refcount_t ref;
43 unsigned flags;
44 struct hlist_nulls_node nulls_node;
e61df66c 45 struct list_head all_list;
771b53d0 46 struct task_struct *task;
771b53d0 47 struct io_wqe *wqe;
36c2f922 48
771b53d0 49 struct io_wq_work *cur_work;
36c2f922 50 spinlock_t lock;
771b53d0 51
eb2de941
JA
52 struct completion ref_done;
53
771b53d0 54 struct rcu_head rcu;
771b53d0
JA
55};
56
771b53d0
JA
57#if BITS_PER_LONG == 64
58#define IO_WQ_HASH_ORDER 6
59#else
60#define IO_WQ_HASH_ORDER 5
61#endif
62
86f3cd1b
PB
63#define IO_WQ_NR_HASH_BUCKETS (1u << IO_WQ_HASH_ORDER)
64
c5def4ab
JA
65struct io_wqe_acct {
66 unsigned nr_workers;
67 unsigned max_workers;
685fe7fe 68 int index;
c5def4ab
JA
69 atomic_t nr_running;
70};
71
72enum {
73 IO_WQ_ACCT_BOUND,
74 IO_WQ_ACCT_UNBOUND,
75};
76
771b53d0
JA
77/*
78 * Per-node worker thread pool
79 */
80struct io_wqe {
81 struct {
95da8465 82 raw_spinlock_t lock;
6206f0e1 83 struct io_wq_work_list work_list;
771b53d0
JA
84 unsigned flags;
85 } ____cacheline_aligned_in_smp;
86
87 int node;
c5def4ab 88 struct io_wqe_acct acct[2];
771b53d0 89
021d1cdd 90 struct hlist_nulls_head free_list;
e61df66c 91 struct list_head all_list;
771b53d0 92
e941894e
JA
93 struct wait_queue_entry wait;
94
771b53d0 95 struct io_wq *wq;
86f3cd1b 96 struct io_wq_work *hash_tail[IO_WQ_NR_HASH_BUCKETS];
0e03496d
JA
97
98 cpumask_var_t cpu_mask;
771b53d0
JA
99};
100
101/*
102 * Per io_wq state
103 */
104struct io_wq {
771b53d0 105 unsigned long state;
771b53d0 106
e9fd9396 107 free_work_fn *free_work;
f5fa38c5 108 io_wq_work_fn *do_work;
7d723065 109
e941894e
JA
110 struct io_wq_hash *hash;
111
fb3a1f6c
JA
112 atomic_t worker_refs;
113 struct completion worker_done;
114
43c01fbe 115 struct hlist_node cpuhp_node;
3bfe6106 116
685fe7fe 117 struct task_struct *task;
c7f405d6
PB
118
119 struct io_wqe *wqes[];
771b53d0
JA
120};
121
43c01fbe
JA
122static enum cpuhp_state io_wq_online;
123
f0127254
JA
124struct io_cb_cancel_data {
125 work_cancel_fn *fn;
126 void *data;
127 int nr_running;
128 int nr_pending;
129 bool cancel_all;
130};
131
685fe7fe 132static void create_io_worker(struct io_wq *wq, struct io_wqe *wqe, int index);
f0127254 133
771b53d0
JA
134static bool io_worker_get(struct io_worker *worker)
135{
136 return refcount_inc_not_zero(&worker->ref);
137}
138
139static void io_worker_release(struct io_worker *worker)
140{
141 if (refcount_dec_and_test(&worker->ref))
eb2de941 142 complete(&worker->ref_done);
771b53d0
JA
143}
144
8418f22a
PB
145static inline struct io_wqe_acct *io_get_acct(struct io_wqe *wqe, bool bound)
146{
147 return &wqe->acct[bound ? IO_WQ_ACCT_BOUND : IO_WQ_ACCT_UNBOUND];
148}
149
c5def4ab
JA
150static inline struct io_wqe_acct *io_work_get_acct(struct io_wqe *wqe,
151 struct io_wq_work *work)
152{
8418f22a 153 return io_get_acct(wqe, !(work->flags & IO_WQ_WORK_UNBOUND));
c5def4ab
JA
154}
155
958234d5 156static inline struct io_wqe_acct *io_wqe_get_acct(struct io_worker *worker)
c5def4ab 157{
8418f22a 158 return io_get_acct(worker->wqe, worker->flags & IO_WORKER_F_BOUND);
c5def4ab
JA
159}
160
685fe7fe
JA
161static void io_worker_ref_put(struct io_wq *wq)
162{
163 if (atomic_dec_and_test(&wq->worker_refs))
164 complete(&wq->worker_done);
165}
166
771b53d0
JA
167static void io_worker_exit(struct io_worker *worker)
168{
169 struct io_wqe *wqe = worker->wqe;
958234d5 170 struct io_wqe_acct *acct = io_wqe_get_acct(worker);
bf1daa4b 171 unsigned flags;
771b53d0 172
eb2de941
JA
173 if (refcount_dec_and_test(&worker->ref))
174 complete(&worker->ref_done);
175 wait_for_completion(&worker->ref_done);
771b53d0
JA
176
177 preempt_disable();
178 current->flags &= ~PF_IO_WORKER;
bf1daa4b
JA
179 flags = worker->flags;
180 worker->flags = 0;
181 if (flags & IO_WORKER_F_RUNNING)
c5def4ab 182 atomic_dec(&acct->nr_running);
771b53d0
JA
183 worker->flags = 0;
184 preempt_enable();
185
95da8465 186 raw_spin_lock_irq(&wqe->lock);
bf1daa4b
JA
187 if (flags & IO_WORKER_F_FREE)
188 hlist_nulls_del_rcu(&worker->nulls_node);
e61df66c 189 list_del_rcu(&worker->all_list);
c5def4ab 190 acct->nr_workers--;
95da8465 191 raw_spin_unlock_irq(&wqe->lock);
771b53d0 192
364b05fd 193 kfree_rcu(worker, rcu);
685fe7fe 194 io_worker_ref_put(wqe->wq);
46fe18b1 195 do_exit(0);
771b53d0
JA
196}
197
c5def4ab
JA
198static inline bool io_wqe_run_queue(struct io_wqe *wqe)
199 __must_hold(wqe->lock)
200{
6206f0e1
JA
201 if (!wq_list_empty(&wqe->work_list) &&
202 !(wqe->flags & IO_WQE_FLAG_STALLED))
c5def4ab
JA
203 return true;
204 return false;
205}
206
207/*
208 * Check head of free list for an available worker. If one isn't available,
685fe7fe 209 * caller must create one.
c5def4ab
JA
210 */
211static bool io_wqe_activate_free_worker(struct io_wqe *wqe)
212 __must_hold(RCU)
213{
214 struct hlist_nulls_node *n;
215 struct io_worker *worker;
216
021d1cdd 217 n = rcu_dereference(hlist_nulls_first_rcu(&wqe->free_list));
c5def4ab
JA
218 if (is_a_nulls(n))
219 return false;
220
221 worker = hlist_nulls_entry(n, struct io_worker, nulls_node);
222 if (io_worker_get(worker)) {
506d95ff 223 wake_up_process(worker->task);
c5def4ab
JA
224 io_worker_release(worker);
225 return true;
226 }
227
228 return false;
229}
230
231/*
232 * We need a worker. If we find a free one, we're good. If not, and we're
685fe7fe 233 * below the max number of workers, create one.
c5def4ab
JA
234 */
235static void io_wqe_wake_worker(struct io_wqe *wqe, struct io_wqe_acct *acct)
236{
237 bool ret;
238
239 /*
240 * Most likely an attempt to queue unbounded work on an io_wq that
241 * wasn't setup with any unbounded workers.
242 */
e6ab8991
PB
243 if (unlikely(!acct->max_workers))
244 pr_warn_once("io-wq is not configured for unbound workers");
c5def4ab
JA
245
246 rcu_read_lock();
247 ret = io_wqe_activate_free_worker(wqe);
248 rcu_read_unlock();
249
685fe7fe
JA
250 if (!ret && acct->nr_workers < acct->max_workers) {
251 atomic_inc(&acct->nr_running);
252 atomic_inc(&wqe->wq->worker_refs);
253 create_io_worker(wqe->wq, wqe, acct->index);
254 }
c5def4ab
JA
255}
256
958234d5 257static void io_wqe_inc_running(struct io_worker *worker)
c5def4ab 258{
958234d5 259 struct io_wqe_acct *acct = io_wqe_get_acct(worker);
c5def4ab
JA
260
261 atomic_inc(&acct->nr_running);
262}
263
685fe7fe
JA
264struct create_worker_data {
265 struct callback_head work;
266 struct io_wqe *wqe;
267 int index;
268};
269
270static void create_worker_cb(struct callback_head *cb)
271{
272 struct create_worker_data *cwd;
273 struct io_wq *wq;
274
275 cwd = container_of(cb, struct create_worker_data, work);
276 wq = cwd->wqe->wq;
277 create_io_worker(wq, cwd->wqe, cwd->index);
278 kfree(cwd);
279}
280
281static void io_queue_worker_create(struct io_wqe *wqe, struct io_wqe_acct *acct)
282{
283 struct create_worker_data *cwd;
284 struct io_wq *wq = wqe->wq;
285
286 /* raced with exit, just ignore create call */
287 if (test_bit(IO_WQ_BIT_EXIT, &wq->state))
288 goto fail;
289
290 cwd = kmalloc(sizeof(*cwd), GFP_ATOMIC);
291 if (cwd) {
292 init_task_work(&cwd->work, create_worker_cb);
293 cwd->wqe = wqe;
294 cwd->index = acct->index;
295 if (!task_work_add(wq->task, &cwd->work, TWA_SIGNAL))
296 return;
297
298 kfree(cwd);
299 }
300fail:
301 atomic_dec(&acct->nr_running);
302 io_worker_ref_put(wq);
303}
304
958234d5 305static void io_wqe_dec_running(struct io_worker *worker)
c5def4ab
JA
306 __must_hold(wqe->lock)
307{
958234d5
JA
308 struct io_wqe_acct *acct = io_wqe_get_acct(worker);
309 struct io_wqe *wqe = worker->wqe;
c5def4ab 310
685fe7fe
JA
311 if (!(worker->flags & IO_WORKER_F_UP))
312 return;
313
314 if (atomic_dec_and_test(&acct->nr_running) && io_wqe_run_queue(wqe)) {
315 atomic_inc(&acct->nr_running);
316 atomic_inc(&wqe->wq->worker_refs);
317 io_queue_worker_create(wqe, acct);
318 }
c5def4ab
JA
319}
320
771b53d0
JA
321/*
322 * Worker will start processing some work. Move it to the busy list, if
323 * it's currently on the freelist
324 */
325static void __io_worker_busy(struct io_wqe *wqe, struct io_worker *worker,
326 struct io_wq_work *work)
327 __must_hold(wqe->lock)
328{
c5def4ab
JA
329 bool worker_bound, work_bound;
330
417b5052
HX
331 BUILD_BUG_ON((IO_WQ_ACCT_UNBOUND ^ IO_WQ_ACCT_BOUND) != 1);
332
771b53d0
JA
333 if (worker->flags & IO_WORKER_F_FREE) {
334 worker->flags &= ~IO_WORKER_F_FREE;
335 hlist_nulls_del_init_rcu(&worker->nulls_node);
771b53d0 336 }
c5def4ab
JA
337
338 /*
339 * If worker is moving from bound to unbound (or vice versa), then
340 * ensure we update the running accounting.
341 */
b2e9c7d6
DC
342 worker_bound = (worker->flags & IO_WORKER_F_BOUND) != 0;
343 work_bound = (work->flags & IO_WQ_WORK_UNBOUND) == 0;
344 if (worker_bound != work_bound) {
417b5052 345 int index = work_bound ? IO_WQ_ACCT_UNBOUND : IO_WQ_ACCT_BOUND;
958234d5 346 io_wqe_dec_running(worker);
417b5052
HX
347 worker->flags ^= IO_WORKER_F_BOUND;
348 wqe->acct[index].nr_workers--;
349 wqe->acct[index ^ 1].nr_workers++;
958234d5 350 io_wqe_inc_running(worker);
c5def4ab 351 }
771b53d0
JA
352}
353
354/*
355 * No work, worker going to sleep. Move to freelist, and unuse mm if we
356 * have one attached. Dropping the mm may potentially sleep, so we drop
357 * the lock in that case and return success. Since the caller has to
358 * retry the loop in that case (we changed task state), we don't regrab
359 * the lock if we return success.
360 */
c6d77d92 361static void __io_worker_idle(struct io_wqe *wqe, struct io_worker *worker)
771b53d0
JA
362 __must_hold(wqe->lock)
363{
364 if (!(worker->flags & IO_WORKER_F_FREE)) {
365 worker->flags |= IO_WORKER_F_FREE;
021d1cdd 366 hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
771b53d0 367 }
771b53d0
JA
368}
369
60cf46ae
PB
370static inline unsigned int io_get_work_hash(struct io_wq_work *work)
371{
372 return work->flags >> IO_WQ_HASH_SHIFT;
373}
374
e941894e
JA
375static void io_wait_on_hash(struct io_wqe *wqe, unsigned int hash)
376{
377 struct io_wq *wq = wqe->wq;
378
379 spin_lock(&wq->hash->wait.lock);
380 if (list_empty(&wqe->wait.entry)) {
381 __add_wait_queue(&wq->hash->wait, &wqe->wait);
382 if (!test_bit(hash, &wq->hash->map)) {
383 __set_current_state(TASK_RUNNING);
384 list_del_init(&wqe->wait.entry);
385 }
386 }
387 spin_unlock(&wq->hash->wait.lock);
388}
389
60cf46ae 390static struct io_wq_work *io_get_next_work(struct io_wqe *wqe)
771b53d0
JA
391 __must_hold(wqe->lock)
392{
6206f0e1 393 struct io_wq_work_node *node, *prev;
86f3cd1b 394 struct io_wq_work *work, *tail;
e941894e 395 unsigned int stall_hash = -1U;
771b53d0 396
6206f0e1 397 wq_list_for_each(node, prev, &wqe->work_list) {
e941894e
JA
398 unsigned int hash;
399
6206f0e1
JA
400 work = container_of(node, struct io_wq_work, list);
401
771b53d0 402 /* not hashed, can run anytime */
8766dd51 403 if (!io_wq_is_hashed(work)) {
86f3cd1b 404 wq_list_del(&wqe->work_list, node, prev);
771b53d0
JA
405 return work;
406 }
407
60cf46ae 408 hash = io_get_work_hash(work);
e941894e
JA
409 /* all items with this hash lie in [work, tail] */
410 tail = wqe->hash_tail[hash];
411
412 /* hashed, can run if not already running */
413 if (!test_and_set_bit(hash, &wqe->wq->hash->map)) {
86f3cd1b
PB
414 wqe->hash_tail[hash] = NULL;
415 wq_list_cut(&wqe->work_list, &tail->list, prev);
771b53d0
JA
416 return work;
417 }
e941894e
JA
418 if (stall_hash == -1U)
419 stall_hash = hash;
420 /* fast forward to a next hash, for-each will fix up @prev */
421 node = &tail->list;
422 }
423
424 if (stall_hash != -1U) {
425 raw_spin_unlock(&wqe->lock);
426 io_wait_on_hash(wqe, stall_hash);
427 raw_spin_lock(&wqe->lock);
771b53d0
JA
428 }
429
430 return NULL;
431}
432
00ddff43 433static bool io_flush_signals(void)
cccf0ee8 434{
0b8cfa97 435 if (unlikely(test_thread_flag(TIF_NOTIFY_SIGNAL))) {
00ddff43 436 __set_current_state(TASK_RUNNING);
0b8cfa97 437 tracehook_notify_signal();
00ddff43 438 return true;
cccf0ee8 439 }
00ddff43 440 return false;
dc026a73
PB
441}
442
443static void io_assign_current_work(struct io_worker *worker,
444 struct io_wq_work *work)
445{
d78298e7 446 if (work) {
3bfe6106 447 io_flush_signals();
d78298e7
PB
448 cond_resched();
449 }
dc026a73
PB
450
451 spin_lock_irq(&worker->lock);
452 worker->cur_work = work;
453 spin_unlock_irq(&worker->lock);
454}
455
60cf46ae
PB
456static void io_wqe_enqueue(struct io_wqe *wqe, struct io_wq_work *work);
457
771b53d0
JA
458static void io_worker_handle_work(struct io_worker *worker)
459 __releases(wqe->lock)
460{
771b53d0
JA
461 struct io_wqe *wqe = worker->wqe;
462 struct io_wq *wq = wqe->wq;
c60eb049 463 bool do_kill = test_bit(IO_WQ_BIT_EXIT, &wq->state);
771b53d0
JA
464
465 do {
86f3cd1b 466 struct io_wq_work *work;
f462fd36 467get_next:
771b53d0
JA
468 /*
469 * If we got some work, mark us as busy. If we didn't, but
470 * the list isn't empty, it means we stalled on hashed work.
471 * Mark us stalled so we don't keep looking for work when we
472 * can't make progress, any work completion or insertion will
473 * clear the stalled flag.
474 */
60cf46ae 475 work = io_get_next_work(wqe);
771b53d0
JA
476 if (work)
477 __io_worker_busy(wqe, worker, work);
6206f0e1 478 else if (!wq_list_empty(&wqe->work_list))
771b53d0
JA
479 wqe->flags |= IO_WQE_FLAG_STALLED;
480
95da8465 481 raw_spin_unlock_irq(&wqe->lock);
771b53d0
JA
482 if (!work)
483 break;
58e39319 484 io_assign_current_work(worker, work);
e941894e 485 __set_current_state(TASK_RUNNING);
36c2f922 486
dc026a73
PB
487 /* handle a whole dependent link */
488 do {
5280f7e5 489 struct io_wq_work *next_hashed, *linked;
b089ed39 490 unsigned int hash = io_get_work_hash(work);
dc026a73 491
86f3cd1b 492 next_hashed = wq_next_work(work);
c60eb049
PB
493
494 if (unlikely(do_kill) && (work->flags & IO_WQ_WORK_UNBOUND))
495 work->flags |= IO_WQ_WORK_CANCEL;
5280f7e5
PB
496 wq->do_work(work);
497 io_assign_current_work(worker, NULL);
dc026a73 498
5280f7e5 499 linked = wq->free_work(work);
86f3cd1b
PB
500 work = next_hashed;
501 if (!work && linked && !io_wq_is_hashed(linked)) {
502 work = linked;
503 linked = NULL;
504 }
505 io_assign_current_work(worker, work);
86f3cd1b
PB
506 if (linked)
507 io_wqe_enqueue(wqe, linked);
508
509 if (hash != -1U && !next_hashed) {
e941894e
JA
510 clear_bit(hash, &wq->hash->map);
511 if (wq_has_sleeper(&wq->hash->wait))
512 wake_up(&wq->hash->wait);
95da8465 513 raw_spin_lock_irq(&wqe->lock);
dc026a73 514 wqe->flags &= ~IO_WQE_FLAG_STALLED;
f462fd36
PB
515 /* skip unnecessary unlock-lock wqe->lock */
516 if (!work)
517 goto get_next;
95da8465 518 raw_spin_unlock_irq(&wqe->lock);
7d723065 519 }
58e39319 520 } while (work);
7d723065 521
95da8465 522 raw_spin_lock_irq(&wqe->lock);
771b53d0
JA
523 } while (1);
524}
525
771b53d0
JA
526static int io_wqe_worker(void *data)
527{
528 struct io_worker *worker = data;
529 struct io_wqe *wqe = worker->wqe;
530 struct io_wq *wq = wqe->wq;
46fe18b1 531 char buf[TASK_COMM_LEN];
771b53d0 532
46fe18b1 533 worker->flags |= (IO_WORKER_F_UP | IO_WORKER_F_RUNNING);
46fe18b1 534
685fe7fe 535 snprintf(buf, sizeof(buf), "iou-wrk-%d", wq->task->pid);
46fe18b1 536 set_task_comm(current, buf);
771b53d0
JA
537
538 while (!test_bit(IO_WQ_BIT_EXIT, &wq->state)) {
16efa4fc
JA
539 long ret;
540
506d95ff 541 set_current_state(TASK_INTERRUPTIBLE);
e995d512 542loop:
95da8465 543 raw_spin_lock_irq(&wqe->lock);
771b53d0 544 if (io_wqe_run_queue(wqe)) {
771b53d0 545 io_worker_handle_work(worker);
e995d512 546 goto loop;
771b53d0 547 }
c6d77d92 548 __io_worker_idle(wqe, worker);
95da8465 549 raw_spin_unlock_irq(&wqe->lock);
00ddff43
JA
550 if (io_flush_signals())
551 continue;
16efa4fc 552 ret = schedule_timeout(WORKER_IDLE_TIMEOUT);
dbe1bdbb
JA
553 if (signal_pending(current)) {
554 struct ksignal ksig;
555
556 if (!get_signal(&ksig))
557 continue;
3bfe6106 558 break;
dbe1bdbb
JA
559 }
560 if (ret)
561 continue;
771b53d0 562 /* timed out, exit unless we're the fixed worker */
769e6837 563 if (!(worker->flags & IO_WORKER_F_FIXED))
771b53d0
JA
564 break;
565 }
566
771b53d0 567 if (test_bit(IO_WQ_BIT_EXIT, &wq->state)) {
95da8465 568 raw_spin_lock_irq(&wqe->lock);
e587227b 569 io_worker_handle_work(worker);
771b53d0
JA
570 }
571
572 io_worker_exit(worker);
573 return 0;
574}
575
771b53d0
JA
576/*
577 * Called when a worker is scheduled in. Mark us as currently running.
578 */
579void io_wq_worker_running(struct task_struct *tsk)
580{
3bfe6106 581 struct io_worker *worker = tsk->pf_io_worker;
771b53d0 582
3bfe6106
JA
583 if (!worker)
584 return;
771b53d0
JA
585 if (!(worker->flags & IO_WORKER_F_UP))
586 return;
587 if (worker->flags & IO_WORKER_F_RUNNING)
588 return;
589 worker->flags |= IO_WORKER_F_RUNNING;
958234d5 590 io_wqe_inc_running(worker);
771b53d0
JA
591}
592
593/*
594 * Called when worker is going to sleep. If there are no workers currently
685fe7fe 595 * running and we have work pending, wake up a free one or create a new one.
771b53d0
JA
596 */
597void io_wq_worker_sleeping(struct task_struct *tsk)
598{
3bfe6106 599 struct io_worker *worker = tsk->pf_io_worker;
771b53d0 600
3bfe6106
JA
601 if (!worker)
602 return;
771b53d0
JA
603 if (!(worker->flags & IO_WORKER_F_UP))
604 return;
605 if (!(worker->flags & IO_WORKER_F_RUNNING))
606 return;
607
608 worker->flags &= ~IO_WORKER_F_RUNNING;
609
3bfe6106 610 raw_spin_lock_irq(&worker->wqe->lock);
958234d5 611 io_wqe_dec_running(worker);
3bfe6106 612 raw_spin_unlock_irq(&worker->wqe->lock);
771b53d0
JA
613}
614
685fe7fe 615static void create_io_worker(struct io_wq *wq, struct io_wqe *wqe, int index)
3bfe6106 616{
46fe18b1 617 struct io_wqe_acct *acct = &wqe->acct[index];
3bfe6106 618 struct io_worker *worker;
46fe18b1 619 struct task_struct *tsk;
3bfe6106 620
8b3e78b5
JA
621 __set_current_state(TASK_RUNNING);
622
3bfe6106
JA
623 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, wqe->node);
624 if (!worker)
685fe7fe 625 goto fail;
3bfe6106
JA
626
627 refcount_set(&worker->ref, 1);
628 worker->nulls_node.pprev = NULL;
629 worker->wqe = wqe;
630 spin_lock_init(&worker->lock);
eb2de941 631 init_completion(&worker->ref_done);
3bfe6106 632
46fe18b1
JA
633 tsk = create_io_thread(io_wqe_worker, worker, wqe->node);
634 if (IS_ERR(tsk)) {
3bfe6106 635 kfree(worker);
685fe7fe
JA
636fail:
637 atomic_dec(&acct->nr_running);
638 io_worker_ref_put(wq);
639 return;
3bfe6106 640 }
46fe18b1
JA
641
642 tsk->pf_io_worker = worker;
643 worker->task = tsk;
0e03496d 644 set_cpus_allowed_ptr(tsk, wqe->cpu_mask);
e22bc9b4 645 tsk->flags |= PF_NO_SETAFFINITY;
46fe18b1
JA
646
647 raw_spin_lock_irq(&wqe->lock);
648 hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
649 list_add_tail_rcu(&worker->all_list, &wqe->all_list);
650 worker->flags |= IO_WORKER_F_FREE;
651 if (index == IO_WQ_ACCT_BOUND)
652 worker->flags |= IO_WORKER_F_BOUND;
653 if (!acct->nr_workers && (worker->flags & IO_WORKER_F_BOUND))
654 worker->flags |= IO_WORKER_F_FIXED;
655 acct->nr_workers++;
656 raw_spin_unlock_irq(&wqe->lock);
657 wake_up_new_task(tsk);
771b53d0
JA
658}
659
c4068bf8
HD
660/*
661 * Iterate the passed in list and call the specific function for each
662 * worker that isn't exiting
663 */
664static bool io_wq_for_each_worker(struct io_wqe *wqe,
665 bool (*func)(struct io_worker *, void *),
666 void *data)
667{
668 struct io_worker *worker;
669 bool ret = false;
670
671 list_for_each_entry_rcu(worker, &wqe->all_list, all_list) {
672 if (io_worker_get(worker)) {
673 /* no task if node is/was offline */
674 if (worker->task)
675 ret = func(worker, data);
676 io_worker_release(worker);
677 if (ret)
678 break;
679 }
680 }
681
682 return ret;
683}
684
685static bool io_wq_worker_wake(struct io_worker *worker, void *data)
686{
46fe18b1 687 set_notify_signal(worker->task);
c4068bf8
HD
688 wake_up_process(worker->task);
689 return false;
690}
691
f0127254
JA
692static bool io_wq_work_match_all(struct io_wq_work *work, void *data)
693{
694 return true;
695}
696
e9fd9396 697static void io_run_cancel(struct io_wq_work *work, struct io_wqe *wqe)
fc04c39b 698{
e9fd9396
PB
699 struct io_wq *wq = wqe->wq;
700
fc04c39b 701 do {
fc04c39b 702 work->flags |= IO_WQ_WORK_CANCEL;
5280f7e5
PB
703 wq->do_work(work);
704 work = wq->free_work(work);
fc04c39b
PB
705 } while (work);
706}
707
86f3cd1b
PB
708static void io_wqe_insert_work(struct io_wqe *wqe, struct io_wq_work *work)
709{
710 unsigned int hash;
711 struct io_wq_work *tail;
712
713 if (!io_wq_is_hashed(work)) {
714append:
715 wq_list_add_tail(&work->list, &wqe->work_list);
716 return;
717 }
718
719 hash = io_get_work_hash(work);
720 tail = wqe->hash_tail[hash];
721 wqe->hash_tail[hash] = work;
722 if (!tail)
723 goto append;
724
725 wq_list_add_after(&work->list, &tail->list, &wqe->work_list);
726}
727
771b53d0
JA
728static void io_wqe_enqueue(struct io_wqe *wqe, struct io_wq_work *work)
729{
c5def4ab 730 struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
895e2ca0 731 int work_flags;
771b53d0
JA
732 unsigned long flags;
733
991468dc
JA
734 /*
735 * If io-wq is exiting for this task, or if the request has explicitly
736 * been marked as one that should not get executed, cancel it here.
737 */
738 if (test_bit(IO_WQ_BIT_EXIT, &wqe->wq->state) ||
739 (work->flags & IO_WQ_WORK_CANCEL)) {
70e35125 740 io_run_cancel(work, wqe);
4fb6ac32
JA
741 return;
742 }
743
895e2ca0 744 work_flags = work->flags;
95da8465 745 raw_spin_lock_irqsave(&wqe->lock, flags);
86f3cd1b 746 io_wqe_insert_work(wqe, work);
771b53d0 747 wqe->flags &= ~IO_WQE_FLAG_STALLED;
95da8465 748 raw_spin_unlock_irqrestore(&wqe->lock, flags);
771b53d0 749
895e2ca0
JA
750 if ((work_flags & IO_WQ_WORK_CONCURRENT) ||
751 !atomic_read(&acct->nr_running))
c5def4ab 752 io_wqe_wake_worker(wqe, acct);
771b53d0
JA
753}
754
755void io_wq_enqueue(struct io_wq *wq, struct io_wq_work *work)
756{
757 struct io_wqe *wqe = wq->wqes[numa_node_id()];
758
759 io_wqe_enqueue(wqe, work);
760}
761
762/*
8766dd51
PB
763 * Work items that hash to the same value will not be done in parallel.
764 * Used to limit concurrent writes, generally hashed by inode.
771b53d0 765 */
8766dd51 766void io_wq_hash_work(struct io_wq_work *work, void *val)
771b53d0 767{
8766dd51 768 unsigned int bit;
771b53d0
JA
769
770 bit = hash_ptr(val, IO_WQ_HASH_ORDER);
771 work->flags |= (IO_WQ_WORK_HASHED | (bit << IO_WQ_HASH_SHIFT));
771b53d0
JA
772}
773
2293b419 774static bool io_wq_worker_cancel(struct io_worker *worker, void *data)
62755e35 775{
2293b419 776 struct io_cb_cancel_data *match = data;
6f72653e 777 unsigned long flags;
62755e35
JA
778
779 /*
780 * Hold the lock to avoid ->cur_work going out of scope, caller
36c2f922 781 * may dereference the passed in work.
62755e35 782 */
36c2f922 783 spin_lock_irqsave(&worker->lock, flags);
62755e35 784 if (worker->cur_work &&
2293b419 785 match->fn(worker->cur_work, match->data)) {
3bfe6106 786 set_notify_signal(worker->task);
4f26bda1 787 match->nr_running++;
771b53d0 788 }
36c2f922 789 spin_unlock_irqrestore(&worker->lock, flags);
771b53d0 790
4f26bda1 791 return match->nr_running && !match->cancel_all;
771b53d0
JA
792}
793
204361a7
PB
794static inline void io_wqe_remove_pending(struct io_wqe *wqe,
795 struct io_wq_work *work,
796 struct io_wq_work_node *prev)
797{
798 unsigned int hash = io_get_work_hash(work);
799 struct io_wq_work *prev_work = NULL;
800
801 if (io_wq_is_hashed(work) && work == wqe->hash_tail[hash]) {
802 if (prev)
803 prev_work = container_of(prev, struct io_wq_work, list);
804 if (prev_work && io_get_work_hash(prev_work) == hash)
805 wqe->hash_tail[hash] = prev_work;
806 else
807 wqe->hash_tail[hash] = NULL;
808 }
809 wq_list_del(&wqe->work_list, &work->list, prev);
810}
811
4f26bda1 812static void io_wqe_cancel_pending_work(struct io_wqe *wqe,
f4c2665e 813 struct io_cb_cancel_data *match)
771b53d0 814{
6206f0e1 815 struct io_wq_work_node *node, *prev;
771b53d0 816 struct io_wq_work *work;
6f72653e 817 unsigned long flags;
771b53d0 818
4f26bda1 819retry:
95da8465 820 raw_spin_lock_irqsave(&wqe->lock, flags);
6206f0e1
JA
821 wq_list_for_each(node, prev, &wqe->work_list) {
822 work = container_of(node, struct io_wq_work, list);
4f26bda1
PB
823 if (!match->fn(work, match->data))
824 continue;
204361a7 825 io_wqe_remove_pending(wqe, work, prev);
95da8465 826 raw_spin_unlock_irqrestore(&wqe->lock, flags);
4f26bda1
PB
827 io_run_cancel(work, wqe);
828 match->nr_pending++;
829 if (!match->cancel_all)
830 return;
831
832 /* not safe to continue after unlock */
833 goto retry;
771b53d0 834 }
95da8465 835 raw_spin_unlock_irqrestore(&wqe->lock, flags);
f4c2665e
PB
836}
837
4f26bda1 838static void io_wqe_cancel_running_work(struct io_wqe *wqe,
f4c2665e
PB
839 struct io_cb_cancel_data *match)
840{
771b53d0 841 rcu_read_lock();
4f26bda1 842 io_wq_for_each_worker(wqe, io_wq_worker_cancel, match);
771b53d0 843 rcu_read_unlock();
771b53d0
JA
844}
845
2293b419 846enum io_wq_cancel io_wq_cancel_cb(struct io_wq *wq, work_cancel_fn *cancel,
4f26bda1 847 void *data, bool cancel_all)
771b53d0 848{
2293b419 849 struct io_cb_cancel_data match = {
4f26bda1
PB
850 .fn = cancel,
851 .data = data,
852 .cancel_all = cancel_all,
00bcda13 853 };
3fc50ab5 854 int node;
771b53d0 855
f4c2665e
PB
856 /*
857 * First check pending list, if we're lucky we can just remove it
858 * from there. CANCEL_OK means that the work is returned as-new,
859 * no completion will be posted for it.
860 */
3fc50ab5
JH
861 for_each_node(node) {
862 struct io_wqe *wqe = wq->wqes[node];
771b53d0 863
4f26bda1
PB
864 io_wqe_cancel_pending_work(wqe, &match);
865 if (match.nr_pending && !match.cancel_all)
f4c2665e 866 return IO_WQ_CANCEL_OK;
771b53d0
JA
867 }
868
f4c2665e
PB
869 /*
870 * Now check if a free (going busy) or busy worker has the work
871 * currently running. If we find it there, we'll return CANCEL_RUNNING
872 * as an indication that we attempt to signal cancellation. The
873 * completion will run normally in this case.
874 */
875 for_each_node(node) {
876 struct io_wqe *wqe = wq->wqes[node];
877
4f26bda1
PB
878 io_wqe_cancel_running_work(wqe, &match);
879 if (match.nr_running && !match.cancel_all)
f4c2665e
PB
880 return IO_WQ_CANCEL_RUNNING;
881 }
882
4f26bda1
PB
883 if (match.nr_running)
884 return IO_WQ_CANCEL_RUNNING;
885 if (match.nr_pending)
886 return IO_WQ_CANCEL_OK;
f4c2665e 887 return IO_WQ_CANCEL_NOTFOUND;
771b53d0
JA
888}
889
e941894e
JA
890static int io_wqe_hash_wake(struct wait_queue_entry *wait, unsigned mode,
891 int sync, void *key)
892{
893 struct io_wqe *wqe = container_of(wait, struct io_wqe, wait);
e941894e
JA
894
895 list_del_init(&wait->entry);
896
897 rcu_read_lock();
685fe7fe 898 io_wqe_activate_free_worker(wqe);
e941894e 899 rcu_read_unlock();
e941894e
JA
900 return 1;
901}
902
576a347b 903struct io_wq *io_wq_create(unsigned bounded, struct io_wq_data *data)
771b53d0 904{
b1b2fc35 905 int ret, node;
771b53d0
JA
906 struct io_wq *wq;
907
f5fa38c5 908 if (WARN_ON_ONCE(!data->free_work || !data->do_work))
e9fd9396 909 return ERR_PTR(-EINVAL);
e6ab8991
PB
910 if (WARN_ON_ONCE(!bounded))
911 return ERR_PTR(-EINVAL);
e9fd9396 912
c7f405d6 913 wq = kzalloc(struct_size(wq, wqes, nr_node_ids), GFP_KERNEL);
771b53d0
JA
914 if (!wq)
915 return ERR_PTR(-ENOMEM);
43c01fbe
JA
916 ret = cpuhp_state_add_instance_nocalls(io_wq_online, &wq->cpuhp_node);
917 if (ret)
c7f405d6 918 goto err_wq;
771b53d0 919
e941894e
JA
920 refcount_inc(&data->hash->refs);
921 wq->hash = data->hash;
e9fd9396 922 wq->free_work = data->free_work;
f5fa38c5 923 wq->do_work = data->do_work;
7d723065 924
43c01fbe 925 ret = -ENOMEM;
3fc50ab5 926 for_each_node(node) {
771b53d0 927 struct io_wqe *wqe;
7563439a 928 int alloc_node = node;
771b53d0 929
7563439a
JA
930 if (!node_online(alloc_node))
931 alloc_node = NUMA_NO_NODE;
932 wqe = kzalloc_node(sizeof(struct io_wqe), GFP_KERNEL, alloc_node);
771b53d0 933 if (!wqe)
3fc50ab5 934 goto err;
0e03496d
JA
935 if (!alloc_cpumask_var(&wqe->cpu_mask, GFP_KERNEL))
936 goto err;
937 cpumask_copy(wqe->cpu_mask, cpumask_of_node(node));
3fc50ab5 938 wq->wqes[node] = wqe;
7563439a 939 wqe->node = alloc_node;
685fe7fe
JA
940 wqe->acct[IO_WQ_ACCT_BOUND].index = IO_WQ_ACCT_BOUND;
941 wqe->acct[IO_WQ_ACCT_UNBOUND].index = IO_WQ_ACCT_UNBOUND;
c5def4ab
JA
942 wqe->acct[IO_WQ_ACCT_BOUND].max_workers = bounded;
943 atomic_set(&wqe->acct[IO_WQ_ACCT_BOUND].nr_running, 0);
728f13e7 944 wqe->acct[IO_WQ_ACCT_UNBOUND].max_workers =
c5def4ab 945 task_rlimit(current, RLIMIT_NPROC);
c5def4ab 946 atomic_set(&wqe->acct[IO_WQ_ACCT_UNBOUND].nr_running, 0);
e941894e
JA
947 wqe->wait.func = io_wqe_hash_wake;
948 INIT_LIST_HEAD(&wqe->wait.entry);
771b53d0 949 wqe->wq = wq;
95da8465 950 raw_spin_lock_init(&wqe->lock);
6206f0e1 951 INIT_WQ_LIST(&wqe->work_list);
021d1cdd 952 INIT_HLIST_NULLS_HEAD(&wqe->free_list, 0);
e61df66c 953 INIT_LIST_HEAD(&wqe->all_list);
771b53d0
JA
954 }
955
685fe7fe 956 wq->task = get_task_struct(data->task);
685fe7fe
JA
957 atomic_set(&wq->worker_refs, 1);
958 init_completion(&wq->worker_done);
959 return wq;
b60fda60 960err:
dc7bbc9e 961 io_wq_put_hash(data->hash);
43c01fbe 962 cpuhp_state_remove_instance_nocalls(io_wq_online, &wq->cpuhp_node);
0e03496d
JA
963 for_each_node(node) {
964 if (!wq->wqes[node])
965 continue;
966 free_cpumask_var(wq->wqes[node]->cpu_mask);
3fc50ab5 967 kfree(wq->wqes[node]);
0e03496d 968 }
43c01fbe 969err_wq:
b60fda60 970 kfree(wq);
771b53d0
JA
971 return ERR_PTR(ret);
972}
973
c80ca470
JA
974static bool io_task_work_match(struct callback_head *cb, void *data)
975{
976 struct create_worker_data *cwd;
977
978 if (cb->func != create_worker_cb)
979 return false;
980 cwd = container_of(cb, struct create_worker_data, work);
981 return cwd->wqe->wq == data;
982}
983
17a91051
PB
984void io_wq_exit_start(struct io_wq *wq)
985{
986 set_bit(IO_WQ_BIT_EXIT, &wq->state);
987}
988
685fe7fe 989static void io_wq_exit_workers(struct io_wq *wq)
afcc4015 990{
685fe7fe
JA
991 struct callback_head *cb;
992 int node;
993
685fe7fe
JA
994 if (!wq->task)
995 return;
996
c80ca470 997 while ((cb = task_work_cancel_match(wq->task, io_task_work_match, wq)) != NULL) {
685fe7fe
JA
998 struct create_worker_data *cwd;
999
1000 cwd = container_of(cb, struct create_worker_data, work);
1001 atomic_dec(&cwd->wqe->acct[cwd->index].nr_running);
1002 io_worker_ref_put(wq);
1003 kfree(cwd);
1004 }
1005
1006 rcu_read_lock();
1007 for_each_node(node) {
1008 struct io_wqe *wqe = wq->wqes[node];
1009
1010 io_wq_for_each_worker(wqe, io_wq_worker_wake, NULL);
afcc4015 1011 }
685fe7fe
JA
1012 rcu_read_unlock();
1013 io_worker_ref_put(wq);
1014 wait_for_completion(&wq->worker_done);
3743c172
Z
1015
1016 for_each_node(node) {
1017 spin_lock_irq(&wq->hash->wait.lock);
1018 list_del_init(&wq->wqes[node]->wait.entry);
1019 spin_unlock_irq(&wq->hash->wait.lock);
1020 }
685fe7fe
JA
1021 put_task_struct(wq->task);
1022 wq->task = NULL;
afcc4015
JA
1023}
1024
4fb6ac32 1025static void io_wq_destroy(struct io_wq *wq)
771b53d0 1026{
3fc50ab5 1027 int node;
771b53d0 1028
43c01fbe
JA
1029 cpuhp_state_remove_instance_nocalls(io_wq_online, &wq->cpuhp_node);
1030
e941894e
JA
1031 for_each_node(node) {
1032 struct io_wqe *wqe = wq->wqes[node];
f5d2d23b
JA
1033 struct io_cb_cancel_data match = {
1034 .fn = io_wq_work_match_all,
1035 .cancel_all = true,
1036 };
1037 io_wqe_cancel_pending_work(wqe, &match);
0e03496d 1038 free_cpumask_var(wqe->cpu_mask);
e941894e
JA
1039 kfree(wqe);
1040 }
e941894e 1041 io_wq_put_hash(wq->hash);
771b53d0 1042 kfree(wq);
4fb6ac32
JA
1043}
1044
afcc4015
JA
1045void io_wq_put_and_exit(struct io_wq *wq)
1046{
17a91051
PB
1047 WARN_ON_ONCE(!test_bit(IO_WQ_BIT_EXIT, &wq->state));
1048
685fe7fe 1049 io_wq_exit_workers(wq);
382cb030 1050 io_wq_destroy(wq);
afcc4015
JA
1051}
1052
0e03496d
JA
1053struct online_data {
1054 unsigned int cpu;
1055 bool online;
1056};
1057
43c01fbe
JA
1058static bool io_wq_worker_affinity(struct io_worker *worker, void *data)
1059{
0e03496d 1060 struct online_data *od = data;
e0051d7d 1061
0e03496d
JA
1062 if (od->online)
1063 cpumask_set_cpu(od->cpu, worker->wqe->cpu_mask);
1064 else
1065 cpumask_clear_cpu(od->cpu, worker->wqe->cpu_mask);
43c01fbe
JA
1066 return false;
1067}
1068
0e03496d 1069static int __io_wq_cpu_online(struct io_wq *wq, unsigned int cpu, bool online)
43c01fbe 1070{
0e03496d
JA
1071 struct online_data od = {
1072 .cpu = cpu,
1073 .online = online
1074 };
43c01fbe
JA
1075 int i;
1076
1077 rcu_read_lock();
1078 for_each_node(i)
0e03496d 1079 io_wq_for_each_worker(wq->wqes[i], io_wq_worker_affinity, &od);
43c01fbe
JA
1080 rcu_read_unlock();
1081 return 0;
1082}
1083
0e03496d
JA
1084static int io_wq_cpu_online(unsigned int cpu, struct hlist_node *node)
1085{
1086 struct io_wq *wq = hlist_entry_safe(node, struct io_wq, cpuhp_node);
1087
1088 return __io_wq_cpu_online(wq, cpu, true);
1089}
1090
1091static int io_wq_cpu_offline(unsigned int cpu, struct hlist_node *node)
1092{
1093 struct io_wq *wq = hlist_entry_safe(node, struct io_wq, cpuhp_node);
1094
1095 return __io_wq_cpu_online(wq, cpu, false);
1096}
1097
fe76421d
JA
1098int io_wq_cpu_affinity(struct io_wq *wq, cpumask_var_t mask)
1099{
1100 int i;
1101
1102 rcu_read_lock();
1103 for_each_node(i) {
1104 struct io_wqe *wqe = wq->wqes[i];
1105
1106 if (mask)
1107 cpumask_copy(wqe->cpu_mask, mask);
1108 else
1109 cpumask_copy(wqe->cpu_mask, cpumask_of_node(i));
1110 }
1111 rcu_read_unlock();
1112 return 0;
1113}
1114
43c01fbe
JA
1115static __init int io_wq_init(void)
1116{
1117 int ret;
1118
1119 ret = cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN, "io-wq/online",
0e03496d 1120 io_wq_cpu_online, io_wq_cpu_offline);
43c01fbe
JA
1121 if (ret < 0)
1122 return ret;
1123 io_wq_online = ret;
1124 return 0;
1125}
1126subsys_initcall(io_wq_init);
This page took 0.357106 seconds and 4 git commands to generate.