backing-dev.c 28.4 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-only
2 3

#include <linux/wait.h>
Tejun Heo's avatar
Tejun Heo committed
4
#include <linux/rbtree.h>
5
#include <linux/backing-dev.h>
6 7
#include <linux/kthread.h>
#include <linux/freezer.h>
8
#include <linux/fs.h>
9
#include <linux/pagemap.h>
10
#include <linux/mm.h>
11 12
#include <linux/sched.h>
#include <linux/module.h>
13 14
#include <linux/writeback.h>
#include <linux/device.h>
15
#include <trace/events/writeback.h>
16

17 18
struct backing_dev_info noop_backing_dev_info = {
	.name		= "noop",
19
	.capabilities	= BDI_CAP_NO_ACCT_AND_WRITEBACK,
20
};
21
EXPORT_SYMBOL_GPL(noop_backing_dev_info);
22

23
static struct class *bdi_class;
24 25

/*
Tejun Heo's avatar
Tejun Heo committed
26 27
 * bdi_lock protects bdi_tree and updates to bdi_list. bdi_list has RCU
 * reader side locking.
28
 */
29
DEFINE_SPINLOCK(bdi_lock);
Tejun Heo's avatar
Tejun Heo committed
30 31
static u64 bdi_id_cursor;
static struct rb_root bdi_tree = RB_ROOT;
32
LIST_HEAD(bdi_list);
33

34 35 36
/* bdi_wq serves all asynchronous writeback tasks */
struct workqueue_struct *bdi_wq;

37 38 39 40 41 42 43 44 45 46 47 48 49 50
#ifdef CONFIG_DEBUG_FS
#include <linux/debugfs.h>
#include <linux/seq_file.h>

static struct dentry *bdi_debug_root;

static void bdi_debug_init(void)
{
	bdi_debug_root = debugfs_create_dir("bdi", NULL);
}

static int bdi_debug_stats_show(struct seq_file *m, void *v)
{
	struct backing_dev_info *bdi = m->private;
51
	struct bdi_writeback *wb = &bdi->wb;
52 53
	unsigned long background_thresh;
	unsigned long dirty_thresh;
54
	unsigned long wb_thresh;
55
	unsigned long nr_dirty, nr_io, nr_more_io, nr_dirty_time;
56 57
	struct inode *inode;

58
	nr_dirty = nr_io = nr_more_io = nr_dirty_time = 0;
59
	spin_lock(&wb->list_lock);
60
	list_for_each_entry(inode, &wb->b_dirty, i_io_list)
61
		nr_dirty++;
62
	list_for_each_entry(inode, &wb->b_io, i_io_list)
63
		nr_io++;
64
	list_for_each_entry(inode, &wb->b_more_io, i_io_list)
65
		nr_more_io++;
66
	list_for_each_entry(inode, &wb->b_dirty_time, i_io_list)
67 68
		if (inode->i_state & I_DIRTY_TIME)
			nr_dirty_time++;
69
	spin_unlock(&wb->list_lock);
70

71
	global_dirty_limits(&background_thresh, &dirty_thresh);
72
	wb_thresh = wb_calc_thresh(wb, dirty_thresh);
73 74 75

#define K(x) ((x) << (PAGE_SHIFT - 10))
	seq_printf(m,
76 77 78 79 80
		   "BdiWriteback:       %10lu kB\n"
		   "BdiReclaimable:     %10lu kB\n"
		   "BdiDirtyThresh:     %10lu kB\n"
		   "DirtyThresh:        %10lu kB\n"
		   "BackgroundThresh:   %10lu kB\n"
81
		   "BdiDirtied:         %10lu kB\n"
82 83 84 85 86
		   "BdiWritten:         %10lu kB\n"
		   "BdiWriteBandwidth:  %10lu kBps\n"
		   "b_dirty:            %10lu\n"
		   "b_io:               %10lu\n"
		   "b_more_io:          %10lu\n"
87
		   "b_dirty_time:       %10lu\n"
88 89
		   "bdi_list:           %10u\n"
		   "state:              %10lx\n",
90 91
		   (unsigned long) K(wb_stat(wb, WB_WRITEBACK)),
		   (unsigned long) K(wb_stat(wb, WB_RECLAIMABLE)),
92
		   K(wb_thresh),
93 94
		   K(dirty_thresh),
		   K(background_thresh),
95 96
		   (unsigned long) K(wb_stat(wb, WB_DIRTIED)),
		   (unsigned long) K(wb_stat(wb, WB_WRITTEN)),
97
		   (unsigned long) K(wb->write_bandwidth),
98 99 100
		   nr_dirty,
		   nr_io,
		   nr_more_io,
101
		   nr_dirty_time,
102
		   !list_empty(&bdi->bdi_list), bdi->wb.state);
103 104 105 106
#undef K

	return 0;
}
107
DEFINE_SHOW_ATTRIBUTE(bdi_debug_stats);
108

109
static void bdi_debug_register(struct backing_dev_info *bdi, const char *name)
110 111
{
	bdi->debug_dir = debugfs_create_dir(name, bdi_debug_root);
112

113 114
	debugfs_create_file("stats", 0444, bdi->debug_dir, bdi,
			    &bdi_debug_stats_fops);
115 116 117 118
}

