Merge git://git.kernel.org/pub/scm/linux/kernel/git/pablo/nf
[linux-2.6-microblaze.git] / fs / io-wq.c
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>
12 #include <linux/percpu.h>
13 #include <linux/slab.h>
14 #include <linux/rculist_nulls.h>
15 #include <linux/cpu.h>
16 #include <linux/tracehook.h>
17 #include <linux/audit.h>
18 #include <uapi/linux/io_uring.h>
19
20 #include "io-wq.h"
21
22 #define WORKER_IDLE_TIMEOUT     (5 * HZ)
23
24 enum {
25         IO_WORKER_F_UP          = 1,    /* up and active */
26         IO_WORKER_F_RUNNING     = 2,    /* account as running */
27         IO_WORKER_F_FREE        = 4,    /* worker on free list */
28         IO_WORKER_F_BOUND       = 8,    /* is doing bounded work */
29 };
30
31 enum {
32         IO_WQ_BIT_EXIT          = 0,    /* wq exiting */
33 };
34
35 enum {
36         IO_ACCT_STALLED_BIT     = 0,    /* stalled on hash */
37 };
38
39 /*
40  * One for each thread in a wqe pool
41  */
42 struct io_worker {
43         refcount_t ref;
44         unsigned flags;
45         struct hlist_nulls_node nulls_node;
46         struct list_head all_list;
47         struct task_struct *task;
48         struct io_wqe *wqe;
49
50         struct io_wq_work *cur_work;
51         spinlock_t lock;
52
53         struct completion ref_done;
54
55         unsigned long create_state;
56         struct callback_head create_work;
57         int create_index;
58
59         union {
60                 struct rcu_head rcu;
61                 struct work_struct work;
62         };
63 };
64
65 #if BITS_PER_LONG == 64
66 #define IO_WQ_HASH_ORDER        6
67 #else
68 #define IO_WQ_HASH_ORDER        5
69 #endif
70
71 #define IO_WQ_NR_HASH_BUCKETS   (1u << IO_WQ_HASH_ORDER)
72
73 struct io_wqe_acct {
74         unsigned nr_workers;
75         unsigned max_workers;
76         int index;
77         atomic_t nr_running;
78         struct io_wq_work_list work_list;
79         unsigned long flags;
80 };
81
82 enum {
83         IO_WQ_ACCT_BOUND,
84         IO_WQ_ACCT_UNBOUND,
85         IO_WQ_ACCT_NR,
86 };
87
88 /*
89  * Per-node worker thread pool
90  */
91 struct io_wqe {
92         raw_spinlock_t lock;
93         struct io_wqe_acct acct[2];
94
95         int node;
96
97         struct hlist_nulls_head free_list;
98         struct list_head all_list;
99
100         struct wait_queue_entry wait;
101
102         struct io_wq *wq;
103         struct io_wq_work *hash_tail[IO_WQ_NR_HASH_BUCKETS];
104
105         cpumask_var_t cpu_mask;
106 };
107
108 /*
109  * Per io_wq state
110   */
111 struct io_wq {
112         unsigned long state;
113
114         free_work_fn *free_work;
115         io_wq_work_fn *do_work;
116
117         struct io_wq_hash *hash;
118
119         atomic_t worker_refs;
120         struct completion worker_done;
121
122         struct hlist_node cpuhp_node;
123
124         struct task_struct *task;
125
126         struct io_wqe *wqes[];
127 };
128
129 static enum cpuhp_state io_wq_online;
130
131 struct io_cb_cancel_data {
132         work_cancel_fn *fn;
133         void *data;
134         int nr_running;
135         int nr_pending;
136         bool cancel_all;
137 };
138
139 static bool create_io_worker(struct io_wq *wq, struct io_wqe *wqe, int index);
140 static void io_wqe_dec_running(struct io_worker *worker);
141 static bool io_acct_cancel_pending_work(struct io_wqe *wqe,
142                                         struct io_wqe_acct *acct,
143                                         struct io_cb_cancel_data *match);
144 static void create_worker_cb(struct callback_head *cb);
145 static void io_wq_cancel_tw_create(struct io_wq *wq);
146
147 static bool io_worker_get(struct io_worker *worker)
148 {
149         return refcount_inc_not_zero(&worker->ref);
150 }
151
152 static void io_worker_release(struct io_worker *worker)
153 {
154         if (refcount_dec_and_test(&worker->ref))
155                 complete(&worker->ref_done);
156 }
157
158 static inline struct io_wqe_acct *io_get_acct(struct io_wqe *wqe, bool bound)
159 {
160         return &wqe->acct[bound ? IO_WQ_ACCT_BOUND : IO_WQ_ACCT_UNBOUND];
161 }
162
163 static inline struct io_wqe_acct *io_work_get_acct(struct io_wqe *wqe,
164                                                    struct io_wq_work *work)
165 {
166         return io_get_acct(wqe, !(work->flags & IO_WQ_WORK_UNBOUND));
167 }
168
169 static inline struct io_wqe_acct *io_wqe_get_acct(struct io_worker *worker)
170 {
171         return io_get_acct(worker->wqe, worker->flags & IO_WORKER_F_BOUND);
172 }
173
174 static void io_worker_ref_put(struct io_wq *wq)
175 {
176         if (atomic_dec_and_test(&wq->worker_refs))
177                 complete(&wq->worker_done);
178 }
179
180 static void io_worker_cancel_cb(struct io_worker *worker)
181 {
182         struct io_wqe_acct *acct = io_wqe_get_acct(worker);
183         struct io_wqe *wqe = worker->wqe;
184         struct io_wq *wq = wqe->wq;
185
186         atomic_dec(&acct->nr_running);
187         raw_spin_lock(&worker->wqe->lock);
188         acct->nr_workers--;
189         raw_spin_unlock(&worker->wqe->lock);
190         io_worker_ref_put(wq);
191         clear_bit_unlock(0, &worker->create_state);
192         io_worker_release(worker);
193 }
194
195 static bool io_task_worker_match(struct callback_head *cb, void *data)
196 {
197         struct io_worker *worker;
198
199         if (cb->func != create_worker_cb)
200                 return false;
201         worker = container_of(cb, struct io_worker, create_work);
202         return worker == data;
203 }
204
205 static void io_worker_exit(struct io_worker *worker)
206 {
207         struct io_wqe *wqe = worker->wqe;
208         struct io_wq *wq = wqe->wq;
209
210         while (1) {
211                 struct callback_head *cb = task_work_cancel_match(wq->task,
212                                                 io_task_worker_match, worker);
213
214                 if (!cb)
215                         break;
216                 io_worker_cancel_cb(worker);
217         }
218
219         io_worker_release(worker);
220         wait_for_completion(&worker->ref_done);
221
222         raw_spin_lock(&wqe->lock);
223         if (worker->flags & IO_WORKER_F_FREE)
224                 hlist_nulls_del_rcu(&worker->nulls_node);
225         list_del_rcu(&worker->all_list);
226         preempt_disable();
227         io_wqe_dec_running(worker);
228         worker->flags = 0;
229         current->flags &= ~PF_IO_WORKER;
230         preempt_enable();
231         raw_spin_unlock(&wqe->lock);
232
233         kfree_rcu(worker, rcu);
234         io_worker_ref_put(wqe->wq);
235         do_exit(0);
236 }
237
238 static inline bool io_acct_run_queue(struct io_wqe_acct *acct)
239 {
240         if (!wq_list_empty(&acct->work_list) &&
241             !test_bit(IO_ACCT_STALLED_BIT, &acct->flags))
242                 return true;
243         return false;
244 }
245
246 /*
247  * Check head of free list for an available worker. If one isn't available,
248  * caller must create one.
249  */
250 static bool io_wqe_activate_free_worker(struct io_wqe *wqe,
251                                         struct io_wqe_acct *acct)
252         __must_hold(RCU)
253 {
254         struct hlist_nulls_node *n;
255         struct io_worker *worker;
256
257         /*
258          * Iterate free_list and see if we can find an idle worker to
259          * activate. If a given worker is on the free_list but in the process
260          * of exiting, keep trying.
261          */
262         hlist_nulls_for_each_entry_rcu(worker, n, &wqe->free_list, nulls_node) {
263                 if (!io_worker_get(worker))
264                         continue;
265                 if (io_wqe_get_acct(worker) != acct) {
266                         io_worker_release(worker);
267                         continue;
268                 }
269                 if (wake_up_process(worker->task)) {
270                         io_worker_release(worker);
271                         return true;
272                 }
273                 io_worker_release(worker);
274         }
275
276         return false;
277 }
278
279 /*
280  * We need a worker. If we find a free one, we're good. If not, and we're
281  * below the max number of workers, create one.
282  */
283 static bool io_wqe_create_worker(struct io_wqe *wqe, struct io_wqe_acct *acct)
284 {
285         /*
286          * Most likely an attempt to queue unbounded work on an io_wq that
287          * wasn't setup with any unbounded workers.
288          */
289         if (unlikely(!acct->max_workers))
290                 pr_warn_once("io-wq is not configured for unbound workers");
291
292         raw_spin_lock(&wqe->lock);
293         if (acct->nr_workers >= acct->max_workers) {
294                 raw_spin_unlock(&wqe->lock);
295                 return true;
296         }
297         acct->nr_workers++;
298         raw_spin_unlock(&wqe->lock);
299         atomic_inc(&acct->nr_running);
300         atomic_inc(&wqe->wq->worker_refs);
301         return create_io_worker(wqe->wq, wqe, acct->index);
302 }
303
304 static void io_wqe_inc_running(struct io_worker *worker)
305 {
306         struct io_wqe_acct *acct = io_wqe_get_acct(worker);
307
308         atomic_inc(&acct->nr_running);
309 }
310
311 static void create_worker_cb(struct callback_head *cb)
312 {
313         struct io_worker *worker;
314         struct io_wq *wq;
315         struct io_wqe *wqe;
316         struct io_wqe_acct *acct;
317         bool do_create = false;
318
319         worker = container_of(cb, struct io_worker, create_work);
320         wqe = worker->wqe;
321         wq = wqe->wq;
322         acct = &wqe->acct[worker->create_index];
323         raw_spin_lock(&wqe->lock);
324         if (acct->nr_workers < acct->max_workers) {
325                 acct->nr_workers++;
326                 do_create = true;
327         }
328         raw_spin_unlock(&wqe->lock);
329         if (do_create) {
330                 create_io_worker(wq, wqe, worker->create_index);
331         } else {
332                 atomic_dec(&acct->nr_running);
333                 io_worker_ref_put(wq);
334         }
335         clear_bit_unlock(0, &worker->create_state);
336         io_worker_release(worker);
337 }
338
339 static bool io_queue_worker_create(struct io_worker *worker,
340                                    struct io_wqe_acct *acct,
341                                    task_work_func_t func)
342 {
343         struct io_wqe *wqe = worker->wqe;
344         struct io_wq *wq = wqe->wq;
345
346         /* raced with exit, just ignore create call */
347         if (test_bit(IO_WQ_BIT_EXIT, &wq->state))
348                 goto fail;
349         if (!io_worker_get(worker))
350                 goto fail;
351         /*
352          * create_state manages ownership of create_work/index. We should
353          * only need one entry per worker, as the worker going to sleep
354          * will trigger the condition, and waking will clear it once it
355          * runs the task_work.
356          */
357         if (test_bit(0, &worker->create_state) ||
358             test_and_set_bit_lock(0, &worker->create_state))
359                 goto fail_release;
360
361         atomic_inc(&wq->worker_refs);
362         init_task_work(&worker->create_work, func);
363         worker->create_index = acct->index;
364         if (!task_work_add(wq->task, &worker->create_work, TWA_SIGNAL)) {
365                 /*
366                  * EXIT may have been set after checking it above, check after
367                  * adding the task_work and remove any creation item if it is
368                  * now set. wq exit does that too, but we can have added this
369                  * work item after we canceled in io_wq_exit_workers().
370                  */
371                 if (test_bit(IO_WQ_BIT_EXIT, &wq->state))
372                         io_wq_cancel_tw_create(wq);
373                 io_worker_ref_put(wq);
374                 return true;
375         }
376         io_worker_ref_put(wq);
377         clear_bit_unlock(0, &worker->create_state);
378 fail_release:
379         io_worker_release(worker);
380 fail:
381         atomic_dec(&acct->nr_running);
382         io_worker_ref_put(wq);
383         return false;
384 }
385
386 static void io_wqe_dec_running(struct io_worker *worker)
387         __must_hold(wqe->lock)
388 {
389         struct io_wqe_acct *acct = io_wqe_get_acct(worker);
390         struct io_wqe *wqe = worker->wqe;
391
392         if (!(worker->flags & IO_WORKER_F_UP))
393                 return;
394
395         if (atomic_dec_and_test(&acct->nr_running) && io_acct_run_queue(acct)) {
396                 atomic_inc(&acct->nr_running);
397                 atomic_inc(&wqe->wq->worker_refs);
398                 raw_spin_unlock(&wqe->lock);
399                 io_queue_worker_create(worker, acct, create_worker_cb);
400                 raw_spin_lock(&wqe->lock);
401         }
402 }
403
404 /*
405  * Worker will start processing some work. Move it to the busy list, if
406  * it's currently on the freelist
407  */
408 static void __io_worker_busy(struct io_wqe *wqe, struct io_worker *worker,
409                              struct io_wq_work *work)
410         __must_hold(wqe->lock)
411 {
412         if (worker->flags & IO_WORKER_F_FREE) {
413                 worker->flags &= ~IO_WORKER_F_FREE;
414                 hlist_nulls_del_init_rcu(&worker->nulls_node);
415         }
416 }
417
418 /*
419  * No work, worker going to sleep. Move to freelist, and unuse mm if we
420  * have one attached. Dropping the mm may potentially sleep, so we drop
421  * the lock in that case and return success. Since the caller has to
422  * retry the loop in that case (we changed task state), we don't regrab
423  * the lock if we return success.
424  */
425 static void __io_worker_idle(struct io_wqe *wqe, struct io_worker *worker)
426         __must_hold(wqe->lock)
427 {
428         if (!(worker->flags & IO_WORKER_F_FREE)) {
429                 worker->flags |= IO_WORKER_F_FREE;
430                 hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
431         }
432 }
433
434 static inline unsigned int io_get_work_hash(struct io_wq_work *work)
435 {
436         return work->flags >> IO_WQ_HASH_SHIFT;
437 }
438
439 static bool io_wait_on_hash(struct io_wqe *wqe, unsigned int hash)
440 {
441         struct io_wq *wq = wqe->wq;
442         bool ret = false;
443
444         spin_lock_irq(&wq->hash->wait.lock);
445         if (list_empty(&wqe->wait.entry)) {
446                 __add_wait_queue(&wq->hash->wait, &wqe->wait);
447                 if (!test_bit(hash, &wq->hash->map)) {
448                         __set_current_state(TASK_RUNNING);
449                         list_del_init(&wqe->wait.entry);
450                         ret = true;
451                 }
452         }
453         spin_unlock_irq(&wq->hash->wait.lock);
454         return ret;
455 }
456
457 static struct io_wq_work *io_get_next_work(struct io_wqe_acct *acct,
458                                            struct io_worker *worker)
459         __must_hold(wqe->lock)
460 {
461         struct io_wq_work_node *node, *prev;
462         struct io_wq_work *work, *tail;
463         unsigned int stall_hash = -1U;
464         struct io_wqe *wqe = worker->wqe;
465
466         wq_list_for_each(node, prev, &acct->work_list) {
467                 unsigned int hash;
468
469                 work = container_of(node, struct io_wq_work, list);
470
471                 /* not hashed, can run anytime */
472                 if (!io_wq_is_hashed(work)) {
473                         wq_list_del(&acct->work_list, node, prev);
474                         return work;
475                 }
476
477                 hash = io_get_work_hash(work);
478                 /* all items with this hash lie in [work, tail] */
479                 tail = wqe->hash_tail[hash];
480
481                 /* hashed, can run if not already running */
482                 if (!test_and_set_bit(hash, &wqe->wq->hash->map)) {
483                         wqe->hash_tail[hash] = NULL;
484                         wq_list_cut(&acct->work_list, &tail->list, prev);
485                         return work;
486                 }
487                 if (stall_hash == -1U)
488                         stall_hash = hash;
489                 /* fast forward to a next hash, for-each will fix up @prev */
490                 node = &tail->list;
491         }
492
493         if (stall_hash != -1U) {
494                 bool unstalled;
495
496                 /*
497                  * Set this before dropping the lock to avoid racing with new
498                  * work being added and clearing the stalled bit.
499                  */
500                 set_bit(IO_ACCT_STALLED_BIT, &acct->flags);
501                 raw_spin_unlock(&wqe->lock);
502                 unstalled = io_wait_on_hash(wqe, stall_hash);
503                 raw_spin_lock(&wqe->lock);
504                 if (unstalled) {
505                         clear_bit(IO_ACCT_STALLED_BIT, &acct->flags);
506                         if (wq_has_sleeper(&wqe->wq->hash->wait))
507                                 wake_up(&wqe->wq->hash->wait);
508                 }
509         }
510
511         return NULL;
512 }
513
514 static bool io_flush_signals(void)
515 {
516         if (unlikely(test_thread_flag(TIF_NOTIFY_SIGNAL))) {
517                 __set_current_state(TASK_RUNNING);
518                 tracehook_notify_signal();
519                 return true;
520         }
521         return false;
522 }
523
524 static void io_assign_current_work(struct io_worker *worker,
525                                    struct io_wq_work *work)
526 {
527         if (work) {
528                 io_flush_signals();
529                 cond_resched();
530         }
531
532         spin_lock(&worker->lock);
533         worker->cur_work = work;
534         spin_unlock(&worker->lock);
535 }
536
537 static void io_wqe_enqueue(struct io_wqe *wqe, struct io_wq_work *work);
538
539 static void io_worker_handle_work(struct io_worker *worker)
540         __releases(wqe->lock)
541 {
542         struct io_wqe_acct *acct = io_wqe_get_acct(worker);
543         struct io_wqe *wqe = worker->wqe;
544         struct io_wq *wq = wqe->wq;
545         bool do_kill = test_bit(IO_WQ_BIT_EXIT, &wq->state);
546
547         do {
548                 struct io_wq_work *work;
549 get_next:
550                 /*
551                  * If we got some work, mark us as busy. If we didn't, but
552                  * the list isn't empty, it means we stalled on hashed work.
553                  * Mark us stalled so we don't keep looking for work when we
554                  * can't make progress, any work completion or insertion will
555                  * clear the stalled flag.
556                  */
557                 work = io_get_next_work(acct, worker);
558                 if (work)
559                         __io_worker_busy(wqe, worker, work);
560
561                 raw_spin_unlock(&wqe->lock);
562                 if (!work)
563                         break;
564                 io_assign_current_work(worker, work);
565                 __set_current_state(TASK_RUNNING);
566
567                 /* handle a whole dependent link */
568                 do {
569                         struct io_wq_work *next_hashed, *linked;
570                         unsigned int hash = io_get_work_hash(work);
571
572                         next_hashed = wq_next_work(work);
573
574                         if (unlikely(do_kill) && (work->flags & IO_WQ_WORK_UNBOUND))
575                                 work->flags |= IO_WQ_WORK_CANCEL;
576                         wq->do_work(work);
577                         io_assign_current_work(worker, NULL);
578
579                         linked = wq->free_work(work);
580                         work = next_hashed;
581                         if (!work && linked && !io_wq_is_hashed(linked)) {
582                                 work = linked;
583                                 linked = NULL;
584                         }
585                         io_assign_current_work(worker, work);
586                         if (linked)
587                                 io_wqe_enqueue(wqe, linked);
588
589                         if (hash != -1U && !next_hashed) {
590                                 /* serialize hash clear with wake_up() */
591                                 spin_lock_irq(&wq->hash->wait.lock);
592                                 clear_bit(hash, &wq->hash->map);
593                                 clear_bit(IO_ACCT_STALLED_BIT, &acct->flags);
594                                 spin_unlock_irq(&wq->hash->wait.lock);
595                                 if (wq_has_sleeper(&wq->hash->wait))
596                                         wake_up(&wq->hash->wait);
597                                 raw_spin_lock(&wqe->lock);
598                                 /* skip unnecessary unlock-lock wqe->lock */
599                                 if (!work)
600                                         goto get_next;
601                                 raw_spin_unlock(&wqe->lock);
602                         }
603                 } while (work);
604
605                 raw_spin_lock(&wqe->lock);
606         } while (1);
607 }
608
609 static int io_wqe_worker(void *data)
610 {
611         struct io_worker *worker = data;
612         struct io_wqe_acct *acct = io_wqe_get_acct(worker);
613         struct io_wqe *wqe = worker->wqe;
614         struct io_wq *wq = wqe->wq;
615         bool last_timeout = false;
616         char buf[TASK_COMM_LEN];
617
618         worker->flags |= (IO_WORKER_F_UP | IO_WORKER_F_RUNNING);
619
620         snprintf(buf, sizeof(buf), "iou-wrk-%d", wq->task->pid);
621         set_task_comm(current, buf);
622
623         audit_alloc_kernel(current);
624
625         while (!test_bit(IO_WQ_BIT_EXIT, &wq->state)) {
626                 long ret;
627
628                 set_current_state(TASK_INTERRUPTIBLE);
629 loop:
630                 raw_spin_lock(&wqe->lock);
631                 if (io_acct_run_queue(acct)) {
632                         io_worker_handle_work(worker);
633                         goto loop;
634                 }
635                 /* timed out, exit unless we're the last worker */
636                 if (last_timeout && acct->nr_workers > 1) {
637                         acct->nr_workers--;
638                         raw_spin_unlock(&wqe->lock);
639                         __set_current_state(TASK_RUNNING);
640                         break;
641                 }
642                 last_timeout = false;
643                 __io_worker_idle(wqe, worker);
644                 raw_spin_unlock(&wqe->lock);
645                 if (io_flush_signals())
646                         continue;
647                 ret = schedule_timeout(WORKER_IDLE_TIMEOUT);
648                 if (signal_pending(current)) {
649                         struct ksignal ksig;
650
651                         if (!get_signal(&ksig))
652                                 continue;
653                         break;
654                 }
655                 last_timeout = !ret;
656         }
657
658         if (test_bit(IO_WQ_BIT_EXIT, &wq->state)) {
659                 raw_spin_lock(&wqe->lock);
660                 io_worker_handle_work(worker);
661         }
662
663         audit_free(current);
664         io_worker_exit(worker);
665         return 0;
666 }
667
668 /*
669  * Called when a worker is scheduled in. Mark us as currently running.
670  */
671 void io_wq_worker_running(struct task_struct *tsk)
672 {
673         struct io_worker *worker = tsk->worker_private;
674
675         if (!worker)
676                 return;
677         if (!(worker->flags & IO_WORKER_F_UP))
678                 return;
679         if (worker->flags & IO_WORKER_F_RUNNING)
680                 return;
681         worker->flags |= IO_WORKER_F_RUNNING;
682         io_wqe_inc_running(worker);
683 }
684
685 /*
686  * Called when worker is going to sleep. If there are no workers currently
687  * running and we have work pending, wake up a free one or create a new one.
688  */
689 void io_wq_worker_sleeping(struct task_struct *tsk)
690 {
691         struct io_worker *worker = tsk->worker_private;
692
693         if (!worker)
694                 return;
695         if (!(worker->flags & IO_WORKER_F_UP))
696                 return;
697         if (!(worker->flags & IO_WORKER_F_RUNNING))
698                 return;
699
700         worker->flags &= ~IO_WORKER_F_RUNNING;
701
702         raw_spin_lock(&worker->wqe->lock);
703         io_wqe_dec_running(worker);
704         raw_spin_unlock(&worker->wqe->lock);
705 }
706
707 static void io_init_new_worker(struct io_wqe *wqe, struct io_worker *worker,
708                                struct task_struct *tsk)
709 {
710         tsk->worker_private = worker;
711         worker->task = tsk;
712         set_cpus_allowed_ptr(tsk, wqe->cpu_mask);
713         tsk->flags |= PF_NO_SETAFFINITY;
714
715         raw_spin_lock(&wqe->lock);
716         hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
717         list_add_tail_rcu(&worker->all_list, &wqe->all_list);
718         worker->flags |= IO_WORKER_F_FREE;
719         raw_spin_unlock(&wqe->lock);
720         wake_up_new_task(tsk);
721 }
722
723 static bool io_wq_work_match_all(struct io_wq_work *work, void *data)
724 {
725         return true;
726 }
727
728 static inline bool io_should_retry_thread(long err)
729 {
730         /*
731          * Prevent perpetual task_work retry, if the task (or its group) is
732          * exiting.
733          */
734         if (fatal_signal_pending(current))
735                 return false;
736
737         switch (err) {
738         case -EAGAIN:
739         case -ERESTARTSYS:
740         case -ERESTARTNOINTR:
741         case -ERESTARTNOHAND:
742                 return true;
743         default:
744                 return false;
745         }
746 }
747
748 static void create_worker_cont(struct callback_head *cb)
749 {
750         struct io_worker *worker;
751         struct task_struct *tsk;
752         struct io_wqe *wqe;
753
754         worker = container_of(cb, struct io_worker, create_work);
755         clear_bit_unlock(0, &worker->create_state);
756         wqe = worker->wqe;
757         tsk = create_io_thread(io_wqe_worker, worker, wqe->node);
758         if (!IS_ERR(tsk)) {
759                 io_init_new_worker(wqe, worker, tsk);
760                 io_worker_release(worker);
761                 return;
762         } else if (!io_should_retry_thread(PTR_ERR(tsk))) {
763                 struct io_wqe_acct *acct = io_wqe_get_acct(worker);
764
765                 atomic_dec(&acct->nr_running);
766                 raw_spin_lock(&wqe->lock);
767                 acct->nr_workers--;
768                 if (!acct->nr_workers) {
769                         struct io_cb_cancel_data match = {
770                                 .fn             = io_wq_work_match_all,
771                                 .cancel_all     = true,
772                         };
773
774                         while (io_acct_cancel_pending_work(wqe, acct, &match))
775                                 raw_spin_lock(&wqe->lock);
776                 }
777                 raw_spin_unlock(&wqe->lock);
778                 io_worker_ref_put(wqe->wq);
779                 kfree(worker);
780                 return;
781         }
782
783         /* re-create attempts grab a new worker ref, drop the existing one */
784         io_worker_release(worker);
785         schedule_work(&worker->work);
786 }
787
788 static void io_workqueue_create(struct work_struct *work)
789 {
790         struct io_worker *worker = container_of(work, struct io_worker, work);
791         struct io_wqe_acct *acct = io_wqe_get_acct(worker);
792
793         if (!io_queue_worker_create(worker, acct, create_worker_cont))
794                 kfree(worker);
795 }
796
797 static bool create_io_worker(struct io_wq *wq, struct io_wqe *wqe, int index)
798 {
799         struct io_wqe_acct *acct = &wqe->acct[index];
800         struct io_worker *worker;
801         struct task_struct *tsk;
802
803         __set_current_state(TASK_RUNNING);
804
805         worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, wqe->node);
806         if (!worker) {
807 fail:
808                 atomic_dec(&acct->nr_running);
809                 raw_spin_lock(&wqe->lock);
810                 acct->nr_workers--;
811                 raw_spin_unlock(&wqe->lock);
812                 io_worker_ref_put(wq);
813                 return false;
814         }
815
816         refcount_set(&worker->ref, 1);
817         worker->wqe = wqe;
818         spin_lock_init(&worker->lock);
819         init_completion(&worker->ref_done);
820
821         if (index == IO_WQ_ACCT_BOUND)
822                 worker->flags |= IO_WORKER_F_BOUND;
823
824         tsk = create_io_thread(io_wqe_worker, worker, wqe->node);
825         if (!IS_ERR(tsk)) {
826                 io_init_new_worker(wqe, worker, tsk);
827         } else if (!io_should_retry_thread(PTR_ERR(tsk))) {
828                 kfree(worker);
829                 goto fail;
830         } else {
831                 INIT_WORK(&worker->work, io_workqueue_create);
832                 schedule_work(&worker->work);
833         }
834
835         return true;
836 }
837
838 /*
839  * Iterate the passed in list and call the specific function for each
840  * worker that isn't exiting
841  */
842 static bool io_wq_for_each_worker(struct io_wqe *wqe,
843                                   bool (*func)(struct io_worker *, void *),
844                                   void *data)
845 {
846         struct io_worker *worker;
847         bool ret = false;
848
849         list_for_each_entry_rcu(worker, &wqe->all_list, all_list) {
850                 if (io_worker_get(worker)) {
851                         /* no task if node is/was offline */
852                         if (worker->task)
853                                 ret = func(worker, data);
854                         io_worker_release(worker);
855                         if (ret)
856                                 break;
857                 }
858         }
859
860         return ret;
861 }
862
863 static bool io_wq_worker_wake(struct io_worker *worker, void *data)
864 {
865         set_notify_signal(worker->task);
866         wake_up_process(worker->task);
867         return false;
868 }
869
870 static void io_run_cancel(struct io_wq_work *work, struct io_wqe *wqe)
871 {
872         struct io_wq *wq = wqe->wq;
873
874         do {
875                 work->flags |= IO_WQ_WORK_CANCEL;
876                 wq->do_work(work);
877                 work = wq->free_work(work);
878         } while (work);
879 }
880
881 static void io_wqe_insert_work(struct io_wqe *wqe, struct io_wq_work *work)
882 {
883         struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
884         unsigned int hash;
885         struct io_wq_work *tail;
886
887         if (!io_wq_is_hashed(work)) {
888 append:
889                 wq_list_add_tail(&work->list, &acct->work_list);
890                 return;
891         }
892
893         hash = io_get_work_hash(work);
894         tail = wqe->hash_tail[hash];
895         wqe->hash_tail[hash] = work;
896         if (!tail)
897                 goto append;
898
899         wq_list_add_after(&work->list, &tail->list, &acct->work_list);
900 }
901
902 static bool io_wq_work_match_item(struct io_wq_work *work, void *data)
903 {
904         return work == data;
905 }
906
907 static void io_wqe_enqueue(struct io_wqe *wqe, struct io_wq_work *work)
908 {
909         struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
910         unsigned work_flags = work->flags;
911         bool do_create;
912
913         /*
914          * If io-wq is exiting for this task, or if the request has explicitly
915          * been marked as one that should not get executed, cancel it here.
916          */
917         if (test_bit(IO_WQ_BIT_EXIT, &wqe->wq->state) ||
918             (work->flags & IO_WQ_WORK_CANCEL)) {
919                 io_run_cancel(work, wqe);
920                 return;
921         }
922
923         raw_spin_lock(&wqe->lock);
924         io_wqe_insert_work(wqe, work);
925         clear_bit(IO_ACCT_STALLED_BIT, &acct->flags);
926
927         rcu_read_lock();
928         do_create = !io_wqe_activate_free_worker(wqe, acct);
929         rcu_read_unlock();
930
931         raw_spin_unlock(&wqe->lock);
932
933         if (do_create && ((work_flags & IO_WQ_WORK_CONCURRENT) ||
934             !atomic_read(&acct->nr_running))) {
935                 bool did_create;
936
937                 did_create = io_wqe_create_worker(wqe, acct);
938                 if (likely(did_create))
939                         return;
940
941                 raw_spin_lock(&wqe->lock);
942                 /* fatal condition, failed to create the first worker */
943                 if (!acct->nr_workers) {
944                         struct io_cb_cancel_data match = {
945                                 .fn             = io_wq_work_match_item,
946                                 .data           = work,
947                                 .cancel_all     = false,
948                         };
949
950                         if (io_acct_cancel_pending_work(wqe, acct, &match))
951                                 raw_spin_lock(&wqe->lock);
952                 }
953                 raw_spin_unlock(&wqe->lock);
954         }
955 }
956
957 void io_wq_enqueue(struct io_wq *wq, struct io_wq_work *work)
958 {
959         struct io_wqe *wqe = wq->wqes[numa_node_id()];
960
961         io_wqe_enqueue(wqe, work);
962 }
963
964 /*
965  * Work items that hash to the same value will not be done in parallel.
966  * Used to limit concurrent writes, generally hashed by inode.
967  */
968 void io_wq_hash_work(struct io_wq_work *work, void *val)
969 {
970         unsigned int bit;
971
972         bit = hash_ptr(val, IO_WQ_HASH_ORDER);
973         work->flags |= (IO_WQ_WORK_HASHED | (bit << IO_WQ_HASH_SHIFT));
974 }
975
976 static bool io_wq_worker_cancel(struct io_worker *worker, void *data)
977 {
978         struct io_cb_cancel_data *match = data;
979
980         /*
981          * Hold the lock to avoid ->cur_work going out of scope, caller
982          * may dereference the passed in work.
983          */
984         spin_lock(&worker->lock);
985         if (worker->cur_work &&
986             match->fn(worker->cur_work, match->data)) {
987                 set_notify_signal(worker->task);
988                 match->nr_running++;
989         }
990         spin_unlock(&worker->lock);
991
992         return match->nr_running && !match->cancel_all;
993 }
994
995 static inline void io_wqe_remove_pending(struct io_wqe *wqe,
996                                          struct io_wq_work *work,
997                                          struct io_wq_work_node *prev)
998 {
999         struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
1000         unsigned int hash = io_get_work_hash(work);
1001         struct io_wq_work *prev_work = NULL;
1002
1003         if (io_wq_is_hashed(work) && work == wqe->hash_tail[hash]) {
1004                 if (prev)
1005                         prev_work = container_of(prev, struct io_wq_work, list);
1006                 if (prev_work && io_get_work_hash(prev_work) == hash)
1007                         wqe->hash_tail[hash] = prev_work;
1008                 else
1009                         wqe->hash_tail[hash] = NULL;
1010         }
1011         wq_list_del(&acct->work_list, &work->list, prev);
1012 }
1013
1014 static bool io_acct_cancel_pending_work(struct io_wqe *wqe,
1015                                         struct io_wqe_acct *acct,
1016                                         struct io_cb_cancel_data *match)
1017         __releases(wqe->lock)
1018 {
1019         struct io_wq_work_node *node, *prev;
1020         struct io_wq_work *work;
1021
1022         wq_list_for_each(node, prev, &acct->work_list) {
1023                 work = container_of(node, struct io_wq_work, list);
1024                 if (!match->fn(work, match->data))
1025                         continue;
1026                 io_wqe_remove_pending(wqe, work, prev);
1027                 raw_spin_unlock(&wqe->lock);
1028                 io_run_cancel(work, wqe);
1029                 match->nr_pending++;
1030                 /* not safe to continue after unlock */
1031                 return true;
1032         }
1033
1034         return false;
1035 }
1036
1037 static void io_wqe_cancel_pending_work(struct io_wqe *wqe,
1038                                        struct io_cb_cancel_data *match)
1039 {
1040         int i;
1041 retry:
1042         raw_spin_lock(&wqe->lock);
1043         for (i = 0; i < IO_WQ_ACCT_NR; i++) {
1044                 struct io_wqe_acct *acct = io_get_acct(wqe, i == 0);
1045
1046                 if (io_acct_cancel_pending_work(wqe, acct, match)) {
1047                         if (match->cancel_all)
1048                                 goto retry;
1049                         return;
1050                 }
1051         }
1052         raw_spin_unlock(&wqe->lock);
1053 }
1054
1055 static void io_wqe_cancel_running_work(struct io_wqe *wqe,
1056                                        struct io_cb_cancel_data *match)
1057 {
1058         rcu_read_lock();
1059         io_wq_for_each_worker(wqe, io_wq_worker_cancel, match);
1060         rcu_read_unlock();
1061 }
1062
1063 enum io_wq_cancel io_wq_cancel_cb(struct io_wq *wq, work_cancel_fn *cancel,
1064                                   void *data, bool cancel_all)
1065 {
1066         struct io_cb_cancel_data match = {
1067                 .fn             = cancel,
1068                 .data           = data,
1069                 .cancel_all     = cancel_all,
1070         };
1071         int node;
1072
1073         /*
1074          * First check pending list, if we're lucky we can just remove it
1075          * from there. CANCEL_OK means that the work is returned as-new,
1076          * no completion will be posted for it.
1077          */
1078         for_each_node(node) {
1079                 struct io_wqe *wqe = wq->wqes[node];
1080
1081                 io_wqe_cancel_pending_work(wqe, &match);
1082                 if (match.nr_pending && !match.cancel_all)
1083                         return IO_WQ_CANCEL_OK;
1084         }
1085
1086         /*
1087          * Now check if a free (going busy) or busy worker has the work
1088          * currently running. If we find it there, we'll return CANCEL_RUNNING
1089          * as an indication that we attempt to signal cancellation. The
1090          * completion will run normally in this case.
1091          */
1092         for_each_node(node) {
1093                 struct io_wqe *wqe = wq->wqes[node];
1094
1095                 io_wqe_cancel_running_work(wqe, &match);
1096                 if (match.nr_running && !match.cancel_all)
1097                         return IO_WQ_CANCEL_RUNNING;
1098         }
1099
1100         if (match.nr_running)
1101                 return IO_WQ_CANCEL_RUNNING;
1102         if (match.nr_pending)
1103                 return IO_WQ_CANCEL_OK;
1104         return IO_WQ_CANCEL_NOTFOUND;
1105 }
1106
1107 static int io_wqe_hash_wake(struct wait_queue_entry *wait, unsigned mode,
1108                             int sync, void *key)
1109 {
1110         struct io_wqe *wqe = container_of(wait, struct io_wqe, wait);
1111         int i;
1112
1113         list_del_init(&wait->entry);
1114
1115         rcu_read_lock();
1116         for (i = 0; i < IO_WQ_ACCT_NR; i++) {
1117                 struct io_wqe_acct *acct = &wqe->acct[i];
1118
1119                 if (test_and_clear_bit(IO_ACCT_STALLED_BIT, &acct->flags))
1120                         io_wqe_activate_free_worker(wqe, acct);
1121         }
1122         rcu_read_unlock();
1123         return 1;
1124 }
1125
1126 struct io_wq *io_wq_create(unsigned bounded, struct io_wq_data *data)
1127 {
1128         int ret, node, i;
1129         struct io_wq *wq;
1130
1131         if (WARN_ON_ONCE(!data->free_work || !data->do_work))
1132                 return ERR_PTR(-EINVAL);
1133         if (WARN_ON_ONCE(!bounded))
1134                 return ERR_PTR(-EINVAL);
1135
1136         wq = kzalloc(struct_size(wq, wqes, nr_node_ids), GFP_KERNEL);
1137         if (!wq)
1138                 return ERR_PTR(-ENOMEM);
1139         ret = cpuhp_state_add_instance_nocalls(io_wq_online, &wq->cpuhp_node);
1140         if (ret)
1141                 goto err_wq;
1142
1143         refcount_inc(&data->hash->refs);
1144         wq->hash = data->hash;
1145         wq->free_work = data->free_work;
1146         wq->do_work = data->do_work;
1147
1148         ret = -ENOMEM;
1149         for_each_node(node) {
1150                 struct io_wqe *wqe;
1151                 int alloc_node = node;
1152
1153                 if (!node_online(alloc_node))
1154                         alloc_node = NUMA_NO_NODE;
1155                 wqe = kzalloc_node(sizeof(struct io_wqe), GFP_KERNEL, alloc_node);
1156                 if (!wqe)
1157                         goto err;
1158                 if (!alloc_cpumask_var(&wqe->cpu_mask, GFP_KERNEL))
1159                         goto err;
1160                 cpumask_copy(wqe->cpu_mask, cpumask_of_node(node));
1161                 wq->wqes[node] = wqe;
1162                 wqe->node = alloc_node;
1163                 wqe->acct[IO_WQ_ACCT_BOUND].max_workers = bounded;
1164                 wqe->acct[IO_WQ_ACCT_UNBOUND].max_workers =
1165                                         task_rlimit(current, RLIMIT_NPROC);
1166                 INIT_LIST_HEAD(&wqe->wait.entry);
1167                 wqe->wait.func = io_wqe_hash_wake;
1168                 for (i = 0; i < IO_WQ_ACCT_NR; i++) {
1169                         struct io_wqe_acct *acct = &wqe->acct[i];
1170
1171                         acct->index = i;
1172                         atomic_set(&acct->nr_running, 0);
1173                         INIT_WQ_LIST(&acct->work_list);
1174                 }
1175                 wqe->wq = wq;
1176                 raw_spin_lock_init(&wqe->lock);
1177                 INIT_HLIST_NULLS_HEAD(&wqe->free_list, 0);
1178                 INIT_LIST_HEAD(&wqe->all_list);
1179         }
1180
1181         wq->task = get_task_struct(data->task);
1182         atomic_set(&wq->worker_refs, 1);
1183         init_completion(&wq->worker_done);
1184         return wq;
1185 err:
1186         io_wq_put_hash(data->hash);
1187         cpuhp_state_remove_instance_nocalls(io_wq_online, &wq->cpuhp_node);
1188         for_each_node(node) {
1189                 if (!wq->wqes[node])
1190                         continue;
1191                 free_cpumask_var(wq->wqes[node]->cpu_mask);
1192                 kfree(wq->wqes[node]);
1193         }
1194 err_wq:
1195         kfree(wq);
1196         return ERR_PTR(ret);
1197 }
1198
1199 static bool io_task_work_match(struct callback_head *cb, void *data)
1200 {
1201         struct io_worker *worker;
1202
1203         if (cb->func != create_worker_cb && cb->func != create_worker_cont)
1204                 return false;
1205         worker = container_of(cb, struct io_worker, create_work);
1206         return worker->wqe->wq == data;
1207 }
1208
1209 void io_wq_exit_start(struct io_wq *wq)
1210 {
1211         set_bit(IO_WQ_BIT_EXIT, &wq->state);
1212 }
1213
1214 static void io_wq_cancel_tw_create(struct io_wq *wq)
1215 {
1216         struct callback_head *cb;
1217
1218         while ((cb = task_work_cancel_match(wq->task, io_task_work_match, wq)) != NULL) {
1219                 struct io_worker *worker;
1220
1221                 worker = container_of(cb, struct io_worker, create_work);
1222                 io_worker_cancel_cb(worker);
1223         }
1224 }
1225
1226 static void io_wq_exit_workers(struct io_wq *wq)
1227 {
1228         int node;
1229
1230         if (!wq->task)
1231                 return;
1232
1233         io_wq_cancel_tw_create(wq);
1234
1235         rcu_read_lock();
1236         for_each_node(node) {
1237                 struct io_wqe *wqe = wq->wqes[node];
1238
1239                 io_wq_for_each_worker(wqe, io_wq_worker_wake, NULL);
1240         }
1241         rcu_read_unlock();
1242         io_worker_ref_put(wq);
1243         wait_for_completion(&wq->worker_done);
1244
1245         for_each_node(node) {
1246                 spin_lock_irq(&wq->hash->wait.lock);
1247                 list_del_init(&wq->wqes[node]->wait.entry);
1248                 spin_unlock_irq(&wq->hash->wait.lock);
1249         }
1250         put_task_struct(wq->task);
1251         wq->task = NULL;
1252 }
1253
1254 static void io_wq_destroy(struct io_wq *wq)
1255 {
1256         int node;
1257
1258         cpuhp_state_remove_instance_nocalls(io_wq_online, &wq->cpuhp_node);
1259
1260         for_each_node(node) {
1261                 struct io_wqe *wqe = wq->wqes[node];
1262                 struct io_cb_cancel_data match = {
1263                         .fn             = io_wq_work_match_all,
1264                         .cancel_all     = true,
1265                 };
1266                 io_wqe_cancel_pending_work(wqe, &match);
1267                 free_cpumask_var(wqe->cpu_mask);
1268                 kfree(wqe);
1269         }
1270         io_wq_put_hash(wq->hash);
1271         kfree(wq);
1272 }
1273
1274 void io_wq_put_and_exit(struct io_wq *wq)
1275 {
1276         WARN_ON_ONCE(!test_bit(IO_WQ_BIT_EXIT, &wq->state));
1277
1278         io_wq_exit_workers(wq);
1279         io_wq_destroy(wq);
1280 }
1281
1282 struct online_data {
1283         unsigned int cpu;
1284         bool online;
1285 };
1286
1287 static bool io_wq_worker_affinity(struct io_worker *worker, void *data)
1288 {
1289         struct online_data *od = data;
1290
1291         if (od->online)
1292                 cpumask_set_cpu(od->cpu, worker->wqe->cpu_mask);
1293         else
1294                 cpumask_clear_cpu(od->cpu, worker->wqe->cpu_mask);
1295         return false;
1296 }
1297
1298 static int __io_wq_cpu_online(struct io_wq *wq, unsigned int cpu, bool online)
1299 {
1300         struct online_data od = {
1301                 .cpu = cpu,
1302                 .online = online
1303         };
1304         int i;
1305
1306         rcu_read_lock();
1307         for_each_node(i)
1308                 io_wq_for_each_worker(wq->wqes[i], io_wq_worker_affinity, &od);
1309         rcu_read_unlock();
1310         return 0;
1311 }
1312
1313 static int io_wq_cpu_online(unsigned int cpu, struct hlist_node *node)
1314 {
1315         struct io_wq *wq = hlist_entry_safe(node, struct io_wq, cpuhp_node);
1316
1317         return __io_wq_cpu_online(wq, cpu, true);
1318 }
1319
1320 static int io_wq_cpu_offline(unsigned int cpu, struct hlist_node *node)
1321 {
1322         struct io_wq *wq = hlist_entry_safe(node, struct io_wq, cpuhp_node);
1323
1324         return __io_wq_cpu_online(wq, cpu, false);
1325 }
1326
1327 int io_wq_cpu_affinity(struct io_wq *wq, cpumask_var_t mask)
1328 {
1329         int i;
1330
1331         rcu_read_lock();
1332         for_each_node(i) {
1333                 struct io_wqe *wqe = wq->wqes[i];
1334
1335                 if (mask)
1336                         cpumask_copy(wqe->cpu_mask, mask);
1337                 else
1338                         cpumask_copy(wqe->cpu_mask, cpumask_of_node(i));
1339         }
1340         rcu_read_unlock();
1341         return 0;
1342 }
1343
1344 /*
1345  * Set max number of unbounded workers, returns old value. If new_count is 0,
1346  * then just return the old value.
1347  */
1348 int io_wq_max_workers(struct io_wq *wq, int *new_count)
1349 {
1350         int prev[IO_WQ_ACCT_NR];
1351         bool first_node = true;
1352         int i, node;
1353
1354         BUILD_BUG_ON((int) IO_WQ_ACCT_BOUND   != (int) IO_WQ_BOUND);
1355         BUILD_BUG_ON((int) IO_WQ_ACCT_UNBOUND != (int) IO_WQ_UNBOUND);
1356         BUILD_BUG_ON((int) IO_WQ_ACCT_NR      != 2);
1357
1358         for (i = 0; i < 2; i++) {
1359                 if (new_count[i] > task_rlimit(current, RLIMIT_NPROC))
1360                         new_count[i] = task_rlimit(current, RLIMIT_NPROC);
1361         }
1362
1363         for (i = 0; i < IO_WQ_ACCT_NR; i++)
1364                 prev[i] = 0;
1365
1366         rcu_read_lock();
1367         for_each_node(node) {
1368                 struct io_wqe *wqe = wq->wqes[node];
1369                 struct io_wqe_acct *acct;
1370
1371                 raw_spin_lock(&wqe->lock);
1372                 for (i = 0; i < IO_WQ_ACCT_NR; i++) {
1373                         acct = &wqe->acct[i];
1374                         if (first_node)
1375                                 prev[i] = max_t(int, acct->max_workers, prev[i]);
1376                         if (new_count[i])
1377                                 acct->max_workers = new_count[i];
1378                 }
1379                 raw_spin_unlock(&wqe->lock);
1380                 first_node = false;
1381         }
1382         rcu_read_unlock();
1383
1384         for (i = 0; i < IO_WQ_ACCT_NR; i++)
1385                 new_count[i] = prev[i];
1386
1387         return 0;
1388 }
1389
1390 static __init int io_wq_init(void)
1391 {
1392         int ret;
1393
1394         ret = cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN, "io-wq/online",
1395                                         io_wq_cpu_online, io_wq_cpu_offline);
1396         if (ret < 0)
1397                 return ret;
1398         io_wq_online = ret;
1399         return 0;
1400 }
1401 subsys_initcall(io_wq_init);