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