blk-cgroup.h 24.9 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
#ifndef _BLK_CGROUP_H
#define _BLK_CGROUP_H
/*
 * Common Block IO controller cgroup interface
 *
 * Based on ideas and code from CFQ, CFS and BFQ:
 * Copyright (C) 2003 Jens Axboe <axboe@kernel.dk>
 *
 * Copyright (C) 2008 Fabio Checconi <fabio@gandalf.sssup.it>
 *		      Paolo Valente <paolo.valente@unimore.it>
 *
 * Copyright (C) 2009 Vivek Goyal <vgoyal@redhat.com>
 * 	              Nauman Rafique <nauman@google.com>
 */

#include <linux/cgroup.h>
T
Tejun Heo 已提交
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

T
Tejun Heo 已提交
26 27 28
/* percpu_counter batch for blkg_[rw]stats, per-cpu drift doesn't matter */
#define BLKG_STAT_CPU_BATCH	(INT_MAX / 2)

29 30 31
/* Max limits for throttle policy */
#define THROTL_IOPS_MAX		UINT_MAX

T
Tejun Heo 已提交
32 33
#ifdef CONFIG_BLK_CGROUP

34 35 36 37 38
enum blkg_rwstat_type {
	BLKG_RWSTAT_READ,
	BLKG_RWSTAT_WRITE,
	BLKG_RWSTAT_SYNC,
	BLKG_RWSTAT_ASYNC,
39
	BLKG_RWSTAT_DISCARD,
40 41 42

	BLKG_RWSTAT_NR,
	BLKG_RWSTAT_TOTAL = BLKG_RWSTAT_NR,
43 44
};

45 46
struct blkcg_gq;

T
Tejun Heo 已提交
47
struct blkcg {
48 49
	struct cgroup_subsys_state	css;
	spinlock_t			lock;
50 51

	struct radix_tree_root		blkg_tree;
52
	struct blkcg_gq	__rcu		*blkg_hint;
53
	struct hlist_head		blkg_list;
T
Tejun Heo 已提交
54

55
	struct blkcg_policy_data	*cpd[BLKCG_MAX_POLS];
56

T
Tejun Heo 已提交
57
	struct list_head		all_blkcgs_node;
58 59
#ifdef CONFIG_CGROUP_WRITEBACK
	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 {
T
Tejun Heo 已提交
69
	struct percpu_counter		cpu_cnt[BLKG_RWSTAT_NR];
70
	atomic64_t			aux_cnt[BLKG_RWSTAT_NR];
71 72
};

73 74 75 76
struct blkg_rwstat_sample {
	u64				cnt[BLKG_RWSTAT_NR];
};

77 78 79 80 81
/*
 * A blkcg_gq (blkg) is association between a block cgroup (blkcg) and a
 * request_queue (q).  This is used by blkcg policies which need to track
 * information per blkcg - q pair.
 *
82 83 84 85 86
 * There can be multiple active blkcg policies and each blkg:policy pair is
 * represented by a blkg_policy_data which is allocated and freed by each
 * policy's pd_alloc/free_fn() methods.  A policy can allocate private data
 * area by allocating larger data structure which embeds blkg_policy_data
 * at the beginning.
87
 */
88
struct blkg_policy_data {
T
Tejun Heo 已提交
89
	/* the blkg and policy id this per-policy data belongs to */
T
Tejun Heo 已提交
90
	struct blkcg_gq			*blkg;
T
Tejun Heo 已提交
91
	int				plid;
92 93
};

94
/*
95 96 97 98 99
 * Policies that need to keep per-blkcg data which is independent from any
 * request_queue associated to it should implement cpd_alloc/free_fn()
 * methods.  A policy can allocate private data area by allocating larger
 * data structure which embeds blkcg_policy_data at the beginning.
 * cpd_init() is invoked to let each policy handle per-blkcg data.
100 101
 */
struct blkcg_policy_data {
102 103
	/* the blkcg and policy id this per-policy data belongs to */
	struct blkcg			*blkcg;
104 105 106
	int				plid;
};

T
Tejun Heo 已提交
107 108
/* association between a blk cgroup and a request queue */
struct blkcg_gq {
T
Tejun Heo 已提交
109
	/* Pointer to the associated request_queue */
110 111 112
	struct request_queue		*q;
	struct list_head		q_node;
	struct hlist_node		blkcg_node;
T
Tejun Heo 已提交
113
	struct blkcg			*blkcg;
T
Tejun Heo 已提交
114

115 116 117 118 119 120
	/*
	 * Each blkg gets congested separately and the congestion state is
	 * propagated to the matching bdi_writeback_congested.
	 */
	struct bdi_writeback_congested	*wb_congested;

T
Tejun Heo 已提交
121 122 123
	/* all non-root blkcg_gq's are guaranteed to have access to parent */
	struct blkcg_gq			*parent;

T
Tejun Heo 已提交
124
	/* reference count */
125
	struct percpu_ref		refcnt;
126

127 128 129
	/* is this blkg online? protected by both blkcg and q locks */
	bool				online;

130 131 132
	struct blkg_rwstat		stat_bytes;
	struct blkg_rwstat		stat_ios;

133
	struct blkg_policy_data		*pd[BLKCG_MAX_POLS];
T
Tejun Heo 已提交
134

T
Tejun Heo 已提交
135 136 137
	spinlock_t			async_bio_lock;
	struct bio_list			async_bios;
	struct work_struct		async_bio_work;
138 139 140 141 142 143

