block/blk-cgroup.c

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