block/blk-cgroup.h

   1 #ifndef _BLK_CGROUP_H
   2 #define _BLK_CGROUP_H
   3 /*
   4  * Common Block IO controller cgroup interface
   5  *
   6  * Based on ideas and code from CFQ, CFS and BFQ:
   7  * Copyright (C) 2003 Jens Axboe <axboe@kernel.dk>
   8  *
   9  * Copyright (C) 2008 Fabio Checconi <fabio@gandalf.sssup.it>
  10  *                    Paolo Valente <paolo.valente@unimore.it>
  11  *
  12  * Copyright (C) 2009 Vivek Goyal <vgoyal@redhat.com>
  13  *                    Nauman Rafique <nauman@google.com>
  14  */
  15
  16 #include <linux/cgroup.h>
  17 #include <linux/u64_stats_sync.h>
  18 #include <linux/seq_file.h>
  19 #include <linux/radix-tree.h>
  20 #include <linux/blkdev.h>
  21
  22 /* Max limits for throttle policy */
  23 #define THROTL_IOPS_MAX         UINT_MAX
  24
  25 /* CFQ specific, out here for blkcg->cfq_weight */
  26 #define CFQ_WEIGHT_MIN          10
  27 #define CFQ_WEIGHT_MAX          1000
  28 #define CFQ_WEIGHT_DEFAULT      500
  29
  30 #ifdef CONFIG_BLK_CGROUP
  31
  32 enum blkg_rwstat_type {
  33         BLKG_RWSTAT_READ,
  34         BLKG_RWSTAT_WRITE,
  35         BLKG_RWSTAT_SYNC,
  36         BLKG_RWSTAT_ASYNC,
  37
  38         BLKG_RWSTAT_NR,
  39         BLKG_RWSTAT_TOTAL = BLKG_RWSTAT_NR,
  40 };
  41
  42 struct blkcg_gq;
  43
  44 struct blkcg {
  45         struct cgroup_subsys_state      css;
  46         spinlock_t                      lock;
  47
  48         struct radix_tree_root          blkg_tree;
  49         struct blkcg_gq                 *blkg_hint;
  50         struct hlist_head               blkg_list;
  51
  52         /* for policies to test whether associated blkcg has changed */
  53         uint64_t                        id;
  54
  55         /* TODO: per-policy storage in blkcg */
  56         unsigned int                    cfq_weight;     /* belongs to cfq */
  57         unsigned int                    cfq_leaf_weight;
  58 };
  59
  60 struct blkg_stat {
  61         struct u64_stats_sync           syncp;
  62         uint64_t                        cnt;
  63 };
  64
  65 struct blkg_rwstat {
  66         struct u64_stats_sync           syncp;
  67         uint64_t                        cnt[BLKG_RWSTAT_NR];
  68 };
  69
  70 /*
  71  * A blkcg_gq (blkg) is association between a block cgroup (blkcg) and a
  72  * request_queue (q).  This is used by blkcg policies which need to track
  73  * information per blkcg - q pair.
  74  *
  75  * There can be multiple active blkcg policies and each has its private
  76  * data on each blkg, the size of which is determined by
  77  * blkcg_policy->pd_size.  blkcg core allocates and frees such areas
  78  * together with blkg and invokes pd_init/exit_fn() methods.
  79  *
  80  * Such private data must embed struct blkg_policy_data (pd) at the
  81  * beginning and pd_size can't be smaller than pd.
  82  */
  83 struct blkg_policy_data {
  84         /* the blkg and policy id this per-policy data belongs to */
  85         struct blkcg_gq                 *blkg;
  86         int                             plid;
  87
  88         /* used during policy activation */
  89         struct list_head                alloc_node;
  90 };
  91
  92 /* association between a blk cgroup and a request queue */
  93 struct blkcg_gq {
  94         /* Pointer to the associated request_queue */
  95         struct request_queue            *q;
  96         struct list_head                q_node;
  97         struct hlist_node               blkcg_node;
  98         struct blkcg                    *blkcg;
  99
 100         /* all non-root blkcg_gq's are guaranteed to have access to parent */
 101         struct blkcg_gq                 *parent;
 102
 103         /* request allocation list for this blkcg-q pair */
 104         struct request_list             rl;
 105
 106         /* reference count */
 107         int                             refcnt;
 108
 109         /* is this blkg online? protected by both blkcg and q locks */
 110         bool                            online;
 111
 112         struct blkg_policy_data         *pd[BLKCG_MAX_POLS];
 113
 114         struct rcu_head                 rcu_head;
 115 };
 116
 117 typedef void (blkcg_pol_init_pd_fn)(struct blkcg_gq *blkg);
 118 typedef void (blkcg_pol_online_pd_fn)(struct blkcg_gq *blkg);
 119 typedef void (blkcg_pol_offline_pd_fn)(struct blkcg_gq *blkg);
 120 typedef void (blkcg_pol_exit_pd_fn)(struct blkcg_gq *blkg);
 121 typedef void (blkcg_pol_reset_pd_stats_fn)(struct blkcg_gq *blkg);
 122
 123 struct blkcg_policy {
 124         int                             plid;
 125         /* policy specific private data size */
 126         size_t                          pd_size;
 127         /* cgroup files for the policy */
 128         struct cftype                   *cftypes;
 129
 130         /* operations */
 131         blkcg_pol_init_pd_fn            *pd_init_fn;
 132         blkcg_pol_online_pd_fn          *pd_online_fn;
 133         blkcg_pol_offline_pd_fn         *pd_offline_fn;
 134         blkcg_pol_exit_pd_fn            *pd_exit_fn;
 135         blkcg_pol_reset_pd_stats_fn     *pd_reset_stats_fn;
 136 };
 137
 138 extern struct blkcg blkcg_root;
 139
 140 struct blkcg_gq *blkg_lookup(struct blkcg *blkcg, struct request_queue *q);
 141 struct blkcg_gq *blkg_lookup_create(struct blkcg *blkcg,
 142                                     struct request_queue *q);
 143 int blkcg_init_queue(struct request_queue *q);
 144 void blkcg_drain_queue(struct request_queue *q);
 145 void blkcg_exit_queue(struct request_queue *q);
 146
 147 /* Blkio controller policy registration */
 148 int blkcg_policy_register(struct blkcg_policy *pol);
 149 void blkcg_policy_unregister(struct blkcg_policy *pol);
 150 int blkcg_activate_policy(struct request_queue *q,
 151                           const struct blkcg_policy *pol);
 152 void blkcg_deactivate_policy(struct request_queue *q,
 153                              const struct blkcg_policy *pol);
 154
 155 void blkcg_print_blkgs(struct seq_file *sf, struct blkcg *blkcg,
 156                        u64 (*prfill)(struct seq_file *,
 157                                      struct blkg_policy_data *, int),
 158                        const struct blkcg_policy *pol, int data,
 159                        bool show_total);
 160 u64 __blkg_prfill_u64(struct seq_file *sf, struct blkg_policy_data *pd, u64 v);
 161 u64 __blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
 162                          const struct blkg_rwstat *rwstat);
 163 u64 blkg_prfill_stat(struct seq_file *sf, struct blkg_policy_data *pd, int off);
 164 u64 blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
 165                        int off);
 166
 167 u64 blkg_stat_recursive_sum(struct blkg_policy_data *pd, int off);
 168 struct blkg_rwstat blkg_rwstat_recursive_sum(struct blkg_policy_data *pd,
 169                                              int off);
 170
 171 struct blkg_conf_ctx {
 172         struct gendisk                  *disk;
 173         struct blkcg_gq                 *blkg;
 174         u64                             v;
 175 };
 176
 177 int blkg_conf_prep(struct blkcg *blkcg, const struct blkcg_policy *pol,
 178                    const char *input, struct blkg_conf_ctx *ctx);
 179 void blkg_conf_finish(struct blkg_conf_ctx *ctx);
 180
 181
 182 static inline struct blkcg *css_to_blkcg(struct cgroup_subsys_state *css)
 183 {
 184         return css ? container_of(css, struct blkcg, css) : NULL;
 185 }
 186
 187 static inline struct blkcg *cgroup_to_blkcg(struct cgroup *cgroup)
 188 {
 189         return css_to_blkcg(cgroup_css(cgroup, blkio_subsys_id));
 190 }
 191
 192 static inline struct blkcg *task_blkcg(struct task_struct *tsk)
 193 {
 194         return css_to_blkcg(task_css(tsk, blkio_subsys_id));
 195 }
 196
 197 static inline struct blkcg *bio_blkcg(struct bio *bio)
 198 {
 199         if (bio && bio->bi_css)
 200                 return css_to_blkcg(bio->bi_css);
 201         return task_blkcg(current);
 202 }
 203
 204 /**
 205  * blkcg_parent - get the parent of a blkcg
 206  * @blkcg: blkcg of interest
 207  *
 208  * Return the parent blkcg of @blkcg.  Can be called anytime.
 209  */
 210 static inline struct blkcg *blkcg_parent(struct blkcg *blkcg)
 211 {
 212         return css_to_blkcg(css_parent(&blkcg->css));
 213 }
 214
 215 /**
 216  * blkg_to_pdata - get policy private data
 217  * @blkg: blkg of interest
 218  * @pol: policy of interest
 219  *
 220  * Return pointer to private data associated with the @blkg-@pol pair.
 221  */
 222 static inline struct blkg_policy_data *blkg_to_pd(struct blkcg_gq *blkg,
 223                                                   struct blkcg_policy *pol)
 224 {
 225         return blkg ? blkg->pd[pol->plid] : NULL;
 226 }
 227
 228 /**
 229  * pdata_to_blkg - get blkg associated with policy private data
 230  * @pd: policy private data of interest
 231  *
 232  * @pd is policy private data.  Determine the blkg it's associated with.
 233  */
 234 static inline struct blkcg_gq *pd_to_blkg(struct blkg_policy_data *pd)
 235 {
 236         return pd ? pd->blkg : NULL;
 237 }
 238
 239 /**
 240  * blkg_path - format cgroup path of blkg
 241  * @blkg: blkg of interest
 242  * @buf: target buffer
 243  * @buflen: target buffer length
 244  *
 245  * Format the path of the cgroup of @blkg into @buf.
 246  */
 247 static inline int blkg_path(struct blkcg_gq *blkg, char *buf, int buflen)
 248 {
 249         int ret;
 250
 251         ret = cgroup_path(blkg->blkcg->css.cgroup, buf, buflen);
 252         if (ret)
 253                 strncpy(buf, "<unavailable>", buflen);
 254         return ret;
 255 }
 256
 257 /**
 258  * blkg_get - get a blkg reference
 259  * @blkg: blkg to get
 260  *
 261  * The caller should be holding queue_lock and an existing reference.
 262  */
 263 static inline void blkg_get(struct blkcg_gq *blkg)
 264 {
 265         lockdep_assert_held(blkg->q->queue_lock);
 266         WARN_ON_ONCE(!blkg->refcnt);
 267         blkg->refcnt++;
 268 }
 269
 270 void __blkg_release_rcu(struct rcu_head *rcu);
 271
 272 /**
 273  * blkg_put - put a blkg reference
 274  * @blkg: blkg to put
 275  *
 276  * The caller should be holding queue_lock.
 277  */
 278 static inline void blkg_put(struct blkcg_gq *blkg)
 279 {
 280         lockdep_assert_held(blkg->q->queue_lock);
 281         WARN_ON_ONCE(blkg->refcnt <= 0);
 282         if (!--blkg->refcnt)
 283                 call_rcu(&blkg->rcu_head, __blkg_release_rcu);
 284 }
 285
 286 struct blkcg_gq *__blkg_lookup(struct blkcg *blkcg, struct request_queue *q,
 287                                bool update_hint);
 288
 289 /**
 290  * blkg_for_each_descendant_pre - pre-order walk of a blkg's descendants
 291  * @d_blkg: loop cursor pointing to the current descendant
 292  * @pos_cgrp: used for iteration
 293  * @p_blkg: target blkg to walk descendants of
 294  *
 295  * Walk @c_blkg through the descendants of @p_blkg.  Must be used with RCU
 296  * read locked.  If called under either blkcg or queue lock, the iteration
 297  * is guaranteed to include all and only online blkgs.  The caller may
 298  * update @pos_cgrp by calling cgroup_rightmost_descendant() to skip
 299  * subtree.
 300  */
 301 #define blkg_for_each_descendant_pre(d_blkg, pos_cgrp, p_blkg)          \
 302         cgroup_for_each_descendant_pre((pos_cgrp), (p_blkg)->blkcg->css.cgroup) \
 303                 if (((d_blkg) = __blkg_lookup(cgroup_to_blkcg(pos_cgrp), \
 304                                               (p_blkg)->q, false)))
 305
 306 /**
 307  * blkg_for_each_descendant_post - post-order walk of a blkg's descendants
 308  * @d_blkg: loop cursor pointing to the current descendant
 309  * @pos_cgrp: used for iteration
 310  * @p_blkg: target blkg to walk descendants of
 311  *
 312  * Similar to blkg_for_each_descendant_pre() but performs post-order
 313  * traversal instead.  Synchronization rules are the same.
 314  */
 315 #define blkg_for_each_descendant_post(d_blkg, pos_cgrp, p_blkg)         \
 316         cgroup_for_each_descendant_post((pos_cgrp), (p_blkg)->blkcg->css.cgroup) \
 317                 if (((d_blkg) = __blkg_lookup(cgroup_to_blkcg(pos_cgrp), \
 318                                               (p_blkg)->q, false)))
 319
 320 /**
 321  * blk_get_rl - get request_list to use
 322  * @q: request_queue of interest
 323  * @bio: bio which will be attached to the allocated request (may be %NULL)
 324  *
 325  * The caller wants to allocate a request from @q to use for @bio.  Find
 326  * the request_list to use and obtain a reference on it.  Should be called
 327  * under queue_lock.  This function is guaranteed to return non-%NULL
 328  * request_list.
 329  */
 330 static inline struct request_list *blk_get_rl(struct request_queue *q,
 331                                               struct bio *bio)
 332 {
 333         struct blkcg *blkcg;
 334         struct blkcg_gq *blkg;
 335
 336         rcu_read_lock();
 337
 338         blkcg = bio_blkcg(bio);
 339
 340         /* bypass blkg lookup and use @q->root_rl directly for root */
 341         if (blkcg == &blkcg_root)
 342                 goto root_rl;
 343
 344         /*
 345          * Try to use blkg->rl.  blkg lookup may fail under memory pressure
 346          * or if either the blkcg or queue is going away.  Fall back to
 347          * root_rl in such cases.
 348          */
 349         blkg = blkg_lookup_create(blkcg, q);
 350         if (unlikely(IS_ERR(blkg)))
 351                 goto root_rl;
 352
 353         blkg_get(blkg);
 354         rcu_read_unlock();
 355         return &blkg->rl;
 356 root_rl:
 357         rcu_read_unlock();
 358         return &q->root_rl;
 359 }
 360
 361 /**
 362  * blk_put_rl - put request_list
 363  * @rl: request_list to put
 364  *
 365  * Put the reference acquired by blk_get_rl().  Should be called under
 366  * queue_lock.
 367  */
 368 static inline void blk_put_rl(struct request_list *rl)
 369 {
 370         /* root_rl may not have blkg set */
 371         if (rl->blkg && rl->blkg->blkcg != &blkcg_root)
 372                 blkg_put(rl->blkg);
 373 }
 374
 375 /**
 376  * blk_rq_set_rl - associate a request with a request_list
 377  * @rq: request of interest
 378  * @rl: target request_list
 379  *
 380  * Associate @rq with @rl so that accounting and freeing can know the
 381  * request_list @rq came from.
 382  */
 383 static inline void blk_rq_set_rl(struct request *rq, struct request_list *rl)
 384 {
 385         rq->rl = rl;
 386 }
 387
 388 /**
 389  * blk_rq_rl - return the request_list a request came from
 390  * @rq: request of interest
 391  *
 392  * Return the request_list @rq is allocated from.
 393  */
 394 static inline struct request_list *blk_rq_rl(struct request *rq)
 395 {
 396         return rq->rl;
 397 }
 398
 399 struct request_list *__blk_queue_next_rl(struct request_list *rl,
 400                                          struct request_queue *q);
 401 /**
 402  * blk_queue_for_each_rl - iterate through all request_lists of a request_queue
 403  *
 404  * Should be used under queue_lock.
 405  */
 406 #define blk_queue_for_each_rl(rl, q)    \
 407         for ((rl) = &(q)->root_rl; (rl); (rl) = __blk_queue_next_rl((rl), (q)))
 408
 409 /**
 410  * blkg_stat_add - add a value to a blkg_stat
 411  * @stat: target blkg_stat
 412  * @val: value to add
 413  *
 414  * Add @val to @stat.  The caller is responsible for synchronizing calls to
 415  * this function.
 416  */
 417 static inline void blkg_stat_add(struct blkg_stat *stat, uint64_t val)
 418 {
 419         u64_stats_update_begin(&stat->syncp);
 420         stat->cnt += val;
 421         u64_stats_update_end(&stat->syncp);
 422 }
 423
 424 /**
 425  * blkg_stat_read - read the current value of a blkg_stat
 426  * @stat: blkg_stat to read
 427  *
 428  * Read the current value of @stat.  This function can be called without
 429  * synchroniztion and takes care of u64 atomicity.
 430  */
 431 static inline uint64_t blkg_stat_read(struct blkg_stat *stat)
 432 {
 433         unsigned int start;
 434         uint64_t v;
 435
 436         do {
 437                 start = u64_stats_fetch_begin(&stat->syncp);
 438                 v = stat->cnt;
 439         } while (u64_stats_fetch_retry(&stat->syncp, start));
 440
 441         return v;
 442 }
 443
 444 /**
 445  * blkg_stat_reset - reset a blkg_stat
 446  * @stat: blkg_stat to reset
 447  */
 448 static inline void blkg_stat_reset(struct blkg_stat *stat)
 449 {
 450         stat->cnt = 0;
 451 }
 452
 453 /**
 454  * blkg_stat_merge - merge a blkg_stat into another
 455  * @to: the destination blkg_stat
 456  * @from: the source
 457  *
 458  * Add @from's count to @to.
 459  */
 460 static inline void blkg_stat_merge(struct blkg_stat *to, struct blkg_stat *from)
 461 {
 462         blkg_stat_add(to, blkg_stat_read(from));
 463 }
 464
 465 /**
 466  * blkg_rwstat_add - add a value to a blkg_rwstat
 467  * @rwstat: target blkg_rwstat
 468  * @rw: mask of REQ_{WRITE|SYNC}
 469  * @val: value to add
 470  *
 471  * Add @val to @rwstat.  The counters are chosen according to @rw.  The
 472  * caller is responsible for synchronizing calls to this function.
 473  */
 474 static inline void blkg_rwstat_add(struct blkg_rwstat *rwstat,
 475                                    int rw, uint64_t val)
 476 {
 477         u64_stats_update_begin(&rwstat->syncp);
 478
 479         if (rw & REQ_WRITE)
 480                 rwstat->cnt[BLKG_RWSTAT_WRITE] += val;
 481         else
 482                 rwstat->cnt[BLKG_RWSTAT_READ] += val;
 483         if (rw & REQ_SYNC)
 484                 rwstat->cnt[BLKG_RWSTAT_SYNC] += val;
 485         else
 486                 rwstat->cnt[BLKG_RWSTAT_ASYNC] += val;
 487
 488         u64_stats_update_end(&rwstat->syncp);
 489 }
 490
 491 /**
 492  * blkg_rwstat_read - read the current values of a blkg_rwstat
 493  * @rwstat: blkg_rwstat to read
 494  *
 495  * Read the current snapshot of @rwstat and return it as the return value.
 496  * This function can be called without synchronization and takes care of
 497  * u64 atomicity.
 498  */
 499 static inline struct blkg_rwstat blkg_rwstat_read(struct blkg_rwstat *rwstat)
 500 {
 501         unsigned int start;
 502         struct blkg_rwstat tmp;
 503
 504         do {
 505                 start = u64_stats_fetch_begin(&rwstat->syncp);
 506                 tmp = *rwstat;
 507         } while (u64_stats_fetch_retry(&rwstat->syncp, start));
 508
 509         return tmp;
 510 }
 511
 512 /**
 513  * blkg_rwstat_total - read the total count of a blkg_rwstat
 514  * @rwstat: blkg_rwstat to read
 515  *
 516  * Return the total count of @rwstat regardless of the IO direction.  This
 517  * function can be called without synchronization and takes care of u64
 518  * atomicity.
 519  */
 520 static inline uint64_t blkg_rwstat_total(struct blkg_rwstat *rwstat)
 521 {
 522         struct blkg_rwstat tmp = blkg_rwstat_read(rwstat);
 523
 524         return tmp.cnt[BLKG_RWSTAT_READ] + tmp.cnt[BLKG_RWSTAT_WRITE];
 525 }
 526
 527 /**
 528  * blkg_rwstat_reset - reset a blkg_rwstat
 529  * @rwstat: blkg_rwstat to reset
 530  */
 531 static inline void blkg_rwstat_reset(struct blkg_rwstat *rwstat)
 532 {
 533         memset(rwstat->cnt, 0, sizeof(rwstat->cnt));
 534 }
 535
 536 /**
 537  * blkg_rwstat_merge - merge a blkg_rwstat into another
 538  * @to: the destination blkg_rwstat
 539  * @from: the source
 540  *
 541  * Add @from's counts to @to.
 542  */
 543 static inline void blkg_rwstat_merge(struct blkg_rwstat *to,
 544                                      struct blkg_rwstat *from)
 545 {
 546         struct blkg_rwstat v = blkg_rwstat_read(from);
 547         int i;
 548
 549         u64_stats_update_begin(&to->syncp);
 550         for (i = 0; i < BLKG_RWSTAT_NR; i++)
 551                 to->cnt[i] += v.cnt[i];
 552         u64_stats_update_end(&to->syncp);
 553 }
 554
 555 #else   /* CONFIG_BLK_CGROUP */
 556
 557 struct cgroup;
 558 struct blkcg;
 559
 560 struct blkg_policy_data {
 561 };
 562
 563 struct blkcg_gq {
 564 };
 565
 566 struct blkcg_policy {
 567 };
 568
 569 static inline struct blkcg_gq *blkg_lookup(struct blkcg *blkcg, void *key) { return NULL; }
 570 static inline int blkcg_init_queue(struct request_queue *q) { return 0; }
 571 static inline void blkcg_drain_queue(struct request_queue *q) { }
 572 static inline void blkcg_exit_queue(struct request_queue *q) { }
 573 static inline int blkcg_policy_register(struct blkcg_policy *pol) { return 0; }
 574 static inline void blkcg_policy_unregister(struct blkcg_policy *pol) { }
 575 static inline int blkcg_activate_policy(struct request_queue *q,
 576                                         const struct blkcg_policy *pol) { return 0; }
 577 static inline void blkcg_deactivate_policy(struct request_queue *q,
 578                                            const struct blkcg_policy *pol) { }
 579
 580 static inline struct blkcg *cgroup_to_blkcg(struct cgroup *cgroup) { return NULL; }
 581 static inline struct blkcg *bio_blkcg(struct bio *bio) { return NULL; }
 582
 583 static inline struct blkg_policy_data *blkg_to_pd(struct blkcg_gq *blkg,
 584                                                   struct blkcg_policy *pol) { return NULL; }
 585 static inline struct blkcg_gq *pd_to_blkg(struct blkg_policy_data *pd) { return NULL; }
 586 static inline char *blkg_path(struct blkcg_gq *blkg) { return NULL; }
 587 static inline void blkg_get(struct blkcg_gq *blkg) { }
 588 static inline void blkg_put(struct blkcg_gq *blkg) { }
 589
 590 static inline struct request_list *blk_get_rl(struct request_queue *q,
 591                                               struct bio *bio) { return &q->root_rl; }
 592 static inline void blk_put_rl(struct request_list *rl) { }
 593 static inline void blk_rq_set_rl(struct request *rq, struct request_list *rl) { }
 594 static inline struct request_list *blk_rq_rl(struct request *rq) { return &rq->q->root_rl; }
 595
 596 #define blk_queue_for_each_rl(rl, q)    \
 597         for ((rl) = &(q)->root_rl; (rl); (rl) = NULL)
 598
 599 #endif  /* CONFIG_BLK_CGROUP */
 600 #endif  /* _BLK_CGROUP_H */