	atomic_t			use_delay;
	atomic64_t			delay_nsec;
	atomic64_t			delay_start;
	u64				last_delay;
	int				last_use;
T
Tejun Heo 已提交
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 154 155
typedef void (blkcg_pol_init_pd_fn)(struct blkg_policy_data *pd);
typedef void (blkcg_pol_online_pd_fn)(struct blkg_policy_data *pd);
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 159
typedef size_t (blkcg_pol_stat_pd_fn)(struct blkg_policy_data *pd, char *buf,
				      size_t size);
160

T
Tejun Heo 已提交
161
struct blkcg_policy {
162 163
	int				plid;
	/* 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 176
	blkcg_pol_online_pd_fn		*pd_online_fn;
	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
};

T
Tejun Heo 已提交
182
extern struct blkcg blkcg_root;
T
Tejun Heo 已提交
183
extern struct cgroup_subsys_state * const blkcg_root_css;
184

T
Tejun Heo 已提交
185 186
struct blkcg_gq *blkg_lookup_slowpath(struct blkcg *blkcg,
				      struct request_queue *q, bool update_hint);
187 188
struct blkcg_gq *__blkg_lookup_create(struct blkcg *blkcg,
				      struct request_queue *q);
T
Tejun Heo 已提交
189 190
struct blkcg_gq *blkg_lookup_create(struct blkcg *blkcg,
				    struct request_queue *q);
191 192 193
int blkcg_init_queue(struct request_queue *q);
void blkcg_drain_queue(struct request_queue *q);
void blkcg_exit_queue(struct request_queue *q);
194

195
/* Blkio controller policy registration */
196
int blkcg_policy_register(struct blkcg_policy *pol);
T
Tejun Heo 已提交
197
void blkcg_policy_unregister(struct blkcg_policy *pol);
198
int blkcg_activate_policy(struct request_queue *q,
T
Tejun Heo 已提交
199
			  const struct blkcg_policy *pol);
200
void blkcg_deactivate_policy(struct request_queue *q,
T
Tejun Heo 已提交
201
			     const struct blkcg_policy *pol);
202

203 204 205 206 207 208 209
static inline u64 blkg_rwstat_read_counter(struct blkg_rwstat *rwstat,
		unsigned int idx)
{
	return atomic64_read(&rwstat->aux_cnt[idx]) +
		percpu_counter_sum_positive(&rwstat->cpu_cnt[idx]);
}

210
const char *blkg_dev_name(struct blkcg_gq *blkg);
T
Tejun Heo 已提交
211
void blkcg_print_blkgs(struct seq_file *sf, struct blkcg *blkcg,
212 213
		       u64 (*prfill)(struct seq_file *,
				     struct blkg_policy_data *, int),
T
Tejun Heo 已提交
214
		       const struct blkcg_policy *pol, int data,
215
		       bool show_total);
216 217
u64 __blkg_prfill_u64(struct seq_file *sf, struct blkg_policy_data *pd, u64 v);
u64 __blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
218
			 const struct blkg_rwstat_sample *rwstat);
219 220
u64 blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
		       int off);
221 222 223 224
int blkg_print_stat_bytes(struct seq_file *sf, void *v);
int blkg_print_stat_ios(struct seq_file *sf, void *v);
int blkg_print_stat_bytes_recursive(struct seq_file *sf, void *v);
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;
T
Tejun Heo 已提交
231
	struct blkcg_gq			*blkg;
232
	char				*body;
233 234
};

