block/blk-cgroup.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Common Block IO controller cgroup interface
   4  *
   5  * Based on ideas and code from CFQ, CFS and BFQ:
   6  * Copyright (C) 2003 Jens Axboe <axboe@kernel.dk>
   7  *
   8  * Copyright (C) 2008 Fabio Checconi <fabio@gandalf.sssup.it>
   9  *                    Paolo Valente <paolo.valente@unimore.it>
  10  *
  11  * Copyright (C) 2009 Vivek Goyal <vgoyal@redhat.com>
  12  *                    Nauman Rafique <nauman@google.com>
  13  *
  14  * For policy-specific per-blkcg data:
  15  * Copyright (C) 2015 Paolo Valente <paolo.valente@unimore.it>
  16  *                    Arianna Avanzini <avanzini.arianna@gmail.com>
  17  */
  18 #include <linux/ioprio.h>
  19 #include <linux/kdev_t.h>
  20 #include <linux/module.h>
  21 #include <linux/sched/signal.h>
  22 #include <linux/err.h>
  23 #include <linux/blkdev.h>
  24 #include <linux/backing-dev.h>
  25 #include <linux/slab.h>
  26 #include <linux/genhd.h>
  27 #include <linux/delay.h>
  28 #include <linux/atomic.h>
  29 #include <linux/ctype.h>
  30 #include <linux/blk-cgroup.h>
  31 #include <linux/tracehook.h>
  32 #include <linux/psi.h>
  33 #include "blk.h"
  34
  35 #define MAX_KEY_LEN 100
  36
  37 /*
  38  * blkcg_pol_mutex protects blkcg_policy[] and policy [de]activation.
  39  * blkcg_pol_register_mutex nests outside of it and synchronizes entire
  40  * policy [un]register operations including cgroup file additions /
  41  * removals.  Putting cgroup file registration outside blkcg_pol_mutex
  42  * allows grabbing it from cgroup callbacks.
  43  */
  44 static DEFINE_MUTEX(blkcg_pol_register_mutex);
  45 static DEFINE_MUTEX(blkcg_pol_mutex);
  46
  47 struct blkcg blkcg_root;
  48 EXPORT_SYMBOL_GPL(blkcg_root);
  49
  50 struct cgroup_subsys_state * const blkcg_root_css = &blkcg_root.css;
  51 EXPORT_SYMBOL_GPL(blkcg_root_css);
  52
  53 static struct blkcg_policy *blkcg_policy[BLKCG_MAX_POLS];
  54
  55 static LIST_HEAD(all_blkcgs);           /* protected by blkcg_pol_mutex */
  56
  57 static bool blkcg_debug_stats = false;
  58
  59 static bool blkcg_policy_enabled(struct request_queue *q,
  60                                  const struct blkcg_policy *pol)
  61 {
  62         return pol && test_bit(pol->plid, q->blkcg_pols);
  63 }
  64
  65 /**
  66  * blkg_free - free a blkg
  67  * @blkg: blkg to free
  68  *
  69  * Free @blkg which may be partially allocated.
  70  */
  71 static void blkg_free(struct blkcg_gq *blkg)
  72 {
  73         int i;
  74
  75         if (!blkg)
  76                 return;
  77
  78         for (i = 0; i < BLKCG_MAX_POLS; i++)
  79                 if (blkg->pd[i])
  80                         blkcg_policy[i]->pd_free_fn(blkg->pd[i]);
  81
  82         blkg_rwstat_exit(&blkg->stat_ios);
  83         blkg_rwstat_exit(&blkg->stat_bytes);
  84         percpu_ref_exit(&blkg->refcnt);
  85         kfree(blkg);
  86 }
  87
  88 static void __blkg_release(struct rcu_head *rcu)
  89 {
  90         struct blkcg_gq *blkg = container_of(rcu, struct blkcg_gq, rcu_head);
  91
  92         /* release the blkcg and parent blkg refs this blkg has been holding */
  93         css_put(&blkg->blkcg->css);
  94         if (blkg->parent)
  95                 blkg_put(blkg->parent);
  96
  97         wb_congested_put(blkg->wb_congested);
  98
  99         blkg_free(blkg);
 100 }
 101
 102 /*
 103  * A group is RCU protected, but having an rcu lock does not mean that one
 104  * can access all the fields of blkg and assume these are valid.  For
 105  * example, don't try to follow throtl_data and request queue links.
 106  *
 107  * Having a reference to blkg under an rcu allows accesses to only values
 108  * local to groups like group stats and group rate limits.
 109  */
 110 static void blkg_release(struct percpu_ref *ref)
 111 {
 112         struct blkcg_gq *blkg = container_of(ref, struct blkcg_gq, refcnt);
 113
 114         call_rcu(&blkg->rcu_head, __blkg_release);
 115 }
 116
 117 /**
 118  * blkg_alloc - allocate a blkg
 119  * @blkcg: block cgroup the new blkg is associated with
 120  * @q: request_queue the new blkg is associated with
 121  * @gfp_mask: allocation mask to use
 122  *
 123  * Allocate a new blkg assocating @blkcg and @q.
 124  */
 125 static struct blkcg_gq *blkg_alloc(struct blkcg *blkcg, struct request_queue *q,
 126                                    gfp_t gfp_mask)
 127 {
 128         struct blkcg_gq *blkg;
 129         int i;
 130
 131         /* alloc and init base part */
 132         blkg = kzalloc_node(sizeof(*blkg), gfp_mask, q->node);
 133         if (!blkg)
 134                 return NULL;
 135
 136         if (percpu_ref_init(&blkg->refcnt, blkg_release, 0, gfp_mask))
 137                 goto err_free;
 138
 139         if (blkg_rwstat_init(&blkg->stat_bytes, gfp_mask) ||
 140             blkg_rwstat_init(&blkg->stat_ios, gfp_mask))
 141                 goto err_free;
 142
 143         blkg->q = q;
 144         INIT_LIST_HEAD(&blkg->q_node);
 145         blkg->blkcg = blkcg;
 146
 147         for (i = 0; i < BLKCG_MAX_POLS; i++) {
 148                 struct blkcg_policy *pol = blkcg_policy[i];
 149                 struct blkg_policy_data *pd;
 150
 151                 if (!blkcg_policy_enabled(q, pol))
 152                         continue;
 153
 154                 /* alloc per-policy data and attach it to blkg */
 155                 pd = pol->pd_alloc_fn(gfp_mask, q->node);
 156                 if (!pd)
 157                         goto err_free;
 158
 159                 blkg->pd[i] = pd;
 160                 pd->blkg = blkg;
 161                 pd->plid = i;
 162         }
 163
 164         return blkg;
 165
 166 err_free:
 167         blkg_free(blkg);
 168         return NULL;
 169 }
 170
 171 struct blkcg_gq *blkg_lookup_slowpath(struct blkcg *blkcg,
 172                                       struct request_queue *q, bool update_hint)
 173 {
 174         struct blkcg_gq *blkg;
 175
 176         /*
 177          * Hint didn't match.  Look up from the radix tree.  Note that the
 178          * hint can only be updated under queue_lock as otherwise @blkg
 179          * could have already been removed from blkg_tree.  The caller is
 180          * responsible for grabbing queue_lock if @update_hint.
 181          */
 182         blkg = radix_tree_lookup(&blkcg->blkg_tree, q->id);
 183         if (blkg && blkg->q == q) {
 184                 if (update_hint) {
 185                         lockdep_assert_held(&q->queue_lock);
 186                         rcu_assign_pointer(blkcg->blkg_hint, blkg);
 187                 }
 188                 return blkg;
 189         }
 190
 191         return NULL;
 192 }
 193 EXPORT_SYMBOL_GPL(blkg_lookup_slowpath);
 194
 195 /*
 196  * If @new_blkg is %NULL, this function tries to allocate a new one as
 197  * necessary using %GFP_NOWAIT.  @new_blkg is always consumed on return.
 198  */
 199 static struct blkcg_gq *blkg_create(struct blkcg *blkcg,
 200                                     struct request_queue *q,
 201                                     struct blkcg_gq *new_blkg)
 202 {
 203         struct blkcg_gq *blkg;
 204         struct bdi_writeback_congested *wb_congested;
 205         int i, ret;
 206
 207         WARN_ON_ONCE(!rcu_read_lock_held());
 208         lockdep_assert_held(&q->queue_lock);
 209
 210         /* request_queue is dying, do not create/recreate a blkg */
 211         if (blk_queue_dying(q)) {
 212                 ret = -ENODEV;
 213                 goto err_free_blkg;
 214         }
 215
 216         /* blkg holds a reference to blkcg */
 217         if (!css_tryget_online(&blkcg->css)) {
 218                 ret = -ENODEV;
 219                 goto err_free_blkg;
 220         }
 221
 222         wb_congested = wb_congested_get_create(q->backing_dev_info,
 223                                                blkcg->css.id,
 224                                                GFP_NOWAIT | __GFP_NOWARN);
 225         if (!wb_congested) {
 226                 ret = -ENOMEM;
 227                 goto err_put_css;
 228         }
 229
 230         /* allocate */
 231         if (!new_blkg) {
 232                 new_blkg = blkg_alloc(blkcg, q, GFP_NOWAIT | __GFP_NOWARN);
 233                 if (unlikely(!new_blkg)) {
 234                         ret = -ENOMEM;
 235                         goto err_put_congested;
 236                 }
 237         }
 238         blkg = new_blkg;
 239         blkg->wb_congested = wb_congested;
 240
 241         /* link parent */
 242         if (blkcg_parent(blkcg)) {
 243                 blkg->parent = __blkg_lookup(blkcg_parent(blkcg), q, false);
 244                 if (WARN_ON_ONCE(!blkg->parent)) {
 245                         ret = -ENODEV;
 246                         goto err_put_congested;
 247                 }
 248                 blkg_get(blkg->parent);
 249         }
 250
 251         /* invoke per-policy init */
 252         for (i = 0; i < BLKCG_MAX_POLS; i++) {
 253                 struct blkcg_policy *pol = blkcg_policy[i];
 254
 255                 if (blkg->pd[i] && pol->pd_init_fn)
 256                         pol->pd_init_fn(blkg->pd[i]);
 257         }
 258
 259         /* insert */
 260         spin_lock(&blkcg->lock);
 261         ret = radix_tree_insert(&blkcg->blkg_tree, q->id, blkg);
 262         if (likely(!ret)) {
 263                 hlist_add_head_rcu(&blkg->blkcg_node, &blkcg->blkg_list);
 264                 list_add(&blkg->q_node, &q->blkg_list);
 265
 266                 for (i = 0; i < BLKCG_MAX_POLS; i++) {
 267                         struct blkcg_policy *pol = blkcg_policy[i];
 268
 269                         if (blkg->pd[i] && pol->pd_online_fn)
 270                                 pol->pd_online_fn(blkg->pd[i]);
 271                 }
 272         }
 273         blkg->online = true;
 274         spin_unlock(&blkcg->lock);
 275
 276         if (!ret)
 277                 return blkg;
 278
 279         /* @blkg failed fully initialized, use the usual release path */
 280         blkg_put(blkg);
 281         return ERR_PTR(ret);
 282
 283 err_put_congested:
 284         wb_congested_put(wb_congested);
 285 err_put_css:
 286         css_put(&blkcg->css);
 287 err_free_blkg:
 288         blkg_free(new_blkg);
 289         return ERR_PTR(ret);
 290 }
 291
 292 /**
 293  * __blkg_lookup_create - lookup blkg, try to create one if not there
 294  * @blkcg: blkcg of interest
 295  * @q: request_queue of interest
 296  *
 297  * Lookup blkg for the @blkcg - @q pair.  If it doesn't exist, try to
 298  * create one.  blkg creation is performed recursively from blkcg_root such
 299  * that all non-root blkg's have access to the parent blkg.  This function
 300  * should be called under RCU read lock and @q->queue_lock.
 301  *
 302  * Returns the blkg or the closest blkg if blkg_create() fails as it walks
 303  * down from root.
 304  */
 305 struct blkcg_gq *__blkg_lookup_create(struct blkcg *blkcg,
 306                                       struct request_queue *q)
 307 {
 308         struct blkcg_gq *blkg;
 309
 310         WARN_ON_ONCE(!rcu_read_lock_held());
 311         lockdep_assert_held(&q->queue_lock);
 312
 313         blkg = __blkg_lookup(blkcg, q, true);
 314         if (blkg)
 315                 return blkg;
 316
 317         /*
 318          * Create blkgs walking down from blkcg_root to @blkcg, so that all
 319          * non-root blkgs have access to their parents.  Returns the closest
 320          * blkg to the intended blkg should blkg_create() fail.
 321          */
 322         while (true) {
 323                 struct blkcg *pos = blkcg;
 324                 struct blkcg *parent = blkcg_parent(blkcg);
 325                 struct blkcg_gq *ret_blkg = q->root_blkg;
 326
 327                 while (parent) {
 328                         blkg = __blkg_lookup(parent, q, false);
 329                         if (blkg) {
 330                                 /* remember closest blkg */
 331                                 ret_blkg = blkg;
 332                                 break;
 333                         }
 334                         pos = parent;
 335                         parent = blkcg_parent(parent);
 336                 }
 337
 338                 blkg = blkg_create(pos, q, NULL);
 339                 if (IS_ERR(blkg))
 340                         return ret_blkg;
 341                 if (pos == blkcg)
 342                         return blkg;
 343         }
 344 }
 345
 346 /**
 347  * blkg_lookup_create - find or create a blkg
 348  * @blkcg: target block cgroup
 349  * @q: target request_queue
 350  *
 351  * This looks up or creates the blkg representing the unique pair
 352  * of the blkcg and the request_queue.
 353  */
 354 struct blkcg_gq *blkg_lookup_create(struct blkcg *blkcg,
 355                                     struct request_queue *q)
 356 {
 357         struct blkcg_gq *blkg = blkg_lookup(blkcg, q);
 358
 359         if (unlikely(!blkg)) {
 360                 unsigned long flags;
 361
 362                 spin_lock_irqsave(&q->queue_lock, flags);
 363                 blkg = __blkg_lookup_create(blkcg, q);
 364                 spin_unlock_irqrestore(&q->queue_lock, flags);
 365         }
 366
 367         return blkg;
 368 }
 369
 370 static void blkg_destroy(struct blkcg_gq *blkg)
 371 {
 372         struct blkcg *blkcg = blkg->blkcg;
 373         struct blkcg_gq *parent = blkg->parent;
 374         int i;
 375
 376         lockdep_assert_held(&blkg->q->queue_lock);
 377         lockdep_assert_held(&blkcg->lock);
 378
 379         /* Something wrong if we are trying to remove same group twice */
 380         WARN_ON_ONCE(list_empty(&blkg->q_node));
 381         WARN_ON_ONCE(hlist_unhashed(&blkg->blkcg_node));
 382
 383         for (i = 0; i < BLKCG_MAX_POLS; i++) {
 384                 struct blkcg_policy *pol = blkcg_policy[i];
 385
 386                 if (blkg->pd[i] && pol->pd_offline_fn)
 387                         pol->pd_offline_fn(blkg->pd[i]);
 388         }
 389
 390         if (parent) {
 391                 blkg_rwstat_add_aux(&parent->stat_bytes, &blkg->stat_bytes);
 392                 blkg_rwstat_add_aux(&parent->stat_ios, &blkg->stat_ios);
 393         }
 394
 395         blkg->online = false;
 396
 397         radix_tree_delete(&blkcg->blkg_tree, blkg->q->id);
 398         list_del_init(&blkg->q_node);
 399         hlist_del_init_rcu(&blkg->blkcg_node);
 400
 401         /*
 402          * Both setting lookup hint to and clearing it from @blkg are done
 403          * under queue_lock.  If it's not pointing to @blkg now, it never
 404          * will.  Hint assignment itself can race safely.
 405          */
 406         if (rcu_access_pointer(blkcg->blkg_hint) == blkg)
 407                 rcu_assign_pointer(blkcg->blkg_hint, NULL);
 408
 409         /*
 410          * Put the reference taken at the time of creation so that when all
 411          * queues are gone, group can be destroyed.
 412          */
 413         percpu_ref_kill(&blkg->refcnt);
 414 }
 415
 416 /**
 417  * blkg_destroy_all - destroy all blkgs associated with a request_queue
 418  * @q: request_queue of interest
 419  *
 420  * Destroy all blkgs associated with @q.
 421  */
 422 static void blkg_destroy_all(struct request_queue *q)
 423 {
 424         struct blkcg_gq *blkg, *n;
 425
 426         spin_lock_irq(&q->queue_lock);
 427         list_for_each_entry_safe(blkg, n, &q->blkg_list, q_node) {
 428                 struct blkcg *blkcg = blkg->blkcg;
 429
 430                 spin_lock(&blkcg->lock);
 431                 blkg_destroy(blkg);
 432                 spin_unlock(&blkcg->lock);
 433         }
 434
 435         q->root_blkg = NULL;
 436         spin_unlock_irq(&q->queue_lock);
 437 }
 438
 439 static int blkcg_reset_stats(struct cgroup_subsys_state *css,
 440                              struct cftype *cftype, u64 val)
 441 {
 442         struct blkcg *blkcg = css_to_blkcg(css);
 443         struct blkcg_gq *blkg;
 444         int i;
 445
 446         mutex_lock(&blkcg_pol_mutex);
 447         spin_lock_irq(&blkcg->lock);
 448
 449         /*
 450          * Note that stat reset is racy - it doesn't synchronize against
 451          * stat updates.  This is a debug feature which shouldn't exist
 452          * anyway.  If you get hit by a race, retry.
 453          */
 454         hlist_for_each_entry(blkg, &blkcg->blkg_list, blkcg_node) {
 455                 blkg_rwstat_reset(&blkg->stat_bytes);
 456                 blkg_rwstat_reset(&blkg->stat_ios);
 457
 458                 for (i = 0; i < BLKCG_MAX_POLS; i++) {
 459                         struct blkcg_policy *pol = blkcg_policy[i];
 460
 461                         if (blkg->pd[i] && pol->pd_reset_stats_fn)
 462                                 pol->pd_reset_stats_fn(blkg->pd[i]);
 463                 }
 464         }
 465
 466         spin_unlock_irq(&blkcg->lock);
 467         mutex_unlock(&blkcg_pol_mutex);
 468         return 0;
 469 }
 470
 471 const char *blkg_dev_name(struct blkcg_gq *blkg)
 472 {
 473         /* some drivers (floppy) instantiate a queue w/o disk registered */
 474         if (blkg->q->backing_dev_info->dev)
 475                 return dev_name(blkg->q->backing_dev_info->dev);
 476         return NULL;
 477 }
 478
 479 /**
 480  * blkcg_print_blkgs - helper for printing per-blkg data
 481  * @sf: seq_file to print to
 482  * @blkcg: blkcg of interest
 483  * @prfill: fill function to print out a blkg
 484  * @pol: policy in question
 485  * @data: data to be passed to @prfill
 486  * @show_total: to print out sum of prfill return values or not
 487  *
 488  * This function invokes @prfill on each blkg of @blkcg if pd for the
 489  * policy specified by @pol exists.  @prfill is invoked with @sf, the
 490  * policy data and @data and the matching queue lock held.  If @show_total
 491  * is %true, the sum of the return values from @prfill is printed with
 492  * "Total" label at the end.
 493  *
 494  * This is to be used to construct print functions for
 495  * cftype->read_seq_string method.
 496  */
 497 void blkcg_print_blkgs(struct seq_file *sf, struct blkcg *blkcg,
 498                        u64 (*prfill)(struct seq_file *,
 499                                      struct blkg_policy_data *, int),
 500                        const struct blkcg_policy *pol, int data,
 501                        bool show_total)
 502 {
 503         struct blkcg_gq *blkg;
 504         u64 total = 0;
 505
 506         rcu_read_lock();
 507         hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
 508                 spin_lock_irq(&blkg->q->queue_lock);
 509                 if (blkcg_policy_enabled(blkg->q, pol))
 510                         total += prfill(sf, blkg->pd[pol->plid], data);
 511                 spin_unlock_irq(&blkg->q->queue_lock);
 512         }
 513         rcu_read_unlock();
 514
 515         if (show_total)
 516                 seq_printf(sf, "Total %llu\n", (unsigned long long)total);
 517 }
 518 EXPORT_SYMBOL_GPL(blkcg_print_blkgs);
 519
 520 /**
 521  * __blkg_prfill_u64 - prfill helper for a single u64 value
 522  * @sf: seq_file to print to
 523  * @pd: policy private data of interest
 524  * @v: value to print
 525  *
 526  * Print @v to @sf for the device assocaited with @pd.
 527  */
 528 u64 __blkg_prfill_u64(struct seq_file *sf, struct blkg_policy_data *pd, u64 v)
 529 {
 530         const char *dname = blkg_dev_name(pd->blkg);
 531
 532         if (!dname)
 533                 return 0;
 534
 535         seq_printf(sf, "%s %llu\n", dname, (unsigned long long)v);
 536         return v;
 537 }
 538 EXPORT_SYMBOL_GPL(__blkg_prfill_u64);
 539
 540 /**
 541  * __blkg_prfill_rwstat - prfill helper for a blkg_rwstat
 542  * @sf: seq_file to print to
 543  * @pd: policy private data of interest
 544  * @rwstat: rwstat to print
 545  *
 546  * Print @rwstat to @sf for the device assocaited with @pd.
 547  */
 548 u64 __blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
 549                          const struct blkg_rwstat_sample *rwstat)
 550 {
 551         static const char *rwstr[] = {
 552                 [BLKG_RWSTAT_READ]      = "Read",
 553                 [BLKG_RWSTAT_WRITE]     = "Write",
 554                 [BLKG_RWSTAT_SYNC]      = "Sync",
 555                 [BLKG_RWSTAT_ASYNC]     = "Async",
 556                 [BLKG_RWSTAT_DISCARD]   = "Discard",
 557         };
 558         const char *dname = blkg_dev_name(pd->blkg);
 559         u64 v;
 560         int i;
 561
 562         if (!dname)
 563                 return 0;
 564
 565         for (i = 0; i < BLKG_RWSTAT_NR; i++)
 566                 seq_printf(sf, "%s %s %llu\n", dname, rwstr[i],
 567                            rwstat->cnt[i]);
 568
 569         v = rwstat->cnt[BLKG_RWSTAT_READ] +
 570                 rwstat->cnt[BLKG_RWSTAT_WRITE] +
 571                 rwstat->cnt[BLKG_RWSTAT_DISCARD];
 572         seq_printf(sf, "%s Total %llu\n", dname, v);
 573         return v;
 574 }
 575 EXPORT_SYMBOL_GPL(__blkg_prfill_rwstat);
 576
 577 /**
 578  * blkg_prfill_rwstat - prfill callback for blkg_rwstat
 579  * @sf: seq_file to print to
 580  * @pd: policy private data of interest
 581  * @off: offset to the blkg_rwstat in @pd
 582  *
 583  * prfill callback for printing a blkg_rwstat.
 584  */
 585 u64 blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
 586                        int off)
 587 {
 588         struct blkg_rwstat_sample rwstat = { };
 589
 590         blkg_rwstat_read((void *)pd + off, &rwstat);
 591         return __blkg_prfill_rwstat(sf, pd, &rwstat);
 592 }
 593 EXPORT_SYMBOL_GPL(blkg_prfill_rwstat);
 594
 595 static u64 blkg_prfill_rwstat_field(struct seq_file *sf,
 596                                     struct blkg_policy_data *pd, int off)
 597 {
 598         struct blkg_rwstat_sample rwstat = { };
 599
 600         blkg_rwstat_read((void *)pd->blkg + off, &rwstat);
 601         return __blkg_prfill_rwstat(sf, pd, &rwstat);
 602 }
 603
 604 /**
 605  * blkg_print_stat_bytes - seq_show callback for blkg->stat_bytes
 606  * @sf: seq_file to print to
 607  * @v: unused
 608  *
 609  * To be used as cftype->seq_show to print blkg->stat_bytes.
 610  * cftype->private must be set to the blkcg_policy.
 611  */
 612 int blkg_print_stat_bytes(struct seq_file *sf, void *v)
 613 {
 614         blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
 615                           blkg_prfill_rwstat_field, (void *)seq_cft(sf)->private,
 616                           offsetof(struct blkcg_gq, stat_bytes), true);
 617         return 0;
 618 }
 619 EXPORT_SYMBOL_GPL(blkg_print_stat_bytes);
 620
 621 /**
 622  * blkg_print_stat_bytes - seq_show callback for blkg->stat_ios
 623  * @sf: seq_file to print to
 624  * @v: unused
 625  *
 626  * To be used as cftype->seq_show to print blkg->stat_ios.  cftype->private
 627  * must be set to the blkcg_policy.
 628  */
 629 int blkg_print_stat_ios(struct seq_file *sf, void *v)
 630 {
 631         blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
 632                           blkg_prfill_rwstat_field, (void *)seq_cft(sf)->private,
 633                           offsetof(struct blkcg_gq, stat_ios), true);
 634         return 0;
 635 }
 636 EXPORT_SYMBOL_GPL(blkg_print_stat_ios);
 637
 638 static u64 blkg_prfill_rwstat_field_recursive(struct seq_file *sf,
 639                                               struct blkg_policy_data *pd,
 640                                               int off)
 641 {
 642         struct blkg_rwstat_sample rwstat;
 643
 644         blkg_rwstat_recursive_sum(pd->blkg, NULL, off, &rwstat);
 645         return __blkg_prfill_rwstat(sf, pd, &rwstat);
 646 }
 647
 648 /**
 649  * blkg_print_stat_bytes_recursive - recursive version of blkg_print_stat_bytes
 650  * @sf: seq_file to print to
 651  * @v: unused
 652  */
 653 int blkg_print_stat_bytes_recursive(struct seq_file *sf, void *v)
 654 {
 655         blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
 656                           blkg_prfill_rwstat_field_recursive,
 657                           (void *)seq_cft(sf)->private,
 658                           offsetof(struct blkcg_gq, stat_bytes), true);
 659         return 0;
 660 }
 661 EXPORT_SYMBOL_GPL(blkg_print_stat_bytes_recursive);
 662
 663 /**
 664  * blkg_print_stat_ios_recursive - recursive version of blkg_print_stat_ios
 665  * @sf: seq_file to print to
 666  * @v: unused
 667  */
 668 int blkg_print_stat_ios_recursive(struct seq_file *sf, void *v)
 669 {
 670         blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
 671                           blkg_prfill_rwstat_field_recursive,
 672                           (void *)seq_cft(sf)->private,
 673                           offsetof(struct blkcg_gq, stat_ios), true);
 674         return 0;
 675 }
 676 EXPORT_SYMBOL_GPL(blkg_print_stat_ios_recursive);
 677
 678 /**
 679  * blkg_rwstat_recursive_sum - collect hierarchical blkg_rwstat
 680  * @blkg: blkg of interest
 681  * @pol: blkcg_policy which contains the blkg_rwstat
 682  * @off: offset to the blkg_rwstat in blkg_policy_data or @blkg
 683  * @sum: blkg_rwstat_sample structure containing the results
 684  *
 685  * Collect the blkg_rwstat specified by @blkg, @pol and @off and all its
 686  * online descendants and their aux counts.  The caller must be holding the
 687  * queue lock for online tests.
 688  *
 689  * If @pol is NULL, blkg_rwstat is at @off bytes into @blkg; otherwise, it
 690  * is at @off bytes into @blkg's blkg_policy_data of the policy.
 691  */
 692 void blkg_rwstat_recursive_sum(struct blkcg_gq *blkg, struct blkcg_policy *pol,
 693                 int off, struct blkg_rwstat_sample *sum)
 694 {
 695         struct blkcg_gq *pos_blkg;
 696         struct cgroup_subsys_state *pos_css;
 697         unsigned int i;
 698
 699         lockdep_assert_held(&blkg->q->queue_lock);
 700
 701         rcu_read_lock();
 702         blkg_for_each_descendant_pre(pos_blkg, pos_css, blkg) {
 703                 struct blkg_rwstat *rwstat;
 704
 705                 if (!pos_blkg->online)
 706                         continue;
 707
 708                 if (pol)
 709                         rwstat = (void *)blkg_to_pd(pos_blkg, pol) + off;
 710                 else
 711                         rwstat = (void *)pos_blkg + off;
 712
 713                 for (i = 0; i < BLKG_RWSTAT_NR; i++)
 714                         sum->cnt[i] = blkg_rwstat_read_counter(rwstat, i);
 715         }
 716         rcu_read_unlock();
 717 }
 718 EXPORT_SYMBOL_GPL(blkg_rwstat_recursive_sum);
 719
 720 /* Performs queue bypass and policy enabled checks then looks up blkg. */
 721 static struct blkcg_gq *blkg_lookup_check(struct blkcg *blkcg,
 722                                           const struct blkcg_policy *pol,
 723                                           struct request_queue *q)
 724 {
 725         WARN_ON_ONCE(!rcu_read_lock_held());
 726         lockdep_assert_held(&q->queue_lock);
 727
 728         if (!blkcg_policy_enabled(q, pol))
 729                 return ERR_PTR(-EOPNOTSUPP);
 730         return __blkg_lookup(blkcg, q, true /* update_hint */);
 731 }
 732
 733 /**
 734  * blkg_conf_prep - parse and prepare for per-blkg config update
 735  * @blkcg: target block cgroup
 736  * @pol: target policy
 737  * @input: input string
 738  * @ctx: blkg_conf_ctx to be filled
 739  *
 740  * Parse per-blkg config update from @input and initialize @ctx with the
 741  * result.  @ctx->blkg points to the blkg to be updated and @ctx->body the
 742  * part of @input following MAJ:MIN.  This function returns with RCU read
 743  * lock and queue lock held and must be paired with blkg_conf_finish().
 744  */
 745 int blkg_conf_prep(struct blkcg *blkcg, const struct blkcg_policy *pol,
 746                    char *input, struct blkg_conf_ctx *ctx)
 747         __acquires(rcu) __acquires(&disk->queue->queue_lock)
 748 {
 749         struct gendisk *disk;
 750         struct request_queue *q;
 751         struct blkcg_gq *blkg;
 752         unsigned int major, minor;
 753         int key_len, part, ret;
 754         char *body;
 755
 756         if (sscanf(input, "%u:%u%n", &major, &minor, &key_len) != 2)
 757                 return -EINVAL;
 758
 759         body = input + key_len;
 760         if (!isspace(*body))
 761                 return -EINVAL;
 762         body = skip_spaces(body);
 763
 764         disk = get_gendisk(MKDEV(major, minor), &part);
 765         if (!disk)
 766                 return -ENODEV;
 767         if (part) {
 768                 ret = -ENODEV;
 769                 goto fail;
 770         }
 771
 772         q = disk->queue;
 773
 774         rcu_read_lock();
 775         spin_lock_irq(&q->queue_lock);
 776
 777         blkg = blkg_lookup_check(blkcg, pol, q);
 778         if (IS_ERR(blkg)) {
 779                 ret = PTR_ERR(blkg);
 780                 goto fail_unlock;
 781         }
 782
 783         if (blkg)
 784                 goto success;
 785
 786         /*
 787          * Create blkgs walking down from blkcg_root to @blkcg, so that all
 788          * non-root blkgs have access to their parents.
 789          */
 790         while (true) {
 791                 struct blkcg *pos = blkcg;
 792                 struct blkcg *parent;
 793                 struct blkcg_gq *new_blkg;
 794
 795                 parent = blkcg_parent(blkcg);
 796                 while (parent && !__blkg_lookup(parent, q, false)) {
 797                         pos = parent;
 798                         parent = blkcg_parent(parent);
 799                 }
 800
 801                 /* Drop locks to do new blkg allocation with GFP_KERNEL. */
 802                 spin_unlock_irq(&q->queue_lock);
 803                 rcu_read_unlock();
 804
 805                 new_blkg = blkg_alloc(pos, q, GFP_KERNEL);
 806                 if (unlikely(!new_blkg)) {
 807                         ret = -ENOMEM;
 808                         goto fail;
 809                 }
 810
 811                 rcu_read_lock();
 812                 spin_lock_irq(&q->queue_lock);
 813
 814                 blkg = blkg_lookup_check(pos, pol, q);
 815                 if (IS_ERR(blkg)) {
 816                         ret = PTR_ERR(blkg);
 817                         goto fail_unlock;
 818                 }
 819
 820                 if (blkg) {
 821                         blkg_free(new_blkg);
 822                 } else {
 823                         blkg = blkg_create(pos, q, new_blkg);
 824                         if (IS_ERR(blkg)) {
 825                                 ret = PTR_ERR(blkg);
 826                                 goto fail_unlock;
 827                         }
 828                 }
 829
 830                 if (pos == blkcg)
 831                         goto success;
 832         }
 833 success:
 834         ctx->disk = disk;
 835         ctx->blkg = blkg;
 836         ctx->body = body;
 837         return 0;
 838
 839 fail_unlock:
 840         spin_unlock_irq(&q->queue_lock);
 841         rcu_read_unlock();
 842 fail:
 843         put_disk_and_module(disk);
 844         /*
 845          * If queue was bypassing, we should retry.  Do so after a
 846          * short msleep().  It isn't strictly necessary but queue
 847          * can be bypassing for some time and it's always nice to
 848          * avoid busy looping.
 849          */
 850         if (ret == -EBUSY) {
 851                 msleep(10);
 852                 ret = restart_syscall();
 853         }
 854         return ret;
 855 }
 856
 857 /**
 858  * blkg_conf_finish - finish up per-blkg config update
 859  * @ctx: blkg_conf_ctx intiailized by blkg_conf_prep()
 860  *
 861  * Finish up after per-blkg config update.  This function must be paired
 862  * with blkg_conf_prep().
 863  */
 864 void blkg_conf_finish(struct blkg_conf_ctx *ctx)
 865         __releases(&ctx->disk->queue->queue_lock) __releases(rcu)
 866 {
 867         spin_unlock_irq(&ctx->disk->queue->queue_lock);
 868         rcu_read_unlock();
 869         put_disk_and_module(ctx->disk);
 870 }
 871
 872 static int blkcg_print_stat(struct seq_file *sf, void *v)
 873 {
 874         struct blkcg *blkcg = css_to_blkcg(seq_css(sf));
 875         struct blkcg_gq *blkg;
 876
 877         rcu_read_lock();
 878
 879         hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
 880                 const char *dname;
 881                 char *buf;
 882                 struct blkg_rwstat_sample rwstat;
 883                 u64 rbytes, wbytes, rios, wios, dbytes, dios;
 884                 size_t size = seq_get_buf(sf, &buf), off = 0;
 885                 int i;
 886                 bool has_stats = false;
 887
 888                 dname = blkg_dev_name(blkg);
 889                 if (!dname)
 890                         continue;
 891
 892                 /*
 893                  * Hooray string manipulation, count is the size written NOT
 894                  * INCLUDING THE \0, so size is now count+1 less than what we
 895                  * had before, but we want to start writing the next bit from
 896                  * the \0 so we only add count to buf.
 897                  */
 898                 off += scnprintf(buf+off, size-off, "%s ", dname);
 899
 900                 spin_lock_irq(&blkg->q->queue_lock);
 901
 902                 blkg_rwstat_recursive_sum(blkg, NULL,
 903                                 offsetof(struct blkcg_gq, stat_bytes), &rwstat);
 904                 rbytes = rwstat.cnt[BLKG_RWSTAT_READ];
 905                 wbytes = rwstat.cnt[BLKG_RWSTAT_WRITE];
 906                 dbytes = rwstat.cnt[BLKG_RWSTAT_DISCARD];
 907
 908                 blkg_rwstat_recursive_sum(blkg, NULL,
 909                                         offsetof(struct blkcg_gq, stat_ios), &rwstat);
 910                 rios = rwstat.cnt[BLKG_RWSTAT_READ];
 911                 wios = rwstat.cnt[BLKG_RWSTAT_WRITE];
 912                 dios = rwstat.cnt[BLKG_RWSTAT_DISCARD];
 913
 914                 spin_unlock_irq(&blkg->q->queue_lock);
 915
 916                 if (rbytes || wbytes || rios || wios) {
 917                         has_stats = true;
 918                         off += scnprintf(buf+off, size-off,
 919                                          "rbytes=%llu wbytes=%llu rios=%llu wios=%llu dbytes=%llu dios=%llu",
 920                                          rbytes, wbytes, rios, wios,
 921                                          dbytes, dios);
 922                 }
 923
 924                 if (!blkcg_debug_stats)
 925                         goto next;
 926
 927                 if (atomic_read(&blkg->use_delay)) {
 928                         has_stats = true;
 929                         off += scnprintf(buf+off, size-off,
 930                                          " use_delay=%d delay_nsec=%llu",
 931                                          atomic_read(&blkg->use_delay),
 932                                         (unsigned long long)atomic64_read(&blkg->delay_nsec));
 933                 }
 934
 935                 for (i = 0; i < BLKCG_MAX_POLS; i++) {
 936                         struct blkcg_policy *pol = blkcg_policy[i];
 937                         size_t written;
 938
 939                         if (!blkg->pd[i] || !pol->pd_stat_fn)
 940                                 continue;
 941
 942                         written = pol->pd_stat_fn(blkg->pd[i], buf+off, size-off);
 943                         if (written)
 944                                 has_stats = true;
 945                         off += written;
 946                 }
 947 next:
 948                 if (has_stats) {
 949                         if (off < size - 1) {
 950                                 off += scnprintf(buf+off, size-off, "\n");
 951                                 seq_commit(sf, off);
 952                         } else {
 953                                 seq_commit(sf, -1);
 954                         }
 955                 }
 956         }
 957
 958         rcu_read_unlock();
 959         return 0;
 960 }
 961
 962 static struct cftype blkcg_files[] = {
 963         {
 964                 .name = "stat",
 965                 .flags = CFTYPE_NOT_ON_ROOT,
 966                 .seq_show = blkcg_print_stat,
 967         },
 968         { }     /* terminate */
 969 };
 970
 971 static struct cftype blkcg_legacy_files[] = {
 972         {
 973                 .name = "reset_stats",
 974                 .write_u64 = blkcg_reset_stats,
 975         },
 976         { }     /* terminate */
 977 };
 978
 979 /*
 980  * blkcg destruction is a three-stage process.
 981  *
 982  * 1. Destruction starts.  The blkcg_css_offline() callback is invoked
 983  *    which offlines writeback.  Here we tie the next stage of blkg destruction
 984  *    to the completion of writeback associated with the blkcg.  This lets us
 985  *    avoid punting potentially large amounts of outstanding writeback to root
 986  *    while maintaining any ongoing policies.  The next stage is triggered when
 987  *    the nr_cgwbs count goes to zero.
 988  *
 989  * 2. When the nr_cgwbs count goes to zero, blkcg_destroy_blkgs() is called
 990  *    and handles the destruction of blkgs.  Here the css reference held by
 991  *    the blkg is put back eventually allowing blkcg_css_free() to be called.
 992  *    This work may occur in cgwb_release_workfn() on the cgwb_release
 993  *    workqueue.  Any submitted ios that fail to get the blkg ref will be
 994  *    punted to the root_blkg.
 995  *
 996  * 3. Once the blkcg ref count goes to zero, blkcg_css_free() is called.
 997  *    This finally frees the blkcg.
 998  */
 999
