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