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                                 break;
 589                         continue;
 590                 }
 591                 last_timeout = !ret;
 592         }
 593
 594         if (test_bit(IO_WQ_BIT_EXIT, &wq->state)) {
 595                 raw_spin_lock(&wqe->lock);
 596                 io_worker_handle_work(worker);
 597         }
 598
 599         io_worker_exit(worker);
 600         return 0;
 601 }
 602
 603 /*
 604  * Called when a worker is scheduled in. Mark us as currently running.
 605  */
 606 void io_wq_worker_running(struct task_struct *tsk)
 607 {
 608         struct io_worker *worker = tsk->pf_io_worker;
 609
 610         if (!worker)
 611                 return;
 612         if (!(worker->flags & IO_WORKER_F_UP))
 613                 return;
 614         if (worker->flags & IO_WORKER_F_RUNNING)
 615                 return;
 616         worker->flags |= IO_WORKER_F_RUNNING;
 617         io_wqe_inc_running(worker);
 618 }
 619
 620 /*
 621  * Called when worker is going to sleep. If there are no workers currently
 622  * running and we have work pending, wake up a free one or create a new one.
 623  */
 624 void io_wq_worker_sleeping(struct task_struct *tsk)
 625 {
 626         struct io_worker *worker = tsk->pf_io_worker;
 627
 628         if (!worker)
 629                 return;
 630         if (!(worker->flags & IO_WORKER_F_UP))
 631                 return;
 632         if (!(worker->flags & IO_WORKER_F_RUNNING))
 633                 return;
 634
 635         worker->flags &= ~IO_WORKER_F_RUNNING;
 636
 637         raw_spin_lock(&worker->wqe->lock);
 638         io_wqe_dec_running(worker);
 639         raw_spin_unlock(&worker->wqe->lock);
 640 }
 641
 642 static void io_init_new_worker(struct io_wqe *wqe, struct io_worker *worker,
 643                                struct task_struct *tsk)
 644 {
 645         tsk->pf_io_worker = worker;
 646         worker->task = tsk;
 647         set_cpus_allowed_ptr(tsk, wqe->cpu_mask);
 648         tsk->flags |= PF_NO_SETAFFINITY;
 649
 650         raw_spin_lock(&wqe->lock);
 651         hlist_nulls_add_head_rcu(&worker->nulls_node, &wqe->free_list);
 652         list_add_tail_rcu(&worker->all_list, &wqe->all_list);
 653         worker->flags |= IO_WORKER_F_FREE;
 654         raw_spin_unlock(&wqe->lock);
 655         wake_up_new_task(tsk);
 656 }
 657
 658 static bool io_wq_work_match_all(struct io_wq_work *work, void *data)
 659 {
 660         return true;
 661 }
 662
 663 static inline bool io_should_retry_thread(long err)
 664 {
 665         switch (err) {
 666         case -EAGAIN:
 667         case -ERESTARTSYS:
 668         case -ERESTARTNOINTR:
 669         case -ERESTARTNOHAND:
 670                 return true;
 671         default:
 672                 return false;
 673         }
 674 }
 675
 676 static void create_worker_cont(struct callback_head *cb)
 677 {
 678         struct io_worker *worker;
 679         struct task_struct *tsk;
 680         struct io_wqe *wqe;
 681
 682         worker = container_of(cb, struct io_worker, create_work);
 683         clear_bit_unlock(0, &worker->create_state);
 684         wqe = worker->wqe;
 685         tsk = create_io_thread(io_wqe_worker, worker, wqe->node);
 686         if (!IS_ERR(tsk)) {
 687                 io_init_new_worker(wqe, worker, tsk);
 688                 io_worker_release(worker);
 689                 return;
 690         } else if (!io_should_retry_thread(PTR_ERR(tsk))) {
 691                 struct io_wqe_acct *acct = io_wqe_get_acct(worker);
 692
 693                 atomic_dec(&acct->nr_running);
 694                 raw_spin_lock(&wqe->lock);
 695                 acct->nr_workers--;
 696                 if (!acct->nr_workers) {
 697                         struct io_cb_cancel_data match = {
 698                                 .fn             = io_wq_work_match_all,
 699                                 .cancel_all     = true,
 700                         };
 701
 702                         while (io_acct_cancel_pending_work(wqe, acct, &match))
 703                                 raw_spin_lock(&wqe->lock);
 704                 }
 705                 raw_spin_unlock(&wqe->lock);
 706                 io_worker_ref_put(wqe->wq);
 707                 kfree(worker);
 708                 return;
 709         }
 710
 711         /* re-create attempts grab a new worker ref, drop the existing one */
 712         io_worker_release(worker);
 713         schedule_work(&worker->work);
 714 }
 715
 716 static void io_workqueue_create(struct work_struct *work)
 717 {
 718         struct io_worker *worker = container_of(work, struct io_worker, work);
 719         struct io_wqe_acct *acct = io_wqe_get_acct(worker);
 720
 721         if (!io_queue_worker_create(worker, acct, create_worker_cont)) {
 722                 clear_bit_unlock(0, &worker->create_state);
 723                 io_worker_release(worker);
 724                 kfree(worker);
 725         }
 726 }
 727
 728 static bool create_io_worker(struct io_wq *wq, struct io_wqe *wqe, int index)
 729 {
 730         struct io_wqe_acct *acct = &wqe->acct[index];
 731         struct io_worker *worker;
 732         struct task_struct *tsk;
 733
 734         __set_current_state(TASK_RUNNING);
 735
 736         worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, wqe->node);
 737         if (!worker) {
 738 fail:
 739                 atomic_dec(&acct->nr_running);
 740                 raw_spin_lock(&wqe->lock);
 741                 acct->nr_workers--;
 742                 raw_spin_unlock(&wqe->lock);
 743                 io_worker_ref_put(wq);
 744                 return false;
 745         }
 746
 747         refcount_set(&worker->ref, 1);
 748         worker->wqe = wqe;
 749         spin_lock_init(&worker->lock);
 750         init_completion(&worker->ref_done);
 751
 752         if (index == IO_WQ_ACCT_BOUND)
 753                 worker->flags |= IO_WORKER_F_BOUND;
 754
 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         } else if (!io_should_retry_thread(PTR_ERR(tsk))) {
 759                 kfree(worker);
 760                 goto fail;
 761         } else {
 762                 INIT_WORK(&worker->work, io_workqueue_create);
 763                 schedule_work(&worker->work);
 764         }
 765
 766         return true;
 767 }
 768
 769 /*
 770  * Iterate the passed in list and call the specific function for each
 771  * worker that isn't exiting
 772  */
 773 static bool io_wq_for_each_worker(struct io_wqe *wqe,
 774                                   bool (*func)(struct io_worker *, void *),
 775                                   void *data)
 776 {
 777         struct io_worker *worker;
 778         bool ret = false;
 779
 780         list_for_each_entry_rcu(worker, &wqe->all_list, all_list) {
 781                 if (io_worker_get(worker)) {
 782                         /* no task if node is/was offline */
 783                         if (worker->task)
 784                                 ret = func(worker, data);
 785                         io_worker_release(worker);
 786                         if (ret)
 787                                 break;
 788                 }
 789         }
 790
 791         return ret;
 792 }
 793
 794 static bool io_wq_worker_wake(struct io_worker *worker, void *data)
 795 {
 796         set_notify_signal(worker->task);
 797         wake_up_process(worker->task);
 798         return false;
 799 }
 800
 801 static void io_run_cancel(struct io_wq_work *work, struct io_wqe *wqe)
 802 {
 803         struct io_wq *wq = wqe->wq;
 804
 805         do {
 806                 work->flags |= IO_WQ_WORK_CANCEL;
 807                 wq->do_work(work);
 808                 work = wq->free_work(work);
 809         } while (work);
 810 }
 811
 812 static void io_wqe_insert_work(struct io_wqe *wqe, struct io_wq_work *work)
 813 {
 814         struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
 815         unsigned int hash;
 816         struct io_wq_work *tail;
 817
 818         if (!io_wq_is_hashed(work)) {
 819 append:
 820                 wq_list_add_tail(&work->list, &acct->work_list);
 821                 return;
 822         }
 823
 824         hash = io_get_work_hash(work);
 825         tail = wqe->hash_tail[hash];
 826         wqe->hash_tail[hash] = work;
 827         if (!tail)
 828                 goto append;
 829
 830         wq_list_add_after(&work->list, &tail->list, &acct->work_list);
 831 }
 832
 833 static bool io_wq_work_match_item(struct io_wq_work *work, void *data)
 834 {
 835         return work == data;
 836 }
 837
 838 static void io_wqe_enqueue(struct io_wqe *wqe, struct io_wq_work *work)
 839 {
 840         struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
 841         unsigned work_flags = work->flags;
 842         bool do_create;
 843
 844         /*
 845          * If io-wq is exiting for this task, or if the request has explicitly
 846          * been marked as one that should not get executed, cancel it here.
 847          */
 848         if (test_bit(IO_WQ_BIT_EXIT, &wqe->wq->state) ||
 849             (work->flags & IO_WQ_WORK_CANCEL)) {
 850                 io_run_cancel(work, wqe);
 851                 return;
 852         }
 853
 854         raw_spin_lock(&wqe->lock);
 855         io_wqe_insert_work(wqe, work);
 856         clear_bit(IO_ACCT_STALLED_BIT, &acct->flags);
 857
 858         rcu_read_lock();
 859         do_create = !io_wqe_activate_free_worker(wqe, acct);
 860         rcu_read_unlock();
 861
 862         raw_spin_unlock(&wqe->lock);
 863
 864         if (do_create && ((work_flags & IO_WQ_WORK_CONCURRENT) ||
 865             !atomic_read(&acct->nr_running))) {
 866                 bool did_create;
 867
 868                 did_create = io_wqe_create_worker(wqe, acct);
 869                 if (likely(did_create))
 870                         return;
 871
 872                 raw_spin_lock(&wqe->lock);
 873                 /* fatal condition, failed to create the first worker */
 874                 if (!acct->nr_workers) {
 875                         struct io_cb_cancel_data match = {
 876                                 .fn             = io_wq_work_match_item,
 877                                 .data           = work,
 878                                 .cancel_all     = false,
 879                         };
 880
 881                         if (io_acct_cancel_pending_work(wqe, acct, &match))
 882                                 raw_spin_lock(&wqe->lock);
 883                 }
 884                 raw_spin_unlock(&wqe->lock);
 885         }
 886 }
 887
 888 void io_wq_enqueue(struct io_wq *wq, struct io_wq_work *work)
 889 {
 890         struct io_wqe *wqe = wq->wqes[numa_node_id()];
 891
 892         io_wqe_enqueue(wqe, work);
 893 }
 894
 895 /*
 896  * Work items that hash to the same value will not be done in parallel.
 897  * Used to limit concurrent writes, generally hashed by inode.
 898  */
 899 void io_wq_hash_work(struct io_wq_work *work, void *val)
 900 {
 901         unsigned int bit;
 902
 903         bit = hash_ptr(val, IO_WQ_HASH_ORDER);
 904         work->flags |= (IO_WQ_WORK_HASHED | (bit << IO_WQ_HASH_SHIFT));
 905 }
 906
 907 static bool io_wq_worker_cancel(struct io_worker *worker, void *data)
 908 {
 909         struct io_cb_cancel_data *match = data;
 910
 911         /*
 912          * Hold the lock to avoid ->cur_work going out of scope, caller
 913          * may dereference the passed in work.
 914          */
 915         spin_lock(&worker->lock);
 916         if (worker->cur_work &&
 917             match->fn(worker->cur_work, match->data)) {
 918                 set_notify_signal(worker->task);
 919                 match->nr_running++;
 920         }
 921         spin_unlock(&worker->lock);
 922
 923         return match->nr_running && !match->cancel_all;
 924 }
 925
 926 static inline void io_wqe_remove_pending(struct io_wqe *wqe,
 927                                          struct io_wq_work *work,
 928                                          struct io_wq_work_node *prev)
 929 {
 930         struct io_wqe_acct *acct = io_work_get_acct(wqe, work);
 931         unsigned int hash = io_get_work_hash(work);
 932         struct io_wq_work *prev_work = NULL;
 933
 934         if (io_wq_is_hashed(work) && work == wqe->hash_tail[hash]) {
 935                 if (prev)
 936                         prev_work = container_of(prev, struct io_wq_work, list);
 937                 if (prev_work && io_get_work_hash(prev_work) == hash)
 938                         wqe->hash_tail[hash] = prev_work;
 939                 else
 940                         wqe->hash_tail[hash] = NULL;
 941         }
 942         wq_list_del(&acct->work_list, &work->list, prev);
 943 }
 944
 945 static bool io_acct_cancel_pending_work(struct io_wqe *wqe,
 946                                         struct io_wqe_acct *acct,
 947                                         struct io_cb_cancel_data *match)
 948         __releases(wqe->lock)
 949 {
 950         struct io_wq_work_node *node, *prev;
 951         struct io_wq_work *work;
 952
 953         wq_list_for_each(node, prev, &acct->work_list) {
 954                 work = container_of(node, struct io_wq_work, list);
 955                 if (!match->fn(work, match->data))
 956                         continue;
 957                 io_wqe_remove_pending(wqe, work, prev);
 958                 raw_spin_unlock(&wqe->lock);
 959                 io_run_cancel(work, wqe);
 960                 match->nr_pending++;
 961                 /* not safe to continue after unlock */
 962                 return true;
 963         }
 964
 965         return false;
 966 }
 967
 968 static void io_wqe_cancel_pending_work(struct io_wqe *wqe,
 969                                        struct io_cb_cancel_data *match)
 970 {
 971         int i;
 972 retry:
 973         raw_spin_lock(&wqe->lock);
 974         for (i = 0; i < IO_WQ_ACCT_NR; i++) {
 975                 struct io_wqe_acct *acct = io_get_acct(wqe, i == 0);
 976
 977                 if (io_acct_cancel_pending_work(wqe, acct, match)) {
 978                         if (match->cancel_all)
 979                                 goto retry;
 980                         return;
 981                 }
 982         }
 983         raw_spin_unlock(&wqe->lock);
 984 }
 985
 986 static void io_wqe_cancel_running_work(struct io_wqe *wqe,
 987                                        struct io_cb_cancel_data *match)
 988 {
 989         rcu_read_lock();
 990         io_wq_for_each_worker(wqe, io_wq_worker_cancel, match);
 991         rcu_read_unlock();
 992 }
 993
 994 enum io_wq_cancel io_wq_cancel_cb(struct io_wq *wq, work_cancel_fn *cancel,
 995                                   void *data, bool cancel_all)
 996 {
 997         struct io_cb_cancel_data match = {
 998                 .fn             = cancel,
 999                 .data           = data,
1000                 .cancel_all     = cancel_all,
1001         };
1002         int node;
1003
1004         /*
1005          * First check pending list, if we're lucky we can just remove it
1006          * from there. CANCEL_OK means that the work is returned as-new,
1007          * no completion will be posted for it.
1008          */
1009         for_each_node(node) {
1010                 struct io_wqe *wqe = wq->wqes[node];
1011
1012                 io_wqe_cancel_pending_work(wqe, &match);
1013                 if (match.nr_pending && !match.cancel_all)
1014                         return IO_WQ_CANCEL_OK;
1015         }
1016
1017         /*
1018          * Now check if a free (going busy) or busy worker has the work
1019          * currently running. If we find it there, we'll return CANCEL_RUNNING
1020          * as an indication that we attempt to signal cancellation. The
1021          * completion will run normally in this case.
1022          */
1023         for_each_node(node) {
1024                 struct io_wqe *wqe = wq->wqes[node];
1025
1026                 io_wqe_cancel_running_work(wqe, &match);
1027                 if (match.nr_running && !match.cancel_all)
1028                         return IO_WQ_CANCEL_RUNNING;
1029         }
1030
1031         if (match.nr_running)
1032                 return IO_WQ_CANCEL_RUNNING;
1033         if (match.nr_pending)
1034                 return IO_WQ_CANCEL_OK;
1035         return IO_WQ_CANCEL_NOTFOUND;
1036 }
1037
1038 static int io_wqe_hash_wake(struct wait_queue_entry *wait, unsigned mode,
1039                             int sync, void *key)
1040 {
1041         struct io_wqe *wqe = container_of(wait, struct io_wqe, wait);
1042         int i;
1043
1044         list_del_init(&wait->entry);
1045
1046         rcu_read_lock();
1047         for (i = 0; i < IO_WQ_ACCT_NR; i++) {
1048                 struct io_wqe_acct *acct = &wqe->acct[i];
1049
1050                 if (test_and_clear_bit(IO_ACCT_STALLED_BIT, &acct->flags))
1051                         io_wqe_activate_free_worker(wqe, acct);
1052         }
1053         rcu_read_unlock();
1054         return 1;
1055 }
1056
1057 struct io_wq *io_wq_create(unsigned bounded, struct io_wq_data *data)
1058 {
1059         int ret, node, i;
1060         struct io_wq *wq;
1061
1062         if (WARN_ON_ONCE(!data->free_work || !data->do_work))
1063                 return ERR_PTR(-EINVAL);
1064         if (WARN_ON_ONCE(!bounded))
1065                 return ERR_PTR(-EINVAL);
1066
1067         wq = kzalloc(struct_size(wq, wqes, nr_node_ids), GFP_KERNEL);
1068         if (!wq)
1069                 return ERR_PTR(-ENOMEM);
1070         ret = cpuhp_state_add_instance_nocalls(io_wq_online, &wq->cpuhp_node);
1071         if (ret)
1072                 goto err_wq;
1073
1074         refcount_inc(&data->hash->refs);
1075         wq->hash = data->hash;
1076         wq->free_work = data->free_work;
1077         wq->do_work = data->do_work;
1078
1079         ret = -ENOMEM;
1080         for_each_node(node) {
1081                 struct io_wqe *wqe;
1082                 int alloc_node = node;
1083
1084                 if (!node_online(alloc_node))
1085                         alloc_node = NUMA_NO_NODE;
1086                 wqe = kzalloc_node(sizeof(struct io_wqe), GFP_KERNEL, alloc_node);
1087                 if (!wqe)
1088                         goto err;
1089                 if (!alloc_cpumask_var(&wqe->cpu_mask, GFP_KERNEL))
1090                         goto err;
1091                 cpumask_copy(wqe->cpu_mask, cpumask_of_node(node));
1092                 wq->wqes[node] = wqe;
1093                 wqe->node = alloc_node;
1094                 wqe->acct[IO_WQ_ACCT_BOUND].max_workers = bounded;
1095                 wqe->acct[IO_WQ_ACCT_UNBOUND].max_workers =
1096                                         task_rlimit(current, RLIMIT_NPROC);
1097                 INIT_LIST_HEAD(&wqe->wait.entry);
1098                 wqe->wait.func = io_wqe_hash_wake;
1099                 for (i = 0; i < IO_WQ_ACCT_NR; i++) {
1100                         struct io_wqe_acct *acct = &wqe->acct[i];
1101
1102                         acct->index = i;
1103                         atomic_set(&acct->nr_running, 0);
1104                         INIT_WQ_LIST(&acct->work_list);
1105                 }
1106                 wqe->wq = wq;
1107                 raw_spin_lock_init(&wqe->lock);
1108                 INIT_HLIST_NULLS_HEAD(&wqe->free_list, 0);
1109                 INIT_LIST_HEAD(&wqe->all_list);
1110         }
1111
1112         wq->task = get_task_struct(data->task);
1113         atomic_set(&wq->worker_refs, 1);
1114         init_completion(&wq->worker_done);
1115         return wq;
1116 err:
1117         io_wq_put_hash(data->hash);
1118         cpuhp_state_remove_instance_nocalls(io_wq_online, &wq->cpuhp_node);
1119         for_each_node(node) {
1120                 if (!wq->wqes[node])
1121                         continue;
1122                 free_cpumask_var(wq->wqes[node]->cpu_mask);
1123                 kfree(wq->wqes[node]);
1124         }
1125 err_wq:
1126         kfree(wq);
1127         return ERR_PTR(ret);
1128 }
1129
1130 static bool io_task_work_match(struct callback_head *cb, void *data)
1131 {
1132         struct io_worker *worker;
1133
1134         if (cb->func != create_worker_cb && cb->func != create_worker_cont)
1135                 return false;
1136         worker = container_of(cb, struct io_worker, create_work);
1137         return worker->wqe->wq == data;
1138 }
1139
1140 void io_wq_exit_start(struct io_wq *wq)
1141 {
1142         set_bit(IO_WQ_BIT_EXIT, &wq->state);
1143 }
1144
1145 static void io_wq_exit_workers(struct io_wq *wq)
1146 {
1147         struct callback_head *cb;
1148         int node;
1149
1150         if (!wq->task)
1151                 return;
1152
1153         while ((cb = task_work_cancel_match(wq->task, io_task_work_match, wq)) != NULL) {
1154                 struct io_worker *worker;
1155                 struct io_wqe_acct *acct;
1156
1157                 worker = container_of(cb, struct io_worker, create_work);
1158                 acct = io_wqe_get_acct(worker);
1159                 atomic_dec(&acct->nr_running);
1160                 raw_spin_lock(&worker->wqe->lock);
1161                 acct->nr_workers--;
1162                 raw_spin_unlock(&worker->wqe->lock);
1163                 io_worker_ref_put(wq);
1164                 clear_bit_unlock(0, &worker->create_state);
1165                 io_worker_release(worker);
1166         }
1167
1168         rcu_read_lock();
1169         for_each_node(node) {
1170                 struct io_wqe *wqe = wq->wqes[node];
1171
1172                 io_wq_for_each_worker(wqe, io_wq_worker_wake, NULL);
1173         }
1174         rcu_read_unlock();
1175         io_worker_ref_put(wq);
1176         wait_for_completion(&wq->worker_done);
1177
1178         for_each_node(node) {
1179                 spin_lock_irq(&wq->hash->wait.lock);
1180                 list_del_init(&wq->wqes[node]->wait.entry);
1181                 spin_unlock_irq(&wq->hash->wait.lock);
1182         }
1183         put_task_struct(wq->task);
1184         wq->task = NULL;
1185 }
1186
1187 static void io_wq_destroy(struct io_wq *wq)
1188 {
1189         int node;
1190
1191         cpuhp_state_remove_instance_nocalls(io_wq_online, &wq->cpuhp_node);
1192
1193         for_each_node(node) {
1194                 struct io_wqe *wqe = wq->wqes[node];
1195                 struct io_cb_cancel_data match = {
1196                         .fn             = io_wq_work_match_all,
1197                         .cancel_all     = true,
1198                 };
1199                 io_wqe_cancel_pending_work(wqe, &match);
1200                 free_cpumask_var(wqe->cpu_mask);
1201                 kfree(wqe);
1202         }
1203         io_wq_put_hash(wq->hash);
1204         kfree(wq);
1205 }
1206
1207 void io_wq_put_and_exit(struct io_wq *wq)
1208 {
1209         WARN_ON_ONCE(!test_bit(IO_WQ_BIT_EXIT, &wq->state));
1210
1211         io_wq_exit_workers(wq);
1212         io_wq_destroy(wq);
1213 }
1214
1215 struct online_data {
1216         unsigned int cpu;
1217         bool online;
1218 };
1219
1220 static bool io_wq_worker_affinity(struct io_worker *worker, void *data)
1221 {
1222         struct online_data *od = data;
1223
1224         if (od->online)
1225                 cpumask_set_cpu(od->cpu, worker->wqe->cpu_mask);
1226         else
1227                 cpumask_clear_cpu(od->cpu, worker->wqe->cpu_mask);
1228         return false;
1229 }
1230
1231 static int __io_wq_cpu_online(struct io_wq *wq, unsigned int cpu, bool online)
1232 {
1233         struct online_data od = {
1234                 .cpu = cpu,
1235                 .online = online
1236         };
1237         int i;
1238
1239         rcu_read_lock();
1240         for_each_node(i)
1241                 io_wq_for_each_worker(wq->wqes[i], io_wq_worker_affinity, &od);
1242         rcu_read_unlock();
1243         return 0;
1244 }
1245
1246 static int io_wq_cpu_online(unsigned int cpu, struct hlist_node *node)
1247 {
1248         struct io_wq *wq = hlist_entry_safe(node, struct io_wq, cpuhp_node);
1249
1250         return __io_wq_cpu_online(wq, cpu, true);
1251 }
1252
1253 static int io_wq_cpu_offline(unsigned int cpu, struct hlist_node *node)
1254 {
1255         struct io_wq *wq = hlist_entry_safe(node, struct io_wq, cpuhp_node);
1256
1257         return __io_wq_cpu_online(wq, cpu, false);
1258 }
1259
1260 int io_wq_cpu_affinity(struct io_wq *wq, cpumask_var_t mask)
1261 {
1262         int i;
1263
1264         rcu_read_lock();
1265         for_each_node(i) {
1266                 struct io_wqe *wqe = wq->wqes[i];
1267
1268                 if (mask)
1269                         cpumask_copy(wqe->cpu_mask, mask);
1270                 else
1271                         cpumask_copy(wqe->cpu_mask, cpumask_of_node(i));
1272         }
1273         rcu_read_unlock();
1274         return 0;
1275 }
1276
1277 /*
1278  * Set max number of unbounded workers, returns old value. If new_count is 0,
1279  * then just return the old value.
1280  */
1281 int io_wq_max_workers(struct io_wq *wq, int *new_count)
1282 {
1283         int i, node, prev = 0;
1284
1285         BUILD_BUG_ON((int) IO_WQ_ACCT_BOUND   != (int) IO_WQ_BOUND);
1286         BUILD_BUG_ON((int) IO_WQ_ACCT_UNBOUND != (int) IO_WQ_UNBOUND);
1287         BUILD_BUG_ON((int) IO_WQ_ACCT_NR      != 2);
1288
1289         for (i = 0; i < 2; i++) {
1290                 if (new_count[i] > task_rlimit(current, RLIMIT_NPROC))
1291                         new_count[i] = task_rlimit(current, RLIMIT_NPROC);
1292         }
1293
1294         rcu_read_lock();
1295         for_each_node(node) {
1296                 struct io_wqe_acct *acct;
1297
1298                 for (i = 0; i < IO_WQ_ACCT_NR; i++) {
1299                         acct = &wq->wqes[node]->acct[i];
1300                         prev = max_t(int, acct->max_workers, prev);
1301                         if (new_count[i])
1302                                 acct->max_workers = new_count[i];
1303                         new_count[i] = prev;
1304                 }
1305         }
1306         rcu_read_unlock();
1307         return 0;
1308 }
1309
1310 static __init int io_wq_init(void)
1311 {
1312         int ret;
1313
1314         ret = cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN, "io-wq/online",
1315                                         io_wq_cpu_online, io_wq_cpu_offline);
1316         if (ret < 0)
1317                 return ret;
1318         io_wq_online = ret;
1319         return 0;
1320 }
1321 subsys_initcall(io_wq_init);