blk-cgroup.h 26.7 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

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

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

T
Tejun Heo 已提交
31 32
#ifdef CONFIG_BLK_CGROUP

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

	BLKG_RWSTAT_NR,
	BLKG_RWSTAT_TOTAL = BLKG_RWSTAT_NR,
42 43
};

44 45
struct blkcg_gq;

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

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

54
	struct blkcg_policy_data	*cpd[BLKCG_MAX_POLS];
55

T
Tejun Heo 已提交
56
	struct list_head		all_blkcgs_node;
57 58
#ifdef CONFIG_CGROUP_WRITEBACK
	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
T
Tejun Heo 已提交
65 66
 * recursive.  Used to carry stats of dead children, and, for blkg_rwstat,
 * to carry result values from read and sum operations.
67
 */
68
struct blkg_stat {
T
Tejun Heo 已提交
69
	struct percpu_counter		cpu_cnt;
70
	atomic64_t			aux_cnt;
71 72 73
};

struct blkg_rwstat {
T
Tejun Heo 已提交
74
	struct percpu_counter		cpu_cnt[BLKG_RWSTAT_NR];
75
	atomic64_t			aux_cnt[BLKG_RWSTAT_NR];
76 77
};

78 79 80 81 82
/*
 * 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.
 *
83 84 85 86 87
 * 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.
88
 */
89
struct blkg_policy_data {
T
Tejun Heo 已提交
90
	/* the blkg and policy id this per-policy data belongs to */
T
Tejun Heo 已提交
91
	struct blkcg_gq			*blkg;
T
Tejun Heo 已提交
92
	int				plid;
93 94
};

95
/*
96 97 98 99 100
 * 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.
101 102
 */
struct blkcg_policy_data {
103 104
	/* the blkcg and policy id this per-policy data belongs to */
	struct blkcg			*blkcg;
105 106 107
	int				plid;
};

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

116 117 118 119 120 121
	/*
	 * 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 已提交
122 123 124
	/* all non-root blkcg_gq's are guaranteed to have access to parent */
	struct blkcg_gq			*parent;

T
Tejun Heo 已提交
125
	/* reference count */
D
Dennis Zhou 已提交
126
	atomic_t			refcnt;
127

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

131 132 133
	struct blkg_rwstat		stat_bytes;
	struct blkg_rwstat		stat_ios;

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

136
	struct rcu_head			rcu_head;
137 138 139 140 141 142

	atomic_t			use_delay;
	atomic64_t			delay_nsec;
	atomic64_t			delay_start;
	u64				last_delay;
	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 151 152
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);
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 156
typedef size_t (blkcg_pol_stat_pd_fn)(struct blkg_policy_data *pd, char *buf,
				      size_t size);
157

