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