blk-cgroup.c 46.6 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
2 3 4 5 6 7 8 9 10 11 12
/*
 * 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>
13 14 15 16
 *
 * For policy-specific per-blkcg data:
 * Copyright (C) 2015 Paolo Valente <paolo.valente@unimore.it>
 *                    Arianna Avanzini <avanzini.arianna@gmail.com>
17 18
 */
#include <linux/ioprio.h>
19
#include <linux/kdev_t.h>
20
#include <linux/module.h>
21
#include <linux/sched/signal.h>
22
#include <linux/err.h>
23
#include <linux/blkdev.h>
24
#include <linux/backing-dev.h>
25
#include <linux/slab.h>
26
#include <linux/genhd.h>
27
#include <linux/delay.h>
T
Tejun Heo 已提交
28
#include <linux/atomic.h>
29
#include <linux/ctype.h>
30
#include <linux/blk-cgroup.h>
31
#include <linux/tracehook.h>
32
#include "blk.h"
33

34 35
#define MAX_KEY_LEN 100

36 37 38 39 40 41 42 43
/*
 * blkcg_pol_mutex protects blkcg_policy[] and policy [de]activation.
 * blkcg_pol_register_mutex nests outside of it and synchronizes entire
 * policy [un]register operations including cgroup file additions /
 * removals.  Putting cgroup file registration outside blkcg_pol_mutex
 * allows grabbing it from cgroup callbacks.
 */
static DEFINE_MUTEX(blkcg_pol_register_mutex);
44
static DEFINE_MUTEX(blkcg_pol_mutex);
45

46
struct blkcg blkcg_root;
T
Tejun Heo 已提交
47
EXPORT_SYMBOL_GPL(blkcg_root);
48

T
Tejun Heo 已提交
49 50
struct cgroup_subsys_state * const blkcg_root_css = &blkcg_root.css;

T
Tejun Heo 已提交
51
static struct blkcg_policy *blkcg_policy[BLKCG_MAX_POLS];
52

T
Tejun Heo 已提交
53 54
static LIST_HEAD(all_blkcgs);		/* protected by blkcg_pol_mutex */

55 56
static bool blkcg_debug_stats = false;

57
static bool blkcg_policy_enabled(struct request_queue *q,
T
Tejun Heo 已提交
58
				 const struct blkcg_policy *pol)
59 60 61 62
{
	return pol && test_bit(pol->plid, q->blkcg_pols);
}

63 64 65 66 67 68
/**
 * blkg_free - free a blkg
 * @blkg: blkg to free
 *
 * Free @blkg which may be partially allocated.
 */
T
Tejun Heo 已提交
69
static void blkg_free(struct blkcg_gq *blkg)
70
{
71
	int i;
72 73 74 75

	if (!blkg)
		return;

76
	for (i = 0; i < BLKCG_MAX_POLS; i++)
77 78
		if (blkg->pd[i])
			blkcg_policy[i]->pd_free_fn(blkg->pd[i]);
79

80 81
	blkg_rwstat_exit(&blkg->stat_ios);
	blkg_rwstat_exit(&blkg->stat_bytes);
82
	percpu_ref_exit(&blkg->refcnt);
83
	kfree(blkg);
84 85
}

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
static void __blkg_release(struct rcu_head *rcu)
{
	struct blkcg_gq *blkg = container_of(rcu, struct blkcg_gq, rcu_head);

	/* release the blkcg and parent blkg refs this blkg has been holding */
	css_put(&blkg->blkcg->css);
	if (blkg->parent)
		blkg_put(blkg->parent);

	wb_congested_put(blkg->wb_congested);

	blkg_free(blkg);
}

/*
 * A group is RCU protected, but having an rcu lock does not mean that one
 * can access all the fields of blkg and assume these are valid.  For
 * example, don't try to follow throtl_data and request queue links.
 *
 * Having a reference to blkg under an rcu allows accesses to only values
 * local to groups like group stats and group rate limits.
 */
static void blkg_release(struct percpu_ref *ref)
{
	struct blkcg_gq *blkg = container_of(ref, struct blkcg_gq, refcnt);

	call_rcu(&blkg->rcu_head, __blkg_release);
}

115 116 117 118
/**
 * blkg_alloc - allocate a blkg
 * @blkcg: block cgroup the new blkg is associated with
 * @q: request_queue the new blkg is associated with
119
 * @gfp_mask: allocation mask to use
120
 *
121
 * Allocate a new blkg assocating @blkcg and @q.
122
 */
123 124
static struct blkcg_gq *blkg_alloc(struct blkcg *blkcg, struct request_queue *q,
				   gfp_t gfp_mask)
125
{
T
Tejun Heo 已提交
126
	struct blkcg_gq *blkg;
127
	int i;
128 129

	/* alloc and init base part */
130
	blkg = kzalloc_node(sizeof(*blkg), gfp_mask, q->node);
131 132 133
	if (!blkg)
		return NULL;

134 135 136
	if (percpu_ref_init(&blkg->refcnt, blkg_release, 0, gfp_mask))
		goto err_free;

137 138 139 140
	if (blkg_rwstat_init(&blkg->stat_bytes, gfp_mask) ||
	    blkg_rwstat_init(&blkg->stat_ios, gfp_mask))
		goto err_free;

T
Tejun Heo 已提交
141
	blkg->q = q;
142
	INIT_LIST_HEAD(&blkg->q_node);
143 144
	blkg->blkcg = blkcg;

T
Tejun Heo 已提交
145
	for (i = 0; i < BLKCG_MAX_POLS; i++) {
T
Tejun Heo 已提交
146
		struct blkcg_policy *pol = blkcg_policy[i];
147
		struct blkg_policy_data *pd;
148

149
		if (!blkcg_policy_enabled(q, pol))
150 151 152
			continue;

		/* alloc per-policy data and attach it to blkg */
153
		pd = pol->pd_alloc_fn(gfp_mask, q->node);
154 155
		if (!pd)
			goto err_free;
156

157 158
		blkg->pd[i] = pd;
		pd->blkg = blkg;
T
Tejun Heo 已提交
159
		pd->plid = i;
160 161
	}

162
	return blkg;
163 164 165 166

err_free:
	blkg_free(blkg);
	return NULL;
167 168
}

T
Tejun Heo 已提交
169 170
struct blkcg_gq *blkg_lookup_slowpath(struct blkcg *blkcg,
				      struct request_queue *q, bool update_hint)
171
{
T
Tejun Heo 已提交
172
	struct blkcg_gq *blkg;
173

174
	/*
175 176 177 178
	 * Hint didn't match.  Look up from the radix tree.  Note that the
	 * hint can only be updated under queue_lock as otherwise @blkg
	 * could have already been removed from blkg_tree.  The caller is
	 * responsible for grabbing queue_lock if @update_hint.
179 180
	 */
	blkg = radix_tree_lookup(&blkcg->blkg_tree, q->id);
181 182
	if (blkg && blkg->q == q) {
		if (update_hint) {
183
			lockdep_assert_held(&q->queue_lock);
184 185
			rcu_assign_pointer(blkcg->blkg_hint, blkg);
		}
186
		return blkg;
187
	}
188

189 190
	return NULL;
}
191
EXPORT_SYMBOL_GPL(blkg_lookup_slowpath);
192

193
/*
194 195
 * If @new_blkg is %NULL, this function tries to allocate a new one as
 * necessary using %GFP_NOWAIT.  @new_blkg is always consumed on return.
196
 */
197
static struct blkcg_gq *blkg_create(struct blkcg *blkcg,
198 199
				    struct request_queue *q,
				    struct blkcg_gq *new_blkg)