T
Tejun Heo 已提交
158
struct blkcg_policy {
159 160
	int				plid;
	/* 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 173
	blkcg_pol_online_pd_fn		*pd_online_fn;
	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
};

T
Tejun Heo 已提交
179
extern struct blkcg blkcg_root;
T
Tejun Heo 已提交
180
extern struct cgroup_subsys_state * const blkcg_root_css;
181

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

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

200
const char *blkg_dev_name(struct blkcg_gq *blkg);
T
Tejun Heo 已提交
201
void blkcg_print_blkgs(struct seq_file *sf, struct blkcg *blkcg,
202 203
		       u64 (*prfill)(struct seq_file *,
				     struct blkg_policy_data *, int),
T
Tejun Heo 已提交
204
		       const struct blkcg_policy *pol, int data,
205
		       bool show_total);
206 207
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,
208
			 const struct blkg_rwstat *rwstat);
209 210 211
u64 blkg_prfill_stat(struct seq_file *sf, struct blkg_policy_data *pd, int off);
u64 blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
		       int off);
212 213 214 215
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);
216

217 218 219 220
u64 blkg_stat_recursive_sum(struct blkcg_gq *blkg,
			    struct blkcg_policy *pol, int off);
struct blkg_rwstat blkg_rwstat_recursive_sum(struct blkcg_gq *blkg,
					     struct blkcg_policy *pol, int off);
221

222
struct blkg_conf_ctx {
223
	struct gendisk			*disk;
T
Tejun Heo 已提交
224
	struct blkcg_gq			*blkg;
225
	char				*body;
226 227
};

T
Tejun Heo 已提交
228
int blkg_conf_prep(struct blkcg *blkcg, const struct blkcg_policy *pol,
229
		   char *input, struct blkg_conf_ctx *ctx);
230 231
void blkg_conf_finish(struct blkg_conf_ctx *ctx);

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
/**
 * 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);
}

/**
 * blkcg_get_css - find and get a reference to the css
 *
 * Find the css associated with either the kthread or the current task.
 * This takes a reference on the blkcg which will need to be managed by the
 * caller.
 */
static inline struct cgroup_subsys_state *blkcg_get_css(void)
{
	struct cgroup_subsys_state *css;

	rcu_read_lock();

	css = kthread_blkcg();
	if (css) {
		css_get(css);
	} else {
		/*
		 * This is a bit complicated.  It is possible task_css() is
		 * seeing an old css pointer here.  This is caused by the
		 * current thread migrating away from this cgroup and this
		 * cgroup dying.  css_tryget() will fail when trying to take a
		 * ref on a cgroup that's ref count has hit 0.
		 *
		 * Therefore, if it does fail, this means current must have
		 * been swapped away already and this is waiting for it to
		 * propagate on the polling cpu.  Hence the use of cpu_relax().
		 */
		while (true) {
			css = task_css(current, io_cgrp_id);
			if (likely(css_tryget(css)))
				break;
			cpu_relax();
		}
	}

	rcu_read_unlock();

	return css;
}
289

290 291 292 293 294
static inline struct blkcg *css_to_blkcg(struct cgroup_subsys_state *css)
{
	return css ? container_of(css, struct blkcg, css) : NULL;
}

295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
/**
 * __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)
310
{
311 312 313 314
	if (bio && bio->bi_css)
		return css_to_blkcg(bio->bi_css);
	return css_to_blkcg(blkcg_css());
}
D
Dennis Zhou 已提交
315

316 317 318 319 320 321 322 323 324 325
/**
 * 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)
{
D
Dennis Zhou 已提交
326 327
	if (bio && bio->bi_css)
		return css_to_blkcg(bio->bi_css);
328
	return NULL;
329 330
}

331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
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;
}

351 352 353 354 355 356 357 358 359 360 361 362 363
/**
 * 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 已提交
364
	return (bio->bi_opf & (REQ_META | REQ_SWAP)) != 0;
365 366
}

T
Tejun Heo 已提交
367 368 369 370 371 372 373 374
/**
 * 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 已提交
375
	return css_to_blkcg(blkcg->css.parent);
T
Tejun Heo 已提交
376 377
}

T
Tejun Heo 已提交
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
/**
 * __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;

395 396 397
	if (blkcg == &blkcg_root)
		return q->root_blkg;

T
Tejun Heo 已提交
398 399 400 401 402 403 404 405 406 407 408 409 410
	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
411
 * under RCU read loc.
T
Tejun Heo 已提交
412 413 414 415 416 417 418 419
 */
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);
}

420
/**
421
 * blk_queue_root_blkg - return blkg for the (blkcg_root, @q) pair
422 423 424 425
 * @q: request_queue of interest
 *
 * Lookup blkg for @q at the root level. See also blkg_lookup().
 */
426
static inline struct blkcg_gq *blk_queue_root_blkg(struct request_queue *q)
427
{
428
	return q->root_blkg;
429 430
}

431 432 433 434 435 436 437
/**
 * 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.
 */
438 439
static inline struct blkg_policy_data *blkg_to_pd(struct blkcg_gq *blkg,
						  struct blkcg_policy *pol)
440
{
441
	return blkg ? blkg->pd[pol->plid] : NULL;
442 443
}

444 445 446
static inline struct blkcg_policy_data *blkcg_to_cpd(struct blkcg *blkcg,
						     struct blkcg_policy *pol)
{
447
	return blkcg ? blkcg->cpd[pol->plid] : NULL;
448 449
}

450 451
/**
 * pdata_to_blkg - get blkg associated with policy private data
452
 * @pd: policy private data of interest
453
 *
454
 * @pd is policy private data.  Determine the blkg it's associated with.
455
 */
456
static inline struct blkcg_gq *pd_to_blkg(struct blkg_policy_data *pd)
457
{
458
	return pd ? pd->blkg : NULL;
459 460
}

