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