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