200
{
201
	struct blkcg_gq *blkg;
202
	struct bdi_writeback_congested *wb_congested;
203
	int i, ret;
204

205
	WARN_ON_ONCE(!rcu_read_lock_held());
206
	lockdep_assert_held(&q->queue_lock);
207

208 209 210 211 212 213
	/* request_queue is dying, do not create/recreate a blkg */
	if (blk_queue_dying(q)) {
		ret = -ENODEV;
		goto err_free_blkg;
	}

214
	/* blkg holds a reference to blkcg */
215
	if (!css_tryget_online(&blkcg->css)) {
216
		ret = -ENODEV;
217
		goto err_free_blkg;
218
	}
219

220
	wb_congested = wb_congested_get_create(q->backing_dev_info,
221 222 223
					       blkcg->css.id,
					       GFP_NOWAIT | __GFP_NOWARN);
	if (!wb_congested) {
224
		ret = -ENOMEM;
225
		goto err_put_css;
226 227
	}

228 229 230 231 232 233
	/* allocate */
	if (!new_blkg) {
		new_blkg = blkg_alloc(blkcg, q, GFP_NOWAIT | __GFP_NOWARN);
		if (unlikely(!new_blkg)) {
			ret = -ENOMEM;
			goto err_put_congested;
234 235
		}
	}
236 237
	blkg = new_blkg;
	blkg->wb_congested = wb_congested;
238

239
	/* link parent */
T
Tejun Heo 已提交
240 241 242
	if (blkcg_parent(blkcg)) {
		blkg->parent = __blkg_lookup(blkcg_parent(blkcg), q, false);
		if (WARN_ON_ONCE(!blkg->parent)) {
243
			ret = -ENODEV;
244
			goto err_put_congested;
T
Tejun Heo 已提交
245 246 247 248
		}
		blkg_get(blkg->parent);
	}

249 250 251 252 253
	/* invoke per-policy init */
	for (i = 0; i < BLKCG_MAX_POLS; i++) {
		struct blkcg_policy *pol = blkcg_policy[i];

		if (blkg->pd[i] && pol->pd_init_fn)
254
			pol->pd_init_fn(blkg->pd[i]);
255 256 257
	}

	/* insert */
258
	spin_lock(&blkcg->lock);
259 260 261 262
	ret = radix_tree_insert(&blkcg->blkg_tree, q->id, blkg);
	if (likely(!ret)) {
		hlist_add_head_rcu(&blkg->blkcg_node, &blkcg->blkg_list);
		list_add(&blkg->q_node, &q->blkg_list);
263 264 265 266 267

		for (i = 0; i < BLKCG_MAX_POLS; i++) {
			struct blkcg_policy *pol = blkcg_policy[i];

			if (blkg->pd[i] && pol->pd_online_fn)
268
				pol->pd_online_fn(blkg->pd[i]);
269
		}
270
	}
271
	blkg->online = true;
272
	spin_unlock(&blkcg->lock);
273

274
	if (!ret)
275
		return blkg;
276

T
Tejun Heo 已提交
277 278 279 280
	/* @blkg failed fully initialized, use the usual release path */
	blkg_put(blkg);
	return ERR_PTR(ret);

281 282 283
err_put_congested:
	wb_congested_put(wb_congested);
err_put_css:
284
	css_put(&blkcg->css);
285
err_free_blkg:
286
	blkg_free(new_blkg);
287
	return ERR_PTR(ret);
288
}
289

290
/**
291
 * __blkg_lookup_create - lookup blkg, try to create one if not there
292 293 294 295
 * @blkcg: blkcg of interest
 * @q: request_queue of interest
 *
 * Lookup blkg for the @blkcg - @q pair.  If it doesn't exist, try to
T
Tejun Heo 已提交
296 297 298
 * create one.  blkg creation is performed recursively from blkcg_root such
 * that all non-root blkg's have access to the parent blkg.  This function
 * should be called under RCU read lock and @q->queue_lock.
299
 *
300 301
 * Returns the blkg or the closest blkg if blkg_create() fails as it walks
 * down from root.
302
 */
303 304
struct blkcg_gq *__blkg_lookup_create(struct blkcg *blkcg,
				      struct request_queue *q)
305
{
306 307 308
	struct blkcg_gq *blkg;

	WARN_ON_ONCE(!rcu_read_lock_held());
309
	lockdep_assert_held(&q->queue_lock);
310 311 312 313 314

	blkg = __blkg_lookup(blkcg, q, true);
	if (blkg)
		return blkg;

T
Tejun Heo 已提交
315 316
	/*
	 * Create blkgs walking down from blkcg_root to @blkcg, so that all
317 318
	 * non-root blkgs have access to their parents.  Returns the closest
	 * blkg to the intended blkg should blkg_create() fail.
T
Tejun Heo 已提交
319 320 321 322
	 */
	while (true) {
		struct blkcg *pos = blkcg;
		struct blkcg *parent = blkcg_parent(blkcg);
323 324 325 326 327 328 329 330 331
		struct blkcg_gq *ret_blkg = q->root_blkg;

		while (parent) {
			blkg = __blkg_lookup(parent, q, false);
			if (blkg) {
				/* remember closest blkg */
				ret_blkg = blkg;
				break;
			}
T
Tejun Heo 已提交
332 333 334 335
			pos = parent;
			parent = blkcg_parent(parent);
		}

336
		blkg = blkg_create(pos, q, NULL);
337 338 339
		if (IS_ERR(blkg))
			return ret_blkg;
		if (pos == blkcg)
T
Tejun Heo 已提交
340 341
			return blkg;
	}
342
}
343

344 345 346 347 348 349 350 351 352 353 354 355 356 357
/**
 * blkg_lookup_create - find or create a blkg
 * @blkcg: target block cgroup
 * @q: target request_queue
 *
 * This looks up or creates the blkg representing the unique pair
 * of the blkcg and the request_queue.
 */
struct blkcg_gq *blkg_lookup_create(struct blkcg *blkcg,
				    struct request_queue *q)
{
	struct blkcg_gq *blkg = blkg_lookup(blkcg, q);

	if (unlikely(!blkg)) {
358 359 360
		unsigned long flags;

		spin_lock_irqsave(&q->queue_lock, flags);
361
		blkg = __blkg_lookup_create(blkcg, q);
362
		spin_unlock_irqrestore(&q->queue_lock, flags);
363 364 365 366 367
	}

	return blkg;
}

T
Tejun Heo 已提交
368
static void blkg_destroy(struct blkcg_gq *blkg)
369
{
T
Tejun Heo 已提交
370
	struct blkcg *blkcg = blkg->blkcg;
371
	struct blkcg_gq *parent = blkg->parent;
372
	int i;
373

374
	lockdep_assert_held(&blkg->q->queue_lock);
375
	lockdep_assert_held(&blkcg->lock);
376 377

	/* Something wrong if we are trying to remove same group twice */
378
	WARN_ON_ONCE(list_empty(&blkg->q_node));
379
	WARN_ON_ONCE(hlist_unhashed(&blkg->blkcg_node));
380

381 382 383 384 385 386 387
	for (i = 0; i < BLKCG_MAX_POLS; i++) {
		struct blkcg_policy *pol = blkcg_policy[i];

		if (blkg->pd[i] && pol->pd_offline_fn)
			pol->pd_offline_fn(blkg->pd[i]);
	}

388 389 390 391 392
	if (parent) {
		blkg_rwstat_add_aux(&parent->stat_bytes, &blkg->stat_bytes);
		blkg_rwstat_add_aux(&parent->stat_ios, &blkg->stat_ios);
	}

393 394
	blkg->online = false;

395
	radix_tree_delete(&blkcg->blkg_tree, blkg->q->id);
396
	list_del_init(&blkg->q_node);
397
	hlist_del_init_rcu(&blkg->blkcg_node);
398

399 400 401 402 403
	/*
	 * Both setting lookup hint to and clearing it from @blkg are done
	 * under queue_lock.  If it's not pointing to @blkg now, it never
	 * will.  Hint assignment itself can race safely.
	 */
404
	if (rcu_access_pointer(blkcg->blkg_hint) == blkg)
405 406
		rcu_assign_pointer(blkcg->blkg_hint, NULL);

407 408 409 410
	/*
	 * Put the reference taken at the time of creation so that when all
	 * queues are gone, group can be destroyed.
	 */
411
	percpu_ref_kill(&blkg->refcnt);
412 413
}

414 415 416 417
/**
 * blkg_destroy_all - destroy all blkgs associated with a request_queue
 * @q: request_queue of interest
 *
418
 * Destroy all blkgs associated with @q.
419
 */
420
static void blkg_destroy_all(struct request_queue *q)
421
{
T
Tejun Heo 已提交
422
	struct blkcg_gq *blkg, *n;
423

424
	spin_lock_irq(&q->queue_lock);
425
	list_for_each_entry_safe(blkg, n, &q->blkg_list, q_node) {
T
Tejun Heo 已提交
426
		struct blkcg *blkcg = blkg->blkcg;
427

428 429 430
		spin_lock(&blkcg->lock);
		blkg_destroy(blkg);
		spin_unlock(&blkcg->lock);
431
	}
432 433

	q->root_blkg = NULL;
434
	spin_unlock_irq(&q->queue_lock);
435 436
}

437 438
static int blkcg_reset_stats(struct cgroup_subsys_state *css,
			     struct cftype *cftype, u64 val)
439
{
440
	struct blkcg *blkcg = css_to_blkcg(css);
T
Tejun Heo 已提交
441
	struct blkcg_gq *blkg;
442
	int i;
443

444
	mutex_lock(&blkcg_pol_mutex);
445
	spin_lock_irq(&blkcg->lock);
T
Tejun Heo 已提交
446 447 448 449 450 451

	/*
	 * Note that stat reset is racy - it doesn't synchronize against
	 * stat updates.  This is a debug feature which shouldn't exist
	 * anyway.  If you get hit by a race, retry.
	 */
452
	hlist_for_each_entry(blkg, &blkcg->blkg_list, blkcg_node) {
453 454 455
		blkg_rwstat_reset(&blkg->stat_bytes);
		blkg_rwstat_reset(&blkg->stat_ios);

T
Tejun Heo 已提交
456
		for (i = 0; i < BLKCG_MAX_POLS; i++) {
T
Tejun Heo 已提交
457
			struct blkcg_policy *pol = blkcg_policy[i];
458

459 460
			if (blkg->pd[i] && pol->pd_reset_stats_fn)
				pol->pd_reset_stats_fn(blkg->pd[i]);
461
		}
462
	}
463

464
	spin_unlock_irq(&blkcg->lock);
465
	mutex_unlock(&blkcg_pol_mutex);
466 467 468
	return 0;
}