T
Tejun Heo 已提交
235
int blkg_conf_prep(struct blkcg *blkcg, const struct blkcg_policy *pol,
236
		   char *input, struct blkg_conf_ctx *ctx);
237 238
void blkg_conf_finish(struct blkg_conf_ctx *ctx);

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
/**
 * blkcg_css - find the current css
 *
 * Find the css associated with either the kthread or the current task.
 * This may return a dying css, so it is up to the caller to use tryget logic
 * to confirm it is alive and well.
 */
static inline struct cgroup_subsys_state *blkcg_css(void)
{
	struct cgroup_subsys_state *css;

	css = kthread_blkcg();
	if (css)
		return css;
	return task_css(current, io_cgrp_id);
}

256 257 258 259 260
static inline struct blkcg *css_to_blkcg(struct cgroup_subsys_state *css)
{
	return css ? container_of(css, struct blkcg, css) : NULL;
}

261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
/**
 * __bio_blkcg - internal, inconsistent version to get blkcg
 *
 * DO NOT USE.
 * This function is inconsistent and consequently is dangerous to use.  The
 * first part of the function returns a blkcg where a reference is owned by the
 * bio.  This means it does not need to be rcu protected as it cannot go away
 * with the bio owning a reference to it.  However, the latter potentially gets
 * it from task_css().  This can race against task migration and the cgroup
 * dying.  It is also semantically different as it must be called rcu protected
 * and is susceptible to failure when trying to get a reference to it.
 * Therefore, it is not ok to assume that *_get() will always succeed on the
 * blkcg returned here.
 */
static inline struct blkcg *__bio_blkcg(struct bio *bio)
276
{
277 278
	if (bio && bio->bi_blkg)
		return bio->bi_blkg->blkcg;
279 280
	return css_to_blkcg(blkcg_css());
}
D
Dennis Zhou 已提交
281

282 283 284 285 286 287 288 289 290 291
/**
 * bio_blkcg - grab the blkcg associated with a bio
 * @bio: target bio
 *
 * This returns the blkcg associated with a bio, %NULL if not associated.
 * Callers are expected to either handle %NULL or know association has been
 * done prior to calling this.
 */
static inline struct blkcg *bio_blkcg(struct bio *bio)
{
292 293
	if (bio && bio->bi_blkg)
		return bio->bi_blkg->blkcg;
294
	return NULL;
295 296
}

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
static inline bool blk_cgroup_congested(void)
{
	struct cgroup_subsys_state *css;
	bool ret = false;

	rcu_read_lock();
	css = kthread_blkcg();
	if (!css)
		css = task_css(current, io_cgrp_id);
	while (css) {
		if (atomic_read(&css->cgroup->congestion_count)) {
			ret = true;
			break;
		}
		css = css->parent;
	}
	rcu_read_unlock();
	return ret;
}

317 318 319 320 321 322 323 324 325 326 327 328 329
/**
 * bio_issue_as_root_blkg - see if this bio needs to be issued as root blkg
 * @return: true if this bio needs to be submitted with the root blkg context.
 *
 * In order to avoid priority inversions we sometimes need to issue a bio as if
 * it were attached to the root blkg, and then backcharge to the actual owning
 * blkg.  The idea is we do bio_blkcg() to look up the actual context for the
 * bio and attach the appropriate blkg to the bio.  Then we call this helper and
 * if it is true run with the root blkg for that queue and then do any
 * backcharging to the originating cgroup once the io is complete.
 */
