block/blk-ioc.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Functions related to io context handling
   4  */
   5 #include <linux/kernel.h>
   6 #include <linux/module.h>
   7 #include <linux/init.h>
   8 #include <linux/bio.h>
   9 #include <linux/blkdev.h>
  10 #include <linux/slab.h>
  11 #include <linux/sched/task.h>
  12
  13 #include "blk.h"
  14 #include "blk-mq-sched.h"
  15
  16 /*
  17  * For io context allocations
  18  */
  19 static struct kmem_cache *iocontext_cachep;
  20
  21 /**
  22  * get_io_context - increment reference count to io_context
  23  * @ioc: io_context to get
  24  *
  25  * Increment reference count to @ioc.
  26  */
  27 static void get_io_context(struct io_context *ioc)
  28 {
  29         BUG_ON(atomic_long_read(&ioc->refcount) <= 0);
  30         atomic_long_inc(&ioc->refcount);
  31 }
  32
  33 static void icq_free_icq_rcu(struct rcu_head *head)
  34 {
  35         struct io_cq *icq = container_of(head, struct io_cq, __rcu_head);
  36
  37         kmem_cache_free(icq->__rcu_icq_cache, icq);
  38 }
  39
  40 /*
  41  * Exit an icq. Called with ioc locked for blk-mq, and with both ioc
  42  * and queue locked for legacy.
  43  */
  44 static void ioc_exit_icq(struct io_cq *icq)
  45 {
  46         struct elevator_type *et = icq->q->elevator->type;
  47
  48         if (icq->flags & ICQ_EXITED)
  49                 return;
  50
  51         if (et->ops.exit_icq)
  52                 et->ops.exit_icq(icq);
  53
  54         icq->flags |= ICQ_EXITED;
  55 }
  56
  57 /*
  58  * Release an icq. Called with ioc locked for blk-mq, and with both ioc
  59  * and queue locked for legacy.
  60  */
  61 static void ioc_destroy_icq(struct io_cq *icq)
  62 {
  63         struct io_context *ioc = icq->ioc;
  64         struct request_queue *q = icq->q;
  65         struct elevator_type *et = q->elevator->type;
  66
  67         lockdep_assert_held(&ioc->lock);
  68
  69         radix_tree_delete(&ioc->icq_tree, icq->q->id);
  70         hlist_del_init(&icq->ioc_node);
  71         list_del_init(&icq->q_node);
  72
  73         /*
  74          * Both setting lookup hint to and clearing it from @icq are done
  75          * under queue_lock.  If it's not pointing to @icq now, it never
  76          * will.  Hint assignment itself can race safely.
  77          */
  78         if (rcu_access_pointer(ioc->icq_hint) == icq)
  79                 rcu_assign_pointer(ioc->icq_hint, NULL);
  80
  81         ioc_exit_icq(icq);
  82
  83         /*
  84          * @icq->q might have gone away by the time RCU callback runs
  85          * making it impossible to determine icq_cache.  Record it in @icq.
  86          */
  87         icq->__rcu_icq_cache = et->icq_cache;
  88         icq->flags |= ICQ_DESTROYED;
  89         call_rcu(&icq->__rcu_head, icq_free_icq_rcu);
  90 }
  91
  92 /*
  93  * Slow path for ioc release in put_io_context().  Performs double-lock
  94  * dancing to unlink all icq's and then frees ioc.
  95  */
  96 static void ioc_release_fn(struct work_struct *work)
  97 {
  98         struct io_context *ioc = container_of(work, struct io_context,
  99                                               release_work);
 100         spin_lock_irq(&ioc->lock);
 101
 102         while (!hlist_empty(&ioc->icq_list)) {
 103                 struct io_cq *icq = hlist_entry(ioc->icq_list.first,
 104                                                 struct io_cq, ioc_node);
 105                 struct request_queue *q = icq->q;
 106
 107                 if (spin_trylock(&q->queue_lock)) {
 108                         ioc_destroy_icq(icq);
 109                         spin_unlock(&q->queue_lock);
 110                 } else {
 111                         /* Make sure q and icq cannot be freed. */
 112                         rcu_read_lock();
 113
 114                         /* Re-acquire the locks in the correct order. */
 115                         spin_unlock(&ioc->lock);
 116                         spin_lock(&q->queue_lock);
 117                         spin_lock(&ioc->lock);
 118
 119                         /*
 120                          * The icq may have been destroyed when the ioc lock
 121                          * was released.
 122                          */
 123                         if (!(icq->flags & ICQ_DESTROYED))
 124                                 ioc_destroy_icq(icq);
 125
 126                         spin_unlock(&q->queue_lock);
 127                         rcu_read_unlock();
 128                 }
 129         }
 130
 131         spin_unlock_irq(&ioc->lock);
 132
 133         kmem_cache_free(iocontext_cachep, ioc);
 134 }
 135
 136 /**
 137  * put_io_context - put a reference of io_context
 138  * @ioc: io_context to put
 139  *
 140  * Decrement reference count of @ioc and release it if the count reaches
 141  * zero.
 142  */
 143 void put_io_context(struct io_context *ioc)
 144 {
 145         unsigned long flags;
 146         bool free_ioc = false;
 147
 148         if (ioc == NULL)
 149                 return;
 150
 151         BUG_ON(atomic_long_read(&ioc->refcount) <= 0);
 152
 153         /*
 154          * Releasing ioc requires reverse order double locking and we may
 155          * already be holding a queue_lock.  Do it asynchronously from wq.
 156          */
 157         if (atomic_long_dec_and_test(&ioc->refcount)) {
 158                 spin_lock_irqsave(&ioc->lock, flags);
 159                 if (!hlist_empty(&ioc->icq_list))
 160                         queue_work(system_power_efficient_wq,
 161                                         &ioc->release_work);
 162                 else
 163                         free_ioc = true;
 164                 spin_unlock_irqrestore(&ioc->lock, flags);
 165         }
 166
 167         if (free_ioc)
 168                 kmem_cache_free(iocontext_cachep, ioc);
 169 }
 170 EXPORT_SYMBOL_GPL(put_io_context);
 171
 172 /**
 173  * put_io_context_active - put active reference on ioc
 174  * @ioc: ioc of interest
 175  *
 176  * Put an active reference to an ioc.  If active reference reaches zero after
 177  * put, @ioc can never issue further IOs and ioscheds are notified.
 178  */
 179 static void put_io_context_active(struct io_context *ioc)
 180 {
 181         struct io_cq *icq;
 182
 183         if (!atomic_dec_and_test(&ioc->active_ref)) {
 184                 put_io_context(ioc);
 185                 return;
 186         }
 187
 188         spin_lock_irq(&ioc->lock);
 189         hlist_for_each_entry(icq, &ioc->icq_list, ioc_node) {
 190                 if (icq->flags & ICQ_EXITED)
 191                         continue;
 192
 193                 ioc_exit_icq(icq);
 194         }
 195         spin_unlock_irq(&ioc->lock);
 196
 197         put_io_context(ioc);
 198 }
 199
 200 /* Called by the exiting task */
 201 void exit_io_context(struct task_struct *task)
 202 {
 203         struct io_context *ioc;
 204
 205         task_lock(task);
 206         ioc = task->io_context;
 207         task->io_context = NULL;
 208         task_unlock(task);
 209
 210         atomic_dec(&ioc->nr_tasks);
 211         put_io_context_active(ioc);
 212 }
 213
 214 static void __ioc_clear_queue(struct list_head *icq_list)
 215 {
 216         unsigned long flags;
 217
 218         rcu_read_lock();
 219         while (!list_empty(icq_list)) {
 220                 struct io_cq *icq = list_entry(icq_list->next,
 221                                                 struct io_cq, q_node);
 222                 struct io_context *ioc = icq->ioc;
 223
 224                 spin_lock_irqsave(&ioc->lock, flags);
 225                 if (icq->flags & ICQ_DESTROYED) {
 226                         spin_unlock_irqrestore(&ioc->lock, flags);
 227                         continue;
 228                 }
 229                 ioc_destroy_icq(icq);
 230                 spin_unlock_irqrestore(&ioc->lock, flags);
 231         }
 232         rcu_read_unlock();
 233 }
 234
 235 /**
 236  * ioc_clear_queue - break any ioc association with the specified queue
 237  * @q: request_queue being cleared
 238  *
 239  * Walk @q->icq_list and exit all io_cq's.
 240  */
 241 void ioc_clear_queue(struct request_queue *q)
 242 {
 243         LIST_HEAD(icq_list);
 244
 245         spin_lock_irq(&q->queue_lock);
 246         list_splice_init(&q->icq_list, &icq_list);
 247         spin_unlock_irq(&q->queue_lock);
 248
 249         __ioc_clear_queue(&icq_list);
 250 }
 251
 252 static struct io_context *alloc_io_context(gfp_t gfp_flags, int node)
 253 {
 254         struct io_context *ioc;
 255
 256         ioc = kmem_cache_alloc_node(iocontext_cachep, gfp_flags | __GFP_ZERO,
 257                                     node);
 258         if (unlikely(!ioc))
 259                 return NULL;
 260
 261         atomic_long_set(&ioc->refcount, 1);
 262         atomic_set(&ioc->nr_tasks, 1);
 263         atomic_set(&ioc->active_ref, 1);
 264         spin_lock_init(&ioc->lock);
 265         INIT_RADIX_TREE(&ioc->icq_tree, GFP_ATOMIC);
 266         INIT_HLIST_HEAD(&ioc->icq_list);
 267         INIT_WORK(&ioc->release_work, ioc_release_fn);
 268         return ioc;
 269 }
 270
 271 static struct io_context *create_task_io_context(struct task_struct *task,
 272                 gfp_t gfp_flags, int node)
 273 {
 274         struct io_context *ioc;
 275
 276         ioc = alloc_io_context(gfp_flags, node);
 277         if (!ioc)
 278                 return NULL;
 279
 280         /*
 281          * Try to install.  ioc shouldn't be installed if someone else
 282          * already did or @task, which isn't %current, is exiting.  Note
 283          * that we need to allow ioc creation on exiting %current as exit
 284          * path may issue IOs from e.g. exit_files().  The exit path is
 285          * responsible for not issuing IO after exit_io_context().
 286          */
 287         task_lock(task);
 288         if (!task->io_context &&
 289             (task == current || !(task->flags & PF_EXITING)))
 290                 task->io_context = ioc;
 291         else
 292                 kmem_cache_free(iocontext_cachep, ioc);
 293
 294         ioc = task->io_context;
 295         if (ioc)
 296                 get_io_context(ioc);
 297         task_unlock(task);
 298         return ioc;
 299 }
 300
 301 /**
 302  * get_task_io_context - get io_context of a task
 303  * @task: task of interest
 304  * @gfp_flags: allocation flags, used if allocation is necessary
 305  * @node: allocation node, used if allocation is necessary
 306  *
 307  * Return io_context of @task.  If it doesn't exist, it is created with
 308  * @gfp_flags and @node.  The returned io_context has its reference count
 309  * incremented.
 310  *
 311  * This function always goes through task_lock() and it's better to use
 312  * %current->io_context + get_io_context() for %current.
 313  */
 314 struct io_context *get_task_io_context(struct task_struct *task,
 315                                        gfp_t gfp_flags, int node)
 316 {
 317         struct io_context *ioc;
 318
 319         might_sleep_if(gfpflags_allow_blocking(gfp_flags));
 320
 321         task_lock(task);
 322         ioc = task->io_context;
 323         if (unlikely(!ioc)) {
 324                 task_unlock(task);
 325                 return create_task_io_context(task, gfp_flags, node);
 326         }
 327         get_io_context(ioc);
 328         task_unlock(task);
 329         return ioc;
 330 }
 331
 332 int __copy_io(unsigned long clone_flags, struct task_struct *tsk)
 333 {
 334         struct io_context *ioc = current->io_context;
 335
 336         /*
 337          * Share io context with parent, if CLONE_IO is set
 338          */
 339         if (clone_flags & CLONE_IO) {
 340                 atomic_long_inc(&ioc->refcount);
 341                 atomic_inc(&ioc->active_ref);
 342                 atomic_inc(&ioc->nr_tasks);
 343                 tsk->io_context = ioc;
 344         } else if (ioprio_valid(ioc->ioprio)) {
 345                 tsk->io_context = alloc_io_context(GFP_KERNEL, NUMA_NO_NODE);
 346                 if (!tsk->io_context)
 347                         return -ENOMEM;
 348                 tsk->io_context->ioprio = ioc->ioprio;
 349         }
 350
 351         return 0;
 352 }
 353
 354 /**
 355  * ioc_lookup_icq - lookup io_cq from ioc
 356  * @q: the associated request_queue
 357  *
 358  * Look up io_cq associated with @ioc - @q pair from @ioc.  Must be called
 359  * with @q->queue_lock held.
 360  */
 361 struct io_cq *ioc_lookup_icq(struct request_queue *q)
 362 {
 363         struct io_context *ioc = current->io_context;
 364         struct io_cq *icq;
 365
 366         lockdep_assert_held(&q->queue_lock);
 367
 368         /*
 369          * icq's are indexed from @ioc using radix tree and hint pointer,
 370          * both of which are protected with RCU.  All removals are done
 371          * holding both q and ioc locks, and we're holding q lock - if we
 372          * find a icq which points to us, it's guaranteed to be valid.
 373          */
 374         rcu_read_lock();
 375         icq = rcu_dereference(ioc->icq_hint);
 376         if (icq && icq->q == q)
 377                 goto out;
 378
 379         icq = radix_tree_lookup(&ioc->icq_tree, q->id);
 380         if (icq && icq->q == q)
 381                 rcu_assign_pointer(ioc->icq_hint, icq); /* allowed to race */
 382         else
 383                 icq = NULL;
 384 out:
 385         rcu_read_unlock();
 386         return icq;
 387 }
 388 EXPORT_SYMBOL(ioc_lookup_icq);
 389
 390 /**
 391  * ioc_create_icq - create and link io_cq
 392  * @q: request_queue of interest
 393  *
 394  * Make sure io_cq linking @ioc and @q exists.  If icq doesn't exist, they
 395  * will be created using @gfp_mask.
 396  *
 397  * The caller is responsible for ensuring @ioc won't go away and @q is
 398  * alive and will stay alive until this function returns.
 399  */
 400 static struct io_cq *ioc_create_icq(struct request_queue *q)
 401 {
 402         struct io_context *ioc = current->io_context;
 403         struct elevator_type *et = q->elevator->type;
 404         struct io_cq *icq;
 405
 406         /* allocate stuff */
 407         icq = kmem_cache_alloc_node(et->icq_cache, GFP_ATOMIC | __GFP_ZERO,
 408                                     q->node);
 409         if (!icq)
 410                 return NULL;
 411
 412         if (radix_tree_maybe_preload(GFP_ATOMIC) < 0) {
 413                 kmem_cache_free(et->icq_cache, icq);
 414                 return NULL;
 415         }
 416
 417         icq->ioc = ioc;
 418         icq->q = q;
 419         INIT_LIST_HEAD(&icq->q_node);
 420         INIT_HLIST_NODE(&icq->ioc_node);
 421
 422         /* lock both q and ioc and try to link @icq */
 423         spin_lock_irq(&q->queue_lock);
 424         spin_lock(&ioc->lock);
 425
 426         if (likely(!radix_tree_insert(&ioc->icq_tree, q->id, icq))) {
 427                 hlist_add_head(&icq->ioc_node, &ioc->icq_list);
 428                 list_add(&icq->q_node, &q->icq_list);
 429                 if (et->ops.init_icq)
 430                         et->ops.init_icq(icq);
 431         } else {
 432                 kmem_cache_free(et->icq_cache, icq);
 433                 icq = ioc_lookup_icq(q);
 434                 if (!icq)
 435                         printk(KERN_ERR "cfq: icq link failed!\n");
 436         }
 437
 438         spin_unlock(&ioc->lock);
 439         spin_unlock_irq(&q->queue_lock);
 440         radix_tree_preload_end();
 441         return icq;
 442 }
 443
 444 struct io_cq *ioc_find_get_icq(struct request_queue *q)
 445 {
 446         struct io_context *ioc = current->io_context;
 447         struct io_cq *icq = NULL;
 448
 449         if (unlikely(!ioc)) {
 450                 ioc = create_task_io_context(current, GFP_ATOMIC, q->node);
 451                 if (!ioc)
 452                         return NULL;
 453         } else {
 454                 get_io_context(ioc);
 455
 456                 spin_lock_irq(&q->queue_lock);
 457                 icq = ioc_lookup_icq(q);
 458                 spin_unlock_irq(&q->queue_lock);
 459         }
 460
 461         if (!icq) {
 462                 icq = ioc_create_icq(q);
 463                 if (!icq) {
 464                         put_io_context(ioc);
 465                         return NULL;
 466                 }
 467         }
 468         return icq;
 469 }
 470 EXPORT_SYMBOL_GPL(ioc_find_get_icq);
 471
 472 static int __init blk_ioc_init(void)
 473 {
 474         iocontext_cachep = kmem_cache_create("blkdev_ioc",
 475                         sizeof(struct io_context), 0, SLAB_PANIC, NULL);
 476         return 0;
 477 }
 478 subsys_initcall(blk_ioc_init);