include/linux/blk-cgroup.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _BLK_CGROUP_H
   3 #define _BLK_CGROUP_H
   4 /*
   5  * Common Block IO controller cgroup interface
   6  *
   7  * Based on ideas and code from CFQ, CFS and BFQ:
   8  * Copyright (C) 2003 Jens Axboe <[email protected]>
   9  *
  10  * Copyright (C) 2008 Fabio Checconi <[email protected]>
  11  *                    Paolo Valente <[email protected]>
  12  *
  13  * Copyright (C) 2009 Vivek Goyal <[email protected]>
  14  *                    Nauman Rafique <[email protected]>
  15  */
  16
  17 #include <linux/cgroup.h>
  18 #include <linux/percpu_counter.h>
  19 #include <linux/seq_file.h>
  20 #include <linux/radix-tree.h>
  21 #include <linux/blkdev.h>
  22 #include <linux/atomic.h>
  23 #include <linux/kthread.h>
  24 #include <linux/fs.h>
  25
  26 /* percpu_counter batch for blkg_[rw]stats, per-cpu drift doesn't matter */
  27 #define BLKG_STAT_CPU_BATCH     (INT_MAX / 2)
  28
  29 /* Max limits for throttle policy */
  30 #define THROTL_IOPS_MAX         UINT_MAX
  31
  32 #ifdef CONFIG_BLK_CGROUP
  33
  34 enum blkg_rwstat_type {
  35         BLKG_RWSTAT_READ,
  36         BLKG_RWSTAT_WRITE,
  37         BLKG_RWSTAT_SYNC,
  38         BLKG_RWSTAT_ASYNC,
  39         BLKG_RWSTAT_DISCARD,
  40
  41         BLKG_RWSTAT_NR,
  42         BLKG_RWSTAT_TOTAL = BLKG_RWSTAT_NR,
  43 };
  44
  45 struct blkcg_gq;
  46
  47 struct blkcg {
  48         struct cgroup_subsys_state      css;
  49         spinlock_t                      lock;
  50
  51         struct radix_tree_root          blkg_tree;
  52         struct blkcg_gq __rcu           *blkg_hint;
  53         struct hlist_head               blkg_list;
  54
  55         struct blkcg_policy_data        *cpd[BLKCG_MAX_POLS];
  56
  57         struct list_head                all_blkcgs_node;
  58 #ifdef CONFIG_CGROUP_WRITEBACK
  59         struct list_head                cgwb_list;
  60         refcount_t                      cgwb_refcnt;
  61 #endif
  62 };
  63
  64 /*
  65  * blkg_[rw]stat->aux_cnt is excluded for local stats but included for
  66  * recursive.  Used to carry stats of dead children.
  67  */
  68 struct blkg_rwstat {
  69         struct percpu_counter           cpu_cnt[BLKG_RWSTAT_NR];
  70         atomic64_t                      aux_cnt[BLKG_RWSTAT_NR];
  71 };
  72
  73 struct blkg_rwstat_sample {
  74         u64                             cnt[BLKG_RWSTAT_NR];
  75 };
  76
  77 /*
  78  * A blkcg_gq (blkg) is association between a block cgroup (blkcg) and a
  79  * request_queue (q).  This is used by blkcg policies which need to track
  80  * information per blkcg - q pair.
  81  *
  82  * There can be multiple active blkcg policies and each blkg:policy pair is
  83  * represented by a blkg_policy_data which is allocated and freed by each
  84  * policy's pd_alloc/free_fn() methods.  A policy can allocate private data
  85  * area by allocating larger data structure which embeds blkg_policy_data
  86  * at the beginning.
  87  */
  88 struct blkg_policy_data {
  89         /* the blkg and policy id this per-policy data belongs to */
  90         struct blkcg_gq                 *blkg;
  91         int                             plid;
  92 };
  93
  94 /*
  95  * Policies that need to keep per-blkcg data which is independent from any
  96  * request_queue associated to it should implement cpd_alloc/free_fn()
  97  * methods.  A policy can allocate private data area by allocating larger
  98  * data structure which embeds blkcg_policy_data at the beginning.
  99  * cpd_init() is invoked to let each policy handle per-blkcg data.
 100  */
 101 struct blkcg_policy_data {
 102         /* the blkcg and policy id this per-policy data belongs to */
 103         struct blkcg                    *blkcg;
 104         int                             plid;
 105 };
 106
 107 /* association between a blk cgroup and a request queue */
 108 struct blkcg_gq {
 109         /* Pointer to the associated request_queue */
 110         struct request_queue            *q;
 111         struct list_head                q_node;
 112         struct hlist_node               blkcg_node;
 113         struct blkcg                    *blkcg;
 114
 115         /*
 116          * Each blkg gets congested separately and the congestion state is
 117          * propagated to the matching bdi_writeback_congested.
 118          */
 119         struct bdi_writeback_congested  *wb_congested;
 120
 121         /* all non-root blkcg_gq's are guaranteed to have access to parent */
 122         struct blkcg_gq                 *parent;
 123
 124         /* reference count */
 125         struct percpu_ref               refcnt;
 126
 127         /* is this blkg online? protected by both blkcg and q locks */
 128         bool                            online;
 129
 130         struct blkg_rwstat              stat_bytes;
 131         struct blkg_rwstat              stat_ios;
 132
 133         struct blkg_policy_data         *pd[BLKCG_MAX_POLS];
 134
 135         struct rcu_head                 rcu_head;
 136
 137         atomic_t                        use_delay;
 138         atomic64_t                      delay_nsec;
 139         atomic64_t                      delay_start;
 140         u64                             last_delay;
 141         int                             last_use;
 142 };
 143
 144 typedef struct blkcg_policy_data *(blkcg_pol_alloc_cpd_fn)(gfp_t gfp);
 145 typedef void (blkcg_pol_init_cpd_fn)(struct blkcg_policy_data *cpd);
 146 typedef void (blkcg_pol_free_cpd_fn)(struct blkcg_policy_data *cpd);
 147 typedef void (blkcg_pol_bind_cpd_fn)(struct blkcg_policy_data *cpd);
 148 typedef struct blkg_policy_data *(blkcg_pol_alloc_pd_fn)(gfp_t gfp, int node);
 149 typedef void (blkcg_pol_init_pd_fn)(struct blkg_policy_data *pd);
 150 typedef void (blkcg_pol_online_pd_fn)(struct blkg_policy_data *pd);
 151 typedef void (blkcg_pol_offline_pd_fn)(struct blkg_policy_data *pd);
 152 typedef void (blkcg_pol_free_pd_fn)(struct blkg_policy_data *pd);
 153 typedef void (blkcg_pol_reset_pd_stats_fn)(struct blkg_policy_data *pd);
 154 typedef size_t (blkcg_pol_stat_pd_fn)(struct blkg_policy_data *pd, char *buf,
 155                                       size_t size);
 156
 157 struct blkcg_policy {
 158         int                             plid;
 159         /* cgroup files for the policy */
 160         struct cftype                   *dfl_cftypes;
 161         struct cftype                   *legacy_cftypes;
 162
 163         /* operations */
 164         blkcg_pol_alloc_cpd_fn          *cpd_alloc_fn;
 165         blkcg_pol_init_cpd_fn           *cpd_init_fn;
 166         blkcg_pol_free_cpd_fn           *cpd_free_fn;
 167         blkcg_pol_bind_cpd_fn           *cpd_bind_fn;
 168
 169         blkcg_pol_alloc_pd_fn           *pd_alloc_fn;
 170         blkcg_pol_init_pd_fn            *pd_init_fn;
 171         blkcg_pol_online_pd_fn          *pd_online_fn;
 172         blkcg_pol_offline_pd_fn         *pd_offline_fn;
 173         blkcg_pol_free_pd_fn            *pd_free_fn;
 174         blkcg_pol_reset_pd_stats_fn     *pd_reset_stats_fn;
 175         blkcg_pol_stat_pd_fn            *pd_stat_fn;
 176 };
 177
 178 extern struct blkcg blkcg_root;
 179 extern struct cgroup_subsys_state * const blkcg_root_css;
 180
 181 struct blkcg_gq *blkg_lookup_slowpath(struct blkcg *blkcg,
 182                                       struct request_queue *q, bool update_hint);
 183 struct blkcg_gq *__blkg_lookup_create(struct blkcg *blkcg,
 184                                       struct request_queue *q);
 185 struct blkcg_gq *blkg_lookup_create(struct blkcg *blkcg,
 186                                     struct request_queue *q);
 187 int blkcg_init_queue(struct request_queue *q);
 188 void blkcg_drain_queue(struct request_queue *q);
 189 void blkcg_exit_queue(struct request_queue *q);
 190
 191 /* Blkio controller policy registration */
 192 int blkcg_policy_register(struct blkcg_policy *pol);
 193 void blkcg_policy_unregister(struct blkcg_policy *pol);
 194 int blkcg_activate_policy(struct request_queue *q,
 195                           const struct blkcg_policy *pol);
 196 void blkcg_deactivate_policy(struct request_queue *q,
 197                              const struct blkcg_policy *pol);
 198
 199 static inline u64 blkg_rwstat_read_counter(struct blkg_rwstat *rwstat,
 200                 unsigned int idx)
 201 {
 202         return atomic64_read(&rwstat->aux_cnt[idx]) +
 203                 percpu_counter_sum_positive(&rwstat->cpu_cnt[idx]);
 204 }
 205
 206 const char *blkg_dev_name(struct blkcg_gq *blkg);
 207 void blkcg_print_blkgs(struct seq_file *sf, struct blkcg *blkcg,
 208                        u64 (*prfill)(struct seq_file *,
 209                                      struct blkg_policy_data *, int),
 210                        const struct blkcg_policy *pol, int data,
 211                        bool show_total);
 212 u64 __blkg_prfill_u64(struct seq_file *sf, struct blkg_policy_data *pd, u64 v);
 213 u64 __blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
 214                          const struct blkg_rwstat_sample *rwstat);
 215 u64 blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
 216                        int off);
 217 int blkg_print_stat_bytes(struct seq_file *sf, void *v);
 218 int blkg_print_stat_ios(struct seq_file *sf, void *v);
 219 int blkg_print_stat_bytes_recursive(struct seq_file *sf, void *v);
 220 int blkg_print_stat_ios_recursive(struct seq_file *sf, void *v);
 221
 222 void blkg_rwstat_recursive_sum(struct blkcg_gq *blkg, struct blkcg_policy *pol,
 223                 int off, struct blkg_rwstat_sample *sum);
 224
 225 struct blkg_conf_ctx {
 226         struct gendisk                  *disk;
 227         struct blkcg_gq                 *blkg;
 228         char                            *body;
 229 };
 230
 231 int blkg_conf_prep(struct blkcg *blkcg, const struct blkcg_policy *pol,
 232                    char *input, struct blkg_conf_ctx *ctx);
 233 void blkg_conf_finish(struct blkg_conf_ctx *ctx);
 234
 235 /**
 236  * blkcg_css - find the current css
 237  *
 238  * Find the css associated with either the kthread or the current task.
 239  * This may return a dying css, so it is up to the caller to use tryget logic
 240  * to confirm it is alive and well.
 241  */
 242 static inline struct cgroup_subsys_state *blkcg_css(void)
 243 {
 244         struct cgroup_subsys_state *css;
 245
 246         css = kthread_blkcg();
 247         if (css)
 248                 return css;
 249         return task_css(current, io_cgrp_id);
 250 }
 251
 252 static inline struct blkcg *css_to_blkcg(struct cgroup_subsys_state *css)
 253 {
 254         return css ? container_of(css, struct blkcg, css) : NULL;
 255 }
 256
 257 /**
 258  * __bio_blkcg - internal, inconsistent version to get blkcg
 259  *
 260  * DO NOT USE.
 261  * This function is inconsistent and consequently is dangerous to use.  The
 262  * first part of the function returns a blkcg where a reference is owned by the
 263  * bio.  This means it does not need to be rcu protected as it cannot go away
 264  * with the bio owning a reference to it.  However, the latter potentially gets
 265  * it from task_css().  This can race against task migration and the cgroup
 266  * dying.  It is also semantically different as it must be called rcu protected
 267  * and is susceptible to failure when trying to get a reference to it.
 268  * Therefore, it is not ok to assume that *_get() will always succeed on the
 269  * blkcg returned here.
 270  */
 271 static inline struct blkcg *__bio_blkcg(struct bio *bio)
 272 {
 273         if (bio && bio->bi_blkg)
 274                 return bio->bi_blkg->blkcg;
 275         return css_to_blkcg(blkcg_css());
 276 }
 277
 278 /**
 279  * bio_blkcg - grab the blkcg associated with a bio
 280  * @bio: target bio
 281  *
 282  * This returns the blkcg associated with a bio, %NULL if not associated.
 283  * Callers are expected to either handle %NULL or know association has been
 284  * done prior to calling this.
 285  */
 286 static inline struct blkcg *bio_blkcg(struct bio *bio)
 287 {
 288         if (bio && bio->bi_blkg)
 289                 return bio->bi_blkg->blkcg;
 290         return NULL;
 291 }
 292
 293 static inline bool blk_cgroup_congested(void)
 294 {
 295         struct cgroup_subsys_state *css;
 296         bool ret = false;
 297
 298         rcu_read_lock();
 299         css = kthread_blkcg();
 300         if (!css)
 301                 css = task_css(current, io_cgrp_id);
 302         while (css) {
 303                 if (atomic_read(&css->cgroup->congestion_count)) {
 304                         ret = true;
 305                         break;
 306                 }
 307                 css = css->parent;
 308         }
 309         rcu_read_unlock();
 310         return ret;
 311 }
 312
 313 /**
 314  * bio_issue_as_root_blkg - see if this bio needs to be issued as root blkg
 315  * @return: true if this bio needs to be submitted with the root blkg context.
 316  *
 317  * In order to avoid priority inversions we sometimes need to issue a bio as if
 318  * it were attached to the root blkg, and then backcharge to the actual owning
 319  * blkg.  The idea is we do bio_blkcg() to look up the actual context for the
 320  * bio and attach the appropriate blkg to the bio.  Then we call this helper and
 321  * if it is true run with the root blkg for that queue and then do any
 322  * backcharging to the originating cgroup once the io is complete.
 323  */
 324 static inline bool bio_issue_as_root_blkg(struct bio *bio)
 325 {
 326         return (bio->bi_opf & (REQ_META | REQ_SWAP)) != 0;
 327 }
 328
 329 /**
 330  * blkcg_parent - get the parent of a blkcg
 331  * @blkcg: blkcg of interest
 332  *
 333  * Return the parent blkcg of @blkcg.  Can be called anytime.
 334  */
 335 static inline struct blkcg *blkcg_parent(struct blkcg *blkcg)
 336 {
 337         return css_to_blkcg(blkcg->css.parent);
 338 }
 339
 340 /**
 341  * __blkg_lookup - internal version of blkg_lookup()
 342  * @blkcg: blkcg of interest
 343  * @q: request_queue of interest
 344  * @update_hint: whether to update lookup hint with the result or not
 345  *
 346  * This is internal version and shouldn't be used by policy
 347  * implementations.  Looks up blkgs for the @blkcg - @q pair regardless of
 348  * @q's bypass state.  If @update_hint is %true, the caller should be
 349  * holding @q->queue_lock and lookup hint is updated on success.
 350  */
 351 static inline struct blkcg_gq *__blkg_lookup(struct blkcg *blkcg,
 352                                              struct request_queue *q,
 353                                              bool update_hint)
 354 {
 355         struct blkcg_gq *blkg;
 356
 357         if (blkcg == &blkcg_root)
 358                 return q->root_blkg;
 359
 360         blkg = rcu_dereference(blkcg->blkg_hint);
 361         if (blkg && blkg->q == q)
 362                 return blkg;
 363
 364         return blkg_lookup_slowpath(blkcg, q, update_hint);
 365 }
 366
 367 /**
 368  * blkg_lookup - lookup blkg for the specified blkcg - q pair
 369  * @blkcg: blkcg of interest
 370  * @q: request_queue of interest
 371  *
 372  * Lookup blkg for the @blkcg - @q pair.  This function should be called
 373  * under RCU read loc.
 374  */
 375 static inline struct blkcg_gq *blkg_lookup(struct blkcg *blkcg,
 376                                            struct request_queue *q)
 377 {
 378         WARN_ON_ONCE(!rcu_read_lock_held());
 379         return __blkg_lookup(blkcg, q, false);
 380 }
 381
 382 /**
 383  * blk_queue_root_blkg - return blkg for the (blkcg_root, @q) pair
 384  * @q: request_queue of interest
 385  *
 386  * Lookup blkg for @q at the root level. See also blkg_lookup().
 387  */
 388 static inline struct blkcg_gq *blk_queue_root_blkg(struct request_queue *q)
 389 {
 390         return q->root_blkg;
 391 }
 392
 393 /**
 394  * blkg_to_pdata - get policy private data
 395  * @blkg: blkg of interest
 396  * @pol: policy of interest
 397  *
 398  * Return pointer to private data associated with the @blkg-@pol pair.
 399  */
 400 static inline struct blkg_policy_data *blkg_to_pd(struct blkcg_gq *blkg,
 401                                                   struct blkcg_policy *pol)
 402 {
 403         return blkg ? blkg->pd[pol->plid] : NULL;
 404 }
 405
 406 static inline struct blkcg_policy_data *blkcg_to_cpd(struct blkcg *blkcg,
 407                                                      struct blkcg_policy *pol)
 408 {
 409         return blkcg ? blkcg->cpd[pol->plid] : NULL;
 410 }
 411
 412 /**
 413  * pdata_to_blkg - get blkg associated with policy private data
 414  * @pd: policy private data of interest
 415  *
 416  * @pd is policy private data.  Determine the blkg it's associated with.
 417  */
 418 static inline struct blkcg_gq *pd_to_blkg(struct blkg_policy_data *pd)
 419 {
 420         return pd ? pd->blkg : NULL;
 421 }
 422
 423 static inline struct blkcg *cpd_to_blkcg(struct blkcg_policy_data *cpd)
 424 {
 425         return cpd ? cpd->blkcg : NULL;
 426 }
 427
 428 extern void blkcg_destroy_blkgs(struct blkcg *blkcg);
 429
 430 #ifdef CONFIG_CGROUP_WRITEBACK
 431
 432 /**
 433  * blkcg_cgwb_get - get a reference for blkcg->cgwb_list
 434  * @blkcg: blkcg of interest
 435  *
 436  * This is used to track the number of active wb's related to a blkcg.
 437  */
 438 static inline void blkcg_cgwb_get(struct blkcg *blkcg)
 439 {
 440         refcount_inc(&blkcg->cgwb_refcnt);
 441 }
 442
 443 /**
 444  * blkcg_cgwb_put - put a reference for @blkcg->cgwb_list
 445  * @blkcg: blkcg of interest
 446  *
 447  * This is used to track the number of active wb's related to a blkcg.
 448  * When this count goes to zero, all active wb has finished so the
 449  * blkcg can continue destruction by calling blkcg_destroy_blkgs().
 450  * This work may occur in cgwb_release_workfn() on the cgwb_release
 451  * workqueue.
 452  */
 453 static inline void blkcg_cgwb_put(struct blkcg *blkcg)
 454 {
 455         if (refcount_dec_and_test(&blkcg->cgwb_refcnt))
 456                 blkcg_destroy_blkgs(blkcg);
 457 }
 458
 459 #else
 460
 461 static inline void blkcg_cgwb_get(struct blkcg *blkcg) { }
 462
 463 static inline void blkcg_cgwb_put(struct blkcg *blkcg)
 464 {
 465         /* wb isn't being accounted, so trigger destruction right away */
 466         blkcg_destroy_blkgs(blkcg);
 467 }
 468
 469 #endif
 470
 471 /**
 472  * blkg_path - format cgroup path of blkg
 473  * @blkg: blkg of interest
 474  * @buf: target buffer
 475  * @buflen: target buffer length
 476  *
 477  * Format the path of the cgroup of @blkg into @buf.
 478  */
 479 static inline int blkg_path(struct blkcg_gq *blkg, char *buf, int buflen)
 480 {
 481         return cgroup_path(blkg->blkcg->css.cgroup, buf, buflen);
 482 }
 483
 484 /**
 485  * blkg_get - get a blkg reference
 486  * @blkg: blkg to get
 487  *
 488  * The caller should be holding an existing reference.
 489  */
 490 static inline void blkg_get(struct blkcg_gq *blkg)
 491 {
 492         percpu_ref_get(&blkg->refcnt);
 493 }
 494
 495 /**
 496  * blkg_tryget - try and get a blkg reference
 497  * @blkg: blkg to get
 498  *
 499  * This is for use when doing an RCU lookup of the blkg.  We may be in the midst
 500  * of freeing this blkg, so we can only use it if the refcnt is not zero.
 501  */
 502 static inline bool blkg_tryget(struct blkcg_gq *blkg)
 503 {
 504         return blkg && percpu_ref_tryget(&blkg->refcnt);
 505 }
 506
 507 /**
 508  * blkg_tryget_closest - try and get a blkg ref on the closet blkg
 509  * @blkg: blkg to get
 510  *
 511  * This needs to be called rcu protected.  As the failure mode here is to walk
 512  * up the blkg tree, this ensure that the blkg->parent pointers are always
 513  * valid.  This returns the blkg that it ended up taking a reference on or %NULL
 514  * if no reference was taken.
 515  */
 516 static inline struct blkcg_gq *blkg_tryget_closest(struct blkcg_gq *blkg)
 517 {
 518         struct blkcg_gq *ret_blkg = NULL;
 519
 520         WARN_ON_ONCE(!rcu_read_lock_held());
 521
 522         while (blkg) {
 523                 if (blkg_tryget(blkg)) {
 524                         ret_blkg = blkg;
 525                         break;
 526                 }
 527                 blkg = blkg->parent;
 528         }
 529
 530         return ret_blkg;
 531 }
 532
 533 /**
 534  * blkg_put - put a blkg reference
 535  * @blkg: blkg to put
 536  */
 537 static inline void blkg_put(struct blkcg_gq *blkg)
 538 {
 539         percpu_ref_put(&blkg->refcnt);
 540 }
 541
 542 /**
 543  * blkg_for_each_descendant_pre - pre-order walk of a blkg's descendants
 544  * @d_blkg: loop cursor pointing to the current descendant
 545  * @pos_css: used for iteration
 546  * @p_blkg: target blkg to walk descendants of
 547  *
 548  * Walk @c_blkg through the descendants of @p_blkg.  Must be used with RCU
 549  * read locked.  If called under either blkcg or queue lock, the iteration
 550  * is guaranteed to include all and only online blkgs.  The caller may
 551  * update @pos_css by calling css_rightmost_descendant() to skip subtree.
 552  * @p_blkg is included in the iteration and the first node to be visited.
 553  */
 554 #define blkg_for_each_descendant_pre(d_blkg, pos_css, p_blkg)           \
 555         css_for_each_descendant_pre((pos_css), &(p_blkg)->blkcg->css)   \
 556                 if (((d_blkg) = __blkg_lookup(css_to_blkcg(pos_css),    \
 557                                               (p_blkg)->q, false)))
 558
 559 /**
 560  * blkg_for_each_descendant_post - post-order walk of a blkg's descendants
 561  * @d_blkg: loop cursor pointing to the current descendant
 562  * @pos_css: used for iteration
 563  * @p_blkg: target blkg to walk descendants of
 564  *
 565  * Similar to blkg_for_each_descendant_pre() but performs post-order
 566  * traversal instead.  Synchronization rules are the same.  @p_blkg is
 567  * included in the iteration and the last node to be visited.
 568  */
 569 #define blkg_for_each_descendant_post(d_blkg, pos_css, p_blkg)          \
 570         css_for_each_descendant_post((pos_css), &(p_blkg)->blkcg->css)  \
 571                 if (((d_blkg) = __blkg_lookup(css_to_blkcg(pos_css),    \
 572                                               (p_blkg)->q, false)))
 573
 574 static inline int blkg_rwstat_init(struct blkg_rwstat *rwstat, gfp_t gfp)
 575 {
 576         int i, ret;
 577
 578         for (i = 0; i < BLKG_RWSTAT_NR; i++) {
 579                 ret = percpu_counter_init(&rwstat->cpu_cnt[i], 0, gfp);
 580                 if (ret) {
 581                         while (--i >= 0)
 582                                 percpu_counter_destroy(&rwstat->cpu_cnt[i]);
 583                         return ret;
 584                 }
 585                 atomic64_set(&rwstat->aux_cnt[i], 0);
 586         }
 587         return 0;
 588 }
 589
 590 static inline void blkg_rwstat_exit(struct blkg_rwstat *rwstat)
 591 {
 592         int i;
 593
 594         for (i = 0; i < BLKG_RWSTAT_NR; i++)
 595                 percpu_counter_destroy(&rwstat->cpu_cnt[i]);
 596 }
 597
 598 /**
 599  * blkg_rwstat_add - add a value to a blkg_rwstat
 600  * @rwstat: target blkg_rwstat
 601  * @op: REQ_OP and flags
 602  * @val: value to add
 603  *
 604  * Add @val to @rwstat.  The counters are chosen according to @rw.  The
 605  * caller is responsible for synchronizing calls to this function.
 606  */
 607 static inline void blkg_rwstat_add(struct blkg_rwstat *rwstat,
 608                                    unsigned int op, uint64_t val)
 609 {
 610         struct percpu_counter *cnt;
 611
 612         if (op_is_discard(op))
 613                 cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_DISCARD];
 614         else if (op_is_write(op))
 615                 cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_WRITE];
 616         else
 617                 cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_READ];
 618
 619         percpu_counter_add_batch(cnt, val, BLKG_STAT_CPU_BATCH);
 620
 621         if (op_is_sync(op))
 622                 cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_SYNC];
 623         else
 624                 cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_ASYNC];
 625
 626         percpu_counter_add_batch(cnt, val, BLKG_STAT_CPU_BATCH);
 627 }
 628
 629 /**
 630  * blkg_rwstat_read - read the current values of a blkg_rwstat
 631  * @rwstat: blkg_rwstat to read
 632  *
 633  * Read the current snapshot of @rwstat and return it in the aux counts.
 634  */
 635 static inline void blkg_rwstat_read(struct blkg_rwstat *rwstat,
 636                 struct blkg_rwstat_sample *result)
 637 {
 638         int i;
 639
 640         for (i = 0; i < BLKG_RWSTAT_NR; i++)
 641                 result->cnt[i] =
 642                         percpu_counter_sum_positive(&rwstat->cpu_cnt[i]);
 643 }
 644
 645 /**
 646  * blkg_rwstat_total - read the total count of a blkg_rwstat
 647  * @rwstat: blkg_rwstat to read
 648  *
 649  * Return the total count of @rwstat regardless of the IO direction.  This
 650  * function can be called without synchronization and takes care of u64
 651  * atomicity.
 652  */
 653 static inline uint64_t blkg_rwstat_total(struct blkg_rwstat *rwstat)
 654 {
 655         struct blkg_rwstat_sample tmp = { };
 656
 657         blkg_rwstat_read(rwstat, &tmp);
 658         return tmp.cnt[BLKG_RWSTAT_READ] + tmp.cnt[BLKG_RWSTAT_WRITE];
 659 }
 660
 661 /**
 662  * blkg_rwstat_reset - reset a blkg_rwstat
 663  * @rwstat: blkg_rwstat to reset
 664  */
 665 static inline void blkg_rwstat_reset(struct blkg_rwstat *rwstat)
 666 {
 667         int i;
 668
 669         for (i = 0; i < BLKG_RWSTAT_NR; i++) {
 670                 percpu_counter_set(&rwstat->cpu_cnt[i], 0);
 671                 atomic64_set(&rwstat->aux_cnt[i], 0);
 672         }
 673 }
 674
 675 /**
 676  * blkg_rwstat_add_aux - add a blkg_rwstat into another's aux count
 677  * @to: the destination blkg_rwstat
 678  * @from: the source
 679  *
 680  * Add @from's count including the aux one to @to's aux count.
 681  */
 682 static inline void blkg_rwstat_add_aux(struct blkg_rwstat *to,
 683                                        struct blkg_rwstat *from)
 684 {
 685         u64 sum[BLKG_RWSTAT_NR];
 686         int i;
 687
 688         for (i = 0; i < BLKG_RWSTAT_NR; i++)
 689                 sum[i] = percpu_counter_sum_positive(&from->cpu_cnt[i]);
 690
 691         for (i = 0; i < BLKG_RWSTAT_NR; i++)
 692                 atomic64_add(sum[i] + atomic64_read(&from->aux_cnt[i]),
 693                              &to->aux_cnt[i]);
 694 }
 695
 696 #ifdef CONFIG_BLK_DEV_THROTTLING
 697 extern bool blk_throtl_bio(struct request_queue *q, struct blkcg_gq *blkg,
 698                            struct bio *bio);
 699 #else
 700 static inline bool blk_throtl_bio(struct request_queue *q, struct blkcg_gq *blkg,
 701                                   struct bio *bio) { return false; }
 702 #endif
 703
 704
 705 static inline void blkcg_bio_issue_init(struct bio *bio)
 706 {
 707         bio_issue_init(&bio->bi_issue, bio_sectors(bio));
 708 }
 709
 710 static inline bool blkcg_bio_issue_check(struct request_queue *q,
 711                                          struct bio *bio)
 712 {
 713         struct blkcg_gq *blkg;
 714         bool throtl = false;
 715
 716         rcu_read_lock();
 717
 718         if (!bio->bi_blkg) {
 719                 char b[BDEVNAME_SIZE];
 720
 721                 WARN_ONCE(1,
 722                           "no blkg associated for bio on block-device: %s\n",
 723                           bio_devname(bio, b));
 724                 bio_associate_blkg(bio);
 725         }
 726
 727         blkg = bio->bi_blkg;
 728
 729         throtl = blk_throtl_bio(q, blkg, bio);
 730
 731         if (!throtl) {
 732                 /*
 733                  * If the bio is flagged with BIO_QUEUE_ENTERED it means this
 734                  * is a split bio and we would have already accounted for the
 735                  * size of the bio.
 736                  */
 737                 if (!bio_flagged(bio, BIO_QUEUE_ENTERED))
 738                         blkg_rwstat_add(&blkg->stat_bytes, bio->bi_opf,
 739                                         bio->bi_iter.bi_size);
 740                 blkg_rwstat_add(&blkg->stat_ios, bio->bi_opf, 1);
 741         }
 742
 743         blkcg_bio_issue_init(bio);
 744
 745         rcu_read_unlock();
 746         return !throtl;
 747 }
 748
 749 static inline void blkcg_use_delay(struct blkcg_gq *blkg)
 750 {
 751         if (atomic_add_return(1, &blkg->use_delay) == 1)
 752                 atomic_inc(&blkg->blkcg->css.cgroup->congestion_count);
 753 }
 754
 755 static inline int blkcg_unuse_delay(struct blkcg_gq *blkg)
 756 {
 757         int old = atomic_read(&blkg->use_delay);
 758
 759         if (old == 0)
 760                 return 0;
 761
 762         /*
 763          * We do this song and dance because we can race with somebody else
 764          * adding or removing delay.  If we just did an atomic_dec we'd end up
 765          * negative and we'd already be in trouble.  We need to subtract 1 and
 766          * then check to see if we were the last delay so we can drop the
 767          * congestion count on the cgroup.
 768          */
 769         while (old) {
 770                 int cur = atomic_cmpxchg(&blkg->use_delay, old, old - 1);
 771                 if (cur == old)
 772                         break;
 773                 old = cur;
 774         }
 775
 776         if (old == 0)
 777                 return 0;
 778         if (old == 1)
 779                 atomic_dec(&blkg->blkcg->css.cgroup->congestion_count);
 780         return 1;
 781 }
 782
 783 static inline void blkcg_clear_delay(struct blkcg_gq *blkg)
 784 {
 785         int old = atomic_read(&blkg->use_delay);
 786         if (!old)
 787                 return;
 788         /* We only want 1 person clearing the congestion count for this blkg. */
 789         while (old) {
 790                 int cur = atomic_cmpxchg(&blkg->use_delay, old, 0);
 791                 if (cur == old) {
 792                         atomic_dec(&blkg->blkcg->css.cgroup->congestion_count);
 793                         break;
 794                 }
 795                 old = cur;
 796         }
 797 }
 798
 799 void blkcg_add_delay(struct blkcg_gq *blkg, u64 now, u64 delta);
 800 void blkcg_schedule_throttle(struct request_queue *q, bool use_memdelay);
 801 void blkcg_maybe_throttle_current(void);
 802 #else   /* CONFIG_BLK_CGROUP */
 803
 804 struct blkcg {
 805 };
 806
 807 struct blkg_policy_data {
 808 };
 809
 810 struct blkcg_policy_data {
 811 };
 812
 813 struct blkcg_gq {
 814 };
 815
 816 struct blkcg_policy {
 817 };
 818
 819 #define blkcg_root_css  ((struct cgroup_subsys_state *)ERR_PTR(-EINVAL))
 820
 821 static inline void blkcg_maybe_throttle_current(void) { }
 822 static inline bool blk_cgroup_congested(void) { return false; }
 823
 824 #ifdef CONFIG_BLOCK
 825
 826 static inline void blkcg_schedule_throttle(struct request_queue *q, bool use_memdelay) { }
 827
 828 static inline struct blkcg_gq *blkg_lookup(struct blkcg *blkcg, void *key) { return NULL; }
 829 static inline struct blkcg_gq *blk_queue_root_blkg(struct request_queue *q)
 830 { return NULL; }
 831 static inline int blkcg_init_queue(struct request_queue *q) { return 0; }
 832 static inline void blkcg_drain_queue(struct request_queue *q) { }
 833 static inline void blkcg_exit_queue(struct request_queue *q) { }
 834 static inline int blkcg_policy_register(struct blkcg_policy *pol) { return 0; }
 835 static inline void blkcg_policy_unregister(struct blkcg_policy *pol) { }
 836 static inline int blkcg_activate_policy(struct request_queue *q,
 837                                         const struct blkcg_policy *pol) { return 0; }
 838 static inline void blkcg_deactivate_policy(struct request_queue *q,
 839                                            const struct blkcg_policy *pol) { }
 840
 841 static inline struct blkcg *__bio_blkcg(struct bio *bio) { return NULL; }
 842 static inline struct blkcg *bio_blkcg(struct bio *bio) { return NULL; }
 843
 844 static inline struct blkg_policy_data *blkg_to_pd(struct blkcg_gq *blkg,
 845                                                   struct blkcg_policy *pol) { return NULL; }
 846 static inline struct blkcg_gq *pd_to_blkg(struct blkg_policy_data *pd) { return NULL; }
 847 static inline char *blkg_path(struct blkcg_gq *blkg) { return NULL; }
 848 static inline void blkg_get(struct blkcg_gq *blkg) { }
 849 static inline void blkg_put(struct blkcg_gq *blkg) { }
 850
 851 static inline void blkcg_bio_issue_init(struct bio *bio) { }
 852 static inline bool blkcg_bio_issue_check(struct request_queue *q,
 853                                          struct bio *bio) { return true; }
 854
 855 #define blk_queue_for_each_rl(rl, q)    \
 856         for ((rl) = &(q)->root_rl; (rl); (rl) = NULL)
 857
 858 #endif  /* CONFIG_BLOCK */
 859 #endif  /* CONFIG_BLK_CGROUP */
 860 #endif  /* _BLK_CGROUP_H */