static inline bool bio_issue_as_root_blkg(struct bio *bio)
{
J
Josef Bacik 已提交
330
	return (bio->bi_opf & (REQ_META | REQ_SWAP)) != 0;
331 332
}

T
Tejun Heo 已提交
333 334 335 336 337 338 339 340
/**
 * blkcg_parent - get the parent of a blkcg
 * @blkcg: blkcg of interest
 *
 * Return the parent blkcg of @blkcg.  Can be called anytime.
 */
static inline struct blkcg *blkcg_parent(struct blkcg *blkcg)
{
T
Tejun Heo 已提交
341
	return css_to_blkcg(blkcg->css.parent);
T
Tejun Heo 已提交
342 343
}

T
Tejun Heo 已提交
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
/**
 * __blkg_lookup - internal version of blkg_lookup()
 * @blkcg: blkcg of interest
 * @q: request_queue of interest
 * @update_hint: whether to update lookup hint with the result or not
 *
 * This is internal version and shouldn't be used by policy
 * implementations.  Looks up blkgs for the @blkcg - @q pair regardless of
 * @q's bypass state.  If @update_hint is %true, the caller should be
 * holding @q->queue_lock and lookup hint is updated on success.
 */
static inline struct blkcg_gq *__blkg_lookup(struct blkcg *blkcg,
					     struct request_queue *q,
					     bool update_hint)
{
	struct blkcg_gq *blkg;

361 362 363
	if (blkcg == &blkcg_root)
		return q->root_blkg;

T
Tejun Heo 已提交
364 365 366 367 368 369 370 371 372 373 374 375 376
	blkg = rcu_dereference(blkcg->blkg_hint);
	if (blkg && blkg->q == q)
		return blkg;

	return blkg_lookup_slowpath(blkcg, q, update_hint);
}

/**
 * blkg_lookup - lookup blkg for the specified blkcg - q pair
 * @blkcg: blkcg of interest
 * @q: request_queue of interest
 *
 * Lookup blkg for the @blkcg - @q pair.  This function should be called
377
 * under RCU read loc.
T
Tejun Heo 已提交
378 379 380 381 382 383 384 385
 */
static inline struct blkcg_gq *blkg_lookup(struct blkcg *blkcg,
					   struct request_queue *q)
{
	WARN_ON_ONCE(!rcu_read_lock_held());
	return __blkg_lookup(blkcg, q, false);
}

386
/**
387
 * blk_queue_root_blkg - return blkg for the (blkcg_root, @q) pair
388 389 390 391
 * @q: request_queue of interest
 *
 * Lookup blkg for @q at the root level. See also blkg_lookup().
 */
392
static inline struct blkcg_gq *blk_queue_root_blkg(struct request_queue *q)
393
{
394
	return q->root_blkg;
395 396
}

397 398 399 400 401 402 403
/**
 * blkg_to_pdata - get policy private data
 * @blkg: blkg of interest
 * @pol: policy of interest
 *
 * Return pointer to private data associated with the @blkg-@pol pair.
 */
404 405
static inline struct blkg_policy_data *blkg_to_pd(struct blkcg_gq *blkg,
						  struct blkcg_policy *pol)
406
{
407
	return blkg ? blkg->pd[pol->plid] : NULL;
408 409
}