461 462 463 464 465
static inline struct blkcg *cpd_to_blkcg(struct blkcg_policy_data *cpd)
{
	return cpd ? cpd->blkcg : NULL;
}

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
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 已提交
509 510 511 512 513 514 515 516
/**
 * 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 已提交
517
static inline int blkg_path(struct blkcg_gq *blkg, char *buf, int buflen)
518
{
519
	return cgroup_path(blkg->blkcg->css.cgroup, buf, buflen);
520 521
}

T
Tejun Heo 已提交
522 523 524 525
/**
 * blkg_get - get a blkg reference
 * @blkg: blkg to get
 *
526
 * The caller should be holding an existing reference.
T
Tejun Heo 已提交
527
 */
T
Tejun Heo 已提交
528
static inline void blkg_get(struct blkcg_gq *blkg)
T
Tejun Heo 已提交
529
{
D
Dennis Zhou 已提交
530 531
	WARN_ON_ONCE(atomic_read(&blkg->refcnt) <= 0);
	atomic_inc(&blkg->refcnt);
T
Tejun Heo 已提交
532 533
}

534
/**
D
Dennis Zhou 已提交
535
 * blkg_try_get - try and get a blkg reference
536 537 538 539 540
 * @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.
 */
D
Dennis Zhou 已提交
541
static inline struct blkcg_gq *blkg_try_get(struct blkcg_gq *blkg)
542
{
D
Dennis Zhou 已提交
543 544 545
	if (atomic_inc_not_zero(&blkg->refcnt))
		return blkg;
	return NULL;
546 547
}

548

D
Dennis Zhou 已提交
549
void __blkg_release_rcu(struct rcu_head *rcu);
550

T
Tejun Heo 已提交
551 552 553 554
/**
 * blkg_put - put a blkg reference
 * @blkg: blkg to put
 */
T
Tejun Heo 已提交
555
static inline void blkg_put(struct blkcg_gq *blkg)
T
Tejun Heo 已提交
556
{
D
Dennis Zhou 已提交
557 558 559
	WARN_ON_ONCE(atomic_read(&blkg->refcnt) <= 0);
	if (atomic_dec_and_test(&blkg->refcnt))
		call_rcu(&blkg->rcu_head, __blkg_release_rcu);
T
Tejun Heo 已提交
560 561
}

562 563 564
/**
 * blkg_for_each_descendant_pre - pre-order walk of a blkg's descendants
 * @d_blkg: loop cursor pointing to the current descendant
565
 * @pos_css: used for iteration
566 567 568 569 570
 * @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
571
 * update @pos_css by calling css_rightmost_descendant() to skip subtree.
572
 * @p_blkg is included in the iteration and the first node to be visited.
573
 */
574 575 576
#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),	\
577 578
					      (p_blkg)->q, false)))

579 580 581
/**
 * blkg_for_each_descendant_post - post-order walk of a blkg's descendants
 * @d_blkg: loop cursor pointing to the current descendant
582
 * @pos_css: used for iteration
583 584 585
 * @p_blkg: target blkg to walk descendants of
 *
 * Similar to blkg_for_each_descendant_pre() but performs post-order
586 587
 * traversal instead.  Synchronization rules are the same.  @p_blkg is
 * included in the iteration and the last node to be visited.
588
 */
589 590 591
#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),	\
592 593
					      (p_blkg)->q, false)))

T
Tejun Heo 已提交
594
static inline int blkg_stat_init(struct blkg_stat *stat, gfp_t gfp)
595
{
T
Tejun Heo 已提交
596 597 598 599 600 601
	int ret;

	ret = percpu_counter_init(&stat->cpu_cnt, 0, gfp);
	if (ret)
		return ret;

602
	atomic64_set(&stat->aux_cnt, 0);
T
Tejun Heo 已提交
603 604 605 606 607 608
	return 0;
}

static inline void blkg_stat_exit(struct blkg_stat *stat)
{
	percpu_counter_destroy(&stat->cpu_cnt);
609 610
}

611 612 613 614 615
/**
 * blkg_stat_add - add a value to a blkg_stat
 * @stat: target blkg_stat
 * @val: value to add
 *
T
Tejun Heo 已提交
616 617
 * Add @val to @stat.  The caller must ensure that IRQ on the same CPU
 * don't re-enter this function for the same counter.
618 619 620
 */
static inline void blkg_stat_add(struct blkg_stat *stat, uint64_t val)
{
621
	percpu_counter_add_batch(&stat->cpu_cnt, val, BLKG_STAT_CPU_BATCH);
622 623 624 625 626 627 628 629
}

/**
 * blkg_stat_read - read the current value of a blkg_stat
 * @stat: blkg_stat to read
 */