469
const char *blkg_dev_name(struct blkcg_gq *blkg)
470
{
471
	/* some drivers (floppy) instantiate a queue w/o disk registered */
472 473
	if (blkg->q->backing_dev_info->dev)
		return dev_name(blkg->q->backing_dev_info->dev);
474
	return NULL;
475 476
}

477 478 479 480 481 482 483 484 485 486 487
/**
 * blkcg_print_blkgs - helper for printing per-blkg data
 * @sf: seq_file to print to
 * @blkcg: blkcg of interest
 * @prfill: fill function to print out a blkg
 * @pol: policy in question
 * @data: data to be passed to @prfill
 * @show_total: to print out sum of prfill return values or not
 *
 * This function invokes @prfill on each blkg of @blkcg if pd for the
 * policy specified by @pol exists.  @prfill is invoked with @sf, the
488 489 490
 * policy data and @data and the matching queue lock held.  If @show_total
 * is %true, the sum of the return values from @prfill is printed with
 * "Total" label at the end.
491 492 493 494
 *
 * This is to be used to construct print functions for
 * cftype->read_seq_string method.
 */
T
Tejun Heo 已提交
495
void blkcg_print_blkgs(struct seq_file *sf, struct blkcg *blkcg,
496 497
		       u64 (*prfill)(struct seq_file *,
				     struct blkg_policy_data *, int),
T
Tejun Heo 已提交
498
		       const struct blkcg_policy *pol, int data,
499
		       bool show_total)
500
{
T
Tejun Heo 已提交
501
	struct blkcg_gq *blkg;
502
	u64 total = 0;
503

504
	rcu_read_lock();
505
	hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
506
		spin_lock_irq(&blkg->q->queue_lock);
507
		if (blkcg_policy_enabled(blkg->q, pol))
508
			total += prfill(sf, blkg->pd[pol->plid], data);
509
		spin_unlock_irq(&blkg->q->queue_lock);
510 511
	}
	rcu_read_unlock();
512 513 514 515

	if (show_total)
		seq_printf(sf, "Total %llu\n", (unsigned long long)total);
}
516
EXPORT_SYMBOL_GPL(blkcg_print_blkgs);
517 518 519 520

/**
 * __blkg_prfill_u64 - prfill helper for a single u64 value
 * @sf: seq_file to print to
521
 * @pd: policy private data of interest
522 523
 * @v: value to print
 *
524
 * Print @v to @sf for the device assocaited with @pd.
525
 */
526
u64 __blkg_prfill_u64(struct seq_file *sf, struct blkg_policy_data *pd, u64 v)
527
{
528
	const char *dname = blkg_dev_name(pd->blkg);
529 530 531 532 533 534 535

	if (!dname)
		return 0;

	seq_printf(sf, "%s %llu\n", dname, (unsigned long long)v);
	return v;
}
536
EXPORT_SYMBOL_GPL(__blkg_prfill_u64);
537 538 539 540

/**
 * __blkg_prfill_rwstat - prfill helper for a blkg_rwstat
 * @sf: seq_file to print to
541
 * @pd: policy private data of interest
542 543
 * @rwstat: rwstat to print
 *
544
 * Print @rwstat to @sf for the device assocaited with @pd.
545
 */
546
u64 __blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
547
			 const struct blkg_rwstat *rwstat)
548 549 550 551 552 553
{
	static const char *rwstr[] = {
		[BLKG_RWSTAT_READ]	= "Read",
		[BLKG_RWSTAT_WRITE]	= "Write",
		[BLKG_RWSTAT_SYNC]	= "Sync",
		[BLKG_RWSTAT_ASYNC]	= "Async",
554
		[BLKG_RWSTAT_DISCARD]	= "Discard",
555
	};
556
	const char *dname = blkg_dev_name(pd->blkg);
557 558 559 560 561 562 563 564
	u64 v;
	int i;

	if (!dname)
		return 0;

	for (i = 0; i < BLKG_RWSTAT_NR; i++)
		seq_printf(sf, "%s %s %llu\n", dname, rwstr[i],
T
Tejun Heo 已提交
565
			   (unsigned long long)atomic64_read(&rwstat->aux_cnt[i]));
566

T
Tejun Heo 已提交
567
	v = atomic64_read(&rwstat->aux_cnt[BLKG_RWSTAT_READ]) +
568 569
		atomic64_read(&rwstat->aux_cnt[BLKG_RWSTAT_WRITE]) +
		atomic64_read(&rwstat->aux_cnt[BLKG_RWSTAT_DISCARD]);
570 571 572
	seq_printf(sf, "%s Total %llu\n", dname, (unsigned long long)v);
	return v;
}
T
Tejun Heo 已提交
573
EXPORT_SYMBOL_GPL(__blkg_prfill_rwstat);
574

575 576 577
/**
 * blkg_prfill_stat - prfill callback for blkg_stat
 * @sf: seq_file to print to
578 579
 * @pd: policy private data of interest
 * @off: offset to the blkg_stat in @pd
580 581 582
 *
 * prfill callback for printing a blkg_stat.
 */
583
u64 blkg_prfill_stat(struct seq_file *sf, struct blkg_policy_data *pd, int off)
584
{
585
	return __blkg_prfill_u64(sf, pd, blkg_stat_read((void *)pd + off));
586
}
587
EXPORT_SYMBOL_GPL(blkg_prfill_stat);
588

589 590 591
/**
 * blkg_prfill_rwstat - prfill callback for blkg_rwstat
 * @sf: seq_file to print to
592 593
 * @pd: policy private data of interest
 * @off: offset to the blkg_rwstat in @pd
594 595 596
 *
 * prfill callback for printing a blkg_rwstat.
 */
597 598
u64 blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
		       int off)
599
{
600
	struct blkg_rwstat rwstat = blkg_rwstat_read((void *)pd + off);
601

602
	return __blkg_prfill_rwstat(sf, pd, &rwstat);
603
}
604
EXPORT_SYMBOL_GPL(blkg_prfill_rwstat);
605

606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
static u64 blkg_prfill_rwstat_field(struct seq_file *sf,
				    struct blkg_policy_data *pd, int off)
{
	struct blkg_rwstat rwstat = blkg_rwstat_read((void *)pd->blkg + off);

	return __blkg_prfill_rwstat(sf, pd, &rwstat);
}

/**
 * blkg_print_stat_bytes - seq_show callback for blkg->stat_bytes
 * @sf: seq_file to print to
 * @v: unused
 *
 * To be used as cftype->seq_show to print blkg->stat_bytes.
 * cftype->private must be set to the blkcg_policy.
 */
int blkg_print_stat_bytes(struct seq_file *sf, void *v)
{
	blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
			  blkg_prfill_rwstat_field, (void *)seq_cft(sf)->private,
			  offsetof(struct blkcg_gq, stat_bytes), true);
	return 0;
}
EXPORT_SYMBOL_GPL(blkg_print_stat_bytes);

/**
 * blkg_print_stat_bytes - seq_show callback for blkg->stat_ios
 * @sf: seq_file to print to
 * @v: unused
 *
 * To be used as cftype->seq_show to print blkg->stat_ios.  cftype->private
 * must be set to the blkcg_policy.
 */
int blkg_print_stat_ios(struct seq_file *sf, void *v)
{
	blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
			  blkg_prfill_rwstat_field, (void *)seq_cft(sf)->private,
			  offsetof(struct blkcg_gq, stat_ios), true);
	return 0;
}
EXPORT_SYMBOL_GPL(blkg_print_stat_ios);

static u64 blkg_prfill_rwstat_field_recursive(struct seq_file *sf,
					      struct blkg_policy_data *pd,
					      int off)
{
	struct blkg_rwstat rwstat = blkg_rwstat_recursive_sum(pd->blkg,
							      NULL, off);
	return __blkg_prfill_rwstat(sf, pd, &rwstat);
}

/**
 * blkg_print_stat_bytes_recursive - recursive version of blkg_print_stat_bytes
 * @sf: seq_file to print to
 * @v: unused
 */
int blkg_print_stat_bytes_recursive(struct seq_file *sf, void *v)
{
	blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
			  blkg_prfill_rwstat_field_recursive,
			  (void *)seq_cft(sf)->private,
			  offsetof(struct blkcg_gq, stat_bytes), true);
	return 0;
}
EXPORT_SYMBOL_GPL(blkg_print_stat_bytes_recursive);