410 411 412
static inline struct blkcg_policy_data *blkcg_to_cpd(struct blkcg *blkcg,
						     struct blkcg_policy *pol)
{
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 428 429 430 431
static inline struct blkcg *cpd_to_blkcg(struct blkcg_policy_data *cpd)
{
	return cpd ? cpd->blkcg : NULL;
}

432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
extern void blkcg_destroy_blkgs(struct blkcg *blkcg);

#ifdef CONFIG_CGROUP_WRITEBACK

/**
 * blkcg_cgwb_get - get a reference for blkcg->cgwb_list
 * @blkcg: blkcg of interest
 *
 * This is used to track the number of active wb's related to a blkcg.
 */
static inline void blkcg_cgwb_get(struct blkcg *blkcg)
{
	refcount_inc(&blkcg->cgwb_refcnt);
}

/**
 * blkcg_cgwb_put - put a reference for @blkcg->cgwb_list
 * @blkcg: blkcg of interest
 *
 * This is used to track the number of active wb's related to a blkcg.
 * When this count goes to zero, all active wb has finished so the
 * blkcg can continue destruction by calling blkcg_destroy_blkgs().
 * This work may occur in cgwb_release_workfn() on the cgwb_release
 * workqueue.
 */
static inline void blkcg_cgwb_put(struct blkcg *blkcg)
{
	if (refcount_dec_and_test(&blkcg->cgwb_refcnt))
		blkcg_destroy_blkgs(blkcg);
}

#else

static inline void blkcg_cgwb_get(struct blkcg *blkcg) { }

static inline void blkcg_cgwb_put(struct blkcg *blkcg)
{
	/* wb isn't being accounted, so trigger destruction right away */
	blkcg_destroy_blkgs(blkcg);
}

#endif

T
Tejun Heo 已提交
475 476 477 478 479 480 481 482
/**
 * blkg_path - format cgroup path of blkg
 * @blkg: blkg of interest
 * @buf: target buffer
 * @buflen: target buffer length
 *
 * Format the path of the cgroup of @blkg into @buf.
 */
T
Tejun Heo 已提交
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
}

T
Tejun Heo 已提交
488 489 490 491
/**
 * blkg_get - get a blkg reference
 * @blkg: blkg to get
 *
492
 * The caller should be holding an existing reference.
T
Tejun Heo 已提交
493
 */
T
Tejun Heo 已提交
494
static inline void blkg_get(struct blkcg_gq *blkg)
T
Tejun Heo 已提交
495
{
496
	percpu_ref_get(&blkg->refcnt);
T
Tejun Heo 已提交
497 498
}

499
/**
500
 * blkg_tryget - try and get a blkg reference
501 502 503 504 505
 * @blkg: blkg to get
 *
 * This is for use when doing an RCU lookup of the blkg.  We may be in the midst
 * of freeing this blkg, so we can only use it if the refcnt is not zero.
 */
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 514
 * @blkg: blkg to get
 *
515 516 517 518
 * This needs to be called rcu protected.  As the failure mode here is to walk
 * up the blkg tree, this ensure that the blkg->parent pointers are always
 * valid.  This returns the blkg that it ended up taking a reference on or %NULL
 * if no reference was taken.
519
 */
520
static inline struct blkcg_gq *blkg_tryget_closest(struct blkcg_gq *blkg)
521
{
522 523 524 525 526 527 528 529 530
	struct blkcg_gq *ret_blkg = NULL;

	WARN_ON_ONCE(!rcu_read_lock_held());

	while (blkg) {
		if (blkg_tryget(blkg)) {
			ret_blkg = blkg;
			break;
		}
531
		blkg = blkg->parent;
532
	}
533

534
	return ret_blkg;
535
}
536

T
Tejun Heo 已提交
537 538 539 540
/**
 * blkg_put - put a blkg reference
 * @blkg: blkg to put
 */
T
Tejun Heo 已提交
541
static inline void blkg_put(struct blkcg_gq *blkg)
T
Tejun Heo 已提交
542
{
543
	percpu_ref_put(&blkg->refcnt);
T
Tejun Heo 已提交
544 545
}

546 547 548
/**
 * blkg_for_each_descendant_pre - pre-order walk of a blkg's descendants
 * @d_blkg: loop cursor pointing to the current descendant
549
 * @pos_css: used for iteration
550 551 552 553 554
 * @p_blkg: target blkg to walk descendants of
 *
 * Walk @c_blkg through the descendants of @p_blkg.  Must be used with RCU
 * read locked.  If called under either blkcg or queue lock, the iteration
 * 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 559 560
#define blkg_for_each_descendant_pre(d_blkg, pos_css, p_blkg)		\
	css_for_each_descendant_pre((pos_css), &(p_blkg)->blkcg->css)	\
		if (((d_blkg) = __blkg_lookup(css_to_blkcg(pos_css),	\
561 562
					      (p_blkg)->q, false)))

563 564 565
/**
 * blkg_for_each_descendant_post - post-order walk of a blkg's descendants
 * @d_blkg: loop cursor pointing to the current descendant
566
 * @pos_css: used for iteration
567 568 569
 * @p_blkg: target blkg to walk descendants of
 *
 * Similar to blkg_for_each_descendant_pre() but performs post-order
570 571
 * traversal instead.  Synchronization rules are the same.  @p_blkg is
 * included in the iteration and the last node to be visited.
572
 */