static void bdi_debug_unregister(struct backing_dev_info *bdi)
{
119
	debugfs_remove_recursive(bdi->debug_dir);
120 121 122 123 124
}
#else
static inline void bdi_debug_init(void)
{
}
125
static inline void bdi_debug_register(struct backing_dev_info *bdi,
126 127 128 129 130 131 132 133
				      const char *name)
{
}
static inline void bdi_debug_unregister(struct backing_dev_info *bdi)
{
}
#endif

134 135 136 137 138 139
static ssize_t read_ahead_kb_store(struct device *dev,
				  struct device_attribute *attr,
				  const char *buf, size_t count)
{
	struct backing_dev_info *bdi = dev_get_drvdata(dev);
	unsigned long read_ahead_kb;
140
	ssize_t ret;
141

142 143 144 145 146 147 148
	ret = kstrtoul(buf, 10, &read_ahead_kb);
	if (ret < 0)
		return ret;

	bdi->ra_pages = read_ahead_kb >> (PAGE_SHIFT - 10);

	return count;
149 150 151 152 153 154 155 156 157 158 159
}

#define K(pages) ((pages) << (PAGE_SHIFT - 10))

#define BDI_SHOW(name, expr)						\
static ssize_t name##_show(struct device *dev,				\
			   struct device_attribute *attr, char *page)	\
{									\
	struct backing_dev_info *bdi = dev_get_drvdata(dev);		\
									\
	return snprintf(page, PAGE_SIZE-1, "%lld\n", (long long)expr);	\
160 161
}									\
static DEVICE_ATTR_RW(name);
162 163 164

BDI_SHOW(read_ahead_kb, K(bdi->ra_pages))

165 166 167 168 169
static ssize_t min_ratio_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t count)
{
	struct backing_dev_info *bdi = dev_get_drvdata(dev);
	unsigned int ratio;
170 171 172 173 174 175 176 177 178
	ssize_t ret;

	ret = kstrtouint(buf, 10, &ratio);
	if (ret < 0)
		return ret;

	ret = bdi_set_min_ratio(bdi, ratio);
	if (!ret)
		ret = count;
179 180 181 182 183

	return ret;
}
BDI_SHOW(min_ratio, bdi->min_ratio)

184 185 186 187 188
static ssize_t max_ratio_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t count)
{
	struct backing_dev_info *bdi = dev_get_drvdata(dev);
	unsigned int ratio;
189 190 191 192 193 194 195 196 197
	ssize_t ret;

	ret = kstrtouint(buf, 10, &ratio);
	if (ret < 0)
		return ret;

	ret = bdi_set_max_ratio(bdi, ratio);
	if (!ret)
		ret = count;
198 199 200 201 202

	return ret;
}
BDI_SHOW(max_ratio, bdi->max_ratio)

203 204 205 206 207 208 209 210 211
static ssize_t stable_pages_required_show(struct device *dev,
					  struct device_attribute *attr,
					  char *page)
{
	struct backing_dev_info *bdi = dev_get_drvdata(dev);

	return snprintf(page, PAGE_SIZE-1, "%d\n",
			bdi_cap_stable_pages_required(bdi) ? 1 : 0);
}
212 213 214 215 216 217 218 219
static DEVICE_ATTR_RO(stable_pages_required);

static struct attribute *bdi_dev_attrs[] = {
	&dev_attr_read_ahead_kb.attr,
	&dev_attr_min_ratio.attr,
	&dev_attr_max_ratio.attr,
	&dev_attr_stable_pages_required.attr,
	NULL,
220
};
221
ATTRIBUTE_GROUPS(bdi_dev);
222 223 224 225

static __init int bdi_class_init(void)
{
	bdi_class = class_create(THIS_MODULE, "bdi");
226 227 228
	if (IS_ERR(bdi_class))
		return PTR_ERR(bdi_class);

229
	bdi_class->dev_groups = bdi_dev_groups;
230
	bdi_debug_init();
231

232 233
	return 0;
}
234
postcore_initcall(bdi_class_init);
235

Jan Kara's avatar
Jan Kara committed
236 237
static int bdi_init(struct backing_dev_info *bdi);

238 239 240 241
static int __init default_bdi_init(void)
{
	int err;

242 243
	bdi_wq = alloc_workqueue("writeback", WQ_MEM_RECLAIM | WQ_UNBOUND |
				 WQ_SYSFS, 0);
244 245 246
	if (!bdi_wq)
		return -ENOMEM;

247
	err = bdi_init(&noop_backing_dev_info);
248 249 250 251 252

	return err;
}
subsys_initcall(default_bdi_init);

253
/*
254
 * This function is used when the first inode for this wb is marked dirty. It
255 256 257 258 259 260 261 262
 * wakes-up the corresponding bdi thread which should then take care of the
 * periodic background write-out of dirty inodes. Since the write-out would
 * starts only 'dirty_writeback_interval' centisecs from now anyway, we just
 * set up a timer which wakes the bdi thread up later.
 *
 * Note, we wouldn't bother setting up the timer, but this function is on the
 * fast-path (used by '__mark_inode_dirty()'), so we save few context switches
 * by delaying the wake-up.
263 264 265
 *
 * We have to be careful not to postpone flush work if it is scheduled for
 * earlier. Thus we use queue_delayed_work().
266
 */
267
void wb_wakeup_delayed(struct bdi_writeback *wb)
268 269 270 271
{
	unsigned long timeout;

	timeout = msecs_to_jiffies(dirty_writeback_interval * 10);
272 273 274 275
	spin_lock_bh(&wb->work_lock);
	if (test_bit(WB_registered, &wb->state))
		queue_delayed_work(bdi_wq, &wb->dwork, timeout);
	spin_unlock_bh(&wb->work_lock);
276 277
}