/**
 * blkg_print_stat_ios_recursive - recursive version of blkg_print_stat_ios
 * @sf: seq_file to print to
 * @v: unused
 */
int blkg_print_stat_ios_recursive(struct seq_file *sf, void *v)
{
	blkcg_print_blkgs(sf, css_to_blkcg(seq_css(sf)),
			  blkg_prfill_rwstat_field_recursive,
			  (void *)seq_cft(sf)->private,
			  offsetof(struct blkcg_gq, stat_ios), true);
	return 0;
}
EXPORT_SYMBOL_GPL(blkg_print_stat_ios_recursive);

687 688
/**
 * blkg_stat_recursive_sum - collect hierarchical blkg_stat
689 690 691
 * @blkg: blkg of interest
 * @pol: blkcg_policy which contains the blkg_stat
 * @off: offset to the blkg_stat in blkg_policy_data or @blkg
692
 *
693 694 695 696 697 698
 * Collect the blkg_stat specified by @blkg, @pol and @off and all its
 * online descendants and their aux counts.  The caller must be holding the
 * queue lock for online tests.
 *
 * If @pol is NULL, blkg_stat is at @off bytes into @blkg; otherwise, it is
 * at @off bytes into @blkg's blkg_policy_data of the policy.
699
 */
700 701
u64 blkg_stat_recursive_sum(struct blkcg_gq *blkg,
			    struct blkcg_policy *pol, int off)
702 703
{
	struct blkcg_gq *pos_blkg;
704
	struct cgroup_subsys_state *pos_css;
705
	u64 sum = 0;
706

707
	lockdep_assert_held(&blkg->q->queue_lock);
708 709

	rcu_read_lock();
710 711 712 713 714
	blkg_for_each_descendant_pre(pos_blkg, pos_css, blkg) {
		struct blkg_stat *stat;

		if (!pos_blkg->online)
			continue;
715

716 717 718 719 720 721
		if (pol)
			stat = (void *)blkg_to_pd(pos_blkg, pol) + off;
		else
			stat = (void *)blkg + off;

		sum += blkg_stat_read(stat) + atomic64_read(&stat->aux_cnt);
722 723 724 725 726 727 728 729 730
	}
	rcu_read_unlock();

	return sum;
}
EXPORT_SYMBOL_GPL(blkg_stat_recursive_sum);

/**
 * blkg_rwstat_recursive_sum - collect hierarchical blkg_rwstat
731 732 733
 * @blkg: blkg of interest
 * @pol: blkcg_policy which contains the blkg_rwstat
 * @off: offset to the blkg_rwstat in blkg_policy_data or @blkg
734
 *
735 736 737 738 739 740
 * Collect the blkg_rwstat specified by @blkg, @pol and @off and all its
 * online descendants and their aux counts.  The caller must be holding the
 * queue lock for online tests.
 *
 * If @pol is NULL, blkg_rwstat is at @off bytes into @blkg; otherwise, it
 * is at @off bytes into @blkg's blkg_policy_data of the policy.
741
 */
742 743
struct blkg_rwstat blkg_rwstat_recursive_sum(struct blkcg_gq *blkg,
					     struct blkcg_policy *pol, int off)
744 745
{
	struct blkcg_gq *pos_blkg;
746
	struct cgroup_subsys_state *pos_css;
747
	struct blkg_rwstat sum = { };
748 749
	int i;

750
	lockdep_assert_held(&blkg->q->queue_lock);
751 752

	rcu_read_lock();
753
	blkg_for_each_descendant_pre(pos_blkg, pos_css, blkg) {
754
		struct blkg_rwstat *rwstat;
755 756 757 758

		if (!pos_blkg->online)
			continue;

759 760 761 762 763
		if (pol)
			rwstat = (void *)blkg_to_pd(pos_blkg, pol) + off;
		else
			rwstat = (void *)pos_blkg + off;

764
		for (i = 0; i < BLKG_RWSTAT_NR; i++)
765 766 767
			atomic64_add(atomic64_read(&rwstat->aux_cnt[i]) +
				percpu_counter_sum_positive(&rwstat->cpu_cnt[i]),
				&sum.aux_cnt[i]);
768 769 770 771 772 773 774
	}
	rcu_read_unlock();

	return sum;
}
EXPORT_SYMBOL_GPL(blkg_rwstat_recursive_sum);

775 776 777 778 779 780
/* Performs queue bypass and policy enabled checks then looks up blkg. */
static struct blkcg_gq *blkg_lookup_check(struct blkcg *blkcg,
					  const struct blkcg_policy *pol,
					  struct request_queue *q)
{
	WARN_ON_ONCE(!rcu_read_lock_held());
781
	lockdep_assert_held(&q->queue_lock);
782 783 784 785 786 787

	if (!blkcg_policy_enabled(q, pol))
		return ERR_PTR(-EOPNOTSUPP);
	return __blkg_lookup(blkcg, q, true /* update_hint */);
}

788 789 790
/**
 * blkg_conf_prep - parse and prepare for per-blkg config update
 * @blkcg: target block cgroup
791
 * @pol: target policy
792 793 794 795
 * @input: input string
 * @ctx: blkg_conf_ctx to be filled
 *
 * Parse per-blkg config update from @input and initialize @ctx with the
796 797 798
 * result.  @ctx->blkg points to the blkg to be updated and @ctx->body the
 * part of @input following MAJ:MIN.  This function returns with RCU read
 * lock and queue lock held and must be paired with blkg_conf_finish().
799
 */
T
Tejun Heo 已提交
800
int blkg_conf_prep(struct blkcg *blkcg, const struct blkcg_policy *pol,
801
		   char *input, struct blkg_conf_ctx *ctx)
802
	__acquires(rcu) __acquires(&disk->queue->queue_lock)
803
{
804
	struct gendisk *disk;
805
	struct request_queue *q;
T
Tejun Heo 已提交
806
	struct blkcg_gq *blkg;
T
Tejun Heo 已提交
807
	unsigned int major, minor;
808 809
	int key_len, part, ret;
	char *body;
810

811
	if (sscanf(input, "%u:%u%n", &major, &minor, &key_len) != 2)
T
Tejun Heo 已提交
812
		return -EINVAL;
813

814 815 816 817 818
	body = input + key_len;
	if (!isspace(*body))
		return -EINVAL;
	body = skip_spaces(body);

T
Tejun Heo 已提交
819
	disk = get_gendisk(MKDEV(major, minor), &part);
820
	if (!disk)
821
		return -ENODEV;
822
	if (part) {
823 824
		ret = -ENODEV;
		goto fail;
825
	}
826

827
	q = disk->queue;
828

829
	rcu_read_lock();
830
	spin_lock_irq(&q->queue_lock);
831

832
	blkg = blkg_lookup_check(blkcg, pol, q);
T
Tejun Heo 已提交
833 834
	if (IS_ERR(blkg)) {
		ret = PTR_ERR(blkg);
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
		goto fail_unlock;
	}

	if (blkg)
		goto success;

	/*
	 * Create blkgs walking down from blkcg_root to @blkcg, so that all
	 * non-root blkgs have access to their parents.
	 */
	while (true) {
		struct blkcg *pos = blkcg;
		struct blkcg *parent;
		struct blkcg_gq *new_blkg;

		parent = blkcg_parent(blkcg);
		while (parent && !__blkg_lookup(parent, q, false)) {
			pos = parent;
			parent = blkcg_parent(parent);
		}

		/* Drop locks to do new blkg allocation with GFP_KERNEL. */
857
		spin_unlock_irq(&q->queue_lock);
858
		rcu_read_unlock();
859 860 861 862 863

		new_blkg = blkg_alloc(pos, q, GFP_KERNEL);
		if (unlikely(!new_blkg)) {
			ret = -ENOMEM;
			goto fail;
864
		}
865

866
		rcu_read_lock();
867
		spin_lock_irq(&q->queue_lock);
868 869 870 871 872 873 874 875 876 877 878

		blkg = blkg_lookup_check(pos, pol, q);
		if (IS_ERR(blkg)) {
			ret = PTR_ERR(blkg);
			goto fail_unlock;
		}

		if (blkg) {
			blkg_free(new_blkg);
		} else {
			blkg = blkg_create(pos, q, new_blkg);
879
			if (IS_ERR(blkg)) {
880 881 882 883 884 885 886 887 888
				ret = PTR_ERR(blkg);
				goto fail_unlock;
			}
		}

		if (pos == blkcg)
			goto success;
	}
success:
889 890
	ctx->disk = disk;
	ctx->blkg = blkg;
891
	ctx->body = body;
T
Tejun Heo 已提交
892
	return 0;
893 894

fail_unlock:
895
	spin_unlock_irq(&q->queue_lock);
896 897
	rcu_read_unlock();
fail:
898
	put_disk_and_module(disk);
899 900 901 902 903 904 905 906 907 908 909
	/*
	 * If queue was bypassing, we should retry.  Do so after a
	 * short msleep().  It isn't strictly necessary but queue
	 * can be bypassing for some time and it's always nice to
	 * avoid busy looping.
	 */
	if (ret == -EBUSY) {
		msleep(10);
		ret = restart_syscall();
	}
	return ret;
910 911
}