573 574 575
#define blkg_for_each_descendant_post(d_blkg, pos_css, p_blkg)		\
	css_for_each_descendant_post((pos_css), &(p_blkg)->blkcg->css)	\
		if (((d_blkg) = __blkg_lookup(css_to_blkcg(pos_css),	\
576 577
					      (p_blkg)->q, false)))

T
Tejun Heo 已提交
578
static inline int blkg_rwstat_init(struct blkg_rwstat *rwstat, gfp_t gfp)
579
{
T
Tejun Heo 已提交
580 581 582 583 584 585 586 587 588 589 590 591 592
	int i, ret;

	for (i = 0; i < BLKG_RWSTAT_NR; i++) {
		ret = percpu_counter_init(&rwstat->cpu_cnt[i], 0, gfp);
		if (ret) {
			while (--i >= 0)
				percpu_counter_destroy(&rwstat->cpu_cnt[i]);
			return ret;
		}
		atomic64_set(&rwstat->aux_cnt[i], 0);
	}
	return 0;
}
593

T
Tejun Heo 已提交
594 595 596
static inline void blkg_rwstat_exit(struct blkg_rwstat *rwstat)
{
	int i;
597 598

	for (i = 0; i < BLKG_RWSTAT_NR; i++)
T
Tejun Heo 已提交
599
		percpu_counter_destroy(&rwstat->cpu_cnt[i]);
600 601
}

602 603 604
/**
 * blkg_rwstat_add - add a value to a blkg_rwstat
 * @rwstat: target blkg_rwstat
605
 * @op: REQ_OP and flags
606 607 608 609 610 611
 * @val: value to add
 *
 * Add @val to @rwstat.  The counters are chosen according to @rw.  The
 * caller is responsible for synchronizing calls to this function.
 */
static inline void blkg_rwstat_add(struct blkg_rwstat *rwstat,
612
				   unsigned int op, uint64_t val)
613
{
T
Tejun Heo 已提交
614
	struct percpu_counter *cnt;
615

616 617 618
	if (op_is_discard(op))
		cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_DISCARD];
	else if (op_is_write(op))
T
Tejun Heo 已提交
619
		cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_WRITE];
620
	else
T
Tejun Heo 已提交
621 622
		cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_READ];

623
	percpu_counter_add_batch(cnt, val, BLKG_STAT_CPU_BATCH);
T
Tejun Heo 已提交
624

625
	if (op_is_sync(op))
T
Tejun Heo 已提交
626
		cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_SYNC];
627
	else
T
Tejun Heo 已提交
628
		cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_ASYNC];
629

630
	percpu_counter_add_batch(cnt, val, BLKG_STAT_CPU_BATCH);
631 632 633 634 635 636
}

/**
 * blkg_rwstat_read - read the current values of a blkg_rwstat
 * @rwstat: blkg_rwstat to read
 *
T
Tejun Heo 已提交
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
{
T
Tejun Heo 已提交
642
	int i;
643

T
Tejun Heo 已提交
644
	for (i = 0; i < BLKG_RWSTAT_NR; i++)
645 646
		result->cnt[i] =
			percpu_counter_sum_positive(&rwstat->cpu_cnt[i]);
647 648 649
}

/**
650
 * blkg_rwstat_total - read the total count of a blkg_rwstat
651 652 653 654 655 656
 * @rwstat: blkg_rwstat to read
 *
 * Return the total count of @rwstat regardless of the IO direction.  This
 * function can be called without synchronization and takes care of u64
 * atomicity.
 */
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 667 668 669 670
}

/**
 * blkg_rwstat_reset - reset a blkg_rwstat
 * @rwstat: blkg_rwstat to reset
 */