278
/*
279
 * Initial write bandwidth: 100 MB/s
280
 */
281
#define INIT_BW		(100 << (20 - PAGE_SHIFT))
282

283
static int wb_init(struct bdi_writeback *wb, struct backing_dev_info *bdi,
284
		   int blkcg_id, gfp_t gfp)
285
{
286
	int i, err;
287

288
	memset(wb, 0, sizeof(*wb));
289

290 291
	if (wb != &bdi->wb)
		bdi_get(bdi);
292 293 294 295 296
	wb->bdi = bdi;
	wb->last_old_flush = jiffies;
	INIT_LIST_HEAD(&wb->b_dirty);
	INIT_LIST_HEAD(&wb->b_io);
	INIT_LIST_HEAD(&wb->b_more_io);
297
	INIT_LIST_HEAD(&wb->b_dirty_time);
298
	spin_lock_init(&wb->list_lock);
299

300 301 302 303 304
	wb->bw_time_stamp = jiffies;
	wb->balanced_dirty_ratelimit = INIT_BW;
	wb->dirty_ratelimit = INIT_BW;
	wb->write_bandwidth = INIT_BW;
	wb->avg_write_bandwidth = INIT_BW;
305

306 307 308
	spin_lock_init(&wb->work_lock);
	INIT_LIST_HEAD(&wb->work_list);
	INIT_DELAYED_WORK(&wb->dwork, wb_workfn);
309
	wb->dirty_sleep = jiffies;
310

311
	wb->congested = wb_congested_get_create(bdi, blkcg_id, gfp);
312 313 314 315
	if (!wb->congested) {
		err = -ENOMEM;
		goto out_put_bdi;
	}
316

317
	err = fprop_local_init_percpu(&wb->completions, gfp);
318
	if (err)
319
		goto out_put_cong;
320

321
	for (i = 0; i < NR_WB_STAT_ITEMS; i++) {
322
		err = percpu_counter_init(&wb->stat[i], 0, gfp);
323 324
		if (err)
			goto out_destroy_stat;
325
	}
326

327
	return 0;
328 329

out_destroy_stat:
330
	while (i--)
331 332 333 334
		percpu_counter_destroy(&wb->stat[i]);
	fprop_local_destroy_percpu(&wb->completions);
out_put_cong:
	wb_congested_put(wb->congested);
335 336 337
out_put_bdi:
	if (wb != &bdi->wb)
		bdi_put(bdi);
338
	return err;
339 340
}

341 342
static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb);

343 344 345
/*
 * Remove bdi from the global list and shutdown any threads we have running
 */
346
static void wb_shutdown(struct bdi_writeback *wb)
347
{
348
	/* Make sure nobody queues further work */
349 350 351
	spin_lock_bh(&wb->work_lock);
	if (!test_and_clear_bit(WB_registered, &wb->state)) {
		spin_unlock_bh(&wb->work_lock);
352
		return;
353
	}
354
	spin_unlock_bh(&wb->work_lock);
355

356
	cgwb_remove_from_bdi_list(wb);
357
	/*
358 359 360
	 * Drain work list and shutdown the delayed_work.  !WB_registered
	 * tells wb_workfn() that @wb is dying and its work_list needs to
	 * be drained no matter what.
361
	 */
362 363 364 365 366
	mod_delayed_work(bdi_wq, &wb->dwork, 0);
	flush_delayed_work(&wb->dwork);
	WARN_ON(!list_empty(&wb->work_list));
}

367
static void wb_exit(struct bdi_writeback *wb)
368 369 370 371 372 373 374
{
	int i;

	WARN_ON(delayed_work_pending(&wb->dwork));

	for (i = 0; i < NR_WB_STAT_ITEMS; i++)
		percpu_counter_destroy(&wb->stat[i]);
375

376
	fprop_local_destroy_percpu(&wb->completions);
377
	wb_congested_put(wb->congested);
378 379
	if (wb != &wb->bdi->wb)
		bdi_put(wb->bdi);
380
}
381

382 383 384 385 386 387 388
#ifdef CONFIG_CGROUP_WRITEBACK

#include <linux/memcontrol.h>

/*
 * cgwb_lock protects bdi->cgwb_tree, bdi->cgwb_congested_tree,
 * blkcg->cgwb_list, and memcg->cgwb_list.  bdi->cgwb_tree is also RCU
389
 * protected.
390 391
 */
static DEFINE_SPINLOCK(cgwb_lock);
392
static struct workqueue_struct *cgwb_release_wq;
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417

/**
 * wb_congested_get_create - get or create a wb_congested
 * @bdi: associated bdi
 * @blkcg_id: ID of the associated blkcg
 * @gfp: allocation mask
 *
 * Look up the wb_congested for @blkcg_id on @bdi.  If missing, create one.
 * The returned wb_congested has its reference count incremented.  Returns
 * NULL on failure.
 */