912 913 914 915 916 917 918
/**
 * blkg_conf_finish - finish up per-blkg config update
 * @ctx: blkg_conf_ctx intiailized by blkg_conf_prep()
 *
 * Finish up after per-blkg config update.  This function must be paired
 * with blkg_conf_prep().
 */
919
void blkg_conf_finish(struct blkg_conf_ctx *ctx)
920
	__releases(&ctx->disk->queue->queue_lock) __releases(rcu)
921
{
922
	spin_unlock_irq(&ctx->disk->queue->queue_lock);
923
	rcu_read_unlock();
924
	put_disk_and_module(ctx->disk);
925 926
}

927 928 929 930 931 932 933 934 935
static int blkcg_print_stat(struct seq_file *sf, void *v)
{
	struct blkcg *blkcg = css_to_blkcg(seq_css(sf));
	struct blkcg_gq *blkg;

	rcu_read_lock();

	hlist_for_each_entry_rcu(blkg, &blkcg->blkg_list, blkcg_node) {
		const char *dname;
936
		char *buf;
937
		struct blkg_rwstat rwstat;
938
		u64 rbytes, wbytes, rios, wios, dbytes, dios;
939 940 941
		size_t size = seq_get_buf(sf, &buf), off = 0;
		int i;
		bool has_stats = false;
942 943 944 945 946

		dname = blkg_dev_name(blkg);
		if (!dname)
			continue;

947 948 949 950 951 952 953 954
		/*
		 * Hooray string manipulation, count is the size written NOT
		 * INCLUDING THE \0, so size is now count+1 less than what we
		 * had before, but we want to start writing the next bit from
		 * the \0 so we only add count to buf.
		 */
		off += scnprintf(buf+off, size-off, "%s ", dname);

955
		spin_lock_irq(&blkg->q->queue_lock);
956 957 958 959 960

		rwstat = blkg_rwstat_recursive_sum(blkg, NULL,
					offsetof(struct blkcg_gq, stat_bytes));
		rbytes = atomic64_read(&rwstat.aux_cnt[BLKG_RWSTAT_READ]);
		wbytes = atomic64_read(&rwstat.aux_cnt[BLKG_RWSTAT_WRITE]);
961
		dbytes = atomic64_read(&rwstat.aux_cnt[BLKG_RWSTAT_DISCARD]);
962 963 964 965 966

		rwstat = blkg_rwstat_recursive_sum(blkg, NULL,
					offsetof(struct blkcg_gq, stat_ios));
		rios = atomic64_read(&rwstat.aux_cnt[BLKG_RWSTAT_READ]);
		wios = atomic64_read(&rwstat.aux_cnt[BLKG_RWSTAT_WRITE]);
967
		dios = atomic64_read(&rwstat.aux_cnt[BLKG_RWSTAT_DISCARD]);
968

969
		spin_unlock_irq(&blkg->q->queue_lock);
970

971 972 973
		if (rbytes || wbytes || rios || wios) {
			has_stats = true;
			off += scnprintf(buf+off, size-off,
974 975 976
					 "rbytes=%llu wbytes=%llu rios=%llu wios=%llu dbytes=%llu dios=%llu",
					 rbytes, wbytes, rios, wios,
					 dbytes, dios);
977 978 979 980 981
		}

		if (!blkcg_debug_stats)
			goto next;

982 983 984 985 986 987 988 989
		if (atomic_read(&blkg->use_delay)) {
			has_stats = true;
			off += scnprintf(buf+off, size-off,
					 " use_delay=%d delay_nsec=%llu",
					 atomic_read(&blkg->use_delay),
					(unsigned long long)atomic64_read(&blkg->delay_nsec));
		}

990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
		for (i = 0; i < BLKCG_MAX_POLS; i++) {
			struct blkcg_policy *pol = blkcg_policy[i];
			size_t written;

			if (!blkg->pd[i] || !pol->pd_stat_fn)
				continue;

			written = pol->pd_stat_fn(blkg->pd[i], buf+off, size-off);
			if (written)
				has_stats = true;
			off += written;
		}
next:
		if (has_stats) {
1004 1005 1006 1007 1008 1009
			if (off < size - 1) {
				off += scnprintf(buf+off, size-off, "\n");
				seq_commit(sf, off);
			} else {
				seq_commit(sf, -1);
			}
1010
		}
1011 1012 1013 1014 1015 1016
	}

	rcu_read_unlock();
	return 0;
}

1017
static struct cftype blkcg_files[] = {
1018 1019
	{
		.name = "stat",
1020
		.flags = CFTYPE_NOT_ON_ROOT,
1021 1022 1023 1024 1025
		.seq_show = blkcg_print_stat,
	},
	{ }	/* terminate */
};

1026
static struct cftype blkcg_legacy_files[] = {
1027 1028
	{
		.name = "reset_stats",
T
Tejun Heo 已提交
1029
		.write_u64 = blkcg_reset_stats,
1030
	},
1031
	{ }	/* terminate */
1032 1033
};

1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
/*
 * blkcg destruction is a three-stage process.
 *
 * 1. Destruction starts.  The blkcg_css_offline() callback is invoked
 *    which offlines writeback.  Here we tie the next stage of blkg destruction
 *    to the completion of writeback associated with the blkcg.  This lets us
 *    avoid punting potentially large amounts of outstanding writeback to root
 *    while maintaining any ongoing policies.  The next stage is triggered when
 *    the nr_cgwbs count goes to zero.
 *
 * 2. When the nr_cgwbs count goes to zero, blkcg_destroy_blkgs() is called
 *    and handles the destruction of blkgs.  Here the css reference held by
 *    the blkg is put back eventually allowing blkcg_css_free() to be called.
 *    This work may occur in cgwb_release_workfn() on the cgwb_release
 *    workqueue.  Any submitted ios that fail to get the blkg ref will be
 *    punted to the root_blkg.
 *
 * 3. Once the blkcg ref count goes to zero, blkcg_css_free() is called.
 *    This finally frees the blkcg.
 */

1055
/**
1056
 * blkcg_css_offline - cgroup css_offline callback
1057
 * @css: css of interest
1058
 *
1059 1060 1061
 * This function is called when @css is about to go away.  Here the cgwbs are
 * offlined first and only once writeback associated with the blkcg has
 * finished do we start step 2 (see above).
1062
 */
1063
static void blkcg_css_offline(struct cgroup_subsys_state *css)
1064
{
1065
	struct blkcg *blkcg = css_to_blkcg(css);
1066

1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
	/* this prevents anyone from attaching or migrating to this blkcg */
	wb_blkcg_offline(blkcg);

	/* put the base cgwb reference allowing step 2 to be triggered */
	blkcg_cgwb_put(blkcg);
}

/**
 * blkcg_destroy_blkgs - responsible for shooting down blkgs
 * @blkcg: blkcg of interest
 *
 * blkgs should be removed while holding both q and blkcg locks.  As blkcg lock
 * is nested inside q lock, this function performs reverse double lock dancing.
 * Destroying the blkgs releases the reference held on the blkcg's css allowing
 * blkcg_css_free to eventually be called.
 *
 * This is the blkcg counterpart of ioc_release_fn().
 */
void blkcg_destroy_blkgs(struct blkcg *blkcg)
{
1087
	spin_lock_irq(&blkcg->lock);
1088

1089 1090
	while (!hlist_empty(&blkcg->blkg_list)) {
		struct blkcg_gq *blkg = hlist_entry(blkcg->blkg_list.first,
1091
						struct blkcg_gq, blkcg_node);
1092 1093
		struct request_queue *q = blkg->q;

1094
		if (spin_trylock(&q->queue_lock)) {
1095
			blkg_destroy(blkg);
1096
			spin_unlock(&q->queue_lock);
1097 1098 1099 1100 1101 1102
		} else {
			spin_unlock_irq(&blkcg->lock);
			cpu_relax();
			spin_lock_irq(&blkcg->lock);
		}
	}
1103

1104 1105 1106
	spin_unlock_irq(&blkcg->lock);
}

1107
static void blkcg_css_free(struct cgroup_subsys_state *css)
1108
{
1109
	struct blkcg *blkcg = css_to_blkcg(css);
1110
	int i;
1111

T
Tejun Heo 已提交
1112
	mutex_lock(&blkcg_pol_mutex);
1113

T
Tejun Heo 已提交
1114 1115
	list_del(&blkcg->all_blkcgs_node);

1116
	for (i = 0; i < BLKCG_MAX_POLS; i++)
1117 1118 1119 1120 1121
		if (blkcg->cpd[i])
			blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);

	mutex_unlock(&blkcg_pol_mutex);

1122
	kfree(blkcg);
