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