struct bdi_writeback_congested *
wb_congested_get_create(struct backing_dev_info *bdi, int blkcg_id, gfp_t gfp)
{
	struct bdi_writeback_congested *new_congested = NULL, *congested;
	struct rb_node **node, *parent;
	unsigned long flags;
retry:
	spin_lock_irqsave(&cgwb_lock, flags);

	node = &bdi->cgwb_congested_tree.rb_node;
	parent = NULL;

	while (*node != NULL) {
		parent = *node;
418 419
		congested = rb_entry(parent, struct bdi_writeback_congested,
				     rb_node);
420 421 422 423 424 425 426 427 428 429 430 431 432
		if (congested->blkcg_id < blkcg_id)
			node = &parent->rb_left;
		else if (congested->blkcg_id > blkcg_id)
			node = &parent->rb_right;
		else
			goto found;
	}

	if (new_congested) {
		/* !found and storage for new one already allocated, insert */
		congested = new_congested;
		rb_link_node(&congested->rb_node, parent, node);
		rb_insert_color(&congested->rb_node, &bdi->cgwb_congested_tree);
433 434
		spin_unlock_irqrestore(&cgwb_lock, flags);
		return congested;
435 436 437 438 439 440 441 442 443
	}

	spin_unlock_irqrestore(&cgwb_lock, flags);

	/* allocate storage for new one and retry */
	new_congested = kzalloc(sizeof(*new_congested), gfp);
	if (!new_congested)
		return NULL;

444
	refcount_set(&new_congested->refcnt, 1);
445
	new_congested->__bdi = bdi;
446 447 448 449
	new_congested->blkcg_id = blkcg_id;
	goto retry;

found:
450
	refcount_inc(&congested->refcnt);
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
	spin_unlock_irqrestore(&cgwb_lock, flags);
	kfree(new_congested);
	return congested;
}

/**
 * wb_congested_put - put a wb_congested
 * @congested: wb_congested to put
 *
 * Put @congested and destroy it if the refcnt reaches zero.
 */
void wb_congested_put(struct bdi_writeback_congested *congested)
{
	unsigned long flags;

466
	if (!refcount_dec_and_lock_irqsave(&congested->refcnt, &cgwb_lock, &flags))
467 468
		return;

469
	/* bdi might already have been destroyed leaving @congested unlinked */
470
	if (congested->__bdi) {
471
		rb_erase(&congested->rb_node,
472 473
			 &congested->__bdi->cgwb_congested_tree);
		congested->__bdi = NULL;
474 475
	}

476 477 478 479 480 481 482 483
	spin_unlock_irqrestore(&cgwb_lock, flags);
	kfree(congested);
}

static void cgwb_release_workfn(struct work_struct *work)
{
	struct bdi_writeback *wb = container_of(work, struct bdi_writeback,
						release_work);
484
	struct blkcg *blkcg = css_to_blkcg(wb->blkcg_css);
485

486
	mutex_lock(&wb->bdi->cgwb_release_mutex);
487 488 489 490
	wb_shutdown(wb);

	css_put(wb->memcg_css);
	css_put(wb->blkcg_css);
491
	mutex_unlock(&wb->bdi->cgwb_release_mutex);
492

493 494 495
	/* triggers blkg destruction if cgwb_refcnt becomes zero */
	blkcg_cgwb_put(blkcg);

496
	fprop_local_destroy_percpu(&wb->memcg_completions);
497 498 499 500 501 502 503 504 505
	percpu_ref_exit(&wb->refcnt);
	wb_exit(wb);
	kfree_rcu(wb, rcu);
}

static void cgwb_release(struct percpu_ref *refcnt)
{
	struct bdi_writeback *wb = container_of(refcnt, struct bdi_writeback,
						refcnt);
506
	queue_work(cgwb_release_wq, &wb->release_work);
507 508 509 510 511 512 513 514 515 516 517 518
}

static void cgwb_kill(struct bdi_writeback *wb)
{
	lockdep_assert_held(&cgwb_lock);

	WARN_ON(!radix_tree_delete(&wb->bdi->cgwb_tree, wb->memcg_css->id));
	list_del(&wb->memcg_node);
	list_del(&wb->blkcg_node);
	percpu_ref_kill(&wb->refcnt);
}

519 520 521 522 523 524 525
static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
{
	spin_lock_irq(&cgwb_lock);
	list_del_rcu(&wb->bdi_node);
	spin_unlock_irq(&cgwb_lock);
}

526 527 528 529 530 531 532 533 534 535 536 537
static int cgwb_create(struct backing_dev_info *bdi,
		       struct cgroup_subsys_state *memcg_css, gfp_t gfp)
{
	struct mem_cgroup *memcg;
	struct cgroup_subsys_state *blkcg_css;
	struct blkcg *blkcg;
	struct list_head *memcg_cgwb_list, *blkcg_cgwb_list;
	struct bdi_writeback *wb;
	unsigned long flags;
	int ret = 0;

	memcg = mem_cgroup_from_css(memcg_css);
538
	blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
539
	blkcg = css_to_blkcg(blkcg_css);
540
	memcg_cgwb_list = &memcg->cgwb_list;
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
	blkcg_cgwb_list = &blkcg->cgwb_list;

	/* look up again under lock and discard on blkcg mismatch */
	spin_lock_irqsave(&cgwb_lock, flags);
	wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
	if (wb && wb->blkcg_css != blkcg_css) {
		cgwb_kill(wb);
		wb = NULL;
	}
	spin_unlock_irqrestore(&cgwb_lock, flags);
	if (wb)
		goto out_put;

	/* need to create a new one */
	wb = kmalloc(sizeof(*wb), gfp);
556 557 558 559
	if (!wb) {
		ret = -ENOMEM;
		goto out_put;
	}
560

561
	ret = wb_init(wb, bdi, blkcg_css->id, gfp);
562 563 564 565 566 567 568
	if (ret)
		goto err_free;