static inline uint64_t blkg_stat_read(struct blkg_stat *stat)
{
T
Tejun Heo 已提交
630
	return percpu_counter_sum_positive(&stat->cpu_cnt);
631 632 633 634 635 636 637 638
}

/**
 * blkg_stat_reset - reset a blkg_stat
 * @stat: blkg_stat to reset
 */
static inline void blkg_stat_reset(struct blkg_stat *stat)
{
T
Tejun Heo 已提交
639
	percpu_counter_set(&stat->cpu_cnt, 0);
640
	atomic64_set(&stat->aux_cnt, 0);
641 642
}

643
/**
644
 * blkg_stat_add_aux - add a blkg_stat into another's aux count
645 646 647
 * @to: the destination blkg_stat
 * @from: the source
 *
648
 * Add @from's count including the aux one to @to's aux count.
649
 */
650 651
static inline void blkg_stat_add_aux(struct blkg_stat *to,
				     struct blkg_stat *from)
652
{
653 654
	atomic64_add(blkg_stat_read(from) + atomic64_read(&from->aux_cnt),
		     &to->aux_cnt);
655 656
}

T
Tejun Heo 已提交
657
static inline int blkg_rwstat_init(struct blkg_rwstat *rwstat, gfp_t gfp)
658
{
T
Tejun Heo 已提交
659 660 661 662 663 664 665 666 667 668 669 670 671
	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;
}
672

T
Tejun Heo 已提交
673 674 675
static inline void blkg_rwstat_exit(struct blkg_rwstat *rwstat)
{
	int i;
676 677

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

681 682 683
/**
 * blkg_rwstat_add - add a value to a blkg_rwstat
 * @rwstat: target blkg_rwstat
684
 * @op: REQ_OP and flags
685 686 687 688 689 690
 * @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,
691
				   unsigned int op, uint64_t val)
692
{
T
Tejun Heo 已提交
693
	struct percpu_counter *cnt;
694

695 696 697
	if (op_is_discard(op))
		cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_DISCARD];
	else if (op_is_write(op))
T
Tejun Heo 已提交
698
		cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_WRITE];
699
	else
T
Tejun Heo 已提交
700 701
		cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_READ];

702
	percpu_counter_add_batch(cnt, val, BLKG_STAT_CPU_BATCH);
T
Tejun Heo 已提交
703

704
	if (op_is_sync(op))
T
Tejun Heo 已提交
705
		cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_SYNC];
706
	else
T
Tejun Heo 已提交
707
		cnt = &rwstat->cpu_cnt[BLKG_RWSTAT_ASYNC];
708

709
	percpu_counter_add_batch(cnt, val, BLKG_STAT_CPU_BATCH);
710 711 712 713 714 715
}

/**
 * blkg_rwstat_read - read the current values of a blkg_rwstat
 * @rwstat: blkg_rwstat to read
 *
T
Tejun Heo 已提交
716
 * Read the current snapshot of @rwstat and return it in the aux counts.
717
 */
718
static inline struct blkg_rwstat blkg_rwstat_read(struct blkg_rwstat *rwstat)
719
{
T
Tejun Heo 已提交
720 721
	struct blkg_rwstat result;
	int i;
722

T
Tejun Heo 已提交
723 724 725 726
	for (i = 0; i < BLKG_RWSTAT_NR; i++)
		atomic64_set(&result.aux_cnt[i],
			     percpu_counter_sum_positive(&rwstat->cpu_cnt[i]));
	return result;
727 728 729
}

/**
730
 * blkg_rwstat_total - read the total count of a blkg_rwstat
731 732 733 734 735 736
 * @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.
 */
737
static inline uint64_t blkg_rwstat_total(struct blkg_rwstat *rwstat)
738 739 740
{
	struct blkg_rwstat tmp = blkg_rwstat_read(rwstat);

T
Tejun Heo 已提交
741 742
	return atomic64_read(&tmp.aux_cnt[BLKG_RWSTAT_READ]) +
		atomic64_read(&tmp.aux_cnt[BLKG_RWSTAT_WRITE]);
743 744 745 746 747 748 749 750
}

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

T
Tejun Heo 已提交
753 754
	for (i = 0; i < BLKG_RWSTAT_NR; i++) {
		percpu_counter_set(&rwstat->cpu_cnt[i], 0);
755
		atomic64_set(&rwstat->aux_cnt[i], 0);
T
Tejun Heo 已提交
756
	}
757 758
}