1123 1124
}

1125 1126
static struct cgroup_subsys_state *
blkcg_css_alloc(struct cgroup_subsys_state *parent_css)
1127
{
T
Tejun Heo 已提交
1128
	struct blkcg *blkcg;
1129 1130
	struct cgroup_subsys_state *ret;
	int i;
1131

T
Tejun Heo 已提交
1132 1133
	mutex_lock(&blkcg_pol_mutex);

1134
	if (!parent_css) {
T
Tejun Heo 已提交
1135
		blkcg = &blkcg_root;
1136 1137 1138 1139
	} else {
		blkcg = kzalloc(sizeof(*blkcg), GFP_KERNEL);
		if (!blkcg) {
			ret = ERR_PTR(-ENOMEM);
1140
			goto unlock;
1141
		}
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
	}

	for (i = 0; i < BLKCG_MAX_POLS ; i++) {
		struct blkcg_policy *pol = blkcg_policy[i];
		struct blkcg_policy_data *cpd;

		/*
		 * If the policy hasn't been attached yet, wait for it
		 * to be attached before doing anything else. Otherwise,
		 * check if the policy requires any specific per-cgroup
		 * data: if it does, allocate and initialize it.
		 */
1154
		if (!pol || !pol->cpd_alloc_fn)
1155 1156
			continue;

1157
		cpd = pol->cpd_alloc_fn(GFP_KERNEL);
1158 1159 1160 1161
		if (!cpd) {
			ret = ERR_PTR(-ENOMEM);
			goto free_pd_blkcg;
		}
1162 1163
		blkcg->cpd[i] = cpd;
		cpd->blkcg = blkcg;
1164
		cpd->plid = i;
1165 1166
		if (pol->cpd_init_fn)
			pol->cpd_init_fn(cpd);
1167
	}
1168 1169

	spin_lock_init(&blkcg->lock);
1170
	INIT_RADIX_TREE(&blkcg->blkg_tree, GFP_NOWAIT | __GFP_NOWARN);
1171
	INIT_HLIST_HEAD(&blkcg->blkg_list);
1172 1173
#ifdef CONFIG_CGROUP_WRITEBACK
	INIT_LIST_HEAD(&blkcg->cgwb_list);
1174
	refcount_set(&blkcg->cgwb_refcnt, 1);
1175
#endif
T
Tejun Heo 已提交
1176 1177 1178
	list_add_tail(&blkcg->all_blkcgs_node, &all_blkcgs);

	mutex_unlock(&blkcg_pol_mutex);
1179
	return &blkcg->css;
1180 1181 1182

free_pd_blkcg:
	for (i--; i >= 0; i--)
1183 1184
		if (blkcg->cpd[i])
			blkcg_policy[i]->cpd_free_fn(blkcg->cpd[i]);
1185 1186 1187 1188

	if (blkcg != &blkcg_root)
		kfree(blkcg);
unlock:
T
Tejun Heo 已提交
1189
	mutex_unlock(&blkcg_pol_mutex);
1190
	return ret;
1191 1192
}

1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
/**
 * blkcg_init_queue - initialize blkcg part of request queue
 * @q: request_queue to initialize
 *
 * Called from blk_alloc_queue_node(). Responsible for initializing blkcg
 * part of new request_queue @q.
 *
 * RETURNS:
 * 0 on success, -errno on failure.
 */
int blkcg_init_queue(struct request_queue *q)
{
1205 1206
	struct blkcg_gq *new_blkg, *blkg;
	bool preloaded;
1207 1208
	int ret;

1209 1210 1211 1212 1213 1214
	new_blkg = blkg_alloc(&blkcg_root, q, GFP_KERNEL);
	if (!new_blkg)
		return -ENOMEM;

	preloaded = !radix_tree_preload(GFP_KERNEL);

1215
	/* Make sure the root blkg exists. */
1216
	rcu_read_lock();
1217
	spin_lock_irq(&q->queue_lock);
1218
	blkg = blkg_create(&blkcg_root, q, new_blkg);
1219 1220 1221
	if (IS_ERR(blkg))
		goto err_unlock;
	q->root_blkg = blkg;
1222
	spin_unlock_irq(&q->queue_lock);
1223 1224
	rcu_read_unlock();

1225 1226 1227
	if (preloaded)
		radix_tree_preload_end();

1228
	ret = blk_iolatency_init(q);
1229 1230
	if (ret)
		goto err_destroy_all;
1231

1232
	ret = blk_throtl_init(q);
1233 1234 1235
	if (ret)
		goto err_destroy_all;
	return 0;
1236

1237 1238 1239
err_destroy_all:
	blkg_destroy_all(q);
	return ret;
1240
err_unlock:
1241
	spin_unlock_irq(&q->queue_lock);
1242 1243 1244 1245
	rcu_read_unlock();
	if (preloaded)
		radix_tree_preload_end();
	return PTR_ERR(blkg);
1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
}

/**
 * blkcg_drain_queue - drain blkcg part of request_queue
 * @q: request_queue to drain
 *
 * Called from blk_drain_queue().  Responsible for draining blkcg part.
 */
void blkcg_drain_queue(struct request_queue *q)
{
1256
	lockdep_assert_held(&q->queue_lock);
1257

1258 1259 1260 1261 1262 1263 1264
	/*
	 * @q could be exiting and already have destroyed all blkgs as
	 * indicated by NULL root_blkg.  If so, don't confuse policies.
	 */
	if (!q->root_blkg)
		return;

1265 1266 1267 1268 1269 1270 1271
	blk_throtl_drain(q);
}

/**
 * blkcg_exit_queue - exit and release blkcg part of request_queue
 * @q: request_queue being released
 *
1272
 * Called from blk_exit_queue().  Responsible for exiting blkcg part.
1273 1274 1275
 */
void blkcg_exit_queue(struct request_queue *q)
{
1276
	blkg_destroy_all(q);
1277 1278 1279
	blk_throtl_exit(q);
}

1280 1281 1282 1283 1284 1285
/*
 * We cannot support shared io contexts, as we have no mean to support
 * two tasks with the same ioc in two different groups without major rework
 * of the main cic data structures.  For now we allow a task to change
 * its cgroup only if it's the only owner of its ioc.
 */
1286
static int blkcg_can_attach(struct cgroup_taskset *tset)
1287
{
1288
	struct task_struct *task;
1289
	struct cgroup_subsys_state *dst_css;
1290 1291 1292 1293
	struct io_context *ioc;
	int ret = 0;

	/* task_lock() is needed to avoid races with exit_io_context() */
1294
	cgroup_taskset_for_each(task, dst_css, tset) {
1295 1296 1297 1298 1299 1300 1301 1302
		task_lock(task);
		ioc = task->io_context;
		if (ioc && atomic_read(&ioc->nr_tasks) > 1)
			ret = -EINVAL;
		task_unlock(task);
		if (ret)
			break;
	}
1303 1304 1305
	return ret;
}

1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
static void blkcg_bind(struct cgroup_subsys_state *root_css)
{
	int i;

	mutex_lock(&blkcg_pol_mutex);

	for (i = 0; i < BLKCG_MAX_POLS; i++) {
		struct blkcg_policy *pol = blkcg_policy[i];
		struct blkcg *blkcg;

		if (!pol || !pol->cpd_bind_fn)
			continue;

		list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node)
			if (blkcg->cpd[pol->plid])
				pol->cpd_bind_fn(blkcg->cpd[pol->plid]);
	}
	mutex_unlock(&blkcg_pol_mutex);
}

1326 1327 1328 1329 1330 1331 1332
static void blkcg_exit(struct task_struct *tsk)
{
	if (tsk->throttle_queue)
		blk_put_queue(tsk->throttle_queue);
	tsk->throttle_queue = NULL;
}

1333
struct cgroup_subsys io_cgrp_subsys = {
1334 1335 1336
	.css_alloc = blkcg_css_alloc,
	.css_offline = blkcg_css_offline,
	.css_free = blkcg_css_free,
T
Tejun Heo 已提交
1337
	.can_attach = blkcg_can_attach,
1338
	.bind = blkcg_bind,
1339
	.dfl_cftypes = blkcg_files,
1340
	.legacy_cftypes = blkcg_legacy_files,
1341
	.legacy_name = "blkio",
1342
	.exit = blkcg_exit,
1343 1344 1345 1346 1347 1348 1349 1350
#ifdef CONFIG_MEMCG
	/*
	 * This ensures that, if available, memcg is automatically enabled
	 * together on the default hierarchy so that the owner cgroup can
	 * be retrieved from writeback pages.
	 */
	.depends_on = 1 << memory_cgrp_id,
#endif
1351
};
1352
EXPORT_SYMBOL_GPL(io_cgrp_subsys);
1353