	ret = percpu_ref_init(&wb->refcnt, cgwb_release, 0, gfp);
	if (ret)
		goto err_wb_exit;

569 570 571 572
	ret = fprop_local_init_percpu(&wb->memcg_completions, gfp);
	if (ret)
		goto err_ref_exit;

573 574 575 576
	wb->memcg_css = memcg_css;
	wb->blkcg_css = blkcg_css;
	INIT_WORK(&wb->release_work, cgwb_release_workfn);
	set_bit(WB_registered, &wb->state);
577 578

	/*
579 580 581 582
	 * The root wb determines the registered state of the whole bdi and
	 * memcg_cgwb_list and blkcg_cgwb_list's next pointers indicate
	 * whether they're still online.  Don't link @wb if any is dead.
	 * See wb_memcg_offline() and wb_blkcg_offline().
583
	 */
584 585 586 587 588 589 590
	ret = -ENODEV;
	spin_lock_irqsave(&cgwb_lock, flags);
	if (test_bit(WB_registered, &bdi->wb.state) &&
	    blkcg_cgwb_list->next && memcg_cgwb_list->next) {
		/* we might have raced another instance of this function */
		ret = radix_tree_insert(&bdi->cgwb_tree, memcg_css->id, wb);
		if (!ret) {
591
			list_add_tail_rcu(&wb->bdi_node, &bdi->wb_list);
592 593
			list_add(&wb->memcg_node, memcg_cgwb_list);
			list_add(&wb->blkcg_node, blkcg_cgwb_list);
594
			blkcg_cgwb_get(blkcg);
595 596 597 598 599 600 601 602
			css_get(memcg_css);
			css_get(blkcg_css);
		}
	}
	spin_unlock_irqrestore(&cgwb_lock, flags);
	if (ret) {
		if (ret == -EEXIST)
			ret = 0;
603
		goto err_fprop_exit;
604 605 606
	}
	goto out_put;

607 608
err_fprop_exit:
	fprop_local_destroy_percpu(&wb->memcg_completions);
609 610 611 612 613 614 615 616 617
err_ref_exit:
	percpu_ref_exit(&wb->refcnt);
err_wb_exit:
	wb_exit(wb);
err_free:
	kfree(wb);
out_put:
	css_put(blkcg_css);
	return ret;
618 619
}

620
/**
621
 * wb_get_lookup - get wb for a given memcg
622 623 624
 * @bdi: target bdi
 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
 *
625 626
 * Try to get the wb for @memcg_css on @bdi.  The returned wb has its
 * refcount incremented.
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
 *
 * This function uses css_get() on @memcg_css and thus expects its refcnt
 * to be positive on invocation.  IOW, rcu_read_lock() protection on
 * @memcg_css isn't enough.  try_get it before calling this function.
 *
 * A wb is keyed by its associated memcg.  As blkcg implicitly enables
 * memcg on the default hierarchy, memcg association is guaranteed to be
 * more specific (equal or descendant to the associated blkcg) and thus can
 * identify both the memcg and blkcg associations.
 *
 * Because the blkcg associated with a memcg may change as blkcg is enabled
 * and disabled closer to root in the hierarchy, each wb keeps track of
 * both the memcg and blkcg associated with it and verifies the blkcg on
 * each lookup.  On mismatch, the existing wb is discarded and a new one is
 * created.
 */
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
struct bdi_writeback *wb_get_lookup(struct backing_dev_info *bdi,
				    struct cgroup_subsys_state *memcg_css)
{
	struct bdi_writeback *wb;

	if (!memcg_css->parent)
		return &bdi->wb;

	rcu_read_lock();
	wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
	if (wb) {
		struct cgroup_subsys_state *blkcg_css;

		/* see whether the blkcg association has changed */
		blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
		if (unlikely(wb->blkcg_css != blkcg_css || !wb_tryget(wb)))
			wb = NULL;
		css_put(blkcg_css);
	}
	rcu_read_unlock();

	return wb;
}

/**
 * wb_get_create - get wb for a given memcg, create if necessary
 * @bdi: target bdi
 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
 * @gfp: allocation mask to use
 *
 * Try to get the wb for @memcg_css on @bdi.  If it doesn't exist, try to
 * create one.  See wb_get_lookup() for more details.
 */
676 677 678
struct bdi_writeback *wb_get_create(struct backing_dev_info *bdi,
				    struct cgroup_subsys_state *memcg_css,
				    gfp_t gfp)
679
{
680 681
	struct bdi_writeback *wb;

682
	might_sleep_if(gfpflags_allow_blocking(gfp));
683 684 685 686 687

	if (!memcg_css->parent)
		return &bdi->wb;

	do {
688
		wb = wb_get_lookup(bdi, memcg_css);
689 690 691 692
	} while (!wb && !cgwb_create(bdi, memcg_css, gfp));

	return wb;
}
693

694
static int cgwb_bdi_init(struct backing_dev_info *bdi)
695
{
696 697
	int ret;

698 699
	INIT_RADIX_TREE(&bdi->cgwb_tree, GFP_ATOMIC);
	bdi->cgwb_congested_tree = RB_ROOT;
700
	mutex_init(&bdi->cgwb_release_mutex);
701
	init_rwsem(&bdi->wb_switch_rwsem);
702 703 704

	ret = wb_init(&bdi->wb, bdi, 1, GFP_KERNEL);
	if (!ret) {
705
		bdi->wb.memcg_css = &root_mem_cgroup->css;
706 707 708
		bdi->wb.blkcg_css = blkcg_root_css;
	}
	return ret;
709 710
}

