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