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
  15 /*
  16  * For io context allocations
  17  */
  18 static struct kmem_cache *iocontext_cachep;
  19
  20 /**
  21  * get_io_context - increment reference count to io_context
  22  * @ioc: io_context to get
  23  *
  24  * Increment reference count to @ioc.
  25  */
  26 void get_io_context(struct io_context *ioc)
  27 {
  28         BUG_ON(atomic_long_read(&ioc->refcount) <= 0);
  29         atomic_long_inc(&ioc->refcount);
  30 }
  31 EXPORT_SYMBOL(get_io_context);
  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         call_rcu(&icq->__rcu_head, icq_free_icq_rcu);
  89 }
  90
  91 /*
  92  * Slow path for ioc release in put_io_context().  Performs double-lock
  93  * dancing to unlink all icq's and then frees ioc.
  94  */
  95 static void ioc_release_fn(struct work_struct *work)
  96 {
  97         struct io_context *ioc = container_of(work, struct io_context,
  98                                               release_work);
  99         unsigned long flags;
 100
 101         /*
 102          * Exiting icq may call into put_io_context() through elevator
 103          * which will trigger lockdep warning.  The ioc's are guaranteed to
 104          * be different, use a different locking subclass here.  Use
 105          * irqsave variant as there's no spin_lock_irq_nested().
 106          */
 107         spin_lock_irqsave_nested(&ioc->lock, flags, 1);
 108
 109         while (!hlist_empty(&ioc->icq_list)) {
 110                 struct io_cq *icq = hlist_entry(ioc->icq_list.first,
 111                                                 struct io_cq, ioc_node);
 112                 struct request_queue *q = icq->q;
 113
 114                 if (spin_trylock(q->queue_lock)) {
 115                         ioc_destroy_icq(icq);
 116                         spin_unlock(q->queue_lock);
 117                 } else {
 118                         spin_unlock_irqrestore(&ioc->lock, flags);
 119                         cpu_relax();
 120                         spin_lock_irqsave_nested(&ioc->lock, flags, 1);
 121                 }
 122         }
 123
 124         spin_unlock_irqrestore(&ioc->lock, flags);
 125
 126         kmem_cache_free(iocontext_cachep, ioc);
 127 }
 128
 129 /**
 130  * put_io_context - put a reference of io_context
 131  * @ioc: io_context to put
 132  *
 133  * Decrement reference count of @ioc and release it if the count reaches
 134  * zero.
 135  */
 136 void put_io_context(struct io_context *ioc)
 137 {
 138         unsigned long flags;
 139         bool free_ioc = false;
 140
 141         if (ioc == NULL)
 142                 return;
 143
 144         BUG_ON(atomic_long_read(&ioc->refcount) <= 0);
 145
 146         /*
 147          * Releasing ioc requires reverse order double locking and we may
 148          * already be holding a queue_lock.  Do it asynchronously from wq.
 149          */
 150         if (atomic_long_dec_and_test(&ioc->refcount)) {
 151                 spin_lock_irqsave(&ioc->lock, flags);
 152                 if (!hlist_empty(&ioc->icq_list))
 153                         queue_work(system_power_efficient_wq,
 154                                         &ioc->release_work);
 155                 else
 156                         free_ioc = true;
 157                 spin_unlock_irqrestore(&ioc->lock, flags);
 158         }
 159
 160         if (free_ioc)
 161                 kmem_cache_free(iocontext_cachep, ioc);
 162 }
 163 EXPORT_SYMBOL(put_io_context);
 164
 165 /**
 166  * put_io_context_active - put active reference on ioc
 167  * @ioc: ioc of interest
 168  *
 169  * Undo get_io_context_active().  If active reference reaches zero after
 170  * put, @ioc can never issue further IOs and ioscheds are notified.
 171  */
 172 void put_io_context_active(struct io_context *ioc)
 173 {
 174         struct elevator_type *et;
 175         unsigned long flags;
 176         struct io_cq *icq;
 177
 178         if (!atomic_dec_and_test(&ioc->active_ref)) {
 179                 put_io_context(ioc);
 180                 return;
 181         }
 182
 183         /*
 184          * Need ioc lock to walk icq_list and q lock to exit icq.  Perform
 185          * reverse double locking.  Read comment in ioc_release_fn() for
 186          * explanation on the nested locking annotation.
 187          */
 188         spin_lock_irqsave_nested(&ioc->lock, flags, 1);
 189         hlist_for_each_entry(icq, &ioc->icq_list, ioc_node) {
 190                 if (icq->flags & ICQ_EXITED)
 191                         continue;
 192
 193                 et = icq->q->elevator->type;
 194                 ioc_exit_icq(icq);
 195         }
 196         spin_unlock_irqrestore(&ioc->lock, flags);
 197
 198         put_io_context(ioc);
 199 }
 200
 201 /* Called by the exiting task */
 202 void exit_io_context(struct task_struct *task)
 203 {
 204         struct io_context *ioc;
 205
 206         task_lock(task);
 207         ioc = task->io_context;
 208         task->io_context = NULL;
 209         task_unlock(task);
 210
 211         atomic_dec(&ioc->nr_tasks);
 212         put_io_context_active(ioc);
 213 }
 214
 215 static void __ioc_clear_queue(struct list_head *icq_list)
 216 {
 217         unsigned long flags;
 218
 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                 ioc_destroy_icq(icq);
 226                 spin_unlock_irqrestore(&ioc->lock, flags);
 227         }
 228 }
 229
 230 /**
 231  * ioc_clear_queue - break any ioc association with the specified queue
 232  * @q: request_queue being cleared
 233  *
 234  * Walk @q->icq_list and exit all io_cq's.
 235  */
 236 void ioc_clear_queue(struct request_queue *q)
 237 {
 238         LIST_HEAD(icq_list);
 239
 240         spin_lock_irq(q->queue_lock);
 241         list_splice_init(&q->icq_list, &icq_list);
 242         spin_unlock_irq(q->queue_lock);
 243
 244         __ioc_clear_queue(&icq_list);
 245 }
 246
 247 int create_task_io_context(struct task_struct *task, gfp_t gfp_flags, int node)
 248 {
 249         struct io_context *ioc;
 250         int ret;
 251
 252         ioc = kmem_cache_alloc_node(iocontext_cachep, gfp_flags | __GFP_ZERO,
 253                                     node);
 254         if (unlikely(!ioc))
 255                 return -ENOMEM;
 256
 257         /* initialize */
 258         atomic_long_set(&ioc->refcount, 1);
 259         atomic_set(&ioc->nr_tasks, 1);
 260         atomic_set(&ioc->active_ref, 1);
 261         spin_lock_init(&ioc->lock);
 262         INIT_RADIX_TREE(&ioc->icq_tree, GFP_ATOMIC);
 263         INIT_HLIST_HEAD(&ioc->icq_list);
 264         INIT_WORK(&ioc->release_work, ioc_release_fn);
 265
 266         /*
 267          * Try to install.  ioc shouldn't be installed if someone else
 268          * already did or @task, which isn't %current, is exiting.  Note
 269          * that we need to allow ioc creation on exiting %current as exit
 270          * path may issue IOs from e.g. exit_files().  The exit path is
 271          * responsible for not issuing IO after exit_io_context().
 272          */
 273         task_lock(task);
 274         if (!task->io_context &&
 275             (task == current || !(task->flags & PF_EXITING)))
 276                 task->io_context = ioc;
 277         else
 278                 kmem_cache_free(iocontext_cachep, ioc);
 279
 280         ret = task->io_context ? 0 : -EBUSY;
 281
 282         task_unlock(task);
 283
 284         return ret;
 285 }
 286
 287 /**
 288  * get_task_io_context - get io_context of a task
 289  * @task: task of interest
 290  * @gfp_flags: allocation flags, used if allocation is necessary
 291  * @node: allocation node, used if allocation is necessary
 292  *
 293  * Return io_context of @task.  If it doesn't exist, it is created with
 294  * @gfp_flags and @node.  The returned io_context has its reference count
 295  * incremented.
 296  *
 297  * This function always goes through task_lock() and it's better to use
 298  * %current->io_context + get_io_context() for %current.
 299  */
 300 struct io_context *get_task_io_context(struct task_struct *task,
 301                                        gfp_t gfp_flags, int node)
 302 {
 303         struct io_context *ioc;
 304
 305         might_sleep_if(gfpflags_allow_blocking(gfp_flags));
 306
 307         do {
 308                 task_lock(task);
 309                 ioc = task->io_context;
 310                 if (likely(ioc)) {
 311                         get_io_context(ioc);
 312                         task_unlock(task);
 313                         return ioc;
 314                 }
 315                 task_unlock(task);
 316         } while (!create_task_io_context(task, gfp_flags, node));
 317
 318         return NULL;
 319 }
 320 EXPORT_SYMBOL(get_task_io_context);
 321
 322 /**
 323  * ioc_lookup_icq - lookup io_cq from ioc
 324  * @ioc: the associated io_context
 325  * @q: the associated request_queue
 326  *
 327  * Look up io_cq associated with @ioc - @q pair from @ioc.  Must be called
 328  * with @q->queue_lock held.
 329  */
 330 struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q)
 331 {
 332         struct io_cq *icq;
 333
 334         lockdep_assert_held(q->queue_lock);
 335
 336         /*
 337          * icq's are indexed from @ioc using radix tree and hint pointer,
 338          * both of which are protected with RCU.  All removals are done
 339          * holding both q and ioc locks, and we're holding q lock - if we
 340          * find a icq which points to us, it's guaranteed to be valid.
 341          */
 342         rcu_read_lock();
 343         icq = rcu_dereference(ioc->icq_hint);
 344         if (icq && icq->q == q)
 345                 goto out;
 346
 347         icq = radix_tree_lookup(&ioc->icq_tree, q->id);
 348         if (icq && icq->q == q)
 349                 rcu_assign_pointer(ioc->icq_hint, icq); /* allowed to race */
 350         else
 351                 icq = NULL;
 352 out:
 353         rcu_read_unlock();
 354         return icq;
 355 }
 356 EXPORT_SYMBOL(ioc_lookup_icq);
 357
 358 /**
 359  * ioc_create_icq - create and link io_cq
 360  * @ioc: io_context of interest
 361  * @q: request_queue of interest
 362  * @gfp_mask: allocation mask
 363  *
 364  * Make sure io_cq linking @ioc and @q exists.  If icq doesn't exist, they
 365  * will be created using @gfp_mask.
 366  *
 367  * The caller is responsible for ensuring @ioc won't go away and @q is
 368  * alive and will stay alive until this function returns.
 369  */
 370 struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
 371                              gfp_t gfp_mask)
 372 {
 373         struct elevator_type *et = q->elevator->type;
 374         struct io_cq *icq;
 375
 376         /* allocate stuff */
 377         icq = kmem_cache_alloc_node(et->icq_cache, gfp_mask | __GFP_ZERO,
 378                                     q->node);
 379         if (!icq)
 380                 return NULL;
 381
 382         if (radix_tree_maybe_preload(gfp_mask) < 0) {
 383                 kmem_cache_free(et->icq_cache, icq);
 384                 return NULL;
 385         }
 386
 387         icq->ioc = ioc;
 388         icq->q = q;
 389         INIT_LIST_HEAD(&icq->q_node);
 390         INIT_HLIST_NODE(&icq->ioc_node);
 391
 392         /* lock both q and ioc and try to link @icq */
 393         spin_lock_irq(q->queue_lock);
 394         spin_lock(&ioc->lock);
 395
 396         if (likely(!radix_tree_insert(&ioc->icq_tree, q->id, icq))) {
 397                 hlist_add_head(&icq->ioc_node, &ioc->icq_list);
 398                 list_add(&icq->q_node, &q->icq_list);
 399                 if (et->ops.init_icq)
 400                         et->ops.init_icq(icq);
 401         } else {
 402                 kmem_cache_free(et->icq_cache, icq);
 403                 icq = ioc_lookup_icq(ioc, q);
 404                 if (!icq)
 405                         printk(KERN_ERR "cfq: icq link failed!\n");
 406         }
 407
 408         spin_unlock(&ioc->lock);
 409         spin_unlock_irq(q->queue_lock);
 410         radix_tree_preload_end();
 411         return icq;
 412 }
 413
 414 static int __init blk_ioc_init(void)
 415 {
 416         iocontext_cachep = kmem_cache_create("blkdev_ioc",
 417                         sizeof(struct io_context), 0, SLAB_PANIC, NULL);
 418         return 0;
 419 }
 420 subsys_initcall(blk_ioc_init);