711
static void cgwb_bdi_unregister(struct backing_dev_info *bdi)
712 713 714
{
	struct radix_tree_iter iter;
	void **slot;
715
	struct bdi_writeback *wb;
716 717 718 719 720 721

	WARN_ON(test_bit(WB_registered, &bdi->wb.state));

	spin_lock_irq(&cgwb_lock);
	radix_tree_for_each_slot(slot, &bdi->cgwb_tree, &iter, 0)
		cgwb_kill(*slot);
722
	spin_unlock_irq(&cgwb_lock);
723

724 725
	mutex_lock(&bdi->cgwb_release_mutex);
	spin_lock_irq(&cgwb_lock);
726 727 728 729 730 731 732
	while (!list_empty(&bdi->wb_list)) {
		wb = list_first_entry(&bdi->wb_list, struct bdi_writeback,
				      bdi_node);
		spin_unlock_irq(&cgwb_lock);
		wb_shutdown(wb);
		spin_lock_irq(&cgwb_lock);
	}
733
	spin_unlock_irq(&cgwb_lock);
734
	mutex_unlock(&bdi->cgwb_release_mutex);
735 736 737 738 739 740 741
}

/**
 * wb_memcg_offline - kill all wb's associated with a memcg being offlined
 * @memcg: memcg being offlined
 *
 * Also prevents creation of any new wb's associated with @memcg.
742
 */
743 744
void wb_memcg_offline(struct mem_cgroup *memcg)
{
745
	struct list_head *memcg_cgwb_list = &memcg->cgwb_list;
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
	struct bdi_writeback *wb, *next;

	spin_lock_irq(&cgwb_lock);
	list_for_each_entry_safe(wb, next, memcg_cgwb_list, memcg_node)
		cgwb_kill(wb);
	memcg_cgwb_list->next = NULL;	/* prevent new wb's */
	spin_unlock_irq(&cgwb_lock);
}

/**
 * wb_blkcg_offline - kill all wb's associated with a blkcg being offlined
 * @blkcg: blkcg being offlined
 *
 * Also prevents creation of any new wb's associated with @blkcg.
 */
void wb_blkcg_offline(struct blkcg *blkcg)
{
	struct bdi_writeback *wb, *next;

	spin_lock_irq(&cgwb_lock);
	list_for_each_entry_safe(wb, next, &blkcg->cgwb_list, blkcg_node)
		cgwb_kill(wb);
	blkcg->cgwb_list.next = NULL;	/* prevent new wb's */
	spin_unlock_irq(&cgwb_lock);
}

772 773 774 775 776 777 778 779 780 781
static void cgwb_bdi_exit(struct backing_dev_info *bdi)
{
	struct rb_node *rbn;

	spin_lock_irq(&cgwb_lock);
	while ((rbn = rb_first(&bdi->cgwb_congested_tree))) {
		struct bdi_writeback_congested *congested =
			rb_entry(rbn, struct bdi_writeback_congested, rb_node);

		rb_erase(rbn, &bdi->cgwb_congested_tree);
782
		congested->__bdi = NULL;	/* mark @congested unlinked */
783 784 785 786
	}
	spin_unlock_irq(&cgwb_lock);
}

787 788 789 790 791 792 793
static void cgwb_bdi_register(struct backing_dev_info *bdi)
{
	spin_lock_irq(&cgwb_lock);
	list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
	spin_unlock_irq(&cgwb_lock);
}

794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
static int __init cgwb_init(void)
{
	/*
	 * There can be many concurrent release work items overwhelming
	 * system_wq.  Put them in a separate wq and limit concurrency.
	 * There's no point in executing many of these in parallel.
	 */
	cgwb_release_wq = alloc_workqueue("cgwb_release", 0, 1);
	if (!cgwb_release_wq)
		return -ENOMEM;

	return 0;
}
subsys_initcall(cgwb_init);

809 810
#else	/* CONFIG_CGROUP_WRITEBACK */

811 812 813 814 815 816 817 818
static int cgwb_bdi_init(struct backing_dev_info *bdi)
{
	int err;

	bdi->wb_congested = kzalloc(sizeof(*bdi->wb_congested), GFP_KERNEL);
	if (!bdi->wb_congested)
		return -ENOMEM;

819
	refcount_set(&bdi->wb_congested->refcnt, 1);
820

821 822
	err = wb_init(&bdi->wb, bdi, 1, GFP_KERNEL);
	if (err) {
823
		wb_congested_put(bdi->wb_congested);
824 825 826 827 828
		return err;
	}
	return 0;
}

829
static void cgwb_bdi_unregister(struct backing_dev_info *bdi) { }
830 831

static void cgwb_bdi_exit(struct backing_dev_info *bdi)
832 833 834
{
	wb_congested_put(bdi->wb_congested);
}
835

836 837 838 839 840 841 842 843 844 845
static void cgwb_bdi_register(struct backing_dev_info *bdi)
{
	list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
}

static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
{
	list_del_rcu(&wb->bdi_node);
}

846
#endif	/* CONFIG_CGROUP_WRITEBACK */
847