759
/**
760
 * blkg_rwstat_add_aux - add a blkg_rwstat into another's aux count
761 762 763
 * @to: the destination blkg_rwstat
 * @from: the source
 *
764
 * Add @from's count including the aux one to @to's aux count.
765
 */
766 767
static inline void blkg_rwstat_add_aux(struct blkg_rwstat *to,
				       struct blkg_rwstat *from)
768
{
769
	u64 sum[BLKG_RWSTAT_NR];
770 771 772
	int i;

	for (i = 0; i < BLKG_RWSTAT_NR; i++)
773 774 775 776
		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]),
777
			     &to->aux_cnt[i]);
778 779
}

780 781 782 783 784 785 786 787 788 789 790
#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

static inline bool blkcg_bio_issue_check(struct request_queue *q,
					 struct bio *bio)
{
D
Dennis Zhou 已提交
791
	struct blkcg *blkcg;
792 793 794 795
	struct blkcg_gq *blkg;
	bool throtl = false;

	rcu_read_lock();
D
Dennis Zhou 已提交
796 797

	/* associate blkcg if bio hasn't attached one */
798 799
	bio_associate_blkcg(bio, NULL);
	blkcg = bio_blkcg(bio);
800

D
Dennis Zhou 已提交
801 802
	blkg = blkg_lookup(blkcg, q);
	if (unlikely(!blkg)) {
803
		spin_lock_irq(&q->queue_lock);
804
		blkg = __blkg_lookup_create(blkcg, q);
D
Dennis Zhou 已提交
805 806
		if (IS_ERR(blkg))
			blkg = NULL;
807
		spin_unlock_irq(&q->queue_lock);
D
Dennis Zhou 已提交
808
	}
809 810 811

	throtl = blk_throtl_bio(q, blkg, bio);

812
	if (!throtl) {
D
Dennis Zhou 已提交
813
		blkg = blkg ?: q->root_blkg;
814 815 816 817 818 819 820 821
		/*
		 * 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);
822
		blkg_rwstat_add(&blkg->stat_ios, bio->bi_opf, 1);
823 824
	}

825 826 827 828
	rcu_read_unlock();
	return !throtl;
}

829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
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);
882 883
#else	/* CONFIG_BLK_CGROUP */

884 885
struct blkcg {
};
886

887 888 889
struct blkg_policy_data {
};

890 891 892
struct blkcg_policy_data {
};

T
Tejun Heo 已提交
893
struct blkcg_gq {
894 895
};

T
Tejun Heo 已提交
896
struct blkcg_policy {
897 898
};

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

901 902 903
static inline void blkcg_maybe_throttle_current(void) { }
static inline bool blk_cgroup_congested(void) { return false; }

904 905
#ifdef CONFIG_BLOCK

906 907
static inline void blkcg_schedule_throttle(struct request_queue *q, bool use_memdelay) { }

T
Tejun Heo 已提交
908
static inline struct blkcg_gq *blkg_lookup(struct blkcg *blkcg, void *key) { return NULL; }
909 910
static inline struct blkcg_gq *blk_queue_root_blkg(struct request_queue *q)
{ return NULL; }
911 912 913
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) { }
914
static inline int blkcg_policy_register(struct blkcg_policy *pol) { return 0; }
T
Tejun Heo 已提交
915
static inline void blkcg_policy_unregister(struct blkcg_policy *pol) { }
916
static inline int blkcg_activate_policy(struct request_queue *q,
T
Tejun Heo 已提交
917
					const struct blkcg_policy *pol) { return 0; }
918
static inline void blkcg_deactivate_policy(struct request_queue *q,
T
Tejun Heo 已提交
919 920
					   const struct blkcg_policy *pol) { }

921
static inline struct blkcg *__bio_blkcg(struct bio *bio) { return NULL; }
922
static inline struct blkcg *bio_blkcg(struct bio *bio) { return NULL; }
923

924 925 926
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 已提交
927 928 929
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) { }
930

931 932 933
static inline bool blkcg_bio_issue_check(struct request_queue *q,
					 struct bio *bio) { return true; }

934 935 936
#define blk_queue_for_each_rl(rl, q)	\
	for ((rl) = &(q)->root_rl; (rl); (rl) = NULL)

937
#endif	/* CONFIG_BLOCK */
938 939
#endif	/* CONFIG_BLK_CGROUP */
#endif	/* _BLK_CGROUP_H */