1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370
/**
 * blkcg_activate_policy - activate a blkcg policy on a request_queue
 * @q: request_queue of interest
 * @pol: blkcg policy to activate
 *
 * Activate @pol on @q.  Requires %GFP_KERNEL context.  @q goes through
 * bypass mode to populate its blkgs with policy_data for @pol.
 *
 * Activation happens with @q bypassed, so nobody would be accessing blkgs
 * from IO path.  Update of each blkg is protected by both queue and blkcg
 * locks so that holding either lock and testing blkcg_policy_enabled() is
 * always enough for dereferencing policy data.
 *
 * The caller is responsible for synchronizing [de]activations and policy
 * [un]registerations.  Returns 0 on success, -errno on failure.
 */
int blkcg_activate_policy(struct request_queue *q,
T
Tejun Heo 已提交
1371
			  const struct blkcg_policy *pol)
1372
{
1373
	struct blkg_policy_data *pd_prealloc = NULL;
1374
	struct blkcg_gq *blkg;
1375
	int ret;
1376 1377 1378 1379

	if (blkcg_policy_enabled(q, pol))
		return 0;

J
Jens Axboe 已提交
1380
	if (queue_is_mq(q))
1381
		blk_mq_freeze_queue(q);
1382 1383
pd_prealloc:
	if (!pd_prealloc) {
1384
		pd_prealloc = pol->pd_alloc_fn(GFP_KERNEL, q->node);
1385
		if (!pd_prealloc) {
1386
			ret = -ENOMEM;
1387
			goto out_bypass_end;
1388 1389 1390
		}
	}

1391
	spin_lock_irq(&q->queue_lock);
1392 1393

	list_for_each_entry(blkg, &q->blkg_list, q_node) {
1394 1395 1396 1397
		struct blkg_policy_data *pd;

		if (blkg->pd[pol->plid])
			continue;
1398

1399
		pd = pol->pd_alloc_fn(GFP_NOWAIT | __GFP_NOWARN, q->node);
1400 1401 1402
		if (!pd)
			swap(pd, pd_prealloc);
		if (!pd) {
1403
			spin_unlock_irq(&q->queue_lock);
1404 1405
			goto pd_prealloc;
		}
1406 1407 1408

		blkg->pd[pol->plid] = pd;
		pd->blkg = blkg;
T
Tejun Heo 已提交
1409
		pd->plid = pol->plid;
1410
		if (pol->pd_init_fn)
1411
			pol->pd_init_fn(pd);
1412 1413 1414 1415
	}

	__set_bit(pol->plid, q->blkcg_pols);
	ret = 0;
1416

1417
	spin_unlock_irq(&q->queue_lock);
1418
out_bypass_end:
J
Jens Axboe 已提交
1419
	if (queue_is_mq(q))
1420
		blk_mq_unfreeze_queue(q);
1421 1422
	if (pd_prealloc)
		pol->pd_free_fn(pd_prealloc);
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
	return ret;
}
EXPORT_SYMBOL_GPL(blkcg_activate_policy);

/**
 * blkcg_deactivate_policy - deactivate a blkcg policy on a request_queue
 * @q: request_queue of interest
 * @pol: blkcg policy to deactivate
 *
 * Deactivate @pol on @q.  Follows the same synchronization rules as
 * blkcg_activate_policy().
 */
void blkcg_deactivate_policy(struct request_queue *q,
T
Tejun Heo 已提交
1436
			     const struct blkcg_policy *pol)
1437
{
T
Tejun Heo 已提交
1438
	struct blkcg_gq *blkg;
1439 1440 1441 1442

	if (!blkcg_policy_enabled(q, pol))
		return;

J
Jens Axboe 已提交
1443
	if (queue_is_mq(q))
1444 1445
		blk_mq_freeze_queue(q);

1446
	spin_lock_irq(&q->queue_lock);
1447 1448 1449 1450

	__clear_bit(pol->plid, q->blkcg_pols);

	list_for_each_entry(blkg, &q->blkg_list, q_node) {
1451
		if (blkg->pd[pol->plid]) {
1452
			if (pol->pd_offline_fn)
1453
				pol->pd_offline_fn(blkg->pd[pol->plid]);
1454 1455 1456
			pol->pd_free_fn(blkg->pd[pol->plid]);
			blkg->pd[pol->plid] = NULL;
		}
1457 1458
	}

1459
	spin_unlock_irq(&q->queue_lock);
1460

J
Jens Axboe 已提交
1461
	if (queue_is_mq(q))
1462
		blk_mq_unfreeze_queue(q);
1463 1464 1465
}
EXPORT_SYMBOL_GPL(blkcg_deactivate_policy);

T
Tejun Heo 已提交
1466
/**
T
Tejun Heo 已提交
1467 1468
 * blkcg_policy_register - register a blkcg policy
 * @pol: blkcg policy to register
T
Tejun Heo 已提交
1469
 *
T
Tejun Heo 已提交
1470 1471
 * Register @pol with blkcg core.  Might sleep and @pol may be modified on
 * successful registration.  Returns 0 on success and -errno on failure.
T
Tejun Heo 已提交
1472
 */
1473
int blkcg_policy_register(struct blkcg_policy *pol)
1474
{
1475
	struct blkcg *blkcg;
T
Tejun Heo 已提交
1476
	int i, ret;
1477

1478
	mutex_lock(&blkcg_pol_register_mutex);
1479 1480
	mutex_lock(&blkcg_pol_mutex);

T
Tejun Heo 已提交
1481 1482 1483
	/* find an empty slot */
	ret = -ENOSPC;
	for (i = 0; i < BLKCG_MAX_POLS; i++)
T
Tejun Heo 已提交
1484
		if (!blkcg_policy[i])
T
Tejun Heo 已提交
1485
			break;
1486 1487
	if (i >= BLKCG_MAX_POLS) {
		pr_warn("blkcg_policy_register: BLKCG_MAX_POLS too small\n");
1488
		goto err_unlock;
1489
	}
1490

1491 1492 1493 1494 1495
	/* Make sure cpd/pd_alloc_fn and cpd/pd_free_fn in pairs */
	if ((!pol->cpd_alloc_fn ^ !pol->cpd_free_fn) ||
		(!pol->pd_alloc_fn ^ !pol->pd_free_fn))
		goto err_unlock;

1496
	/* register @pol */
T
Tejun Heo 已提交
1497
	pol->plid = i;
1498 1499 1500
	blkcg_policy[pol->plid] = pol;

	/* allocate and install cpd's */
1501
	if (pol->cpd_alloc_fn) {
1502 1503 1504
		list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
			struct blkcg_policy_data *cpd;

1505
			cpd = pol->cpd_alloc_fn(GFP_KERNEL);
1506
			if (!cpd)
1507 1508
				goto err_free_cpds;

1509 1510
			blkcg->cpd[pol->plid] = cpd;
			cpd->blkcg = blkcg;
1511
			cpd->plid = pol->plid;
1512
			pol->cpd_init_fn(cpd);
1513 1514 1515
		}
	}

1516
	mutex_unlock(&blkcg_pol_mutex);
T
Tejun Heo 已提交
1517 1518

	/* everything is in place, add intf files for the new policy */
1519 1520 1521
	if (pol->dfl_cftypes)
		WARN_ON(cgroup_add_dfl_cftypes(&io_cgrp_subsys,
					       pol->dfl_cftypes));
1522
	if (pol->legacy_cftypes)
1523
		WARN_ON(cgroup_add_legacy_cftypes(&io_cgrp_subsys,
1524
						  pol->legacy_cftypes));
1525 1526 1527
	mutex_unlock(&blkcg_pol_register_mutex);
	return 0;

1528
err_free_cpds:
1529
	if (pol->cpd_free_fn) {
1530
		list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1531 1532 1533 1534
			if (blkcg->cpd[pol->plid]) {
				pol->cpd_free_fn(blkcg->cpd[pol->plid]);
				blkcg->cpd[pol->plid] = NULL;
			}
1535 1536 1537
		}
	}
	blkcg_policy[pol->plid] = NULL;
1538
err_unlock:
1539
	mutex_unlock(&blkcg_pol_mutex);
1540
	mutex_unlock(&blkcg_pol_register_mutex);
T
Tejun Heo 已提交
1541
	return ret;
1542
}
T
Tejun Heo 已提交
1543
EXPORT_SYMBOL_GPL(blkcg_policy_register);
1544

T
Tejun Heo 已提交
1545
/**
T
Tejun Heo 已提交
1546 1547
 * blkcg_policy_unregister - unregister a blkcg policy
 * @pol: blkcg policy to unregister
T
Tejun Heo 已提交
1548
 *
T
Tejun Heo 已提交
1549
 * Undo blkcg_policy_register(@pol).  Might sleep.
T
Tejun Heo 已提交
1550
 */
