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