fs/io-wq.c

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