T
Tejun Heo 已提交
1551
void blkcg_policy_unregister(struct blkcg_policy *pol)
1552
{
1553 1554
	struct blkcg *blkcg;

1555
	mutex_lock(&blkcg_pol_register_mutex);
1556

T
Tejun Heo 已提交
1557
	if (WARN_ON(blkcg_policy[pol->plid] != pol))
T
Tejun Heo 已提交
1558 1559 1560
		goto out_unlock;

	/* kill the intf files first */
1561 1562
	if (pol->dfl_cftypes)
		cgroup_rm_cftypes(pol->dfl_cftypes);
1563 1564
	if (pol->legacy_cftypes)
		cgroup_rm_cftypes(pol->legacy_cftypes);
1565

1566
	/* remove cpds and unregister */
1567
	mutex_lock(&blkcg_pol_mutex);
1568

1569
	if (pol->cpd_free_fn) {
1570
		list_for_each_entry(blkcg, &all_blkcgs, all_blkcgs_node) {
1571 1572 1573 1574
			if (blkcg->cpd[pol->plid]) {
				pol->cpd_free_fn(blkcg->cpd[pol->plid]);
				blkcg->cpd[pol->plid] = NULL;
			}
1575 1576
		}
	}
T
Tejun Heo 已提交
1577
	blkcg_policy[pol->plid] = NULL;
1578

1579
	mutex_unlock(&blkcg_pol_mutex);
1580 1581
out_unlock:
	mutex_unlock(&blkcg_pol_register_mutex);
1582
}
T
Tejun Heo 已提交
1583
EXPORT_SYMBOL_GPL(blkcg_policy_unregister);
1584

1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723
/*
 * Scale the accumulated delay based on how long it has been since we updated
 * the delay.  We only call this when we are adding delay, in case it's been a
 * while since we added delay, and when we are checking to see if we need to
 * delay a task, to account for any delays that may have occurred.
 */
static void blkcg_scale_delay(struct blkcg_gq *blkg, u64 now)
{
	u64 old = atomic64_read(&blkg->delay_start);

	/*
	 * We only want to scale down every second.  The idea here is that we
	 * want to delay people for min(delay_nsec, NSEC_PER_SEC) in a certain
	 * time window.  We only want to throttle tasks for recent delay that
	 * has occurred, in 1 second time windows since that's the maximum
	 * things can be throttled.  We save the current delay window in
	 * blkg->last_delay so we know what amount is still left to be charged
	 * to the blkg from this point onward.  blkg->last_use keeps track of
	 * the use_delay counter.  The idea is if we're unthrottling the blkg we
	 * are ok with whatever is happening now, and we can take away more of
	 * the accumulated delay as we've already throttled enough that
	 * everybody is happy with their IO latencies.
	 */
	if (time_before64(old + NSEC_PER_SEC, now) &&
	    atomic64_cmpxchg(&blkg->delay_start, old, now) == old) {
		u64 cur = atomic64_read(&blkg->delay_nsec);
		u64 sub = min_t(u64, blkg->last_delay, now - old);
		int cur_use = atomic_read(&blkg->use_delay);

		/*
		 * We've been unthrottled, subtract a larger chunk of our
		 * accumulated delay.
		 */
		if (cur_use < blkg->last_use)
			sub = max_t(u64, sub, blkg->last_delay >> 1);

		/*
		 * This shouldn't happen, but handle it anyway.  Our delay_nsec
		 * should only ever be growing except here where we subtract out
		 * min(last_delay, 1 second), but lord knows bugs happen and I'd
		 * rather not end up with negative numbers.
		 */
		if (unlikely(cur < sub)) {
			atomic64_set(&blkg->delay_nsec, 0);
			blkg->last_delay = 0;
		} else {
			atomic64_sub(sub, &blkg->delay_nsec);
			blkg->last_delay = cur - sub;
		}
		blkg->last_use = cur_use;
	}
}

/*
 * This is called when we want to actually walk up the hierarchy and check to
 * see if we need to throttle, and then actually throttle if there is some
 * accumulated delay.  This should only be called upon return to user space so
 * we're not holding some lock that would induce a priority inversion.
 */
static void blkcg_maybe_throttle_blkg(struct blkcg_gq *blkg, bool use_memdelay)
{
	u64 now = ktime_to_ns(ktime_get());
	u64 exp;
	u64 delay_nsec = 0;
	int tok;

	while (blkg->parent) {
		if (atomic_read(&blkg->use_delay)) {
			blkcg_scale_delay(blkg, now);
			delay_nsec = max_t(u64, delay_nsec,
					   atomic64_read(&blkg->delay_nsec));
		}
		blkg = blkg->parent;
	}

	if (!delay_nsec)
		return;

	/*
	 * Let's not sleep for all eternity if we've amassed a huge delay.
	 * Swapping or metadata IO can accumulate 10's of seconds worth of
	 * delay, and we want userspace to be able to do _something_ so cap the
	 * delays at 1 second.  If there's 10's of seconds worth of delay then
	 * the tasks will be delayed for 1 second for every syscall.
	 */
	delay_nsec = min_t(u64, delay_nsec, 250 * NSEC_PER_MSEC);

	/*
	 * TODO: the use_memdelay flag is going to be for the upcoming psi stuff
	 * that hasn't landed upstream yet.  Once that stuff is in place we need
	 * to do a psi_memstall_enter/leave if memdelay is set.
	 */

	exp = ktime_add_ns(now, delay_nsec);
	tok = io_schedule_prepare();
	do {
		__set_current_state(TASK_KILLABLE);
		if (!schedule_hrtimeout(&exp, HRTIMER_MODE_ABS))
			break;
	} while (!fatal_signal_pending(current));
	io_schedule_finish(tok);
}

/**
 * blkcg_maybe_throttle_current - throttle the current task if it has been marked
 *
 * This is only called if we've been marked with set_notify_resume().  Obviously
 * we can be set_notify_resume() for reasons other than blkcg throttling, so we
 * check to see if current->throttle_queue is set and if not this doesn't do
 * anything.  This should only ever be called by the resume code, it's not meant
 * to be called by people willy-nilly as it will actually do the work to
 * throttle the task if it is setup for throttling.
 */
void blkcg_maybe_throttle_current(void)
{
	struct request_queue *q = current->throttle_queue;
	struct cgroup_subsys_state *css;
	struct blkcg *blkcg;
	struct blkcg_gq *blkg;
	bool use_memdelay = current->use_memdelay;

	if (!q)
		return;

	current->throttle_queue = NULL;
	current->use_memdelay = false;

	rcu_read_lock();
	css = kthread_blkcg();
	if (css)
		blkcg = css_to_blkcg(css);
	else
		blkcg = css_to_blkcg(task_css(current, io_cgrp_id));

	if (!blkcg)
		goto out;
	blkg = blkg_lookup(blkcg, q);
	if (!blkg)
		goto out;
1724
	if (!blkg_tryget(blkg))
1725 1726 1727 1728 1729
		goto out;
	rcu_read_unlock();

	blkcg_maybe_throttle_blkg(blkg, use_memdelay);
	blkg_put(blkg);
1730
	blk_put_queue(q);
1731 1732 1733 1734 1735 1736 1737 1738
	return;
out:
	rcu_read_unlock();
	blk_put_queue(q);
}

/**
 * blkcg_schedule_throttle - this task needs to check for throttling
B
Bart Van Assche 已提交
1739 1740
 * @q: the request queue IO was submitted on
 * @use_memdelay: do we charge this to memory delay for PSI
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771
 *
 * This is called by the IO controller when we know there's delay accumulated
 * for the blkg for this task.  We do not pass the blkg because there are places
 * we call this that may not have that information, the swapping code for
 * instance will only have a request_queue at that point.  This set's the
 * notify_resume for the task to check and see if it requires throttling before
 * returning to user space.
 *
 * We will only schedule once per syscall.  You can call this over and over
 * again and it will only do the check once upon return to user space, and only
 * throttle once.  If the task needs to be throttled again it'll need to be
 * re-set at the next time we see the task.
 */
void blkcg_schedule_throttle(struct request_queue *q, bool use_memdelay)
{
	if (unlikely(current->flags & PF_KTHREAD))
		return;

	if (!blk_get_queue(q))
		return;

	if (current->throttle_queue)
		blk_put_queue(current->throttle_queue);
	current->throttle_queue = q;
	if (use_memdelay)
		current->use_memdelay = use_memdelay;
	set_notify_resume(current);
}

/**
 * blkcg_add_delay - add delay to this blkg
B
Bart Van Assche 已提交
1772 1773 1774
 * @blkg: blkg of interest
 * @now: the current time in nanoseconds
 * @delta: how many nanoseconds of delay to add
1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
 *
 * Charge @delta to the blkg's current delay accumulation.  This is used to
 * throttle tasks if an IO controller thinks we need more throttling.
 */
void blkcg_add_delay(struct blkcg_gq *blkg, u64 now, u64 delta)
{
	blkcg_scale_delay(blkg, now);
	atomic64_add(delta, &blkg->delay_nsec);
}

1785 1786
module_param(blkcg_debug_stats, bool, 0644);
MODULE_PARM_DESC(blkcg_debug_stats, "True if you want debug stats, false if not");