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