Merge tag 'pidfd.v5.16' of git://git.kernel.org/pub/scm/linux/kernel/git/brauner...
[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 void io_wait_on_hash(struct io_wqe *wqe, unsigned int hash)
427 {
428         struct io_wq *wq = wqe->wq;
429
430         spin_lock_irq(&wq->hash->wait.lock);
431         if (list_empty(&wqe->wait.entry)) {
432                 __add_wait_queue(&wq->hash->wait, &wqe->wait);
433                 if (!test_bit(hash, &wq->hash->map)) {
434                         __set_current_state(TASK_RUNNING);
435                         list_del_init(&wqe->wait.entry);
436                 }
437         }
438         spin_unlock_irq(&wq->hash->wait.lock);
439 }
440
441 static struct io_wq_work *io_get_next_work(struct io_wqe_acct *acct,
442                                            struct io_worker *worker)
443         __must_hold(wqe->lock)
444 {
445         struct io_wq_work_node *node, *prev;
446         struct io_wq_work *work, *tail;
447         unsigned int stall_hash = -1U;
448         struct io_wqe *wqe = worker->wqe;
449
450         wq_list_for_each(node, prev, &acct->work_list) {
451                 unsigned int hash;
452
453                 work = container_of(node, struct io_wq_work, list);
454
455                 /* not hashed, can run anytime */
456                 if (!io_wq_is_hashed(work)) {
457                         wq_list_del(&acct->work_list, node, prev);
458                         return work;
459                 }
460
461                 hash = io_get_work_hash(work);
462                 /* all items with this hash lie in [work, tail] */
463                 tail = wqe->hash_tail[hash];
464
465                 /* hashed, can run if not already running */
466                 if (!test_and_set_bit(hash, &wqe->wq->hash->map)) {
467                         wqe->hash_tail[hash] = NULL;
468                         wq_list_cut(&acct->work_list, &tail->list, prev);
469                         return work;
470                 }
471                 if (stall_hash == -1U)
472                         stall_hash = hash;
473                 /* fast forward to a next hash, for-each will fix up @prev */
474                 node = &tail->list;
475         }
476
477         if (stall_hash != -1U) {
478                 /*
479                  * Set this before dropping the lock to avoid racing with new
480                  * work being added and clearing the stalled bit.
481                  */
482                 set_bit(IO_ACCT_STALLED_BIT, &acct->flags);
483                 raw_spin_unlock(&wqe->lock);
484                 io_wait_on_hash(wqe, stall_hash);
485                 raw_spin_lock(&wqe->lock);
486         }
487
488         return NULL;
489 }
490
491 static bool io_flush_signals(void)
492 {
493         if (unlikely(test_thread_flag(TIF_NOTIFY_SIGNAL))) {
494                 __set_current_state(TASK_RUNNING);
495                 tracehook_notify_signal();
496                 return true;
497         }
498         return false;
499 }
500
501 static void io_assign_current_work(struct io_worker *worker,
502                                    struct io_wq_work *work)
503 {
504         if (work) {
505                 io_flush_signals();
506                 cond_resched();
507         }
508
509         spin_lock(&worker->lock);
510         worker->cur_work = work;
511         spin_unlock(&worker->lock);
512 }
513
514 static void io_wqe_enqueue(struct io_wqe *wqe, struct io_wq_work *work);
515
516 static void io_worker_handle_work(struct io_worker *worker)
517         __releases(wqe->lock)
518 {
519         struct io_wqe_acct *acct = io_wqe_get_acct(worker);
520         struct io_wqe *wqe = worker->wqe;
521         struct io_wq *wq = wqe->wq;
522         bool do_kill = test_bit(IO_WQ_BIT_EXIT, &wq->state);
523
524         do {
525                 struct io_wq_work *work;
526 get_next:
527                 /*
528                  * If we got some work, mark us as busy. If we didn't, but
529                  * the list isn't empty, it means we stalled on hashed work.
530                  * Mark us stalled so we don't keep looking for work when we
531                  * can't make progress, any work completion or insertion will
532                  * clear the stalled flag.
533                  */
534                 work = io_get_next_work(acct, worker);
535                 if (work)
536                         __io_worker_busy(wqe, worker, work);
537
538                 raw_spin_unlock(&wqe->lock);
539                 if (!work)
540                         break;
541                 io_assign_current_work(worker, work);
542                 __set_current_state(TASK_RUNNING);
543
544                 /* handle a whole dependent link */
545                 do {
546                         struct io_wq_work *next_hashed, *linked;
547                         unsigned int hash = io_get_work_hash(work);
548
549                         next_hashed = wq_next_work(work);
550
551                         if (unlikely(do_kill) && (work->flags & IO_WQ_WORK_UNBOUND))
552                                 work->flags |= IO_WQ_WORK_CANCEL;
553                         wq->do_work(work);
554                         io_assign_current_work(worker, NULL);
555
556                         linked = wq->free_work(work);
557                         work = next_hashed;
558                         if (!work && linked && !io_wq_is_hashed(linked)) {
559                                 work = linked;
560                                 linked = NULL;
561                         }
562                         io_assign_current_work(worker, work);
563                         if (linked)
564                                 io_wqe_enqueue(wqe, linked);
565
566                         if (hash != -1U && !next_hashed) {
567                                 clear_bit(hash, &wq->hash->map);
568                                 clear_bit(IO_ACCT_STALLED_BIT, &acct->flags);
569                                 if (wq_has_sleeper(&wq->hash->wait))
570                                         wake_up(&wq->hash->wait);
571                                 raw_spin_lock(&wqe->lock);
572                                 /* skip unnecessary unlock-lock wqe->lock */
573                                 if (!work)
574                                         goto get_next;
575                                 raw_spin_unlock(&wqe->lock);
576                         }
577                 } while (work);
578
579                 raw_spin_lock(&wqe->lock);
580         } while (1);
581 }
582
583 static int io_wqe_worker(void *data)
584 {
585         struct io_worker *worker = data;
586         struct io_wqe_acct *acct = io_wqe_get_acct(worker);
587         struct io_wqe *wqe = worker->wqe;
588         struct io_wq *wq = wqe->wq;
589         bool last_timeout = false;
590         char buf[TASK_COMM_LEN];
591
592         worker->flags |= (IO_WORKER_F_UP | IO_WORKER_F_RUNNING);
593
594         snprintf(buf, sizeof(buf), "iou-wrk-%d", wq->task->pid);
595         set_task_comm(current, buf);
596
597         audit_alloc_kernel(current);
598
599         while (!test_bit(IO_WQ_BIT_EXIT, &wq->state)) {
600                 long ret;
601
602                 set_current_state(TASK_INTERRUPTIBLE);
603 loop:
604                 raw_spin_lock(&wqe->lock);
605                 if (io_acct_run_queue(acct)) {
606                         io_worker_handle_work(worker);
607                         goto loop;
608                 }
609                 /* timed out, exit unless we're the last worker */
610                 if (last_timeout && acct->nr_workers > 1) {
611                         acct->nr_workers--;
612                         raw_spin_unlock(&wqe->lock);
613                         __set_current_state(TASK_RUNNING);
614                         break;
615                 }
616                 last_timeout = false;
617                 __io_worker_idle(wqe, worker);
618                 raw_spin_unlock(&wqe->lock);
619                 if (io_flush_signals())
620                         continue;
621                 ret = schedule_timeout(WORKER_IDLE_TIMEOUT);
622                 if (signal_pending(current)) {
623                         struct ksignal ksig;
624
625                         if (!get_signal(&ksig))
626                                 continue;
627                         break;
628                 }
629                 last_timeout = !ret;
630         }
631
632         if (test_bit(IO_WQ_BIT_EXIT, &wq->state)) {
633                 raw_spin_lock(&wqe->lock);
634                 io_worker_handle_work(worker);
635         }
636
637         audit_free(current);
638         io_worker_exit(worker);
639         return 0;
640 }
641
642 /*
643  * Called when a worker is scheduled in. Mark us as currently running.
644  */
645 void io_wq_worker_running(struct task_struct *tsk)
646 {
647         struct io_worker *worker = tsk->pf_io_worker;
648
649         if (!worker)
650                 return;
651         if (!(worker->flags & IO_WORKER_F_UP))
652                 return;
653         if (worker->flags & IO_WORKER_F_RUNNING)
654                 return;
655         worker->flags |= IO_WORKER_F_RUNNING;
656         io_wqe_inc_running(worker);
657 }
658
659 /*
660  * Called when worker is going to sleep. If there are no workers currently
661  * running and we have work pending, wake up a free one or create a new one.
662  */
663 void io_wq_worker_sleeping(struct task_struct *tsk)
664 {
665         struct io_worker *worker = tsk->pf_io_worker;
666
667         if (!worker)
668                 return;
669         if (!(worker->flags & IO_WORKER_F_UP))
670                 return;
671         if (!(worker->flags & IO_WORKER_F_RUNNING))
672                 return;
673
674         worker->flags &= ~IO_WORKER_F_RUNNING;
675
676         raw_spin_lock(&worker->wqe->lock);
677         io_wqe_dec_running(worker);
678         raw_spin_unlock(&worker->wqe->lock);
679 }
680
681 static void io_init_new_worker(struct io_wqe *wqe, struct io_worker *worker,
682                                struct task_struct *tsk)
683 {
684         tsk->pf_io_worker = worker;
685         worker->task = tsk;
686         set_cpus_allowed_ptr(tsk, wqe->cpu_mask);
687         tsk->flags |= PF_NO_SETAFFINITY;
688
689         raw_spin_lock(&wqe->lock);
690         hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
691         list_add_tail_rcu(&worker->all_list, &wqe->all_list);
692         worker->flags |= IO_WORKER_F_FREE;
693         raw_spin_unlock(&wqe->lock);
694         wake_up_new_task(tsk);
695 }
696
697 static bool io_wq_work_match_all(struct io_wq_work *work, void *data)
698 {
699         return true;
700 }
701
702 static inline bool io_should_retry_thread(long err)
703 {
704         switch (err) {
705         case -EAGAIN:
706         case -ERESTARTSYS:
707         case -ERESTARTNOINTR:
708         case -ERESTARTNOHAND:
709                 return true;
710         default:
711                 return false;
712         }
713 }
714
715 static void create_worker_cont(struct callback_head *cb)
716 {
717         struct io_worker *worker;
718         struct task_struct *tsk;
719         struct io_wqe *wqe;
720
721         worker = container_of(cb, struct io_worker, create_work);
722         clear_bit_unlock(0, &worker->create_state);
723         wqe = worker->wqe;
724         tsk = create_io_thread(io_wqe_worker, worker, wqe->node);
725         if (!IS_ERR(tsk)) {
726                 io_init_new_worker(wqe, worker, tsk);
727                 io_worker_release(worker);
728                 return;
729         } else if (!io_should_retry_thread(PTR_ERR(tsk))) {
730                 struct io_wqe_acct *acct = io_wqe_get_acct(worker);
731
732                 atomic_dec(&acct->nr_running);
733                 raw_spin_lock(&wqe->lock);
734                 acct->nr_workers--;
735                 if (!acct->nr_workers) {
736                         struct io_cb_cancel_data match = {
737                                 .fn             = io_wq_work_match_all,
738                                 .cancel_all     = true,
739                         };
740
741                         while (io_acct_cancel_pending_work(wqe, acct, &match))
742                                 raw_spin_lock(&wqe->lock);
743                 }
744                 raw_spin_unlock(&wqe->lock);
745                 io_worker_ref_put(wqe->wq);
746                 kfree(worker);
747                 return;
748         }
749
750         /* re-create attempts grab a new worker ref, drop the existing one */
751         io_worker_release(worker);
752         schedule_work(&worker->work);
753 }
754
755 static void io_workqueue_create(struct work_struct *work)
756 {
757         struct io_worker *worker = container_of(work, struct io_worker, work);
758         struct io_wqe_acct *acct = io_wqe_get_acct(worker);
759
760         if (!io_queue_worker_create(worker, acct, create_worker_cont))
761                 kfree(worker);
762 }
763
764 static bool create_io_worker(struct io_wq *wq, struct io_wqe *wqe, int index)
765 {
766         struct io_wqe_acct *acct = &wqe->acct[index];
767         struct io_worker *worker;
768         struct task_struct *tsk;
769
770         __set_current_state(TASK_RUNNING);
771
772         worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, wqe->node);
773         if (!worker) {
774 fail:
775                 atomic_dec(&acct->nr_running);
776                 raw_spin_lock(&wqe->lock);
777                 acct->nr_workers--;
778                 raw_spin_unlock(&wqe->lock);
779                 io_worker_ref_put(wq);
780                 return false;
781         }
782
783         refcount_set(&worker->ref, 1);
784         worker->wqe = wqe;
785         spin_lock_init(&worker->lock);
786         init_completion(&worker->ref_done);
787
788         if (index == IO_WQ_ACCT_BOUND)
789                 worker->flags |= IO_WORKER_F_BOUND;
790
791         tsk = create_io_thread(io_wqe_worker, worker, wqe->node);
792         if (!IS_ERR(tsk)) {
793                 io_init_new_worker(wqe, worker, tsk);
794         } else if (!io_should_retry_thread(PTR_ERR(tsk))) {
795                 kfree(worker);
796                 goto fail;
797         } else {
798                 INIT_WORK(&worker->work, io_workqueue_create);
799                 schedule_work(&worker->work);
800         }
801
802         return true;
803 }
804
805 /*
806  * Iterate the passed in list and call the specific function for each
807  * worker that isn't exiting
808  */
809 static bool io_wq_for_each_worker(struct io_wqe *wqe,
810                                   bool (*func)(struct io_worker *, void *),
811                                   void *data)
812 {
813         struct io_worker *worker;
814         bool ret = false;
815
816         list_for_each_entry_rcu(worker, &wqe->all_list, all_list) {
817                 if (io_worker_get(worker)) {
818                         /* no task if node is/was offline */
819                         if (worker->task)
820                                 ret = func(worker, data);
821                         io_worker_release(worker);
822                         if (ret)
823                                 break;
824                 }
825         }
826
827         return ret;
828 }
829
830 static bool io_wq_worker_wake(struct io_worker *worker, void *data)
831 {
832         set_notify_signal(worker->task);
833         wake_up_process(worker->task);
834         return false;
835 }
836
837 static void io_run_cancel(struct io_wq_work *work, struct io_wqe *wqe)
838 {
839         struct io_wq *wq = wqe->wq;
840
841         do {
842                 work->flags |= IO_WQ_WORK_CANCEL;
843                 wq->do_work(work);
844                 work = wq->free_work(work);
845         } while (work);
846 }
847
848 static void io_wqe_insert_work(struct io_wqe *wqe, struct io_wq_work *work)
849 {
850         struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
851         unsigned int hash;
852         struct io_wq_work *tail;
853
854         if (!io_wq_is_hashed(work)) {
855 append:
856                 wq_list_add_tail(&work->list, &acct->work_list);
857                 return;
858         }
859
860         hash = io_get_work_hash(work);
861         tail = wqe->hash_tail[hash];
862         wqe->hash_tail[hash] = work;
863         if (!tail)
864                 goto append;
865
866         wq_list_add_after(&work->list, &tail->list, &acct->work_list);
867 }
868
869 static bool io_wq_work_match_item(struct io_wq_work *work, void *data)
870 {
871         return work == data;
872 }
873
874 static void io_wqe_enqueue(struct io_wqe *wqe, struct io_wq_work *work)
875 {
876         struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
877         unsigned work_flags = work->flags;
878         bool do_create;
879
880         /*
881          * If io-wq is exiting for this task, or if the request has explicitly
882          * been marked as one that should not get executed, cancel it here.
883          */
884         if (test_bit(IO_WQ_BIT_EXIT, &wqe->wq->state) ||
885             (work->flags & IO_WQ_WORK_CANCEL)) {
886                 io_run_cancel(work, wqe);
887                 return;
888         }
889
890         raw_spin_lock(&wqe->lock);
891         io_wqe_insert_work(wqe, work);
892         clear_bit(IO_ACCT_STALLED_BIT, &acct->flags);
893
894         rcu_read_lock();
895         do_create = !io_wqe_activate_free_worker(wqe, acct);
896         rcu_read_unlock();
897
898         raw_spin_unlock(&wqe->lock);
899
900         if (do_create && ((work_flags & IO_WQ_WORK_CONCURRENT) ||
901             !atomic_read(&acct->nr_running))) {
902                 bool did_create;
903
904                 did_create = io_wqe_create_worker(wqe, acct);
905                 if (likely(did_create))
906                         return;
907
908                 raw_spin_lock(&wqe->lock);
909                 /* fatal condition, failed to create the first worker */
910                 if (!acct->nr_workers) {
911                         struct io_cb_cancel_data match = {
912                                 .fn             = io_wq_work_match_item,
913                                 .data           = work,
914                                 .cancel_all     = false,
915                         };
916
917                         if (io_acct_cancel_pending_work(wqe, acct, &match))
918                                 raw_spin_lock(&wqe->lock);
919                 }
920                 raw_spin_unlock(&wqe->lock);
921         }
922 }
923
924 void io_wq_enqueue(struct io_wq *wq, struct io_wq_work *work)
925 {
926         struct io_wqe *wqe = wq->wqes[numa_node_id()];
927
928         io_wqe_enqueue(wqe, work);
929 }
930
931 /*
932  * Work items that hash to the same value will not be done in parallel.
933  * Used to limit concurrent writes, generally hashed by inode.
934  */
935 void io_wq_hash_work(struct io_wq_work *work, void *val)
936 {
937         unsigned int bit;
938
939         bit = hash_ptr(val, IO_WQ_HASH_ORDER);
940         work->flags |= (IO_WQ_WORK_HASHED | (bit << IO_WQ_HASH_SHIFT));
941 }
942
943 static bool io_wq_worker_cancel(struct io_worker *worker, void *data)
944 {
945         struct io_cb_cancel_data *match = data;
946
947         /*
948          * Hold the lock to avoid ->cur_work going out of scope, caller
949          * may dereference the passed in work.
950          */
951         spin_lock(&worker->lock);
952         if (worker->cur_work &&
953             match->fn(worker->cur_work, match->data)) {
954                 set_notify_signal(worker->task);
955                 match->nr_running++;
956         }
957         spin_unlock(&worker->lock);
958
959         return match->nr_running && !match->cancel_all;
960 }
961
962 static inline void io_wqe_remove_pending(struct io_wqe *wqe,
963                                          struct io_wq_work *work,
964                                          struct io_wq_work_node *prev)
965 {
966         struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
967         unsigned int hash = io_get_work_hash(work);
968         struct io_wq_work *prev_work = NULL;
969
970         if (io_wq_is_hashed(work) && work == wqe->hash_tail[hash]) {
971                 if (prev)
972                         prev_work = container_of(prev, struct io_wq_work, list);
973                 if (prev_work && io_get_work_hash(prev_work) == hash)
974                         wqe->hash_tail[hash] = prev_work;
975                 else
976                         wqe->hash_tail[hash] = NULL;
977         }
978         wq_list_del(&acct->work_list, &work->list, prev);
979 }
980
981 static bool io_acct_cancel_pending_work(struct io_wqe *wqe,
982                                         struct io_wqe_acct *acct,
983                                         struct io_cb_cancel_data *match)
984         __releases(wqe->lock)
985 {
986         struct io_wq_work_node *node, *prev;
987         struct io_wq_work *work;
988
989         wq_list_for_each(node, prev, &acct->work_list) {
990                 work = container_of(node, struct io_wq_work, list);
991                 if (!match->fn(work, match->data))
992                         continue;
993                 io_wqe_remove_pending(wqe, work, prev);
994                 raw_spin_unlock(&wqe->lock);
995                 io_run_cancel(work, wqe);
996                 match->nr_pending++;
997                 /* not safe to continue after unlock */
998                 return true;
999         }
1000
1001         return false;
1002 }
1003
1004 static void io_wqe_cancel_pending_work(struct io_wqe *wqe,
1005                                        struct io_cb_cancel_data *match)
1006 {
1007         int i;
1008 retry:
1009         raw_spin_lock(&wqe->lock);
1010         for (i = 0; i < IO_WQ_ACCT_NR; i++) {
1011                 struct io_wqe_acct *acct = io_get_acct(wqe, i == 0);
1012
1013                 if (io_acct_cancel_pending_work(wqe, acct, match)) {
1014                         if (match->cancel_all)
1015                                 goto retry;
1016                         return;
1017                 }
1018         }
1019         raw_spin_unlock(&wqe->lock);
1020 }
1021
1022 static void io_wqe_cancel_running_work(struct io_wqe *wqe,
1023                                        struct io_cb_cancel_data *match)
1024 {
1025         rcu_read_lock();
1026         io_wq_for_each_worker(wqe, io_wq_worker_cancel, match);
1027         rcu_read_unlock();
1028 }
1029
1030 enum io_wq_cancel io_wq_cancel_cb(struct io_wq *wq, work_cancel_fn *cancel,
1031                                   void *data, bool cancel_all)
1032 {
1033         struct io_cb_cancel_data match = {
1034                 .fn             = cancel,
1035                 .data           = data,
1036                 .cancel_all     = cancel_all,
1037         };
1038         int node;
1039
1040         /*
1041          * First check pending list, if we're lucky we can just remove it
1042          * from there. CANCEL_OK means that the work is returned as-new,
1043          * no completion will be posted for it.
1044          */
1045         for_each_node(node) {
1046                 struct io_wqe *wqe = wq->wqes[node];
1047
1048                 io_wqe_cancel_pending_work(wqe, &match);
1049                 if (match.nr_pending && !match.cancel_all)
1050                         return IO_WQ_CANCEL_OK;
1051         }
1052
1053         /*
1054          * Now check if a free (going busy) or busy worker has the work
1055          * currently running. If we find it there, we'll return CANCEL_RUNNING
1056          * as an indication that we attempt to signal cancellation. The
1057          * completion will run normally in this case.
1058          */
1059         for_each_node(node) {
1060                 struct io_wqe *wqe = wq->wqes[node];
1061
1062                 io_wqe_cancel_running_work(wqe, &match);
1063                 if (match.nr_running && !match.cancel_all)
1064                         return IO_WQ_CANCEL_RUNNING;
1065         }
1066
1067         if (match.nr_running)
1068                 return IO_WQ_CANCEL_RUNNING;
1069         if (match.nr_pending)
1070                 return IO_WQ_CANCEL_OK;
1071         return IO_WQ_CANCEL_NOTFOUND;
1072 }
1073
1074 static int io_wqe_hash_wake(struct wait_queue_entry *wait, unsigned mode,
1075                             int sync, void *key)
1076 {
1077         struct io_wqe *wqe = container_of(wait, struct io_wqe, wait);
1078         int i;
1079
1080         list_del_init(&wait->entry);
1081
1082         rcu_read_lock();
1083         for (i = 0; i < IO_WQ_ACCT_NR; i++) {
1084                 struct io_wqe_acct *acct = &wqe->acct[i];
1085
1086                 if (test_and_clear_bit(IO_ACCT_STALLED_BIT, &acct->flags))
1087                         io_wqe_activate_free_worker(wqe, acct);
1088         }
1089         rcu_read_unlock();
1090         return 1;
1091 }
1092
1093 struct io_wq *io_wq_create(unsigned bounded, struct io_wq_data *data)
1094 {
1095         int ret, node, i;
1096         struct io_wq *wq;
1097
1098         if (WARN_ON_ONCE(!data->free_work || !data->do_work))
1099                 return ERR_PTR(-EINVAL);
1100         if (WARN_ON_ONCE(!bounded))
1101                 return ERR_PTR(-EINVAL);
1102
1103         wq = kzalloc(struct_size(wq, wqes, nr_node_ids), GFP_KERNEL);
1104         if (!wq)
1105                 return ERR_PTR(-ENOMEM);
1106         ret = cpuhp_state_add_instance_nocalls(io_wq_online, &wq->cpuhp_node);
1107         if (ret)
1108                 goto err_wq;
1109
1110         refcount_inc(&data->hash->refs);
1111         wq->hash = data->hash;
1112         wq->free_work = data->free_work;
1113         wq->do_work = data->do_work;
1114
1115         ret = -ENOMEM;
1116         for_each_node(node) {
1117                 struct io_wqe *wqe;
1118                 int alloc_node = node;
1119
1120                 if (!node_online(alloc_node))
1121                         alloc_node = NUMA_NO_NODE;
1122                 wqe = kzalloc_node(sizeof(struct io_wqe), GFP_KERNEL, alloc_node);
1123                 if (!wqe)
1124                         goto err;
1125                 if (!alloc_cpumask_var(&wqe->cpu_mask, GFP_KERNEL))
1126                         goto err;
1127                 cpumask_copy(wqe->cpu_mask, cpumask_of_node(node));
1128                 wq->wqes[node] = wqe;
1129                 wqe->node = alloc_node;
1130                 wqe->acct[IO_WQ_ACCT_BOUND].max_workers = bounded;
1131                 wqe->acct[IO_WQ_ACCT_UNBOUND].max_workers =
1132                                         task_rlimit(current, RLIMIT_NPROC);
1133                 INIT_LIST_HEAD(&wqe->wait.entry);
1134                 wqe->wait.func = io_wqe_hash_wake;
1135                 for (i = 0; i < IO_WQ_ACCT_NR; i++) {
1136                         struct io_wqe_acct *acct = &wqe->acct[i];
1137
1138                         acct->index = i;
1139                         atomic_set(&acct->nr_running, 0);
1140                         INIT_WQ_LIST(&acct->work_list);
1141                 }
1142                 wqe->wq = wq;
1143                 raw_spin_lock_init(&wqe->lock);
1144                 INIT_HLIST_NULLS_HEAD(&wqe->free_list, 0);
1145                 INIT_LIST_HEAD(&wqe->all_list);
1146         }
1147
1148         wq->task = get_task_struct(data->task);
1149         atomic_set(&wq->worker_refs, 1);
1150         init_completion(&wq->worker_done);
1151         return wq;
1152 err:
1153         io_wq_put_hash(data->hash);
1154         cpuhp_state_remove_instance_nocalls(io_wq_online, &wq->cpuhp_node);
1155         for_each_node(node) {
1156                 if (!wq->wqes[node])
1157                         continue;
1158                 free_cpumask_var(wq->wqes[node]->cpu_mask);
1159                 kfree(wq->wqes[node]);
1160         }
1161 err_wq:
1162         kfree(wq);
1163         return ERR_PTR(ret);
1164 }
1165
1166 static bool io_task_work_match(struct callback_head *cb, void *data)
1167 {
1168         struct io_worker *worker;
1169
1170         if (cb->func != create_worker_cb && cb->func != create_worker_cont)
1171                 return false;
1172         worker = container_of(cb, struct io_worker, create_work);
1173         return worker->wqe->wq == data;
1174 }
1175
1176 void io_wq_exit_start(struct io_wq *wq)
1177 {
1178         set_bit(IO_WQ_BIT_EXIT, &wq->state);
1179 }
1180
1181 static void io_wq_exit_workers(struct io_wq *wq)
1182 {
1183         struct callback_head *cb;
1184         int node;
1185
1186         if (!wq->task)
1187                 return;
1188
1189         while ((cb = task_work_cancel_match(wq->task, io_task_work_match, wq)) != NULL) {
1190                 struct io_worker *worker;
1191
1192                 worker = container_of(cb, struct io_worker, create_work);
1193                 io_worker_cancel_cb(worker);
1194         }
1195
1196         rcu_read_lock();
1197         for_each_node(node) {
1198                 struct io_wqe *wqe = wq->wqes[node];
1199
1200                 io_wq_for_each_worker(wqe, io_wq_worker_wake, NULL);
1201         }
1202         rcu_read_unlock();
1203         io_worker_ref_put(wq);
1204         wait_for_completion(&wq->worker_done);
1205
1206         for_each_node(node) {
1207                 spin_lock_irq(&wq->hash->wait.lock);
1208                 list_del_init(&wq->wqes[node]->wait.entry);
1209                 spin_unlock_irq(&wq->hash->wait.lock);
1210         }
1211         put_task_struct(wq->task);
1212         wq->task = NULL;
1213 }
1214
1215 static void io_wq_destroy(struct io_wq *wq)
1216 {
1217         int node;
1218
1219         cpuhp_state_remove_instance_nocalls(io_wq_online, &wq->cpuhp_node);
1220
1221         for_each_node(node) {
1222                 struct io_wqe *wqe = wq->wqes[node];
1223                 struct io_cb_cancel_data match = {
1224                         .fn             = io_wq_work_match_all,
1225                         .cancel_all     = true,
1226                 };
1227                 io_wqe_cancel_pending_work(wqe, &match);
1228                 free_cpumask_var(wqe->cpu_mask);
1229                 kfree(wqe);
1230         }
1231         io_wq_put_hash(wq->hash);
1232         kfree(wq);
1233 }
1234
1235 void io_wq_put_and_exit(struct io_wq *wq)
1236 {
1237         WARN_ON_ONCE(!test_bit(IO_WQ_BIT_EXIT, &wq->state));
1238
1239         io_wq_exit_workers(wq);
1240         io_wq_destroy(wq);
1241 }
1242
1243 struct online_data {
1244         unsigned int cpu;
1245         bool online;
1246 };
1247
1248 static bool io_wq_worker_affinity(struct io_worker *worker, void *data)
1249 {
1250         struct online_data *od = data;
1251
1252         if (od->online)
1253                 cpumask_set_cpu(od->cpu, worker->wqe->cpu_mask);
1254         else
1255                 cpumask_clear_cpu(od->cpu, worker->wqe->cpu_mask);
1256         return false;
1257 }
1258
1259 static int __io_wq_cpu_online(struct io_wq *wq, unsigned int cpu, bool online)
1260 {
1261         struct online_data od = {
1262                 .cpu = cpu,
1263                 .online = online
1264         };
1265         int i;
1266
1267         rcu_read_lock();
1268         for_each_node(i)
1269                 io_wq_for_each_worker(wq->wqes[i], io_wq_worker_affinity, &od);
1270         rcu_read_unlock();
1271         return 0;
1272 }
1273
1274 static int io_wq_cpu_online(unsigned int cpu, struct hlist_node *node)
1275 {
1276         struct io_wq *wq = hlist_entry_safe(node, struct io_wq, cpuhp_node);
1277
1278         return __io_wq_cpu_online(wq, cpu, true);
1279 }
1280
1281 static int io_wq_cpu_offline(unsigned int cpu, struct hlist_node *node)
1282 {
1283         struct io_wq *wq = hlist_entry_safe(node, struct io_wq, cpuhp_node);
1284
1285         return __io_wq_cpu_online(wq, cpu, false);
1286 }
1287
1288 int io_wq_cpu_affinity(struct io_wq *wq, cpumask_var_t mask)
1289 {
1290         int i;
1291
1292         rcu_read_lock();
1293         for_each_node(i) {
1294                 struct io_wqe *wqe = wq->wqes[i];
1295
1296                 if (mask)
1297                         cpumask_copy(wqe->cpu_mask, mask);
1298                 else
1299                         cpumask_copy(wqe->cpu_mask, cpumask_of_node(i));
1300         }
1301         rcu_read_unlock();
1302         return 0;
1303 }
1304
1305 /*
1306  * Set max number of unbounded workers, returns old value. If new_count is 0,
1307  * then just return the old value.
1308  */
1309 int io_wq_max_workers(struct io_wq *wq, int *new_count)
1310 {
1311         int prev[IO_WQ_ACCT_NR];
1312         bool first_node = true;
1313         int i, node;
1314
1315         BUILD_BUG_ON((int) IO_WQ_ACCT_BOUND   != (int) IO_WQ_BOUND);
1316         BUILD_BUG_ON((int) IO_WQ_ACCT_UNBOUND != (int) IO_WQ_UNBOUND);
1317         BUILD_BUG_ON((int) IO_WQ_ACCT_NR      != 2);
1318
1319         for (i = 0; i < 2; i++) {
1320                 if (new_count[i] > task_rlimit(current, RLIMIT_NPROC))
1321                         new_count[i] = task_rlimit(current, RLIMIT_NPROC);
1322         }
1323
1324         for (i = 0; i < IO_WQ_ACCT_NR; i++)
1325                 prev[i] = 0;
1326
1327         rcu_read_lock();
1328         for_each_node(node) {
1329                 struct io_wqe *wqe = wq->wqes[node];
1330                 struct io_wqe_acct *acct;
1331
1332                 raw_spin_lock(&wqe->lock);
1333                 for (i = 0; i < IO_WQ_ACCT_NR; i++) {
1334                         acct = &wqe->acct[i];
1335                         if (first_node)
1336                                 prev[i] = max_t(int, acct->max_workers, prev[i]);
1337                         if (new_count[i])
1338                                 acct->max_workers = new_count[i];
1339                 }
1340                 raw_spin_unlock(&wqe->lock);
1341                 first_node = false;
1342         }
1343         rcu_read_unlock();
1344
1345         for (i = 0; i < IO_WQ_ACCT_NR; i++)
1346                 new_count[i] = prev[i];
1347
1348         return 0;
1349 }
1350
1351 static __init int io_wq_init(void)
1352 {
1353         int ret;
1354
1355         ret = cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN, "io-wq/online",
1356                                         io_wq_cpu_online, io_wq_cpu_offline);
1357         if (ret < 0)
1358                 return ret;
1359         io_wq_online = ret;
1360         return 0;
1361 }
1362 subsys_initcall(io_wq_init);