1 // SPDX-License-Identifier: GPL-2.0-only
3 #include <linux/wait.h>
4 #include <linux/rbtree.h>
5 #include <linux/kthread.h>
6 #include <linux/backing-dev.h>
7 #include <linux/blk-cgroup.h>
8 #include <linux/freezer.h>
10 #include <linux/pagemap.h>
12 #include <linux/sched/mm.h>
13 #include <linux/sched.h>
14 #include <linux/module.h>
15 #include <linux/writeback.h>
16 #include <linux/device.h>
17 #include <trace/events/writeback.h>
19 struct backing_dev_info noop_backing_dev_info;
20 EXPORT_SYMBOL_GPL(noop_backing_dev_info);
22 static struct class *bdi_class;
23 static const char *bdi_unknown_name = "(unknown)";
26 * bdi_lock protects bdi_tree and updates to bdi_list. bdi_list has RCU
27 * reader side locking.
29 DEFINE_SPINLOCK(bdi_lock);
30 static u64 bdi_id_cursor;
31 static struct rb_root bdi_tree = RB_ROOT;
34 /* bdi_wq serves all asynchronous writeback tasks */
35 struct workqueue_struct *bdi_wq;
37 #define K(x) ((x) << (PAGE_SHIFT - 10))
39 #ifdef CONFIG_DEBUG_FS
40 #include <linux/debugfs.h>
41 #include <linux/seq_file.h>
43 static struct dentry *bdi_debug_root;
45 static void bdi_debug_init(void)
47 bdi_debug_root = debugfs_create_dir("bdi", NULL);
50 static int bdi_debug_stats_show(struct seq_file *m, void *v)
52 struct backing_dev_info *bdi = m->private;
53 struct bdi_writeback *wb = &bdi->wb;
54 unsigned long background_thresh;
55 unsigned long dirty_thresh;
56 unsigned long wb_thresh;
57 unsigned long nr_dirty, nr_io, nr_more_io, nr_dirty_time;
60 nr_dirty = nr_io = nr_more_io = nr_dirty_time = 0;
61 spin_lock(&wb->list_lock);
62 list_for_each_entry(inode, &wb->b_dirty, i_io_list)
64 list_for_each_entry(inode, &wb->b_io, i_io_list)
66 list_for_each_entry(inode, &wb->b_more_io, i_io_list)
68 list_for_each_entry(inode, &wb->b_dirty_time, i_io_list)
69 if (inode->i_state & I_DIRTY_TIME)
71 spin_unlock(&wb->list_lock);
73 global_dirty_limits(&background_thresh, &dirty_thresh);
74 wb_thresh = wb_calc_thresh(wb, dirty_thresh);
77 "BdiWriteback: %10lu kB\n"
78 "BdiReclaimable: %10lu kB\n"
79 "BdiDirtyThresh: %10lu kB\n"
80 "DirtyThresh: %10lu kB\n"
81 "BackgroundThresh: %10lu kB\n"
82 "BdiDirtied: %10lu kB\n"
83 "BdiWritten: %10lu kB\n"
84 "BdiWriteBandwidth: %10lu kBps\n"
88 "b_dirty_time: %10lu\n"
91 (unsigned long) K(wb_stat(wb, WB_WRITEBACK)),
92 (unsigned long) K(wb_stat(wb, WB_RECLAIMABLE)),
96 (unsigned long) K(wb_stat(wb, WB_DIRTIED)),
97 (unsigned long) K(wb_stat(wb, WB_WRITTEN)),
98 (unsigned long) K(wb->write_bandwidth),
103 !list_empty(&bdi->bdi_list), bdi->wb.state);
107 DEFINE_SHOW_ATTRIBUTE(bdi_debug_stats);
109 static void bdi_debug_register(struct backing_dev_info *bdi, const char *name)
111 bdi->debug_dir = debugfs_create_dir(name, bdi_debug_root);
113 debugfs_create_file("stats", 0444, bdi->debug_dir, bdi,
114 &bdi_debug_stats_fops);
117 static void bdi_debug_unregister(struct backing_dev_info *bdi)
119 debugfs_remove_recursive(bdi->debug_dir);
122 static inline void bdi_debug_init(void)
125 static inline void bdi_debug_register(struct backing_dev_info *bdi,
129 static inline void bdi_debug_unregister(struct backing_dev_info *bdi)
134 static ssize_t read_ahead_kb_store(struct device *dev,
135 struct device_attribute *attr,
136 const char *buf, size_t count)
138 struct backing_dev_info *bdi = dev_get_drvdata(dev);
139 unsigned long read_ahead_kb;
142 ret = kstrtoul(buf, 10, &read_ahead_kb);
146 bdi->ra_pages = read_ahead_kb >> (PAGE_SHIFT - 10);
151 #define BDI_SHOW(name, expr) \
152 static ssize_t name##_show(struct device *dev, \
153 struct device_attribute *attr, char *buf) \
155 struct backing_dev_info *bdi = dev_get_drvdata(dev); \
157 return sysfs_emit(buf, "%lld\n", (long long)expr); \
159 static DEVICE_ATTR_RW(name);
161 BDI_SHOW(read_ahead_kb, K(bdi->ra_pages))
163 static ssize_t min_ratio_store(struct device *dev,
164 struct device_attribute *attr, const char *buf, size_t count)
166 struct backing_dev_info *bdi = dev_get_drvdata(dev);
170 ret = kstrtouint(buf, 10, &ratio);
174 ret = bdi_set_min_ratio(bdi, ratio);
180 BDI_SHOW(min_ratio, bdi->min_ratio)
182 static ssize_t max_ratio_store(struct device *dev,
183 struct device_attribute *attr, const char *buf, size_t count)
185 struct backing_dev_info *bdi = dev_get_drvdata(dev);
189 ret = kstrtouint(buf, 10, &ratio);
193 ret = bdi_set_max_ratio(bdi, ratio);
199 BDI_SHOW(max_ratio, bdi->max_ratio)
201 static ssize_t stable_pages_required_show(struct device *dev,
202 struct device_attribute *attr,
206 "the stable_pages_required attribute has been removed. Use the stable_writes queue attribute instead.\n");
207 return sysfs_emit(buf, "%d\n", 0);
209 static DEVICE_ATTR_RO(stable_pages_required);
211 static struct attribute *bdi_dev_attrs[] = {
212 &dev_attr_read_ahead_kb.attr,
213 &dev_attr_min_ratio.attr,
214 &dev_attr_max_ratio.attr,
215 &dev_attr_stable_pages_required.attr,
218 ATTRIBUTE_GROUPS(bdi_dev);
220 static __init int bdi_class_init(void)
222 bdi_class = class_create(THIS_MODULE, "bdi");
223 if (IS_ERR(bdi_class))
224 return PTR_ERR(bdi_class);
226 bdi_class->dev_groups = bdi_dev_groups;
231 postcore_initcall(bdi_class_init);
233 static int bdi_init(struct backing_dev_info *bdi);
235 static int __init default_bdi_init(void)
239 bdi_wq = alloc_workqueue("writeback", WQ_MEM_RECLAIM | WQ_UNBOUND |
244 err = bdi_init(&noop_backing_dev_info);
248 subsys_initcall(default_bdi_init);
251 * This function is used when the first inode for this wb is marked dirty. It
252 * wakes-up the corresponding bdi thread which should then take care of the
253 * periodic background write-out of dirty inodes. Since the write-out would
254 * starts only 'dirty_writeback_interval' centisecs from now anyway, we just
255 * set up a timer which wakes the bdi thread up later.
257 * Note, we wouldn't bother setting up the timer, but this function is on the
258 * fast-path (used by '__mark_inode_dirty()'), so we save few context switches
259 * by delaying the wake-up.
261 * We have to be careful not to postpone flush work if it is scheduled for
262 * earlier. Thus we use queue_delayed_work().
264 void wb_wakeup_delayed(struct bdi_writeback *wb)
266 unsigned long timeout;
268 timeout = msecs_to_jiffies(dirty_writeback_interval * 10);
269 spin_lock_bh(&wb->work_lock);
270 if (test_bit(WB_registered, &wb->state))
271 queue_delayed_work(bdi_wq, &wb->dwork, timeout);
272 spin_unlock_bh(&wb->work_lock);
275 static void wb_update_bandwidth_workfn(struct work_struct *work)
277 struct bdi_writeback *wb = container_of(to_delayed_work(work),
278 struct bdi_writeback, bw_dwork);
280 wb_update_bandwidth(wb);
284 * Initial write bandwidth: 100 MB/s
286 #define INIT_BW (100 << (20 - PAGE_SHIFT))
288 static int wb_init(struct bdi_writeback *wb, struct backing_dev_info *bdi,
293 memset(wb, 0, sizeof(*wb));
298 wb->last_old_flush = jiffies;
299 INIT_LIST_HEAD(&wb->b_dirty);
300 INIT_LIST_HEAD(&wb->b_io);
301 INIT_LIST_HEAD(&wb->b_more_io);
302 INIT_LIST_HEAD(&wb->b_dirty_time);
303 spin_lock_init(&wb->list_lock);
305 atomic_set(&wb->writeback_inodes, 0);
306 wb->bw_time_stamp = jiffies;
307 wb->balanced_dirty_ratelimit = INIT_BW;
308 wb->dirty_ratelimit = INIT_BW;
309 wb->write_bandwidth = INIT_BW;
310 wb->avg_write_bandwidth = INIT_BW;
312 spin_lock_init(&wb->work_lock);
313 INIT_LIST_HEAD(&wb->work_list);
314 INIT_DELAYED_WORK(&wb->dwork, wb_workfn);
315 INIT_DELAYED_WORK(&wb->bw_dwork, wb_update_bandwidth_workfn);
316 wb->dirty_sleep = jiffies;
318 err = fprop_local_init_percpu(&wb->completions, gfp);
322 for (i = 0; i < NR_WB_STAT_ITEMS; i++) {
323 err = percpu_counter_init(&wb->stat[i], 0, gfp);
325 goto out_destroy_stat;
332 percpu_counter_destroy(&wb->stat[i]);
333 fprop_local_destroy_percpu(&wb->completions);
340 static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb);
343 * Remove bdi from the global list and shutdown any threads we have running
345 static void wb_shutdown(struct bdi_writeback *wb)
347 /* Make sure nobody queues further work */
348 spin_lock_bh(&wb->work_lock);
349 if (!test_and_clear_bit(WB_registered, &wb->state)) {
350 spin_unlock_bh(&wb->work_lock);
353 spin_unlock_bh(&wb->work_lock);
355 cgwb_remove_from_bdi_list(wb);
357 * Drain work list and shutdown the delayed_work. !WB_registered
358 * tells wb_workfn() that @wb is dying and its work_list needs to
359 * be drained no matter what.
361 mod_delayed_work(bdi_wq, &wb->dwork, 0);
362 flush_delayed_work(&wb->dwork);
363 WARN_ON(!list_empty(&wb->work_list));
364 flush_delayed_work(&wb->bw_dwork);
367 static void wb_exit(struct bdi_writeback *wb)
371 WARN_ON(delayed_work_pending(&wb->dwork));
373 for (i = 0; i < NR_WB_STAT_ITEMS; i++)
374 percpu_counter_destroy(&wb->stat[i]);
376 fprop_local_destroy_percpu(&wb->completions);
377 if (wb != &wb->bdi->wb)
381 #ifdef CONFIG_CGROUP_WRITEBACK
383 #include <linux/memcontrol.h>
386 * cgwb_lock protects bdi->cgwb_tree, blkcg->cgwb_list, offline_cgwbs and
387 * memcg->cgwb_list. bdi->cgwb_tree is also RCU protected.
389 static DEFINE_SPINLOCK(cgwb_lock);
390 static struct workqueue_struct *cgwb_release_wq;
392 static LIST_HEAD(offline_cgwbs);
393 static void cleanup_offline_cgwbs_workfn(struct work_struct *work);
394 static DECLARE_WORK(cleanup_offline_cgwbs_work, cleanup_offline_cgwbs_workfn);
396 static void cgwb_release_workfn(struct work_struct *work)
398 struct bdi_writeback *wb = container_of(work, struct bdi_writeback,
400 struct blkcg *blkcg = css_to_blkcg(wb->blkcg_css);
402 mutex_lock(&wb->bdi->cgwb_release_mutex);
405 css_put(wb->memcg_css);
406 css_put(wb->blkcg_css);
407 mutex_unlock(&wb->bdi->cgwb_release_mutex);
409 /* triggers blkg destruction if no online users left */
410 blkcg_unpin_online(blkcg);
412 fprop_local_destroy_percpu(&wb->memcg_completions);
414 spin_lock_irq(&cgwb_lock);
415 list_del(&wb->offline_node);
416 spin_unlock_irq(&cgwb_lock);
418 percpu_ref_exit(&wb->refcnt);
420 WARN_ON_ONCE(!list_empty(&wb->b_attached));
424 static void cgwb_release(struct percpu_ref *refcnt)
426 struct bdi_writeback *wb = container_of(refcnt, struct bdi_writeback,
428 queue_work(cgwb_release_wq, &wb->release_work);
431 static void cgwb_kill(struct bdi_writeback *wb)
433 lockdep_assert_held(&cgwb_lock);
435 WARN_ON(!radix_tree_delete(&wb->bdi->cgwb_tree, wb->memcg_css->id));
436 list_del(&wb->memcg_node);
437 list_del(&wb->blkcg_node);
438 list_add(&wb->offline_node, &offline_cgwbs);
439 percpu_ref_kill(&wb->refcnt);
442 static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
444 spin_lock_irq(&cgwb_lock);
445 list_del_rcu(&wb->bdi_node);
446 spin_unlock_irq(&cgwb_lock);
449 static int cgwb_create(struct backing_dev_info *bdi,
450 struct cgroup_subsys_state *memcg_css, gfp_t gfp)
452 struct mem_cgroup *memcg;
453 struct cgroup_subsys_state *blkcg_css;
455 struct list_head *memcg_cgwb_list, *blkcg_cgwb_list;
456 struct bdi_writeback *wb;
460 memcg = mem_cgroup_from_css(memcg_css);
461 blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
462 blkcg = css_to_blkcg(blkcg_css);
463 memcg_cgwb_list = &memcg->cgwb_list;
464 blkcg_cgwb_list = &blkcg->cgwb_list;
466 /* look up again under lock and discard on blkcg mismatch */
467 spin_lock_irqsave(&cgwb_lock, flags);
468 wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
469 if (wb && wb->blkcg_css != blkcg_css) {
473 spin_unlock_irqrestore(&cgwb_lock, flags);
477 /* need to create a new one */
478 wb = kmalloc(sizeof(*wb), gfp);
484 ret = wb_init(wb, bdi, gfp);
488 ret = percpu_ref_init(&wb->refcnt, cgwb_release, 0, gfp);
492 ret = fprop_local_init_percpu(&wb->memcg_completions, gfp);
496 wb->memcg_css = memcg_css;
497 wb->blkcg_css = blkcg_css;
498 INIT_LIST_HEAD(&wb->b_attached);
499 INIT_WORK(&wb->release_work, cgwb_release_workfn);
500 set_bit(WB_registered, &wb->state);
503 * The root wb determines the registered state of the whole bdi and
504 * memcg_cgwb_list and blkcg_cgwb_list's next pointers indicate
505 * whether they're still online. Don't link @wb if any is dead.
506 * See wb_memcg_offline() and wb_blkcg_offline().
509 spin_lock_irqsave(&cgwb_lock, flags);
510 if (test_bit(WB_registered, &bdi->wb.state) &&
511 blkcg_cgwb_list->next && memcg_cgwb_list->next) {
512 /* we might have raced another instance of this function */
513 ret = radix_tree_insert(&bdi->cgwb_tree, memcg_css->id, wb);
515 list_add_tail_rcu(&wb->bdi_node, &bdi->wb_list);
516 list_add(&wb->memcg_node, memcg_cgwb_list);
517 list_add(&wb->blkcg_node, blkcg_cgwb_list);
518 blkcg_pin_online(blkcg);
523 spin_unlock_irqrestore(&cgwb_lock, flags);
532 fprop_local_destroy_percpu(&wb->memcg_completions);
534 percpu_ref_exit(&wb->refcnt);
545 * wb_get_lookup - get wb for a given memcg
547 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
549 * Try to get the wb for @memcg_css on @bdi. The returned wb has its
550 * refcount incremented.
552 * This function uses css_get() on @memcg_css and thus expects its refcnt
553 * to be positive on invocation. IOW, rcu_read_lock() protection on
554 * @memcg_css isn't enough. try_get it before calling this function.
556 * A wb is keyed by its associated memcg. As blkcg implicitly enables
557 * memcg on the default hierarchy, memcg association is guaranteed to be
558 * more specific (equal or descendant to the associated blkcg) and thus can
559 * identify both the memcg and blkcg associations.
561 * Because the blkcg associated with a memcg may change as blkcg is enabled
562 * and disabled closer to root in the hierarchy, each wb keeps track of
563 * both the memcg and blkcg associated with it and verifies the blkcg on
564 * each lookup. On mismatch, the existing wb is discarded and a new one is
567 struct bdi_writeback *wb_get_lookup(struct backing_dev_info *bdi,
568 struct cgroup_subsys_state *memcg_css)
570 struct bdi_writeback *wb;
572 if (!memcg_css->parent)
576 wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
578 struct cgroup_subsys_state *blkcg_css;
580 /* see whether the blkcg association has changed */
581 blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
582 if (unlikely(wb->blkcg_css != blkcg_css || !wb_tryget(wb)))
592 * wb_get_create - get wb for a given memcg, create if necessary
594 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
595 * @gfp: allocation mask to use
597 * Try to get the wb for @memcg_css on @bdi. If it doesn't exist, try to
598 * create one. See wb_get_lookup() for more details.
600 struct bdi_writeback *wb_get_create(struct backing_dev_info *bdi,
601 struct cgroup_subsys_state *memcg_css,
604 struct bdi_writeback *wb;
608 if (!memcg_css->parent)
612 wb = wb_get_lookup(bdi, memcg_css);
613 } while (!wb && !cgwb_create(bdi, memcg_css, gfp));
618 static int cgwb_bdi_init(struct backing_dev_info *bdi)
622 INIT_RADIX_TREE(&bdi->cgwb_tree, GFP_ATOMIC);
623 mutex_init(&bdi->cgwb_release_mutex);
624 init_rwsem(&bdi->wb_switch_rwsem);
626 ret = wb_init(&bdi->wb, bdi, GFP_KERNEL);
628 bdi->wb.memcg_css = &root_mem_cgroup->css;
629 bdi->wb.blkcg_css = blkcg_root_css;
634 static void cgwb_bdi_unregister(struct backing_dev_info *bdi)
636 struct radix_tree_iter iter;
638 struct bdi_writeback *wb;
640 WARN_ON(test_bit(WB_registered, &bdi->wb.state));
642 spin_lock_irq(&cgwb_lock);
643 radix_tree_for_each_slot(slot, &bdi->cgwb_tree, &iter, 0)
645 spin_unlock_irq(&cgwb_lock);
647 mutex_lock(&bdi->cgwb_release_mutex);
648 spin_lock_irq(&cgwb_lock);
649 while (!list_empty(&bdi->wb_list)) {
650 wb = list_first_entry(&bdi->wb_list, struct bdi_writeback,
652 spin_unlock_irq(&cgwb_lock);
654 spin_lock_irq(&cgwb_lock);
656 spin_unlock_irq(&cgwb_lock);
657 mutex_unlock(&bdi->cgwb_release_mutex);
661 * cleanup_offline_cgwbs_workfn - try to release dying cgwbs
663 * Try to release dying cgwbs by switching attached inodes to the nearest
664 * living ancestor's writeback. Processed wbs are placed at the end
665 * of the list to guarantee the forward progress.
667 static void cleanup_offline_cgwbs_workfn(struct work_struct *work)
669 struct bdi_writeback *wb;
670 LIST_HEAD(processed);
672 spin_lock_irq(&cgwb_lock);
674 while (!list_empty(&offline_cgwbs)) {
675 wb = list_first_entry(&offline_cgwbs, struct bdi_writeback,
677 list_move(&wb->offline_node, &processed);
680 * If wb is dirty, cleaning up the writeback by switching
681 * attached inodes will result in an effective removal of any
682 * bandwidth restrictions, which isn't the goal. Instead,
683 * it can be postponed until the next time, when all io
684 * will be likely completed. If in the meantime some inodes
685 * will get re-dirtied, they should be eventually switched to
688 if (wb_has_dirty_io(wb))
694 spin_unlock_irq(&cgwb_lock);
695 while (cleanup_offline_cgwb(wb))
697 spin_lock_irq(&cgwb_lock);
702 if (!list_empty(&processed))
703 list_splice_tail(&processed, &offline_cgwbs);
705 spin_unlock_irq(&cgwb_lock);
709 * wb_memcg_offline - kill all wb's associated with a memcg being offlined
710 * @memcg: memcg being offlined
712 * Also prevents creation of any new wb's associated with @memcg.
714 void wb_memcg_offline(struct mem_cgroup *memcg)
716 struct list_head *memcg_cgwb_list = &memcg->cgwb_list;
717 struct bdi_writeback *wb, *next;
719 spin_lock_irq(&cgwb_lock);
720 list_for_each_entry_safe(wb, next, memcg_cgwb_list, memcg_node)
722 memcg_cgwb_list->next = NULL; /* prevent new wb's */
723 spin_unlock_irq(&cgwb_lock);
725 queue_work(system_unbound_wq, &cleanup_offline_cgwbs_work);
729 * wb_blkcg_offline - kill all wb's associated with a blkcg being offlined
730 * @blkcg: blkcg being offlined
732 * Also prevents creation of any new wb's associated with @blkcg.
734 void wb_blkcg_offline(struct blkcg *blkcg)
736 struct bdi_writeback *wb, *next;
738 spin_lock_irq(&cgwb_lock);
739 list_for_each_entry_safe(wb, next, &blkcg->cgwb_list, blkcg_node)
741 blkcg->cgwb_list.next = NULL; /* prevent new wb's */
742 spin_unlock_irq(&cgwb_lock);
745 static void cgwb_bdi_register(struct backing_dev_info *bdi)
747 spin_lock_irq(&cgwb_lock);
748 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
749 spin_unlock_irq(&cgwb_lock);
752 static int __init cgwb_init(void)
755 * There can be many concurrent release work items overwhelming
756 * system_wq. Put them in a separate wq and limit concurrency.
757 * There's no point in executing many of these in parallel.
759 cgwb_release_wq = alloc_workqueue("cgwb_release", 0, 1);
760 if (!cgwb_release_wq)
765 subsys_initcall(cgwb_init);
767 #else /* CONFIG_CGROUP_WRITEBACK */
769 static int cgwb_bdi_init(struct backing_dev_info *bdi)
771 return wb_init(&bdi->wb, bdi, GFP_KERNEL);
774 static void cgwb_bdi_unregister(struct backing_dev_info *bdi) { }
776 static void cgwb_bdi_register(struct backing_dev_info *bdi)
778 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
781 static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
783 list_del_rcu(&wb->bdi_node);
786 #endif /* CONFIG_CGROUP_WRITEBACK */
788 static int bdi_init(struct backing_dev_info *bdi)
794 kref_init(&bdi->refcnt);
796 bdi->max_ratio = 100;
797 bdi->max_prop_frac = FPROP_FRAC_BASE;
798 INIT_LIST_HEAD(&bdi->bdi_list);
799 INIT_LIST_HEAD(&bdi->wb_list);
800 init_waitqueue_head(&bdi->wb_waitq);
802 ret = cgwb_bdi_init(bdi);
807 struct backing_dev_info *bdi_alloc(int node_id)
809 struct backing_dev_info *bdi;
811 bdi = kzalloc_node(sizeof(*bdi), GFP_KERNEL, node_id);
819 bdi->capabilities = BDI_CAP_WRITEBACK | BDI_CAP_WRITEBACK_ACCT;
820 bdi->ra_pages = VM_READAHEAD_PAGES;
821 bdi->io_pages = VM_READAHEAD_PAGES;
822 timer_setup(&bdi->laptop_mode_wb_timer, laptop_mode_timer_fn, 0);
825 EXPORT_SYMBOL(bdi_alloc);
827 static struct rb_node **bdi_lookup_rb_node(u64 id, struct rb_node **parentp)
829 struct rb_node **p = &bdi_tree.rb_node;
830 struct rb_node *parent = NULL;
831 struct backing_dev_info *bdi;
833 lockdep_assert_held(&bdi_lock);
837 bdi = rb_entry(parent, struct backing_dev_info, rb_node);
841 else if (bdi->id < id)
853 * bdi_get_by_id - lookup and get bdi from its id
854 * @id: bdi id to lookup
856 * Find bdi matching @id and get it. Returns NULL if the matching bdi
857 * doesn't exist or is already unregistered.
859 struct backing_dev_info *bdi_get_by_id(u64 id)
861 struct backing_dev_info *bdi = NULL;
864 spin_lock_bh(&bdi_lock);
865 p = bdi_lookup_rb_node(id, NULL);
867 bdi = rb_entry(*p, struct backing_dev_info, rb_node);
870 spin_unlock_bh(&bdi_lock);
875 int bdi_register_va(struct backing_dev_info *bdi, const char *fmt, va_list args)
878 struct rb_node *parent, **p;
880 if (bdi->dev) /* The driver needs to use separate queues per device */
883 vsnprintf(bdi->dev_name, sizeof(bdi->dev_name), fmt, args);
884 dev = device_create(bdi_class, NULL, MKDEV(0, 0), bdi, bdi->dev_name);
888 cgwb_bdi_register(bdi);
891 bdi_debug_register(bdi, dev_name(dev));
892 set_bit(WB_registered, &bdi->wb.state);
894 spin_lock_bh(&bdi_lock);
896 bdi->id = ++bdi_id_cursor;
898 p = bdi_lookup_rb_node(bdi->id, &parent);
899 rb_link_node(&bdi->rb_node, parent, p);
900 rb_insert_color(&bdi->rb_node, &bdi_tree);
902 list_add_tail_rcu(&bdi->bdi_list, &bdi_list);
904 spin_unlock_bh(&bdi_lock);
906 trace_writeback_bdi_register(bdi);
910 int bdi_register(struct backing_dev_info *bdi, const char *fmt, ...)
916 ret = bdi_register_va(bdi, fmt, args);
920 EXPORT_SYMBOL(bdi_register);
922 void bdi_set_owner(struct backing_dev_info *bdi, struct device *owner)
924 WARN_ON_ONCE(bdi->owner);
930 * Remove bdi from bdi_list, and ensure that it is no longer visible
932 static void bdi_remove_from_list(struct backing_dev_info *bdi)
934 spin_lock_bh(&bdi_lock);
935 rb_erase(&bdi->rb_node, &bdi_tree);
936 list_del_rcu(&bdi->bdi_list);
937 spin_unlock_bh(&bdi_lock);
939 synchronize_rcu_expedited();
942 void bdi_unregister(struct backing_dev_info *bdi)
944 del_timer_sync(&bdi->laptop_mode_wb_timer);
946 /* make sure nobody finds us on the bdi_list anymore */
947 bdi_remove_from_list(bdi);
948 wb_shutdown(&bdi->wb);
949 cgwb_bdi_unregister(bdi);
952 bdi_debug_unregister(bdi);
953 device_unregister(bdi->dev);
958 put_device(bdi->owner);
963 static void release_bdi(struct kref *ref)
965 struct backing_dev_info *bdi =
966 container_of(ref, struct backing_dev_info, refcnt);
968 if (test_bit(WB_registered, &bdi->wb.state))
970 WARN_ON_ONCE(bdi->dev);
975 void bdi_put(struct backing_dev_info *bdi)
977 kref_put(&bdi->refcnt, release_bdi);
979 EXPORT_SYMBOL(bdi_put);
981 struct backing_dev_info *inode_to_bdi(struct inode *inode)
983 struct super_block *sb;
986 return &noop_backing_dev_info;
990 if (sb_is_blkdev_sb(sb))
991 return I_BDEV(inode)->bd_disk->bdi;
995 EXPORT_SYMBOL(inode_to_bdi);
997 const char *bdi_dev_name(struct backing_dev_info *bdi)
999 if (!bdi || !bdi->dev)
1000 return bdi_unknown_name;
1001 return bdi->dev_name;
1003 EXPORT_SYMBOL_GPL(bdi_dev_name);
1005 static wait_queue_head_t congestion_wqh[2] = {
1006 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[0]),
1007 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[1])
1009 static atomic_t nr_wb_congested[2];
1011 void clear_bdi_congested(struct backing_dev_info *bdi, int sync)
1013 wait_queue_head_t *wqh = &congestion_wqh[sync];
1014 enum wb_congested_state bit;
1016 bit = sync ? WB_sync_congested : WB_async_congested;
1017 if (test_and_clear_bit(bit, &bdi->wb.congested))
1018 atomic_dec(&nr_wb_congested[sync]);
1019 smp_mb__after_atomic();
1020 if (waitqueue_active(wqh))
1023 EXPORT_SYMBOL(clear_bdi_congested);
1025 void set_bdi_congested(struct backing_dev_info *bdi, int sync)
1027 enum wb_congested_state bit;
1029 bit = sync ? WB_sync_congested : WB_async_congested;
1030 if (!test_and_set_bit(bit, &bdi->wb.congested))
1031 atomic_inc(&nr_wb_congested[sync]);
1033 EXPORT_SYMBOL(set_bdi_congested);
1036 * congestion_wait - wait for a backing_dev to become uncongested
1037 * @sync: SYNC or ASYNC IO
1038 * @timeout: timeout in jiffies
1040 * Waits for up to @timeout jiffies for a backing_dev (any backing_dev) to exit
1041 * write congestion. If no backing_devs are congested then just wait for the
1042 * next write to be completed.
1044 long congestion_wait(int sync, long timeout)
1047 unsigned long start = jiffies;
1049 wait_queue_head_t *wqh = &congestion_wqh[sync];
1051 prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
1052 ret = io_schedule_timeout(timeout);
1053 finish_wait(wqh, &wait);
1055 trace_writeback_congestion_wait(jiffies_to_usecs(timeout),
1056 jiffies_to_usecs(jiffies - start));
1060 EXPORT_SYMBOL(congestion_wait);
1063 * wait_iff_congested - Conditionally wait for a backing_dev to become uncongested or a pgdat to complete writes
1064 * @sync: SYNC or ASYNC IO
1065 * @timeout: timeout in jiffies
1067 * In the event of a congested backing_dev (any backing_dev) this waits
1068 * for up to @timeout jiffies for either a BDI to exit congestion of the
1069 * given @sync queue or a write to complete.
1071 * The return value is 0 if the sleep is for the full timeout. Otherwise,
1072 * it is the number of jiffies that were still remaining when the function
1073 * returned. return_value == timeout implies the function did not sleep.
1075 long wait_iff_congested(int sync, long timeout)
1078 unsigned long start = jiffies;
1080 wait_queue_head_t *wqh = &congestion_wqh[sync];
1083 * If there is no congestion, yield if necessary instead
1084 * of sleeping on the congestion queue
1086 if (atomic_read(&nr_wb_congested[sync]) == 0) {
1089 /* In case we scheduled, work out time remaining */
1090 ret = timeout - (jiffies - start);
1097 /* Sleep until uncongested or a write happens */
1098 prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
1099 ret = io_schedule_timeout(timeout);
1100 finish_wait(wqh, &wait);
1103 trace_writeback_wait_iff_congested(jiffies_to_usecs(timeout),
1104 jiffies_to_usecs(jiffies - start));
1108 EXPORT_SYMBOL(wait_iff_congested);