static inline void blkg_rwstat_reset(struct blkg_rwstat *rwstat)
{
671 672
	int i;

T
Tejun Heo 已提交
673 674
	for (i = 0; i < BLKG_RWSTAT_NR; i++) {
		percpu_counter_set(&rwstat->cpu_cnt[i], 0);
675
		atomic64_set(&rwstat->aux_cnt[i], 0);
T
Tejun Heo 已提交
676
	}
677 678
}

679
/**
680
 * blkg_rwstat_add_aux - add a blkg_rwstat into another's aux count
681 682 683
 * @to: the destination blkg_rwstat
 * @from: the source
 *
684
 * Add @from's count including the aux one to @to's aux count.
685
 */
686 687
static inline void blkg_rwstat_add_aux(struct blkg_rwstat *to,
				       struct blkg_rwstat *from)
688
{
689
	u64 sum[BLKG_RWSTAT_NR];
690 691 692
	int i;

	for (i = 0; i < BLKG_RWSTAT_NR; i++)
693 694 695 696
		sum[i] = percpu_counter_sum_positive(&from->cpu_cnt[i]);

	for (i = 0; i < BLKG_RWSTAT_NR; i++)
		atomic64_add(sum[i] + atomic64_read(&from->aux_cnt[i]),
697
			     &to->aux_cnt[i]);
698 699
}

700 701 702 703 704 705 706 707
#ifdef CONFIG_BLK_DEV_THROTTLING
extern bool blk_throtl_bio(struct request_queue *q, struct blkcg_gq *blkg,
			   struct bio *bio);
#else
static inline bool blk_throtl_bio(struct request_queue *q, struct blkcg_gq *blkg,
				  struct bio *bio) { return false; }
#endif

T
Tejun Heo 已提交
708 709 710 711 712 713 714 715 716
bool __blkcg_punt_bio_submit(struct bio *bio);

static inline bool blkcg_punt_bio_submit(struct bio *bio)
{
	if (bio->bi_opf & REQ_CGROUP_PUNT)
		return __blkcg_punt_bio_submit(bio);
	else
		return false;
}
717 718 719 720 721 722

static inline void blkcg_bio_issue_init(struct bio *bio)
{
	bio_issue_init(&bio->bi_issue, bio_sectors(bio));
}

723 724 725 726 727 728
static inline bool blkcg_bio_issue_check(struct request_queue *q,
					 struct bio *bio)
{
	struct blkcg_gq *blkg;
	bool throtl = false;

729 730
	rcu_read_lock();

731 732 733 734 735 736 737 738
	if (!bio->bi_blkg) {
		char b[BDEVNAME_SIZE];

		WARN_ONCE(1,
			  "no blkg associated for bio on block-device: %s\n",
			  bio_devname(bio, b));
		bio_associate_blkg(bio);
	}
D
Dennis Zhou 已提交
739

740
	blkg = bio->bi_blkg;
741 742 743

	throtl = blk_throtl_bio(q, blkg, bio);

744
	if (!throtl) {
745 746 747 748 749 750 751 752
		/*
		 * If the bio is flagged with BIO_QUEUE_ENTERED it means this
		 * is a split bio and we would have already accounted for the
		 * size of the bio.
		 */
		if (!bio_flagged(bio, BIO_QUEUE_ENTERED))
			blkg_rwstat_add(&blkg->stat_bytes, bio->bi_opf,
					bio->bi_iter.bi_size);
753
		blkg_rwstat_add(&blkg->stat_ios, bio->bi_opf, 1);
754 755
	}

756 757
	blkcg_bio_issue_init(bio);

758
	rcu_read_unlock();
759 760 761
	return !throtl;
}

762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
static inline void blkcg_use_delay(struct blkcg_gq *blkg)
{
	if (atomic_add_return(1, &blkg->use_delay) == 1)
		atomic_inc(&blkg->blkcg->css.cgroup->congestion_count);
}

