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