Jan Kara's avatar
Jan Kara committed
848
static int bdi_init(struct backing_dev_info *bdi)
849
{
850 851
	int ret;

852 853
	bdi->dev = NULL;

854
	kref_init(&bdi->refcnt);
855
	bdi->min_ratio = 0;
856
	bdi->max_ratio = 100;
857
	bdi->max_prop_frac = FPROP_FRAC_BASE;
858
	INIT_LIST_HEAD(&bdi->bdi_list);
859
	INIT_LIST_HEAD(&bdi->wb_list);
860
	init_waitqueue_head(&bdi->wb_waitq);
861

862 863 864
	ret = cgwb_bdi_init(bdi);

	return ret;
865
}
866

867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
struct backing_dev_info *bdi_alloc_node(gfp_t gfp_mask, int node_id)
{
	struct backing_dev_info *bdi;

	bdi = kmalloc_node(sizeof(struct backing_dev_info),
			   gfp_mask | __GFP_ZERO, node_id);
	if (!bdi)
		return NULL;

	if (bdi_init(bdi)) {
		kfree(bdi);
		return NULL;
	}
	return bdi;
}
882
EXPORT_SYMBOL(bdi_alloc_node);
883

Tejun Heo's avatar
Tejun Heo committed
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
static struct rb_node **bdi_lookup_rb_node(u64 id, struct rb_node **parentp)
{
	struct rb_node **p = &bdi_tree.rb_node;
	struct rb_node *parent = NULL;
	struct backing_dev_info *bdi;

	lockdep_assert_held(&bdi_lock);

	while (*p) {
		parent = *p;
		bdi = rb_entry(parent, struct backing_dev_info, rb_node);

		if (bdi->id > id)
			p = &(*p)->rb_left;
		else if (bdi->id < id)
			p = &(*p)->rb_right;
		else
			break;
	}

	if (parentp)
		*parentp = parent;
	return p;
}

/**
 * bdi_get_by_id - lookup and get bdi from its id
 * @id: bdi id to lookup
 *
 * Find bdi matching @id and get it.  Returns NULL if the matching bdi
 * doesn't exist or is already unregistered.
 */
struct backing_dev_info *bdi_get_by_id(u64 id)
{
	struct backing_dev_info *bdi = NULL;
	struct rb_node **p;

	spin_lock_bh(&bdi_lock);
	p = bdi_lookup_rb_node(id, NULL);
	if (*p) {
		bdi = rb_entry(*p, struct backing_dev_info, rb_node);
		bdi_get(bdi);
	}
	spin_unlock_bh(&bdi_lock);

	return bdi;
}

932
int bdi_register_va(struct backing_dev_info *bdi, const char *fmt, va_list args)
933 934
{
	struct device *dev;
Tejun Heo's avatar
Tejun Heo committed
935
	struct rb_node *parent, **p;
936

937 938
	if (bdi->dev)	/* The driver needs to use separate queues per device */
		return 0;
939

940
	dev = device_create_vargs(bdi_class, NULL, MKDEV(0, 0), bdi, fmt, args);
941 942
	if (IS_ERR(dev))
		return PTR_ERR(dev);
943

944
	cgwb_bdi_register(bdi);
945
	bdi->dev = dev;
946

947
	bdi_debug_register(bdi, dev_name(dev));
948 949 950
	set_bit(WB_registered, &bdi->wb.state);

	spin_lock_bh(&bdi_lock);
Tejun Heo's avatar
Tejun Heo committed
951 952 953 954 955 956 957

	bdi->id = ++bdi_id_cursor;

	p = bdi_lookup_rb_node(bdi->id, &parent);
	rb_link_node(&bdi->rb_node, parent, p);
	rb_insert_color(&bdi->rb_node, &bdi_tree);

958
	list_add_tail_rcu(&bdi->bdi_list, &bdi_list);
Tejun Heo's avatar
Tejun Heo committed
959

960 961 962 963
	spin_unlock_bh(&bdi_lock);

	trace_writeback_bdi_register(bdi);
	return 0;
964
}
965 966
EXPORT_SYMBOL(bdi_register_va);

967
int bdi_register(struct backing_dev_info *bdi, const char *fmt, ...)
968 969 970 971 972
{
	va_list args;
	int ret;

	va_start(args, fmt);
973
	ret = bdi_register_va(bdi, fmt, args);
974 975 976
	va_end(args);
	return ret;
}
977
EXPORT_SYMBOL(bdi_register);
978

979 980 981 982
int bdi_register_owner(struct backing_dev_info *bdi, struct device *owner)
{
	int rc;

983
	rc = bdi_register(bdi, "%u:%u", MAJOR(owner->devt), MINOR(owner->devt));
984 985
	if (rc)
		return rc;
986 987
	/* Leaking owner reference... */
	WARN_ON(bdi->owner);
988 989 990 991 992 993
	bdi->owner = owner;
	get_device(owner);
	return 0;
}
EXPORT_SYMBOL(bdi_register_owner);

994 995 996 997 998 999
/*
 * Remove bdi from bdi_list, and ensure that it is no longer visible
 */
static void bdi_remove_from_list(struct backing_dev_info *bdi)
{
	spin_lock_bh(&bdi_lock);
Tejun Heo's avatar
Tejun Heo committed
1000
	rb_erase(&bdi->rb_node, &bdi_tree);
1001 1002
	list_del_rcu(&bdi->bdi_list);
	spin_unlock_bh(&bdi_lock);
1003

1004 1005
	synchronize_rcu_expedited();
}
1006