static inline int blkcg_unuse_delay(struct blkcg_gq *blkg)
{
	int old = atomic_read(&blkg->use_delay);

	if (old == 0)
		return 0;

	/*
	 * We do this song and dance because we can race with somebody else
	 * adding or removing delay.  If we just did an atomic_dec we'd end up
	 * negative and we'd already be in trouble.  We need to subtract 1 and
	 * then check to see if we were the last delay so we can drop the
	 * congestion count on the cgroup.
	 */
	while (old) {
		int cur = atomic_cmpxchg(&blkg->use_delay, old, old - 1);
		if (cur == old)
			break;
		old = cur;
	}

	if (old == 0)
		return 0;
	if (old == 1)
		atomic_dec(&blkg->blkcg->css.cgroup->congestion_count);
	return 1;
}

static inline void blkcg_clear_delay(struct blkcg_gq *blkg)
{
	int old = atomic_read(&blkg->use_delay);
	if (!old)
		return;
	/* We only want 1 person clearing the congestion count for this blkg. */
	while (old) {
		int cur = atomic_cmpxchg(&blkg->use_delay, old, 0);
		if (cur == old) {
			atomic_dec(&blkg->blkcg->css.cgroup->congestion_count);
			break;
		}
		old = cur;
	}
}

void blkcg_add_delay(struct blkcg_gq *blkg, u64 now, u64 delta);
void blkcg_schedule_throttle(struct request_queue *q, bool use_memdelay);
void blkcg_maybe_throttle_current(void);
815 816
#else	/* CONFIG_BLK_CGROUP */

817 818
struct blkcg {
};
819

820 821 822
struct blkg_policy_data {
};

823 824 825
struct blkcg_policy_data {
};

T
Tejun Heo 已提交
826
struct blkcg_gq {
827 828
};

T
Tejun Heo 已提交
829
struct blkcg_policy {
830 831
};

T
Tejun Heo 已提交
832 833
#define blkcg_root_css	((struct cgroup_subsys_state *)ERR_PTR(-EINVAL))

834 835 836
static inline void blkcg_maybe_throttle_current(void) { }
static inline bool blk_cgroup_congested(void) { return false; }

837 838
#ifdef CONFIG_BLOCK

839 840
static inline void blkcg_schedule_throttle(struct request_queue *q, bool use_memdelay) { }

T
Tejun Heo 已提交
841
static inline struct blkcg_gq *blkg_lookup(struct blkcg *blkcg, void *key) { return NULL; }
842 843
static inline struct blkcg_gq *blk_queue_root_blkg(struct request_queue *q)
{ return NULL; }
844 845 846
static inline int blkcg_init_queue(struct request_queue *q) { return 0; }
static inline void blkcg_drain_queue(struct request_queue *q) { }
static inline void blkcg_exit_queue(struct request_queue *q) { }
847
static inline int blkcg_policy_register(struct blkcg_policy *pol) { return 0; }
T
Tejun Heo 已提交
848
static inline void blkcg_policy_unregister(struct blkcg_policy *pol) { }
849
static inline int blkcg_activate_policy(struct request_queue *q,
T
Tejun Heo 已提交
850
					const struct blkcg_policy *pol) { return 0; }
851
static inline void blkcg_deactivate_policy(struct request_queue *q,
T
Tejun Heo 已提交
852 853
					   const struct blkcg_policy *pol) { }

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 858 859
static inline struct blkg_policy_data *blkg_to_pd(struct blkcg_gq *blkg,
						  struct blkcg_policy *pol) { return NULL; }
static inline struct blkcg_gq *pd_to_blkg(struct blkg_policy_data *pd) { return NULL; }
T
Tejun Heo 已提交
860 861 862
static inline char *blkg_path(struct blkcg_gq *blkg) { return NULL; }
static inline void blkg_get(struct blkcg_gq *blkg) { }
static inline void blkg_put(struct blkcg_gq *blkg) { }
863

T
Tejun Heo 已提交
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 867 868
static inline bool blkcg_bio_issue_check(struct request_queue *q,
					 struct bio *bio) { return true; }

869 870 871
#define blk_queue_for_each_rl(rl, q)	\
	for ((rl) = &(q)->root_rl; (rl); (rl) = NULL)

872
#endif	/* CONFIG_BLOCK */
873 874
#endif	/* CONFIG_BLK_CGROUP */
#endif	/* _BLK_CGROUP_H */