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