1007
void bdi_unregister(struct backing_dev_info *bdi)
1008
{
1009 1010 1011
	/* make sure nobody finds us on the bdi_list anymore */
	bdi_remove_from_list(bdi);
	wb_shutdown(&bdi->wb);
1012
	cgwb_bdi_unregister(bdi);
1013

1014 1015 1016 1017 1018
	if (bdi->dev) {
		bdi_debug_unregister(bdi);
		device_unregister(bdi->dev);
		bdi->dev = NULL;
	}
1019 1020 1021 1022 1023

	if (bdi->owner) {
		put_device(bdi->owner);
		bdi->owner = NULL;
	}
1024
}
1025

1026 1027 1028 1029 1030
static void release_bdi(struct kref *ref)
{
	struct backing_dev_info *bdi =
			container_of(ref, struct backing_dev_info, refcnt);

1031 1032
	if (test_bit(WB_registered, &bdi->wb.state))
		bdi_unregister(bdi);
Jan Kara's avatar
Jan Kara committed
1033 1034 1035
	WARN_ON_ONCE(bdi->dev);
	wb_exit(&bdi->wb);
	cgwb_bdi_exit(bdi);
1036 1037 1038 1039 1040 1041 1042
	kfree(bdi);
}

void bdi_put(struct backing_dev_info *bdi)
{
	kref_put(&bdi->refcnt, release_bdi);
}
1043
EXPORT_SYMBOL(bdi_put);
1044

1045 1046 1047 1048
static wait_queue_head_t congestion_wqh[2] = {
		__WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[0]),
		__WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[1])
	};
1049
static atomic_t nr_wb_congested[2];
1050

1051
void clear_wb_congested(struct bdi_writeback_congested *congested, int sync)
1052
{
1053
	wait_queue_head_t *wqh = &congestion_wqh[sync];
1054
	enum wb_congested_state bit;
1055

1056
	bit = sync ? WB_sync_congested : WB_async_congested;
1057 1058
	if (test_and_clear_bit(bit, &congested->state))
		atomic_dec(&nr_wb_congested[sync]);
1059
	smp_mb__after_atomic();
1060 1061 1062
	if (waitqueue_active(wqh))
		wake_up(wqh);
}
1063
EXPORT_SYMBOL(clear_wb_congested);
1064

1065
void set_wb_congested(struct bdi_writeback_congested *congested, int sync)
1066
{
1067
	enum wb_congested_state bit;
1068

1069
	bit = sync ? WB_sync_congested : WB_async_congested;
1070 1071
	if (!test_and_set_bit(bit, &congested->state))
		atomic_inc(&nr_wb_congested[sync]);
1072
}
1073
EXPORT_SYMBOL(set_wb_congested);
1074 1075 1076

/**
 * congestion_wait - wait for a backing_dev to become uncongested
1077
 * @sync: SYNC or ASYNC IO
1078 1079 1080 1081 1082 1083
 * @timeout: timeout in jiffies
 *
 * Waits for up to @timeout jiffies for a backing_dev (any backing_dev) to exit
 * write congestion.  If no backing_devs are congested then just wait for the
 * next write to be completed.
 */
1084
long congestion_wait(int sync, long timeout)
1085 1086
{
	long ret;
1087
	unsigned long start = jiffies;
1088
	DEFINE_WAIT(wait);
1089
	wait_queue_head_t *wqh = &congestion_wqh[sync];
1090 1091 1092 1093

	prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
	ret = io_schedule_timeout(timeout);
	finish_wait(wqh, &wait);
1094 1095 1096 1097

	trace_writeback_congestion_wait(jiffies_to_usecs(timeout),
					jiffies_to_usecs(jiffies - start));

1098 1099 1100
	return ret;
}
EXPORT_SYMBOL(congestion_wait);
1101

1102
/**
1103
 * wait_iff_congested - Conditionally wait for a backing_dev to become uncongested or a pgdat to complete writes
1104 1105 1106
 * @sync: SYNC or ASYNC IO
 * @timeout: timeout in jiffies
 *
1107 1108 1109
 * In the event of a congested backing_dev (any backing_dev) this waits
 * for up to @timeout jiffies for either a BDI to exit congestion of the
 * given @sync queue or a write to complete.
1110 1111 1112 1113 1114
 *
 * The return value is 0 if the sleep is for the full timeout. Otherwise,
 * it is the number of jiffies that were still remaining when the function
 * returned. return_value == timeout implies the function did not sleep.
 */
1115
long wait_iff_congested(int sync, long timeout)
1116 1117 1118 1119 1120 1121 1122
{
	long ret;
	unsigned long start = jiffies;
	DEFINE_WAIT(wait);
	wait_queue_head_t *wqh = &congestion_wqh[sync];

	/*
1123
	 * If there is no congestion, yield if necessary instead
1124 1125
	 * of sleeping on the congestion queue
	 */
1126
	if (atomic_read(&nr_wb_congested[sync]) == 0) {
1127
		cond_resched();
1128

1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
		/* In case we scheduled, work out time remaining */
		ret = timeout - (jiffies - start);
		if (ret < 0)
			ret = 0;

		goto out;
	}

	/* Sleep until uncongested or a write happens */
	prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
	ret = io_schedule_timeout(timeout);
	finish_wait(wqh, &wait);

out:
	trace_writeback_wait_iff_congested(jiffies_to_usecs(timeout),
					jiffies_to_usecs(jiffies - start));

	return ret;
}
EXPORT_SYMBOL(wait_iff_congested);