1000 /**
1001  * blkcg_css_offline - cgroup css_offline callback
1002  * @css: css of interest
1003  *
1004  * This function is called when @css is about to go away.  Here the cgwbs are
1005  * offlined first and only once writeback associated with the blkcg has
1006  * finished do we start step 2 (see above).
1007  */
1008 static void blkcg_css_offline(struct cgroup_subsys_state *css)
1009 {
1010         struct blkcg *blkcg = css_to_blkcg(css);
1011
1012         /* this prevents anyone from attaching or migrating to this blkcg */
1013         wb_blkcg_offline(blkcg);
1014
1015         /* put the base cgwb reference allowing step 2 to be triggered */
1016         blkcg_cgwb_put(blkcg);
1017 }
1018
1019 /**
1020  * blkcg_destroy_blkgs - responsible for shooting down blkgs
1021  * @blkcg: blkcg of interest
1022  *
1023  * blkgs should be removed while holding both q and blkcg locks.  As blkcg lock
1024  * is nested inside q lock, this function performs reverse double lock dancing.
1025  * Destroying the blkgs releases the reference held on the blkcg's css allowing
1026  * blkcg_css_free to eventually be called.
1027  *
1028  * This is the blkcg counterpart of ioc_release_fn().
1029  */
1030 void blkcg_destroy_blkgs(struct blkcg *blkcg)
1031 {
1032         spin_lock_irq(&blkcg->lock);
1033
1034         while (!hlist_empty(&blkcg->blkg_list)) {
1035                 struct blkcg_gq *blkg = hlist_entry(blkcg->blkg_list.first,
1036                                                 struct blkcg_gq, blkcg_node);
1037                 struct request_queue *q = blkg->q;
1038
1039                 if (spin_trylock(&q->queue_lock)) {
1040                         blkg_destroy(blkg);
1041                         spin_unlock(&q->queue_lock);
1042                 } else {
1043                         spin_unlock_irq(&blkcg->lock);
1044                         cpu_relax();
1045                         spin_lock_irq(&blkcg->lock);
1046                 }
1047         }
1048
1049         spin_unlock_irq(&blkcg->lock);
1050 }
1051
1052 static void blkcg_css_free(struct cgroup_subsys_state *css)
1053 {
1054         struct blkcg *blkcg = css_to_blkcg(css);
1055         int i;
1056
1057         mutex_lock(&blkcg_pol_mutex);
1058
1059         list_del(&blkcg->all_blkcgs_node);
1060
1061         for (i = 0; i < BLKCG_MAX_POLS; i++)
1062                 if (blkcg->cpd[i])
1063                         blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);
1064
1065         mutex_unlock(&blkcg_pol_mutex);
1066
1067         kfree(blkcg);
1068 }
1069
1070 static struct cgroup_subsys_state *
1071 blkcg_css_alloc(struct cgroup_subsys_state *parent_css)
1072 {
1073         struct blkcg *blkcg;
1074         struct cgroup_subsys_state *ret;
1075         int i;
1076
1077         mutex_lock(&blkcg_pol_mutex);
1078
1079         if (!parent_css) {
1080                 blkcg = &blkcg_root;
1081         } else {
1082                 blkcg = kzalloc(sizeof(*blkcg), GFP_KERNEL);
1083                 if (!blkcg) {
1084                         ret = ERR_PTR(-ENOMEM);
1085                         goto unlock;
1086                 }
1087         }
1088
1089         for (i = 0; i < BLKCG_MAX_POLS ; i++) {
1090                 struct blkcg_policy *pol = blkcg_policy[i];
1091                 struct blkcg_policy_data *cpd;
1092
1093                 /*
1094                  * If the policy hasn't been attached yet, wait for it
1095                  * to be attached before doing anything else. Otherwise,
1096                  * check if the policy requires any specific per-cgroup
1097                  * data: if it does, allocate and initialize it.
1098                  */
1099                 if (!pol || !pol->cpd_alloc_fn)
1100                         continue;
1101
1102                 cpd = pol->cpd_alloc_fn(GFP_KERNEL);
1103                 if (!cpd) {
1104                         ret = ERR_PTR(-ENOMEM);
1105                         goto free_pd_blkcg;
1106                 }
1107                 blkcg->cpd[i] = cpd;
1108                 cpd->blkcg = blkcg;
1109                 cpd->plid = i;
1110                 if (pol->cpd_init_fn)
1111                         pol->cpd_init_fn(cpd);
1112         }
1113
1114         spin_lock_init(&blkcg->lock);
1115         INIT_RADIX_TREE(&blkcg->blkg_tree, GFP_NOWAIT | __GFP_NOWARN);
1116         INIT_HLIST_HEAD(&blkcg->blkg_list);
1117 #ifdef CONFIG_CGROUP_WRITEBACK
1118         INIT_LIST_HEAD(&blkcg->cgwb_list);
1119         refcount_set(&blkcg->cgwb_refcnt, 1);
1120 #endif
1121         list_add_tail(&blkcg->all_blkcgs_node, &all_blkcgs);
1122
1123         mutex_unlock(&blkcg_pol_mutex);
1124         return &blkcg->css;
1125
1126 free_pd_blkcg:
1127         for (i--; i >= 0; i--)
1128                 if (blkcg->cpd[i])
1129                         blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);
1130
1131         if (blkcg != &blkcg_root)
1132                 kfree(blkcg);
1133 unlock:
1134         mutex_unlock(&blkcg_pol_mutex);
1135         return ret;
1136 }
1137
1138 /**
1139  * blkcg_init_queue - initialize blkcg part of request queue
1140  * @q: request_queue to initialize
1141  *
1142  * Called from blk_alloc_queue_node(). Responsible for initializing blkcg
1143  * part of new request_queue @q.
1144  *
1145  * RETURNS:
1146  * 0 on success, -errno on failure.
1147  */
1148 int blkcg_init_queue(struct request_queue *q)
1149 {
1150         struct blkcg_gq *new_blkg, *blkg;
1151         bool preloaded;
1152         int ret;
1153
1154         new_blkg = blkg_alloc(&blkcg_root, q, GFP_KERNEL);
1155         if (!new_blkg)
1156                 return -ENOMEM;
1157
1158         preloaded = !radix_tree_preload(GFP_KERNEL);
1159
1160         /* Make sure the root blkg exists. */
1161         rcu_read_lock();
1162         spin_lock_irq(&q->queue_lock);
1163         blkg = blkg_create(&blkcg_root, q, new_blkg);
1164         if (IS_ERR(blkg))
1165                 goto err_unlock;
1166         q->root_blkg = blkg;
1167         spin_unlock_irq(&q->queue_lock);
1168         rcu_read_unlock();
1169
1170         if (preloaded)
1171                 radix_tree_preload_end();
1172
1173         ret = blk_iolatency_init(q);
1174         if (ret)
1175                 goto err_destroy_all;
1176
1177         ret = blk_throtl_init(q);
1178         if (ret)
1179                 goto err_destroy_all;
1180         return 0;
1181
1182 err_destroy_all:
1183         blkg_destroy_all(q);
1184         return ret;
1185 err_unlock:
1186         spin_unlock_irq(&q->queue_lock);
1187         rcu_read_unlock();
1188         if (preloaded)
1189                 radix_tree_preload_end();
1190         return PTR_ERR(blkg);
1191 }
1192
1193 /**
1194  * blkcg_drain_queue - drain blkcg part of request_queue
1195  * @q: request_queue to drain
1196  *
1197  * Called from blk_drain_queue().  Responsible for draining blkcg part.
1198  */
1199 void blkcg_drain_queue(struct request_queue *q)
1200 {
1201         lockdep_assert_held(&q->queue_lock);
1202
1203         /*
1204          * @q could be exiting and already have destroyed all blkgs as
1205          * indicated by NULL root_blkg.  If so, don't confuse policies.
1206          */
1207         if (!q->root_blkg)
1208                 return;
1209
1210         blk_throtl_drain(q);
1211 }
1212
1213 /**
1214  * blkcg_exit_queue - exit and release blkcg part of request_queue
1215  * @q: request_queue being released
1216  *
1217  * Called from blk_exit_queue().  Responsible for exiting blkcg part.
1218  */
1219 void blkcg_exit_queue(struct request_queue *q)
1220 {
1221         blkg_destroy_all(q);
1222         blk_throtl_exit(q);
1223 }
1224
1225 /*
1226  * We cannot support shared io contexts, as we have no mean to support
1227  * two tasks with the same ioc in two different groups without major rework
1228  * of the main cic data structures.  For now we allow a task to change
1229  * its cgroup only if it's the only owner of its ioc.
1230  */
1231 static int blkcg_can_attach(struct cgroup_taskset *tset)
1232 {
1233         struct task_struct *task;
1234         struct cgroup_subsys_state *dst_css;
1235         struct io_context *ioc;
1236         int ret = 0;
1237
1238         /* task_lock() is needed to avoid races with exit_io_context() */
1239         cgroup_taskset_for_each(task, dst_css, tset) {
1240                 task_lock(task);
1241                 ioc = task->io_context;
1242                 if (ioc && atomic_read(&ioc->nr_tasks) > 1)
1243                         ret = -EINVAL;
1244                 task_unlock(task);
1245                 if (ret)
1246                         break;
1247         }
1248         return ret;
1249 }
1250
1251 static void blkcg_bind(struct cgroup_subsys_state *root_css)
1252 {
1253         int i;
1254
1255         mutex_lock(&blkcg_pol_mutex);
1256
1257         for (i = 0; i < BLKCG_MAX_POLS; i++) {
1258                 struct blkcg_policy *pol = blkcg_policy[i];
1259                 struct blkcg *blkcg;
1260
1261                 if (!pol || !pol->cpd_bind_fn)
1262                         continue;
1263
1264                 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node)
1265                         if (blkcg->cpd[pol->plid])
1266                                 pol->cpd_bind_fn(blkcg->cpd[pol->plid]);
1267         }
1268         mutex_unlock(&blkcg_pol_mutex);
1269 }
1270
1271 static void blkcg_exit(struct task_struct *tsk)
1272 {
1273         if (tsk->throttle_queue)
1274                 blk_put_queue(tsk->throttle_queue);
1275         tsk->throttle_queue = NULL;
1276 }
1277
1278 struct cgroup_subsys io_cgrp_subsys = {
1279         .css_alloc = blkcg_css_alloc,
1280         .css_offline = blkcg_css_offline,
1281         .css_free = blkcg_css_free,
1282         .can_attach = blkcg_can_attach,
1283         .bind = blkcg_bind,
1284         .dfl_cftypes = blkcg_files,
1285         .legacy_cftypes = blkcg_legacy_files,
1286         .legacy_name = "blkio",
1287         .exit = blkcg_exit,
1288 #ifdef CONFIG_MEMCG
1289         /*
1290          * This ensures that, if available, memcg is automatically enabled
1291          * together on the default hierarchy so that the owner cgroup can
1292          * be retrieved from writeback pages.
1293          */
1294         .depends_on = 1 << memory_cgrp_id,
1295 #endif
1296 };
1297 EXPORT_SYMBOL_GPL(io_cgrp_subsys);
1298
1299 /**
1300  * blkcg_activate_policy - activate a blkcg policy on a request_queue
1301  * @q: request_queue of interest
1302  * @pol: blkcg policy to activate
1303  *
1304  * Activate @pol on @q.  Requires %GFP_KERNEL context.  @q goes through
1305  * bypass mode to populate its blkgs with policy_data for @pol.
1306  *
1307  * Activation happens with @q bypassed, so nobody would be accessing blkgs
1308  * from IO path.  Update of each blkg is protected by both queue and blkcg
1309  * locks so that holding either lock and testing blkcg_policy_enabled() is
1310  * always enough for dereferencing policy data.
1311  *
1312  * The caller is responsible for synchronizing [de]activations and policy
1313  * [un]registerations.  Returns 0 on success, -errno on failure.
1314  */
1315 int blkcg_activate_policy(struct request_queue *q,
1316                           const struct blkcg_policy *pol)
1317 {
1318         struct blkg_policy_data *pd_prealloc = NULL;
1319         struct blkcg_gq *blkg;
1320         int ret;
1321
1322         if (blkcg_policy_enabled(q, pol))
1323                 return 0;
1324
1325         if (queue_is_mq(q))
1326                 blk_mq_freeze_queue(q);
1327 pd_prealloc:
1328         if (!pd_prealloc) {
1329                 pd_prealloc = pol->pd_alloc_fn(GFP_KERNEL, q->node);
1330                 if (!pd_prealloc) {
1331                         ret = -ENOMEM;
1332                         goto out_bypass_end;
1333                 }
1334         }
1335
1336         spin_lock_irq(&q->queue_lock);
1337
1338         /* blkg_list is pushed at the head, reverse walk to init parents first */
1339         list_for_each_entry_reverse(blkg, &q->blkg_list, q_node) {
1340                 struct blkg_policy_data *pd;
1341
1342                 if (blkg->pd[pol->plid])
1343                         continue;
1344
1345                 pd = pol->pd_alloc_fn(GFP_NOWAIT | __GFP_NOWARN, q->node);
1346                 if (!pd)
1347                         swap(pd, pd_prealloc);
1348                 if (!pd) {
1349                         spin_unlock_irq(&q->queue_lock);
1350                         goto pd_prealloc;
1351                 }
1352
1353                 blkg->pd[pol->plid] = pd;
1354                 pd->blkg = blkg;
1355                 pd->plid = pol->plid;
1356                 if (pol->pd_init_fn)
1357                         pol->pd_init_fn(pd);
1358         }
1359
1360         __set_bit(pol->plid, q->blkcg_pols);
1361         ret = 0;
1362
1363         spin_unlock_irq(&q->queue_lock);
1364 out_bypass_end:
1365         if (queue_is_mq(q))
1366                 blk_mq_unfreeze_queue(q);
1367         if (pd_prealloc)
1368                 pol->pd_free_fn(pd_prealloc);
1369         return ret;
1370 }
1371 EXPORT_SYMBOL_GPL(blkcg_activate_policy);
1372
1373 /**
1374  * blkcg_deactivate_policy - deactivate a blkcg policy on a request_queue
1375  * @q: request_queue of interest
1376  * @pol: blkcg policy to deactivate
1377  *
1378  * Deactivate @pol on @q.  Follows the same synchronization rules as
1379  * blkcg_activate_policy().
1380  */
1381 void blkcg_deactivate_policy(struct request_queue *q,
1382                              const struct blkcg_policy *pol)
1383 {
1384         struct blkcg_gq *blkg;
1385
1386         if (!blkcg_policy_enabled(q, pol))
1387                 return;
1388
1389         if (queue_is_mq(q))
1390                 blk_mq_freeze_queue(q);
1391
1392         spin_lock_irq(&q->queue_lock);
1393
1394         __clear_bit(pol->plid, q->blkcg_pols);
1395
1396         list_for_each_entry(blkg, &q->blkg_list, q_node) {
1397                 if (blkg->pd[pol->plid]) {
1398                         if (pol->pd_offline_fn)
1399                                 pol->pd_offline_fn(blkg->pd[pol->plid]);
1400                         pol->pd_free_fn(blkg->pd[pol->plid]);
1401                         blkg->pd[pol->plid] = NULL;
1402                 }
1403         }
1404
1405         spin_unlock_irq(&q->queue_lock);
1406
1407         if (queue_is_mq(q))
1408                 blk_mq_unfreeze_queue(q);
1409 }
1410 EXPORT_SYMBOL_GPL(blkcg_deactivate_policy);
1411
1412 /**
1413  * blkcg_policy_register - register a blkcg policy
1414  * @pol: blkcg policy to register
1415  *
1416  * Register @pol with blkcg core.  Might sleep and @pol may be modified on
1417  * successful registration.  Returns 0 on success and -errno on failure.
1418  */
1419 int blkcg_policy_register(struct blkcg_policy *pol)
1420 {
1421         struct blkcg *blkcg;
1422         int i, ret;
1423
1424         mutex_lock(&blkcg_pol_register_mutex);
1425         mutex_lock(&blkcg_pol_mutex);
1426
1427         /* find an empty slot */
1428         ret = -ENOSPC;
1429         for (i = 0; i < BLKCG_MAX_POLS; i++)
1430                 if (!blkcg_policy[i])
1431                         break;
1432         if (i >= BLKCG_MAX_POLS) {
1433                 pr_warn("blkcg_policy_register: BLKCG_MAX_POLS too small\n");
1434                 goto err_unlock;
1435         }
1436
1437         /* Make sure cpd/pd_alloc_fn and cpd/pd_free_fn in pairs */
1438         if ((!pol->cpd_alloc_fn ^ !pol->cpd_free_fn) ||
1439                 (!pol->pd_alloc_fn ^ !pol->pd_free_fn))
1440                 goto err_unlock;
1441
1442         /* register @pol */
1443         pol->plid = i;
1444         blkcg_policy[pol->plid] = pol;
1445
1446         /* allocate and install cpd's */
1447         if (pol->cpd_alloc_fn) {
1448                 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1449                         struct blkcg_policy_data *cpd;
1450
1451                         cpd = pol->cpd_alloc_fn(GFP_KERNEL);
1452                         if (!cpd)
1453                                 goto err_free_cpds;
1454
1455                         blkcg->cpd[pol->plid] = cpd;
1456                         cpd->blkcg = blkcg;
1457                         cpd->plid = pol->plid;
1458                         pol->cpd_init_fn(cpd);
1459                 }
1460         }
1461
1462         mutex_unlock(&blkcg_pol_mutex);
1463
1464         /* everything is in place, add intf files for the new policy */
1465         if (pol->dfl_cftypes)
1466                 WARN_ON(cgroup_add_dfl_cftypes(&io_cgrp_subsys,
1467                                                pol->dfl_cftypes));
1468         if (pol->legacy_cftypes)
1469                 WARN_ON(cgroup_add_legacy_cftypes(&io_cgrp_subsys,
1470                                                   pol->legacy_cftypes));
1471         mutex_unlock(&blkcg_pol_register_mutex);
1472         return 0;
1473
1474 err_free_cpds:
1475         if (pol->cpd_free_fn) {
1476                 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1477                         if (blkcg->cpd[pol->plid]) {
1478                                 pol->cpd_free_fn(blkcg->cpd[pol->plid]);
1479                                 blkcg->cpd[pol->plid] = NULL;
1480                         }
1481                 }
1482         }
1483         blkcg_policy[pol->plid] = NULL;
1484 err_unlock:
1485         mutex_unlock(&blkcg_pol_mutex);
1486         mutex_unlock(&blkcg_pol_register_mutex);
1487         return ret;
1488 }
1489 EXPORT_SYMBOL_GPL(blkcg_policy_register);
1490
1491 /**
1492  * blkcg_policy_unregister - unregister a blkcg policy
1493  * @pol: blkcg policy to unregister
1494  *
1495  * Undo blkcg_policy_register(@pol).  Might sleep.
1496  */
1497 void blkcg_policy_unregister(struct blkcg_policy *pol)
1498 {
1499         struct blkcg *blkcg;
1500
1501         mutex_lock(&blkcg_pol_register_mutex);
1502
1503         if (WARN_ON(blkcg_policy[pol->plid] != pol))
1504                 goto out_unlock;
1505
1506         /* kill the intf files first */
1507         if (pol->dfl_cftypes)
1508                 cgroup_rm_cftypes(pol->dfl_cftypes);
1509         if (pol->legacy_cftypes)
1510                 cgroup_rm_cftypes(pol->legacy_cftypes);
1511
1512         /* remove cpds and unregister */
1513         mutex_lock(&blkcg_pol_mutex);
1514
1515         if (pol->cpd_free_fn) {
1516                 list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1517                         if (blkcg->cpd[pol->plid]) {
1518                                 pol->cpd_free_fn(blkcg->cpd[pol->plid]);
1519                                 blkcg->cpd[pol->plid] = NULL;
1520                         }
1521                 }
1522         }
1523         blkcg_policy[pol->plid] = NULL;
1524
1525         mutex_unlock(&blkcg_pol_mutex);
1526 out_unlock:
1527         mutex_unlock(&blkcg_pol_register_mutex);
1528 }
1529 EXPORT_SYMBOL_GPL(blkcg_policy_unregister);
1530
1531 /*
1532  * Scale the accumulated delay based on how long it has been since we updated
1533  * the delay.  We only call this when we are adding delay, in case it's been a
1534  * while since we added delay, and when we are checking to see if we need to
1535  * delay a task, to account for any delays that may have occurred.
1536  */
1537 static void blkcg_scale_delay(struct blkcg_gq *blkg, u64 now)
1538 {
1539         u64 old = atomic64_read(&blkg->delay_start);
1540
1541         /*
1542          * We only want to scale down every second.  The idea here is that we
1543          * want to delay people for min(delay_nsec, NSEC_PER_SEC) in a certain
1544          * time window.  We only want to throttle tasks for recent delay that
1545          * has occurred, in 1 second time windows since that's the maximum
1546          * things can be throttled.  We save the current delay window in
1547          * blkg->last_delay so we know what amount is still left to be charged
1548          * to the blkg from this point onward.  blkg->last_use keeps track of
1549          * the use_delay counter.  The idea is if we're unthrottling the blkg we
1550          * are ok with whatever is happening now, and we can take away more of
1551          * the accumulated delay as we've already throttled enough that
1552          * everybody is happy with their IO latencies.
1553          */
1554         if (time_before64(old + NSEC_PER_SEC, now) &&
1555             atomic64_cmpxchg(&blkg->delay_start, old, now) == old) {
1556                 u64 cur = atomic64_read(&blkg->delay_nsec);
1557                 u64 sub = min_t(u64, blkg->last_delay, now - old);
1558                 int cur_use = atomic_read(&blkg->use_delay);
1559
1560                 /*
1561                  * We've been unthrottled, subtract a larger chunk of our
1562                  * accumulated delay.
1563                  */
1564                 if (cur_use < blkg->last_use)
1565                         sub = max_t(u64, sub, blkg->last_delay >> 1);
1566
1567                 /*
1568                  * This shouldn't happen, but handle it anyway.  Our delay_nsec
1569                  * should only ever be growing except here where we subtract out
1570                  * min(last_delay, 1 second), but lord knows bugs happen and I'd
1571                  * rather not end up with negative numbers.
1572                  */
1573                 if (unlikely(cur < sub)) {
1574                         atomic64_set(&blkg->delay_nsec, 0);
1575                         blkg->last_delay = 0;
1576                 } else {
1577                         atomic64_sub(sub, &blkg->delay_nsec);
1578                         blkg->last_delay = cur - sub;
1579                 }
1580                 blkg->last_use = cur_use;
1581         }
1582 }
1583
1584 /*
1585  * This is called when we want to actually walk up the hierarchy and check to
1586  * see if we need to throttle, and then actually throttle if there is some
1587  * accumulated delay.  This should only be called upon return to user space so
1588  * we're not holding some lock that would induce a priority inversion.
1589  */
1590 static void blkcg_maybe_throttle_blkg(struct blkcg_gq *blkg, bool use_memdelay)
1591 {
1592         unsigned long pflags;
1593         u64 now = ktime_to_ns(ktime_get());
1594         u64 exp;
1595         u64 delay_nsec = 0;
1596         int tok;
1597
1598         while (blkg->parent) {
1599                 if (atomic_read(&blkg->use_delay)) {
1600                         blkcg_scale_delay(blkg, now);
1601                         delay_nsec = max_t(u64, delay_nsec,
1602                                            atomic64_read(&blkg->delay_nsec));
1603                 }
1604                 blkg = blkg->parent;
1605         }
1606
1607         if (!delay_nsec)
1608                 return;
1609
1610         /*
1611          * Let's not sleep for all eternity if we've amassed a huge delay.
1612          * Swapping or metadata IO can accumulate 10's of seconds worth of
1613          * delay, and we want userspace to be able to do _something_ so cap the
1614          * delays at 1 second.  If there's 10's of seconds worth of delay then
1615          * the tasks will be delayed for 1 second for every syscall.
1616          */
1617         delay_nsec = min_t(u64, delay_nsec, 250 * NSEC_PER_MSEC);
1618
1619         if (use_memdelay)
1620                 psi_memstall_enter(&pflags);
1621
1622         exp = ktime_add_ns(now, delay_nsec);
1623         tok = io_schedule_prepare();
1624         do {
1625                 __set_current_state(TASK_KILLABLE);
1626                 if (!schedule_hrtimeout(&exp, HRTIMER_MODE_ABS))
1627                         break;
1628         } while (!fatal_signal_pending(current));
1629         io_schedule_finish(tok);
1630
1631         if (use_memdelay)
1632                 psi_memstall_leave(&pflags);
1633 }
1634
1635 /**
1636  * blkcg_maybe_throttle_current - throttle the current task if it has been marked
1637  *
1638  * This is only called if we've been marked with set_notify_resume().  Obviously
1639  * we can be set_notify_resume() for reasons other than blkcg throttling, so we
1640  * check to see if current->throttle_queue is set and if not this doesn't do
1641  * anything.  This should only ever be called by the resume code, it's not meant
1642  * to be called by people willy-nilly as it will actually do the work to
1643  * throttle the task if it is setup for throttling.
1644  */
1645 void blkcg_maybe_throttle_current(void)
1646 {
1647         struct request_queue *q = current->throttle_queue;
1648         struct cgroup_subsys_state *css;
1649         struct blkcg *blkcg;
1650         struct blkcg_gq *blkg;
1651         bool use_memdelay = current->use_memdelay;
1652
1653         if (!q)
1654                 return;
1655
1656         current->throttle_queue = NULL;
1657         current->use_memdelay = false;
1658
1659         rcu_read_lock();
1660         css = kthread_blkcg();
1661         if (css)
1662                 blkcg = css_to_blkcg(css);
1663         else
1664                 blkcg = css_to_blkcg(task_css(current, io_cgrp_id));
1665
1666         if (!blkcg)
1667                 goto out;
1668         blkg = blkg_lookup(blkcg, q);
1669         if (!blkg)
1670                 goto out;
1671         if (!blkg_tryget(blkg))
1672                 goto out;
1673         rcu_read_unlock();
1674
1675         blkcg_maybe_throttle_blkg(blkg, use_memdelay);
1676         blkg_put(blkg);
1677         blk_put_queue(q);
1678         return;
1679 out:
1680         rcu_read_unlock();
1681         blk_put_queue(q);
1682 }
1683
1684 /**
1685  * blkcg_schedule_throttle - this task needs to check for throttling
1686  * @q: the request queue IO was submitted on
1687  * @use_memdelay: do we charge this to memory delay for PSI
1688  *
1689  * This is called by the IO controller when we know there's delay accumulated
1690  * for the blkg for this task.  We do not pass the blkg because there are places
1691  * we call this that may not have that information, the swapping code for
1692  * instance will only have a request_queue at that point.  This set's the
1693  * notify_resume for the task to check and see if it requires throttling before
1694  * returning to user space.
1695  *
1696  * We will only schedule once per syscall.  You can call this over and over
1697  * again and it will only do the check once upon return to user space, and only
1698  * throttle once.  If the task needs to be throttled again it'll need to be
1699  * re-set at the next time we see the task.
1700  */
1701 void blkcg_schedule_throttle(struct request_queue *q, bool use_memdelay)
1702 {
1703         if (unlikely(current->flags & PF_KTHREAD))
1704                 return;
1705
1706         if (!blk_get_queue(q))
1707                 return;
1708
1709         if (current->throttle_queue)
1710                 blk_put_queue(current->throttle_queue);
1711         current->throttle_queue = q;
1712         if (use_memdelay)
1713                 current->use_memdelay = use_memdelay;
1714         set_notify_resume(current);
1715 }
1716
1717 /**
1718  * blkcg_add_delay - add delay to this blkg
1719  * @blkg: blkg of interest
1720  * @now: the current time in nanoseconds
1721  * @delta: how many nanoseconds of delay to add
1722  *
1723  * Charge @delta to the blkg's current delay accumulation.  This is used to
1724  * throttle tasks if an IO controller thinks we need more throttling.
1725  */
1726 void blkcg_add_delay(struct blkcg_gq *blkg, u64 now, u64 delta)
1727 {
1728         blkcg_scale_delay(blkg, now);
1729         atomic64_add(delta, &blkg->delay_nsec);
1730 }
1731
1732 module_param(blkcg_debug_stats, bool, 0644);
1733 MODULE_PARM_DESC(blkcg_debug_stats, "True if you want debug stats, false if not");