xref: /linux-6.15/mm/backing-dev.c (revision bca52dcb)
1 // SPDX-License-Identifier: GPL-2.0-only
2 
3 #include <linux/blkdev.h>
4 #include <linux/wait.h>
5 #include <linux/rbtree.h>
6 #include <linux/kthread.h>
7 #include <linux/backing-dev.h>
8 #include <linux/blk-cgroup.h>
9 #include <linux/freezer.h>
10 #include <linux/fs.h>
11 #include <linux/pagemap.h>
12 #include <linux/mm.h>
13 #include <linux/sched/mm.h>
14 #include <linux/sched.h>
15 #include <linux/module.h>
16 #include <linux/writeback.h>
17 #include <linux/device.h>
18 #include <trace/events/writeback.h>
19 
20 struct backing_dev_info noop_backing_dev_info;
21 EXPORT_SYMBOL_GPL(noop_backing_dev_info);
22 
23 static struct class *bdi_class;
24 static const char *bdi_unknown_name = "(unknown)";
25 
26 /*
27  * bdi_lock protects bdi_tree and updates to bdi_list. bdi_list has RCU
28  * reader side locking.
29  */
30 DEFINE_SPINLOCK(bdi_lock);
31 static u64 bdi_id_cursor;
32 static struct rb_root bdi_tree = RB_ROOT;
33 LIST_HEAD(bdi_list);
34 
35 /* bdi_wq serves all asynchronous writeback tasks */
36 struct workqueue_struct *bdi_wq;
37 
38 #define K(x) ((x) << (PAGE_SHIFT - 10))
39 
40 #ifdef CONFIG_DEBUG_FS
41 #include <linux/debugfs.h>
42 #include <linux/seq_file.h>
43 
44 static struct dentry *bdi_debug_root;
45 
46 static void bdi_debug_init(void)
47 {
48 	bdi_debug_root = debugfs_create_dir("bdi", NULL);
49 }
50 
51 static int bdi_debug_stats_show(struct seq_file *m, void *v)
52 {
53 	struct backing_dev_info *bdi = m->private;
54 	struct bdi_writeback *wb = &bdi->wb;
55 	unsigned long background_thresh;
56 	unsigned long dirty_thresh;
57 	unsigned long wb_thresh;
58 	unsigned long nr_dirty, nr_io, nr_more_io, nr_dirty_time;
59 	struct inode *inode;
60 
61 	nr_dirty = nr_io = nr_more_io = nr_dirty_time = 0;
62 	spin_lock(&wb->list_lock);
63 	list_for_each_entry(inode, &wb->b_dirty, i_io_list)
64 		nr_dirty++;
65 	list_for_each_entry(inode, &wb->b_io, i_io_list)
66 		nr_io++;
67 	list_for_each_entry(inode, &wb->b_more_io, i_io_list)
68 		nr_more_io++;
69 	list_for_each_entry(inode, &wb->b_dirty_time, i_io_list)
70 		if (inode->i_state & I_DIRTY_TIME)
71 			nr_dirty_time++;
72 	spin_unlock(&wb->list_lock);
73 
74 	global_dirty_limits(&background_thresh, &dirty_thresh);
75 	wb_thresh = wb_calc_thresh(wb, dirty_thresh);
76 
77 	seq_printf(m,
78 		   "BdiWriteback:       %10lu kB\n"
79 		   "BdiReclaimable:     %10lu kB\n"
80 		   "BdiDirtyThresh:     %10lu kB\n"
81 		   "DirtyThresh:        %10lu kB\n"
82 		   "BackgroundThresh:   %10lu kB\n"
83 		   "BdiDirtied:         %10lu kB\n"
84 		   "BdiWritten:         %10lu kB\n"
85 		   "BdiWriteBandwidth:  %10lu kBps\n"
86 		   "b_dirty:            %10lu\n"
87 		   "b_io:               %10lu\n"
88 		   "b_more_io:          %10lu\n"
89 		   "b_dirty_time:       %10lu\n"
90 		   "bdi_list:           %10u\n"
91 		   "state:              %10lx\n",
92 		   (unsigned long) K(wb_stat(wb, WB_WRITEBACK)),
93 		   (unsigned long) K(wb_stat(wb, WB_RECLAIMABLE)),
94 		   K(wb_thresh),
95 		   K(dirty_thresh),
96 		   K(background_thresh),
97 		   (unsigned long) K(wb_stat(wb, WB_DIRTIED)),
98 		   (unsigned long) K(wb_stat(wb, WB_WRITTEN)),
99 		   (unsigned long) K(wb->write_bandwidth),
100 		   nr_dirty,
101 		   nr_io,
102 		   nr_more_io,
103 		   nr_dirty_time,
104 		   !list_empty(&bdi->bdi_list), bdi->wb.state);
105 
106 	return 0;
107 }
108 DEFINE_SHOW_ATTRIBUTE(bdi_debug_stats);
109 
110 static void bdi_debug_register(struct backing_dev_info *bdi, const char *name)
111 {
112 	bdi->debug_dir = debugfs_create_dir(name, bdi_debug_root);
113 
114 	debugfs_create_file("stats", 0444, bdi->debug_dir, bdi,
115 			    &bdi_debug_stats_fops);
116 }
117 
118 static void bdi_debug_unregister(struct backing_dev_info *bdi)
119 {
120 	debugfs_remove_recursive(bdi->debug_dir);
121 }
122 #else
123 static inline void bdi_debug_init(void)
124 {
125 }
126 static inline void bdi_debug_register(struct backing_dev_info *bdi,
127 				      const char *name)
128 {
129 }
130 static inline void bdi_debug_unregister(struct backing_dev_info *bdi)
131 {
132 }
133 #endif
134 
135 static ssize_t read_ahead_kb_store(struct device *dev,
136 				  struct device_attribute *attr,
137 				  const char *buf, size_t count)
138 {
139 	struct backing_dev_info *bdi = dev_get_drvdata(dev);
140 	unsigned long read_ahead_kb;
141 	ssize_t ret;
142 
143 	ret = kstrtoul(buf, 10, &read_ahead_kb);
144 	if (ret < 0)
145 		return ret;
146 
147 	bdi->ra_pages = read_ahead_kb >> (PAGE_SHIFT - 10);
148 
149 	return count;
150 }
151 
152 #define BDI_SHOW(name, expr)						\
153 static ssize_t name##_show(struct device *dev,				\
154 			   struct device_attribute *attr, char *buf)	\
155 {									\
156 	struct backing_dev_info *bdi = dev_get_drvdata(dev);		\
157 									\
158 	return sysfs_emit(buf, "%lld\n", (long long)expr);		\
159 }									\
160 static DEVICE_ATTR_RW(name);
161 
162 BDI_SHOW(read_ahead_kb, K(bdi->ra_pages))
163 
164 static ssize_t min_ratio_store(struct device *dev,
165 		struct device_attribute *attr, const char *buf, size_t count)
166 {
167 	struct backing_dev_info *bdi = dev_get_drvdata(dev);
168 	unsigned int ratio;
169 	ssize_t ret;
170 
171 	ret = kstrtouint(buf, 10, &ratio);
172 	if (ret < 0)
173 		return ret;
174 
175 	ret = bdi_set_min_ratio(bdi, ratio);
176 	if (!ret)
177 		ret = count;
178 
179 	return ret;
180 }
181 BDI_SHOW(min_ratio, bdi->min_ratio / BDI_RATIO_SCALE)
182 
183 static ssize_t max_ratio_store(struct device *dev,
184 		struct device_attribute *attr, const char *buf, size_t count)
185 {
186 	struct backing_dev_info *bdi = dev_get_drvdata(dev);
187 	unsigned int ratio;
188 	ssize_t ret;
189 
190 	ret = kstrtouint(buf, 10, &ratio);
191 	if (ret < 0)
192 		return ret;
193 
194 	ret = bdi_set_max_ratio(bdi, ratio);
195 	if (!ret)
196 		ret = count;
197 
198 	return ret;
199 }
200 BDI_SHOW(max_ratio, bdi->max_ratio / BDI_RATIO_SCALE)
201 
202 static ssize_t max_ratio_fine_store(struct device *dev,
203 		struct device_attribute *attr, const char *buf, size_t count)
204 {
205 	struct backing_dev_info *bdi = dev_get_drvdata(dev);
206 	unsigned int ratio;
207 	ssize_t ret;
208 
209 	ret = kstrtouint(buf, 10, &ratio);
210 	if (ret < 0)
211 		return ret;
212 
213 	ret = bdi_set_max_ratio_no_scale(bdi, ratio);
214 	if (!ret)
215 		ret = count;
216 
217 	return ret;
218 }
219 BDI_SHOW(max_ratio_fine, bdi->max_ratio)
220 
221 static ssize_t min_bytes_show(struct device *dev,
222 			      struct device_attribute *attr,
223 			      char *buf)
224 {
225 	struct backing_dev_info *bdi = dev_get_drvdata(dev);
226 
227 	return sysfs_emit(buf, "%llu\n", bdi_get_min_bytes(bdi));
228 }
229 
230 static ssize_t min_bytes_store(struct device *dev,
231 		struct device_attribute *attr, const char *buf, size_t count)
232 {
233 	struct backing_dev_info *bdi = dev_get_drvdata(dev);
234 	u64 bytes;
235 	ssize_t ret;
236 
237 	ret = kstrtoull(buf, 10, &bytes);
238 	if (ret < 0)
239 		return ret;
240 
241 	ret = bdi_set_min_bytes(bdi, bytes);
242 	if (!ret)
243 		ret = count;
244 
245 	return ret;
246 }
247 DEVICE_ATTR_RW(min_bytes);
248 
249 static ssize_t max_bytes_show(struct device *dev,
250 			      struct device_attribute *attr,
251 			      char *buf)
252 {
253 	struct backing_dev_info *bdi = dev_get_drvdata(dev);
254 
255 	return sysfs_emit(buf, "%llu\n", bdi_get_max_bytes(bdi));
256 }
257 
258 static ssize_t max_bytes_store(struct device *dev,
259 		struct device_attribute *attr, const char *buf, size_t count)
260 {
261 	struct backing_dev_info *bdi = dev_get_drvdata(dev);
262 	u64 bytes;
263 	ssize_t ret;
264 
265 	ret = kstrtoull(buf, 10, &bytes);
266 	if (ret < 0)
267 		return ret;
268 
269 	ret = bdi_set_max_bytes(bdi, bytes);
270 	if (!ret)
271 		ret = count;
272 
273 	return ret;
274 }
275 DEVICE_ATTR_RW(max_bytes);
276 
277 static ssize_t stable_pages_required_show(struct device *dev,
278 					  struct device_attribute *attr,
279 					  char *buf)
280 {
281 	dev_warn_once(dev,
282 		"the stable_pages_required attribute has been removed. Use the stable_writes queue attribute instead.\n");
283 	return sysfs_emit(buf, "%d\n", 0);
284 }
285 static DEVICE_ATTR_RO(stable_pages_required);
286 
287 static ssize_t strict_limit_store(struct device *dev,
288 		struct device_attribute *attr, const char *buf, size_t count)
289 {
290 	struct backing_dev_info *bdi = dev_get_drvdata(dev);
291 	unsigned int strict_limit;
292 	ssize_t ret;
293 
294 	ret = kstrtouint(buf, 10, &strict_limit);
295 	if (ret < 0)
296 		return ret;
297 
298 	ret = bdi_set_strict_limit(bdi, strict_limit);
299 	if (!ret)
300 		ret = count;
301 
302 	return ret;
303 }
304 
305 static ssize_t strict_limit_show(struct device *dev,
306 		struct device_attribute *attr, char *buf)
307 {
308 	struct backing_dev_info *bdi = dev_get_drvdata(dev);
309 
310 	return sysfs_emit(buf, "%d\n",
311 			!!(bdi->capabilities & BDI_CAP_STRICTLIMIT));
312 }
313 static DEVICE_ATTR_RW(strict_limit);
314 
315 static struct attribute *bdi_dev_attrs[] = {
316 	&dev_attr_read_ahead_kb.attr,
317 	&dev_attr_min_ratio.attr,
318 	&dev_attr_max_ratio.attr,
319 	&dev_attr_max_ratio_fine.attr,
320 	&dev_attr_min_bytes.attr,
321 	&dev_attr_max_bytes.attr,
322 	&dev_attr_stable_pages_required.attr,
323 	&dev_attr_strict_limit.attr,
324 	NULL,
325 };
326 ATTRIBUTE_GROUPS(bdi_dev);
327 
328 static __init int bdi_class_init(void)
329 {
330 	bdi_class = class_create(THIS_MODULE, "bdi");
331 	if (IS_ERR(bdi_class))
332 		return PTR_ERR(bdi_class);
333 
334 	bdi_class->dev_groups = bdi_dev_groups;
335 	bdi_debug_init();
336 
337 	return 0;
338 }
339 postcore_initcall(bdi_class_init);
340 
341 static int __init default_bdi_init(void)
342 {
343 	bdi_wq = alloc_workqueue("writeback", WQ_MEM_RECLAIM | WQ_UNBOUND |
344 				 WQ_SYSFS, 0);
345 	if (!bdi_wq)
346 		return -ENOMEM;
347 	return 0;
348 }
349 subsys_initcall(default_bdi_init);
350 
351 /*
352  * This function is used when the first inode for this wb is marked dirty. It
353  * wakes-up the corresponding bdi thread which should then take care of the
354  * periodic background write-out of dirty inodes. Since the write-out would
355  * starts only 'dirty_writeback_interval' centisecs from now anyway, we just
356  * set up a timer which wakes the bdi thread up later.
357  *
358  * Note, we wouldn't bother setting up the timer, but this function is on the
359  * fast-path (used by '__mark_inode_dirty()'), so we save few context switches
360  * by delaying the wake-up.
361  *
362  * We have to be careful not to postpone flush work if it is scheduled for
363  * earlier. Thus we use queue_delayed_work().
364  */
365 void wb_wakeup_delayed(struct bdi_writeback *wb)
366 {
367 	unsigned long timeout;
368 
369 	timeout = msecs_to_jiffies(dirty_writeback_interval * 10);
370 	spin_lock_irq(&wb->work_lock);
371 	if (test_bit(WB_registered, &wb->state))
372 		queue_delayed_work(bdi_wq, &wb->dwork, timeout);
373 	spin_unlock_irq(&wb->work_lock);
374 }
375 
376 static void wb_update_bandwidth_workfn(struct work_struct *work)
377 {
378 	struct bdi_writeback *wb = container_of(to_delayed_work(work),
379 						struct bdi_writeback, bw_dwork);
380 
381 	wb_update_bandwidth(wb);
382 }
383 
384 /*
385  * Initial write bandwidth: 100 MB/s
386  */
387 #define INIT_BW		(100 << (20 - PAGE_SHIFT))
388 
389 static int wb_init(struct bdi_writeback *wb, struct backing_dev_info *bdi,
390 		   gfp_t gfp)
391 {
392 	int i, err;
393 
394 	memset(wb, 0, sizeof(*wb));
395 
396 	wb->bdi = bdi;
397 	wb->last_old_flush = jiffies;
398 	INIT_LIST_HEAD(&wb->b_dirty);
399 	INIT_LIST_HEAD(&wb->b_io);
400 	INIT_LIST_HEAD(&wb->b_more_io);
401 	INIT_LIST_HEAD(&wb->b_dirty_time);
402 	spin_lock_init(&wb->list_lock);
403 
404 	atomic_set(&wb->writeback_inodes, 0);
405 	wb->bw_time_stamp = jiffies;
406 	wb->balanced_dirty_ratelimit = INIT_BW;
407 	wb->dirty_ratelimit = INIT_BW;
408 	wb->write_bandwidth = INIT_BW;
409 	wb->avg_write_bandwidth = INIT_BW;
410 
411 	spin_lock_init(&wb->work_lock);
412 	INIT_LIST_HEAD(&wb->work_list);
413 	INIT_DELAYED_WORK(&wb->dwork, wb_workfn);
414 	INIT_DELAYED_WORK(&wb->bw_dwork, wb_update_bandwidth_workfn);
415 	wb->dirty_sleep = jiffies;
416 
417 	err = fprop_local_init_percpu(&wb->completions, gfp);
418 	if (err)
419 		return err;
420 
421 	for (i = 0; i < NR_WB_STAT_ITEMS; i++) {
422 		err = percpu_counter_init(&wb->stat[i], 0, gfp);
423 		if (err)
424 			goto out_destroy_stat;
425 	}
426 
427 	return 0;
428 
429 out_destroy_stat:
430 	while (i--)
431 		percpu_counter_destroy(&wb->stat[i]);
432 	fprop_local_destroy_percpu(&wb->completions);
433 	return err;
434 }
435 
436 static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb);
437 
438 /*
439  * Remove bdi from the global list and shutdown any threads we have running
440  */
441 static void wb_shutdown(struct bdi_writeback *wb)
442 {
443 	/* Make sure nobody queues further work */
444 	spin_lock_irq(&wb->work_lock);
445 	if (!test_and_clear_bit(WB_registered, &wb->state)) {
446 		spin_unlock_irq(&wb->work_lock);
447 		return;
448 	}
449 	spin_unlock_irq(&wb->work_lock);
450 
451 	cgwb_remove_from_bdi_list(wb);
452 	/*
453 	 * Drain work list and shutdown the delayed_work.  !WB_registered
454 	 * tells wb_workfn() that @wb is dying and its work_list needs to
455 	 * be drained no matter what.
456 	 */
457 	mod_delayed_work(bdi_wq, &wb->dwork, 0);
458 	flush_delayed_work(&wb->dwork);
459 	WARN_ON(!list_empty(&wb->work_list));
460 	flush_delayed_work(&wb->bw_dwork);
461 }
462 
463 static void wb_exit(struct bdi_writeback *wb)
464 {
465 	int i;
466 
467 	WARN_ON(delayed_work_pending(&wb->dwork));
468 
469 	for (i = 0; i < NR_WB_STAT_ITEMS; i++)
470 		percpu_counter_destroy(&wb->stat[i]);
471 
472 	fprop_local_destroy_percpu(&wb->completions);
473 }
474 
475 #ifdef CONFIG_CGROUP_WRITEBACK
476 
477 #include <linux/memcontrol.h>
478 
479 /*
480  * cgwb_lock protects bdi->cgwb_tree, blkcg->cgwb_list, offline_cgwbs and
481  * memcg->cgwb_list.  bdi->cgwb_tree is also RCU protected.
482  */
483 static DEFINE_SPINLOCK(cgwb_lock);
484 static struct workqueue_struct *cgwb_release_wq;
485 
486 static LIST_HEAD(offline_cgwbs);
487 static void cleanup_offline_cgwbs_workfn(struct work_struct *work);
488 static DECLARE_WORK(cleanup_offline_cgwbs_work, cleanup_offline_cgwbs_workfn);
489 
490 static void cgwb_release_workfn(struct work_struct *work)
491 {
492 	struct bdi_writeback *wb = container_of(work, struct bdi_writeback,
493 						release_work);
494 	struct backing_dev_info *bdi = wb->bdi;
495 
496 	mutex_lock(&wb->bdi->cgwb_release_mutex);
497 	wb_shutdown(wb);
498 
499 	css_put(wb->memcg_css);
500 	css_put(wb->blkcg_css);
501 	mutex_unlock(&wb->bdi->cgwb_release_mutex);
502 
503 	/* triggers blkg destruction if no online users left */
504 	blkcg_unpin_online(wb->blkcg_css);
505 
506 	fprop_local_destroy_percpu(&wb->memcg_completions);
507 
508 	spin_lock_irq(&cgwb_lock);
509 	list_del(&wb->offline_node);
510 	spin_unlock_irq(&cgwb_lock);
511 
512 	percpu_ref_exit(&wb->refcnt);
513 	wb_exit(wb);
514 	bdi_put(bdi);
515 	WARN_ON_ONCE(!list_empty(&wb->b_attached));
516 	kfree_rcu(wb, rcu);
517 }
518 
519 static void cgwb_release(struct percpu_ref *refcnt)
520 {
521 	struct bdi_writeback *wb = container_of(refcnt, struct bdi_writeback,
522 						refcnt);
523 	queue_work(cgwb_release_wq, &wb->release_work);
524 }
525 
526 static void cgwb_kill(struct bdi_writeback *wb)
527 {
528 	lockdep_assert_held(&cgwb_lock);
529 
530 	WARN_ON(!radix_tree_delete(&wb->bdi->cgwb_tree, wb->memcg_css->id));
531 	list_del(&wb->memcg_node);
532 	list_del(&wb->blkcg_node);
533 	list_add(&wb->offline_node, &offline_cgwbs);
534 	percpu_ref_kill(&wb->refcnt);
535 }
536 
537 static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
538 {
539 	spin_lock_irq(&cgwb_lock);
540 	list_del_rcu(&wb->bdi_node);
541 	spin_unlock_irq(&cgwb_lock);
542 }
543 
544 static int cgwb_create(struct backing_dev_info *bdi,
545 		       struct cgroup_subsys_state *memcg_css, gfp_t gfp)
546 {
547 	struct mem_cgroup *memcg;
548 	struct cgroup_subsys_state *blkcg_css;
549 	struct list_head *memcg_cgwb_list, *blkcg_cgwb_list;
550 	struct bdi_writeback *wb;
551 	unsigned long flags;
552 	int ret = 0;
553 
554 	memcg = mem_cgroup_from_css(memcg_css);
555 	blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
556 	memcg_cgwb_list = &memcg->cgwb_list;
557 	blkcg_cgwb_list = blkcg_get_cgwb_list(blkcg_css);
558 
559 	/* look up again under lock and discard on blkcg mismatch */
560 	spin_lock_irqsave(&cgwb_lock, flags);
561 	wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
562 	if (wb && wb->blkcg_css != blkcg_css) {
563 		cgwb_kill(wb);
564 		wb = NULL;
565 	}
566 	spin_unlock_irqrestore(&cgwb_lock, flags);
567 	if (wb)
568 		goto out_put;
569 
570 	/* need to create a new one */
571 	wb = kmalloc(sizeof(*wb), gfp);
572 	if (!wb) {
573 		ret = -ENOMEM;
574 		goto out_put;
575 	}
576 
577 	ret = wb_init(wb, bdi, gfp);
578 	if (ret)
579 		goto err_free;
580 
581 	ret = percpu_ref_init(&wb->refcnt, cgwb_release, 0, gfp);
582 	if (ret)
583 		goto err_wb_exit;
584 
585 	ret = fprop_local_init_percpu(&wb->memcg_completions, gfp);
586 	if (ret)
587 		goto err_ref_exit;
588 
589 	wb->memcg_css = memcg_css;
590 	wb->blkcg_css = blkcg_css;
591 	INIT_LIST_HEAD(&wb->b_attached);
592 	INIT_WORK(&wb->release_work, cgwb_release_workfn);
593 	set_bit(WB_registered, &wb->state);
594 	bdi_get(bdi);
595 
596 	/*
597 	 * The root wb determines the registered state of the whole bdi and
598 	 * memcg_cgwb_list and blkcg_cgwb_list's next pointers indicate
599 	 * whether they're still online.  Don't link @wb if any is dead.
600 	 * See wb_memcg_offline() and wb_blkcg_offline().
601 	 */
602 	ret = -ENODEV;
603 	spin_lock_irqsave(&cgwb_lock, flags);
604 	if (test_bit(WB_registered, &bdi->wb.state) &&
605 	    blkcg_cgwb_list->next && memcg_cgwb_list->next) {
606 		/* we might have raced another instance of this function */
607 		ret = radix_tree_insert(&bdi->cgwb_tree, memcg_css->id, wb);
608 		if (!ret) {
609 			list_add_tail_rcu(&wb->bdi_node, &bdi->wb_list);
610 			list_add(&wb->memcg_node, memcg_cgwb_list);
611 			list_add(&wb->blkcg_node, blkcg_cgwb_list);
612 			blkcg_pin_online(blkcg_css);
613 			css_get(memcg_css);
614 			css_get(blkcg_css);
615 		}
616 	}
617 	spin_unlock_irqrestore(&cgwb_lock, flags);
618 	if (ret) {
619 		if (ret == -EEXIST)
620 			ret = 0;
621 		goto err_fprop_exit;
622 	}
623 	goto out_put;
624 
625 err_fprop_exit:
626 	bdi_put(bdi);
627 	fprop_local_destroy_percpu(&wb->memcg_completions);
628 err_ref_exit:
629 	percpu_ref_exit(&wb->refcnt);
630 err_wb_exit:
631 	wb_exit(wb);
632 err_free:
633 	kfree(wb);
634 out_put:
635 	css_put(blkcg_css);
636 	return ret;
637 }
638 
639 /**
640  * wb_get_lookup - get wb for a given memcg
641  * @bdi: target bdi
642  * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
643  *
644  * Try to get the wb for @memcg_css on @bdi.  The returned wb has its
645  * refcount incremented.
646  *
647  * This function uses css_get() on @memcg_css and thus expects its refcnt
648  * to be positive on invocation.  IOW, rcu_read_lock() protection on
649  * @memcg_css isn't enough.  try_get it before calling this function.
650  *
651  * A wb is keyed by its associated memcg.  As blkcg implicitly enables
652  * memcg on the default hierarchy, memcg association is guaranteed to be
653  * more specific (equal or descendant to the associated blkcg) and thus can
654  * identify both the memcg and blkcg associations.
655  *
656  * Because the blkcg associated with a memcg may change as blkcg is enabled
657  * and disabled closer to root in the hierarchy, each wb keeps track of
658  * both the memcg and blkcg associated with it and verifies the blkcg on
659  * each lookup.  On mismatch, the existing wb is discarded and a new one is
660  * created.
661  */
662 struct bdi_writeback *wb_get_lookup(struct backing_dev_info *bdi,
663 				    struct cgroup_subsys_state *memcg_css)
664 {
665 	struct bdi_writeback *wb;
666 
667 	if (!memcg_css->parent)
668 		return &bdi->wb;
669 
670 	rcu_read_lock();
671 	wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
672 	if (wb) {
673 		struct cgroup_subsys_state *blkcg_css;
674 
675 		/* see whether the blkcg association has changed */
676 		blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
677 		if (unlikely(wb->blkcg_css != blkcg_css || !wb_tryget(wb)))
678 			wb = NULL;
679 		css_put(blkcg_css);
680 	}
681 	rcu_read_unlock();
682 
683 	return wb;
684 }
685 
686 /**
687  * wb_get_create - get wb for a given memcg, create if necessary
688  * @bdi: target bdi
689  * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
690  * @gfp: allocation mask to use
691  *
692  * Try to get the wb for @memcg_css on @bdi.  If it doesn't exist, try to
693  * create one.  See wb_get_lookup() for more details.
694  */
695 struct bdi_writeback *wb_get_create(struct backing_dev_info *bdi,
696 				    struct cgroup_subsys_state *memcg_css,
697 				    gfp_t gfp)
698 {
699 	struct bdi_writeback *wb;
700 
701 	might_alloc(gfp);
702 
703 	if (!memcg_css->parent)
704 		return &bdi->wb;
705 
706 	do {
707 		wb = wb_get_lookup(bdi, memcg_css);
708 	} while (!wb && !cgwb_create(bdi, memcg_css, gfp));
709 
710 	return wb;
711 }
712 
713 static int cgwb_bdi_init(struct backing_dev_info *bdi)
714 {
715 	int ret;
716 
717 	INIT_RADIX_TREE(&bdi->cgwb_tree, GFP_ATOMIC);
718 	mutex_init(&bdi->cgwb_release_mutex);
719 	init_rwsem(&bdi->wb_switch_rwsem);
720 
721 	ret = wb_init(&bdi->wb, bdi, GFP_KERNEL);
722 	if (!ret) {
723 		bdi->wb.memcg_css = &root_mem_cgroup->css;
724 		bdi->wb.blkcg_css = blkcg_root_css;
725 	}
726 	return ret;
727 }
728 
729 static void cgwb_bdi_unregister(struct backing_dev_info *bdi)
730 {
731 	struct radix_tree_iter iter;
732 	void **slot;
733 	struct bdi_writeback *wb;
734 
735 	WARN_ON(test_bit(WB_registered, &bdi->wb.state));
736 
737 	spin_lock_irq(&cgwb_lock);
738 	radix_tree_for_each_slot(slot, &bdi->cgwb_tree, &iter, 0)
739 		cgwb_kill(*slot);
740 	spin_unlock_irq(&cgwb_lock);
741 
742 	mutex_lock(&bdi->cgwb_release_mutex);
743 	spin_lock_irq(&cgwb_lock);
744 	while (!list_empty(&bdi->wb_list)) {
745 		wb = list_first_entry(&bdi->wb_list, struct bdi_writeback,
746 				      bdi_node);
747 		spin_unlock_irq(&cgwb_lock);
748 		wb_shutdown(wb);
749 		spin_lock_irq(&cgwb_lock);
750 	}
751 	spin_unlock_irq(&cgwb_lock);
752 	mutex_unlock(&bdi->cgwb_release_mutex);
753 }
754 
755 /*
756  * cleanup_offline_cgwbs_workfn - try to release dying cgwbs
757  *
758  * Try to release dying cgwbs by switching attached inodes to the nearest
759  * living ancestor's writeback. Processed wbs are placed at the end
760  * of the list to guarantee the forward progress.
761  */
762 static void cleanup_offline_cgwbs_workfn(struct work_struct *work)
763 {
764 	struct bdi_writeback *wb;
765 	LIST_HEAD(processed);
766 
767 	spin_lock_irq(&cgwb_lock);
768 
769 	while (!list_empty(&offline_cgwbs)) {
770 		wb = list_first_entry(&offline_cgwbs, struct bdi_writeback,
771 				      offline_node);
772 		list_move(&wb->offline_node, &processed);
773 
774 		/*
775 		 * If wb is dirty, cleaning up the writeback by switching
776 		 * attached inodes will result in an effective removal of any
777 		 * bandwidth restrictions, which isn't the goal.  Instead,
778 		 * it can be postponed until the next time, when all io
779 		 * will be likely completed.  If in the meantime some inodes
780 		 * will get re-dirtied, they should be eventually switched to
781 		 * a new cgwb.
782 		 */
783 		if (wb_has_dirty_io(wb))
784 			continue;
785 
786 		if (!wb_tryget(wb))
787 			continue;
788 
789 		spin_unlock_irq(&cgwb_lock);
790 		while (cleanup_offline_cgwb(wb))
791 			cond_resched();
792 		spin_lock_irq(&cgwb_lock);
793 
794 		wb_put(wb);
795 	}
796 
797 	if (!list_empty(&processed))
798 		list_splice_tail(&processed, &offline_cgwbs);
799 
800 	spin_unlock_irq(&cgwb_lock);
801 }
802 
803 /**
804  * wb_memcg_offline - kill all wb's associated with a memcg being offlined
805  * @memcg: memcg being offlined
806  *
807  * Also prevents creation of any new wb's associated with @memcg.
808  */
809 void wb_memcg_offline(struct mem_cgroup *memcg)
810 {
811 	struct list_head *memcg_cgwb_list = &memcg->cgwb_list;
812 	struct bdi_writeback *wb, *next;
813 
814 	spin_lock_irq(&cgwb_lock);
815 	list_for_each_entry_safe(wb, next, memcg_cgwb_list, memcg_node)
816 		cgwb_kill(wb);
817 	memcg_cgwb_list->next = NULL;	/* prevent new wb's */
818 	spin_unlock_irq(&cgwb_lock);
819 
820 	queue_work(system_unbound_wq, &cleanup_offline_cgwbs_work);
821 }
822 
823 /**
824  * wb_blkcg_offline - kill all wb's associated with a blkcg being offlined
825  * @css: blkcg being offlined
826  *
827  * Also prevents creation of any new wb's associated with @blkcg.
828  */
829 void wb_blkcg_offline(struct cgroup_subsys_state *css)
830 {
831 	struct bdi_writeback *wb, *next;
832 	struct list_head *list = blkcg_get_cgwb_list(css);
833 
834 	spin_lock_irq(&cgwb_lock);
835 	list_for_each_entry_safe(wb, next, list, blkcg_node)
836 		cgwb_kill(wb);
837 	list->next = NULL;	/* prevent new wb's */
838 	spin_unlock_irq(&cgwb_lock);
839 }
840 
841 static void cgwb_bdi_register(struct backing_dev_info *bdi)
842 {
843 	spin_lock_irq(&cgwb_lock);
844 	list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
845 	spin_unlock_irq(&cgwb_lock);
846 }
847 
848 static int __init cgwb_init(void)
849 {
850 	/*
851 	 * There can be many concurrent release work items overwhelming
852 	 * system_wq.  Put them in a separate wq and limit concurrency.
853 	 * There's no point in executing many of these in parallel.
854 	 */
855 	cgwb_release_wq = alloc_workqueue("cgwb_release", 0, 1);
856 	if (!cgwb_release_wq)
857 		return -ENOMEM;
858 
859 	return 0;
860 }
861 subsys_initcall(cgwb_init);
862 
863 #else	/* CONFIG_CGROUP_WRITEBACK */
864 
865 static int cgwb_bdi_init(struct backing_dev_info *bdi)
866 {
867 	return wb_init(&bdi->wb, bdi, GFP_KERNEL);
868 }
869 
870 static void cgwb_bdi_unregister(struct backing_dev_info *bdi) { }
871 
872 static void cgwb_bdi_register(struct backing_dev_info *bdi)
873 {
874 	list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
875 }
876 
877 static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
878 {
879 	list_del_rcu(&wb->bdi_node);
880 }
881 
882 #endif	/* CONFIG_CGROUP_WRITEBACK */
883 
884 int bdi_init(struct backing_dev_info *bdi)
885 {
886 	bdi->dev = NULL;
887 
888 	kref_init(&bdi->refcnt);
889 	bdi->min_ratio = 0;
890 	bdi->max_ratio = 100 * BDI_RATIO_SCALE;
891 	bdi->max_prop_frac = FPROP_FRAC_BASE;
892 	INIT_LIST_HEAD(&bdi->bdi_list);
893 	INIT_LIST_HEAD(&bdi->wb_list);
894 	init_waitqueue_head(&bdi->wb_waitq);
895 
896 	return cgwb_bdi_init(bdi);
897 }
898 
899 struct backing_dev_info *bdi_alloc(int node_id)
900 {
901 	struct backing_dev_info *bdi;
902 
903 	bdi = kzalloc_node(sizeof(*bdi), GFP_KERNEL, node_id);
904 	if (!bdi)
905 		return NULL;
906 
907 	if (bdi_init(bdi)) {
908 		kfree(bdi);
909 		return NULL;
910 	}
911 	bdi->capabilities = BDI_CAP_WRITEBACK | BDI_CAP_WRITEBACK_ACCT;
912 	bdi->ra_pages = VM_READAHEAD_PAGES;
913 	bdi->io_pages = VM_READAHEAD_PAGES;
914 	timer_setup(&bdi->laptop_mode_wb_timer, laptop_mode_timer_fn, 0);
915 	return bdi;
916 }
917 EXPORT_SYMBOL(bdi_alloc);
918 
919 static struct rb_node **bdi_lookup_rb_node(u64 id, struct rb_node **parentp)
920 {
921 	struct rb_node **p = &bdi_tree.rb_node;
922 	struct rb_node *parent = NULL;
923 	struct backing_dev_info *bdi;
924 
925 	lockdep_assert_held(&bdi_lock);
926 
927 	while (*p) {
928 		parent = *p;
929 		bdi = rb_entry(parent, struct backing_dev_info, rb_node);
930 
931 		if (bdi->id > id)
932 			p = &(*p)->rb_left;
933 		else if (bdi->id < id)
934 			p = &(*p)->rb_right;
935 		else
936 			break;
937 	}
938 
939 	if (parentp)
940 		*parentp = parent;
941 	return p;
942 }
943 
944 /**
945  * bdi_get_by_id - lookup and get bdi from its id
946  * @id: bdi id to lookup
947  *
948  * Find bdi matching @id and get it.  Returns NULL if the matching bdi
949  * doesn't exist or is already unregistered.
950  */
951 struct backing_dev_info *bdi_get_by_id(u64 id)
952 {
953 	struct backing_dev_info *bdi = NULL;
954 	struct rb_node **p;
955 
956 	spin_lock_bh(&bdi_lock);
957 	p = bdi_lookup_rb_node(id, NULL);
958 	if (*p) {
959 		bdi = rb_entry(*p, struct backing_dev_info, rb_node);
960 		bdi_get(bdi);
961 	}
962 	spin_unlock_bh(&bdi_lock);
963 
964 	return bdi;
965 }
966 
967 int bdi_register_va(struct backing_dev_info *bdi, const char *fmt, va_list args)
968 {
969 	struct device *dev;
970 	struct rb_node *parent, **p;
971 
972 	if (bdi->dev)	/* The driver needs to use separate queues per device */
973 		return 0;
974 
975 	vsnprintf(bdi->dev_name, sizeof(bdi->dev_name), fmt, args);
976 	dev = device_create(bdi_class, NULL, MKDEV(0, 0), bdi, bdi->dev_name);
977 	if (IS_ERR(dev))
978 		return PTR_ERR(dev);
979 
980 	cgwb_bdi_register(bdi);
981 	bdi->dev = dev;
982 
983 	bdi_debug_register(bdi, dev_name(dev));
984 	set_bit(WB_registered, &bdi->wb.state);
985 
986 	spin_lock_bh(&bdi_lock);
987 
988 	bdi->id = ++bdi_id_cursor;
989 
990 	p = bdi_lookup_rb_node(bdi->id, &parent);
991 	rb_link_node(&bdi->rb_node, parent, p);
992 	rb_insert_color(&bdi->rb_node, &bdi_tree);
993 
994 	list_add_tail_rcu(&bdi->bdi_list, &bdi_list);
995 
996 	spin_unlock_bh(&bdi_lock);
997 
998 	trace_writeback_bdi_register(bdi);
999 	return 0;
1000 }
1001 
1002 int bdi_register(struct backing_dev_info *bdi, const char *fmt, ...)
1003 {
1004 	va_list args;
1005 	int ret;
1006 
1007 	va_start(args, fmt);
1008 	ret = bdi_register_va(bdi, fmt, args);
1009 	va_end(args);
1010 	return ret;
1011 }
1012 EXPORT_SYMBOL(bdi_register);
1013 
1014 void bdi_set_owner(struct backing_dev_info *bdi, struct device *owner)
1015 {
1016 	WARN_ON_ONCE(bdi->owner);
1017 	bdi->owner = owner;
1018 	get_device(owner);
1019 }
1020 
1021 /*
1022  * Remove bdi from bdi_list, and ensure that it is no longer visible
1023  */
1024 static void bdi_remove_from_list(struct backing_dev_info *bdi)
1025 {
1026 	spin_lock_bh(&bdi_lock);
1027 	rb_erase(&bdi->rb_node, &bdi_tree);
1028 	list_del_rcu(&bdi->bdi_list);
1029 	spin_unlock_bh(&bdi_lock);
1030 
1031 	synchronize_rcu_expedited();
1032 }
1033 
1034 void bdi_unregister(struct backing_dev_info *bdi)
1035 {
1036 	del_timer_sync(&bdi->laptop_mode_wb_timer);
1037 
1038 	/* make sure nobody finds us on the bdi_list anymore */
1039 	bdi_remove_from_list(bdi);
1040 	wb_shutdown(&bdi->wb);
1041 	cgwb_bdi_unregister(bdi);
1042 
1043 	/*
1044 	 * If this BDI's min ratio has been set, use bdi_set_min_ratio() to
1045 	 * update the global bdi_min_ratio.
1046 	 */
1047 	if (bdi->min_ratio)
1048 		bdi_set_min_ratio(bdi, 0);
1049 
1050 	if (bdi->dev) {
1051 		bdi_debug_unregister(bdi);
1052 		device_unregister(bdi->dev);
1053 		bdi->dev = NULL;
1054 	}
1055 
1056 	if (bdi->owner) {
1057 		put_device(bdi->owner);
1058 		bdi->owner = NULL;
1059 	}
1060 }
1061 EXPORT_SYMBOL(bdi_unregister);
1062 
1063 static void release_bdi(struct kref *ref)
1064 {
1065 	struct backing_dev_info *bdi =
1066 			container_of(ref, struct backing_dev_info, refcnt);
1067 
1068 	WARN_ON_ONCE(test_bit(WB_registered, &bdi->wb.state));
1069 	WARN_ON_ONCE(bdi->dev);
1070 	wb_exit(&bdi->wb);
1071 	kfree(bdi);
1072 }
1073 
1074 void bdi_put(struct backing_dev_info *bdi)
1075 {
1076 	kref_put(&bdi->refcnt, release_bdi);
1077 }
1078 EXPORT_SYMBOL(bdi_put);
1079 
1080 struct backing_dev_info *inode_to_bdi(struct inode *inode)
1081 {
1082 	struct super_block *sb;
1083 
1084 	if (!inode)
1085 		return &noop_backing_dev_info;
1086 
1087 	sb = inode->i_sb;
1088 #ifdef CONFIG_BLOCK
1089 	if (sb_is_blkdev_sb(sb))
1090 		return I_BDEV(inode)->bd_disk->bdi;
1091 #endif
1092 	return sb->s_bdi;
1093 }
1094 EXPORT_SYMBOL(inode_to_bdi);
1095 
1096 const char *bdi_dev_name(struct backing_dev_info *bdi)
1097 {
1098 	if (!bdi || !bdi->dev)
1099 		return bdi_unknown_name;
1100 	return bdi->dev_name;
1101 }
1102 EXPORT_SYMBOL_GPL(bdi_dev_name);
1103