1 // SPDX-License-Identifier: GPL-2.0-only
3 #include <linux/wait.h>
4 #include <linux/rbtree.h>
5 #include <linux/backing-dev.h>
6 #include <linux/kthread.h>
7 #include <linux/freezer.h>
9 #include <linux/pagemap.h>
11 #include <linux/sched/mm.h>
12 #include <linux/sched.h>
13 #include <linux/module.h>
14 #include <linux/writeback.h>
15 #include <linux/device.h>
16 #include <trace/events/writeback.h>
18 struct backing_dev_info noop_backing_dev_info;
19 EXPORT_SYMBOL_GPL(noop_backing_dev_info);
21 static struct class *bdi_class;
22 static const char *bdi_unknown_name = "(unknown)";
25 * bdi_lock protects bdi_tree and updates to bdi_list. bdi_list has RCU
26 * reader side locking.
28 DEFINE_SPINLOCK(bdi_lock);
29 static u64 bdi_id_cursor;
30 static struct rb_root bdi_tree = RB_ROOT;
33 /* bdi_wq serves all asynchronous writeback tasks */
34 struct workqueue_struct *bdi_wq;
36 #define K(x) ((x) << (PAGE_SHIFT - 10))
38 #ifdef CONFIG_DEBUG_FS
39 #include <linux/debugfs.h>
40 #include <linux/seq_file.h>
42 static struct dentry *bdi_debug_root;
44 static void bdi_debug_init(void)
46 bdi_debug_root = debugfs_create_dir("bdi", NULL);
49 static int bdi_debug_stats_show(struct seq_file *m, void *v)
51 struct backing_dev_info *bdi = m->private;
52 struct bdi_writeback *wb = &bdi->wb;
53 unsigned long background_thresh;
54 unsigned long dirty_thresh;
55 unsigned long wb_thresh;
56 unsigned long nr_dirty, nr_io, nr_more_io, nr_dirty_time;
59 nr_dirty = nr_io = nr_more_io = nr_dirty_time = 0;
60 spin_lock(&wb->list_lock);
61 list_for_each_entry(inode, &wb->b_dirty, i_io_list)
63 list_for_each_entry(inode, &wb->b_io, i_io_list)
65 list_for_each_entry(inode, &wb->b_more_io, i_io_list)
67 list_for_each_entry(inode, &wb->b_dirty_time, i_io_list)
68 if (inode->i_state & I_DIRTY_TIME)
70 spin_unlock(&wb->list_lock);
72 global_dirty_limits(&background_thresh, &dirty_thresh);
73 wb_thresh = wb_calc_thresh(wb, dirty_thresh);
76 "BdiWriteback: %10lu kB\n"
77 "BdiReclaimable: %10lu kB\n"
78 "BdiDirtyThresh: %10lu kB\n"
79 "DirtyThresh: %10lu kB\n"
80 "BackgroundThresh: %10lu kB\n"
81 "BdiDirtied: %10lu kB\n"
82 "BdiWritten: %10lu kB\n"
83 "BdiWriteBandwidth: %10lu kBps\n"
87 "b_dirty_time: %10lu\n"
90 (unsigned long) K(wb_stat(wb, WB_WRITEBACK)),
91 (unsigned long) K(wb_stat(wb, WB_RECLAIMABLE)),
95 (unsigned long) K(wb_stat(wb, WB_DIRTIED)),
96 (unsigned long) K(wb_stat(wb, WB_WRITTEN)),
97 (unsigned long) K(wb->write_bandwidth),
102 !list_empty(&bdi->bdi_list), bdi->wb.state);
106 DEFINE_SHOW_ATTRIBUTE(bdi_debug_stats);
108 static void bdi_debug_register(struct backing_dev_info *bdi, const char *name)
110 bdi->debug_dir = debugfs_create_dir(name, bdi_debug_root);
112 debugfs_create_file("stats", 0444, bdi->debug_dir, bdi,
113 &bdi_debug_stats_fops);
116 static void bdi_debug_unregister(struct backing_dev_info *bdi)
118 debugfs_remove_recursive(bdi->debug_dir);
121 static inline void bdi_debug_init(void)
124 static inline void bdi_debug_register(struct backing_dev_info *bdi,
128 static inline void bdi_debug_unregister(struct backing_dev_info *bdi)
133 static ssize_t read_ahead_kb_store(struct device *dev,
134 struct device_attribute *attr,
135 const char *buf, size_t count)
137 struct backing_dev_info *bdi = dev_get_drvdata(dev);
138 unsigned long read_ahead_kb;
141 ret = kstrtoul(buf, 10, &read_ahead_kb);
145 bdi->ra_pages = read_ahead_kb >> (PAGE_SHIFT - 10);
150 #define BDI_SHOW(name, expr) \
151 static ssize_t name##_show(struct device *dev, \
152 struct device_attribute *attr, char *buf) \
154 struct backing_dev_info *bdi = dev_get_drvdata(dev); \
156 return sysfs_emit(buf, "%lld\n", (long long)expr); \
158 static DEVICE_ATTR_RW(name);
160 BDI_SHOW(read_ahead_kb, K(bdi->ra_pages))
162 static ssize_t min_ratio_store(struct device *dev,
163 struct device_attribute *attr, const char *buf, size_t count)
165 struct backing_dev_info *bdi = dev_get_drvdata(dev);
169 ret = kstrtouint(buf, 10, &ratio);
173 ret = bdi_set_min_ratio(bdi, ratio);
179 BDI_SHOW(min_ratio, bdi->min_ratio)
181 static ssize_t max_ratio_store(struct device *dev,
182 struct device_attribute *attr, const char *buf, size_t count)
184 struct backing_dev_info *bdi = dev_get_drvdata(dev);
188 ret = kstrtouint(buf, 10, &ratio);
192 ret = bdi_set_max_ratio(bdi, ratio);
198 BDI_SHOW(max_ratio, bdi->max_ratio)
200 static ssize_t stable_pages_required_show(struct device *dev,
201 struct device_attribute *attr,
205 "the stable_pages_required attribute has been removed. Use the stable_writes queue attribute instead.\n");
206 return sysfs_emit(buf, "%d\n", 0);
208 static DEVICE_ATTR_RO(stable_pages_required);
210 static struct attribute *bdi_dev_attrs[] = {
211 &dev_attr_read_ahead_kb.attr,
212 &dev_attr_min_ratio.attr,
213 &dev_attr_max_ratio.attr,
214 &dev_attr_stable_pages_required.attr,
217 ATTRIBUTE_GROUPS(bdi_dev);
219 static __init int bdi_class_init(void)
221 bdi_class = class_create(THIS_MODULE, "bdi");
222 if (IS_ERR(bdi_class))
223 return PTR_ERR(bdi_class);
225 bdi_class->dev_groups = bdi_dev_groups;
230 postcore_initcall(bdi_class_init);
232 static int __init default_bdi_init(void)
234 bdi_wq = alloc_workqueue("writeback", WQ_MEM_RECLAIM | WQ_UNBOUND |
240 subsys_initcall(default_bdi_init);
243 * This function is used when the first inode for this wb is marked dirty. It
244 * wakes-up the corresponding bdi thread which should then take care of the
245 * periodic background write-out of dirty inodes. Since the write-out would
246 * starts only 'dirty_writeback_interval' centisecs from now anyway, we just
247 * set up a timer which wakes the bdi thread up later.
249 * Note, we wouldn't bother setting up the timer, but this function is on the
250 * fast-path (used by '__mark_inode_dirty()'), so we save few context switches
251 * by delaying the wake-up.
253 * We have to be careful not to postpone flush work if it is scheduled for
254 * earlier. Thus we use queue_delayed_work().
256 void wb_wakeup_delayed(struct bdi_writeback *wb)
258 unsigned long timeout;
260 timeout = msecs_to_jiffies(dirty_writeback_interval * 10);
261 spin_lock_irq(&wb->work_lock);
262 if (test_bit(WB_registered, &wb->state))
263 queue_delayed_work(bdi_wq, &wb->dwork, timeout);
264 spin_unlock_irq(&wb->work_lock);
267 static void wb_update_bandwidth_workfn(struct work_struct *work)
269 struct bdi_writeback *wb = container_of(to_delayed_work(work),
270 struct bdi_writeback, bw_dwork);
272 wb_update_bandwidth(wb);
276 * Initial write bandwidth: 100 MB/s
278 #define INIT_BW (100 << (20 - PAGE_SHIFT))
280 static int wb_init(struct bdi_writeback *wb, struct backing_dev_info *bdi,
285 memset(wb, 0, sizeof(*wb));
290 wb->last_old_flush = jiffies;
291 INIT_LIST_HEAD(&wb->b_dirty);
292 INIT_LIST_HEAD(&wb->b_io);
293 INIT_LIST_HEAD(&wb->b_more_io);
294 INIT_LIST_HEAD(&wb->b_dirty_time);
295 spin_lock_init(&wb->list_lock);
297 atomic_set(&wb->writeback_inodes, 0);
298 wb->bw_time_stamp = jiffies;
299 wb->balanced_dirty_ratelimit = INIT_BW;
300 wb->dirty_ratelimit = INIT_BW;
301 wb->write_bandwidth = INIT_BW;
302 wb->avg_write_bandwidth = INIT_BW;
304 spin_lock_init(&wb->work_lock);
305 INIT_LIST_HEAD(&wb->work_list);
306 INIT_DELAYED_WORK(&wb->dwork, wb_workfn);
307 INIT_DELAYED_WORK(&wb->bw_dwork, wb_update_bandwidth_workfn);
308 wb->dirty_sleep = jiffies;
310 err = fprop_local_init_percpu(&wb->completions, gfp);
314 for (i = 0; i < NR_WB_STAT_ITEMS; i++) {
315 err = percpu_counter_init(&wb->stat[i], 0, gfp);
317 goto out_destroy_stat;
324 percpu_counter_destroy(&wb->stat[i]);
325 fprop_local_destroy_percpu(&wb->completions);
332 static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb);
335 * Remove bdi from the global list and shutdown any threads we have running
337 static void wb_shutdown(struct bdi_writeback *wb)
339 /* Make sure nobody queues further work */
340 spin_lock_irq(&wb->work_lock);
341 if (!test_and_clear_bit(WB_registered, &wb->state)) {
342 spin_unlock_irq(&wb->work_lock);
345 spin_unlock_irq(&wb->work_lock);
347 cgwb_remove_from_bdi_list(wb);
349 * Drain work list and shutdown the delayed_work. !WB_registered
350 * tells wb_workfn() that @wb is dying and its work_list needs to
351 * be drained no matter what.
353 mod_delayed_work(bdi_wq, &wb->dwork, 0);
354 flush_delayed_work(&wb->dwork);
355 WARN_ON(!list_empty(&wb->work_list));
356 flush_delayed_work(&wb->bw_dwork);
359 static void wb_exit(struct bdi_writeback *wb)
363 WARN_ON(delayed_work_pending(&wb->dwork));
365 for (i = 0; i < NR_WB_STAT_ITEMS; i++)
366 percpu_counter_destroy(&wb->stat[i]);
368 fprop_local_destroy_percpu(&wb->completions);
369 if (wb != &wb->bdi->wb)
373 #ifdef CONFIG_CGROUP_WRITEBACK
375 #include <linux/memcontrol.h>
378 * cgwb_lock protects bdi->cgwb_tree, blkcg->cgwb_list, offline_cgwbs and
379 * memcg->cgwb_list. bdi->cgwb_tree is also RCU protected.
381 static DEFINE_SPINLOCK(cgwb_lock);
382 static struct workqueue_struct *cgwb_release_wq;
384 static LIST_HEAD(offline_cgwbs);
385 static void cleanup_offline_cgwbs_workfn(struct work_struct *work);
386 static DECLARE_WORK(cleanup_offline_cgwbs_work, cleanup_offline_cgwbs_workfn);
388 static void cgwb_release_workfn(struct work_struct *work)
390 struct bdi_writeback *wb = container_of(work, struct bdi_writeback,
392 struct blkcg *blkcg = css_to_blkcg(wb->blkcg_css);
394 mutex_lock(&wb->bdi->cgwb_release_mutex);
397 css_put(wb->memcg_css);
398 css_put(wb->blkcg_css);
399 mutex_unlock(&wb->bdi->cgwb_release_mutex);
401 /* triggers blkg destruction if no online users left */
402 blkcg_unpin_online(blkcg);
404 fprop_local_destroy_percpu(&wb->memcg_completions);
406 spin_lock_irq(&cgwb_lock);
407 list_del(&wb->offline_node);
408 spin_unlock_irq(&cgwb_lock);
410 percpu_ref_exit(&wb->refcnt);
412 WARN_ON_ONCE(!list_empty(&wb->b_attached));
416 static void cgwb_release(struct percpu_ref *refcnt)
418 struct bdi_writeback *wb = container_of(refcnt, struct bdi_writeback,
420 queue_work(cgwb_release_wq, &wb->release_work);
423 static void cgwb_kill(struct bdi_writeback *wb)
425 lockdep_assert_held(&cgwb_lock);
427 WARN_ON(!radix_tree_delete(&wb->bdi->cgwb_tree, wb->memcg_css->id));
428 list_del(&wb->memcg_node);
429 list_del(&wb->blkcg_node);
430 list_add(&wb->offline_node, &offline_cgwbs);
431 percpu_ref_kill(&wb->refcnt);
434 static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
436 spin_lock_irq(&cgwb_lock);
437 list_del_rcu(&wb->bdi_node);
438 spin_unlock_irq(&cgwb_lock);
441 static int cgwb_create(struct backing_dev_info *bdi,
442 struct cgroup_subsys_state *memcg_css, gfp_t gfp)
444 struct mem_cgroup *memcg;
445 struct cgroup_subsys_state *blkcg_css;
447 struct list_head *memcg_cgwb_list, *blkcg_cgwb_list;
448 struct bdi_writeback *wb;
452 memcg = mem_cgroup_from_css(memcg_css);
453 blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
454 blkcg = css_to_blkcg(blkcg_css);
455 memcg_cgwb_list = &memcg->cgwb_list;
456 blkcg_cgwb_list = &blkcg->cgwb_list;
458 /* look up again under lock and discard on blkcg mismatch */
459 spin_lock_irqsave(&cgwb_lock, flags);
460 wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
461 if (wb && wb->blkcg_css != blkcg_css) {
465 spin_unlock_irqrestore(&cgwb_lock, flags);
469 /* need to create a new one */
470 wb = kmalloc(sizeof(*wb), gfp);
476 ret = wb_init(wb, bdi, gfp);
480 ret = percpu_ref_init(&wb->refcnt, cgwb_release, 0, gfp);
484 ret = fprop_local_init_percpu(&wb->memcg_completions, gfp);
488 wb->memcg_css = memcg_css;
489 wb->blkcg_css = blkcg_css;
490 INIT_LIST_HEAD(&wb->b_attached);
491 INIT_WORK(&wb->release_work, cgwb_release_workfn);
492 set_bit(WB_registered, &wb->state);
495 * The root wb determines the registered state of the whole bdi and
496 * memcg_cgwb_list and blkcg_cgwb_list's next pointers indicate
497 * whether they're still online. Don't link @wb if any is dead.
498 * See wb_memcg_offline() and wb_blkcg_offline().
501 spin_lock_irqsave(&cgwb_lock, flags);
502 if (test_bit(WB_registered, &bdi->wb.state) &&
503 blkcg_cgwb_list->next && memcg_cgwb_list->next) {
504 /* we might have raced another instance of this function */
505 ret = radix_tree_insert(&bdi->cgwb_tree, memcg_css->id, wb);
507 list_add_tail_rcu(&wb->bdi_node, &bdi->wb_list);
508 list_add(&wb->memcg_node, memcg_cgwb_list);
509 list_add(&wb->blkcg_node, blkcg_cgwb_list);
510 blkcg_pin_online(blkcg);
515 spin_unlock_irqrestore(&cgwb_lock, flags);
524 fprop_local_destroy_percpu(&wb->memcg_completions);
526 percpu_ref_exit(&wb->refcnt);
537 * wb_get_lookup - get wb for a given memcg
539 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
541 * Try to get the wb for @memcg_css on @bdi. The returned wb has its
542 * refcount incremented.
544 * This function uses css_get() on @memcg_css and thus expects its refcnt
545 * to be positive on invocation. IOW, rcu_read_lock() protection on
546 * @memcg_css isn't enough. try_get it before calling this function.
548 * A wb is keyed by its associated memcg. As blkcg implicitly enables
549 * memcg on the default hierarchy, memcg association is guaranteed to be
550 * more specific (equal or descendant to the associated blkcg) and thus can
551 * identify both the memcg and blkcg associations.
553 * Because the blkcg associated with a memcg may change as blkcg is enabled
554 * and disabled closer to root in the hierarchy, each wb keeps track of
555 * both the memcg and blkcg associated with it and verifies the blkcg on
556 * each lookup. On mismatch, the existing wb is discarded and a new one is
559 struct bdi_writeback *wb_get_lookup(struct backing_dev_info *bdi,
560 struct cgroup_subsys_state *memcg_css)
562 struct bdi_writeback *wb;
564 if (!memcg_css->parent)
568 wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
570 struct cgroup_subsys_state *blkcg_css;
572 /* see whether the blkcg association has changed */
573 blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
574 if (unlikely(wb->blkcg_css != blkcg_css || !wb_tryget(wb)))
584 * wb_get_create - get wb for a given memcg, create if necessary
586 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
587 * @gfp: allocation mask to use
589 * Try to get the wb for @memcg_css on @bdi. If it doesn't exist, try to
590 * create one. See wb_get_lookup() for more details.
592 struct bdi_writeback *wb_get_create(struct backing_dev_info *bdi,
593 struct cgroup_subsys_state *memcg_css,
596 struct bdi_writeback *wb;
600 if (!memcg_css->parent)
604 wb = wb_get_lookup(bdi, memcg_css);
605 } while (!wb && !cgwb_create(bdi, memcg_css, gfp));
610 static int cgwb_bdi_init(struct backing_dev_info *bdi)
614 INIT_RADIX_TREE(&bdi->cgwb_tree, GFP_ATOMIC);
615 mutex_init(&bdi->cgwb_release_mutex);
616 init_rwsem(&bdi->wb_switch_rwsem);
618 ret = wb_init(&bdi->wb, bdi, GFP_KERNEL);
620 bdi->wb.memcg_css = &root_mem_cgroup->css;
621 bdi->wb.blkcg_css = blkcg_root_css;
626 static void cgwb_bdi_unregister(struct backing_dev_info *bdi)
628 struct radix_tree_iter iter;
630 struct bdi_writeback *wb;
632 WARN_ON(test_bit(WB_registered, &bdi->wb.state));
634 spin_lock_irq(&cgwb_lock);
635 radix_tree_for_each_slot(slot, &bdi->cgwb_tree, &iter, 0)
637 spin_unlock_irq(&cgwb_lock);
639 mutex_lock(&bdi->cgwb_release_mutex);
640 spin_lock_irq(&cgwb_lock);
641 while (!list_empty(&bdi->wb_list)) {
642 wb = list_first_entry(&bdi->wb_list, struct bdi_writeback,
644 spin_unlock_irq(&cgwb_lock);
646 spin_lock_irq(&cgwb_lock);
648 spin_unlock_irq(&cgwb_lock);
649 mutex_unlock(&bdi->cgwb_release_mutex);
653 * cleanup_offline_cgwbs_workfn - try to release dying cgwbs
655 * Try to release dying cgwbs by switching attached inodes to the nearest
656 * living ancestor's writeback. Processed wbs are placed at the end
657 * of the list to guarantee the forward progress.
659 static void cleanup_offline_cgwbs_workfn(struct work_struct *work)
661 struct bdi_writeback *wb;
662 LIST_HEAD(processed);
664 spin_lock_irq(&cgwb_lock);
666 while (!list_empty(&offline_cgwbs)) {
667 wb = list_first_entry(&offline_cgwbs, struct bdi_writeback,
669 list_move(&wb->offline_node, &processed);
672 * If wb is dirty, cleaning up the writeback by switching
673 * attached inodes will result in an effective removal of any
674 * bandwidth restrictions, which isn't the goal. Instead,
675 * it can be postponed until the next time, when all io
676 * will be likely completed. If in the meantime some inodes
677 * will get re-dirtied, they should be eventually switched to
680 if (wb_has_dirty_io(wb))
686 spin_unlock_irq(&cgwb_lock);
687 while (cleanup_offline_cgwb(wb))
689 spin_lock_irq(&cgwb_lock);
694 if (!list_empty(&processed))
695 list_splice_tail(&processed, &offline_cgwbs);
697 spin_unlock_irq(&cgwb_lock);
701 * wb_memcg_offline - kill all wb's associated with a memcg being offlined
702 * @memcg: memcg being offlined
704 * Also prevents creation of any new wb's associated with @memcg.
706 void wb_memcg_offline(struct mem_cgroup *memcg)
708 struct list_head *memcg_cgwb_list = &memcg->cgwb_list;
709 struct bdi_writeback *wb, *next;
711 spin_lock_irq(&cgwb_lock);
712 list_for_each_entry_safe(wb, next, memcg_cgwb_list, memcg_node)
714 memcg_cgwb_list->next = NULL; /* prevent new wb's */
715 spin_unlock_irq(&cgwb_lock);
717 queue_work(system_unbound_wq, &cleanup_offline_cgwbs_work);
721 * wb_blkcg_offline - kill all wb's associated with a blkcg being offlined
722 * @blkcg: blkcg being offlined
724 * Also prevents creation of any new wb's associated with @blkcg.
726 void wb_blkcg_offline(struct blkcg *blkcg)
728 struct bdi_writeback *wb, *next;
730 spin_lock_irq(&cgwb_lock);
731 list_for_each_entry_safe(wb, next, &blkcg->cgwb_list, blkcg_node)
733 blkcg->cgwb_list.next = NULL; /* prevent new wb's */
734 spin_unlock_irq(&cgwb_lock);
737 static void cgwb_bdi_register(struct backing_dev_info *bdi)
739 spin_lock_irq(&cgwb_lock);
740 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
741 spin_unlock_irq(&cgwb_lock);
744 static int __init cgwb_init(void)
747 * There can be many concurrent release work items overwhelming
748 * system_wq. Put them in a separate wq and limit concurrency.
749 * There's no point in executing many of these in parallel.
751 cgwb_release_wq = alloc_workqueue("cgwb_release", 0, 1);
752 if (!cgwb_release_wq)
757 subsys_initcall(cgwb_init);
759 #else /* CONFIG_CGROUP_WRITEBACK */
761 static int cgwb_bdi_init(struct backing_dev_info *bdi)
763 return wb_init(&bdi->wb, bdi, GFP_KERNEL);
766 static void cgwb_bdi_unregister(struct backing_dev_info *bdi) { }
768 static void cgwb_bdi_register(struct backing_dev_info *bdi)
770 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
773 static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
775 list_del_rcu(&wb->bdi_node);
778 #endif /* CONFIG_CGROUP_WRITEBACK */
780 int bdi_init(struct backing_dev_info *bdi)
786 kref_init(&bdi->refcnt);
788 bdi->max_ratio = 100;
789 bdi->max_prop_frac = FPROP_FRAC_BASE;
790 INIT_LIST_HEAD(&bdi->bdi_list);
791 INIT_LIST_HEAD(&bdi->wb_list);
792 init_waitqueue_head(&bdi->wb_waitq);
794 ret = cgwb_bdi_init(bdi);
799 struct backing_dev_info *bdi_alloc(int node_id)
801 struct backing_dev_info *bdi;
803 bdi = kzalloc_node(sizeof(*bdi), GFP_KERNEL, node_id);
811 bdi->capabilities = BDI_CAP_WRITEBACK | BDI_CAP_WRITEBACK_ACCT;
812 bdi->ra_pages = VM_READAHEAD_PAGES;
813 bdi->io_pages = VM_READAHEAD_PAGES;
814 timer_setup(&bdi->laptop_mode_wb_timer, laptop_mode_timer_fn, 0);
817 EXPORT_SYMBOL(bdi_alloc);
819 static struct rb_node **bdi_lookup_rb_node(u64 id, struct rb_node **parentp)
821 struct rb_node **p = &bdi_tree.rb_node;
822 struct rb_node *parent = NULL;
823 struct backing_dev_info *bdi;
825 lockdep_assert_held(&bdi_lock);
829 bdi = rb_entry(parent, struct backing_dev_info, rb_node);
833 else if (bdi->id < id)
845 * bdi_get_by_id - lookup and get bdi from its id
846 * @id: bdi id to lookup
848 * Find bdi matching @id and get it. Returns NULL if the matching bdi
849 * doesn't exist or is already unregistered.
851 struct backing_dev_info *bdi_get_by_id(u64 id)
853 struct backing_dev_info *bdi = NULL;
856 spin_lock_bh(&bdi_lock);
857 p = bdi_lookup_rb_node(id, NULL);
859 bdi = rb_entry(*p, struct backing_dev_info, rb_node);
862 spin_unlock_bh(&bdi_lock);
867 int bdi_register_va(struct backing_dev_info *bdi, const char *fmt, va_list args)
870 struct rb_node *parent, **p;
872 if (bdi->dev) /* The driver needs to use separate queues per device */
875 vsnprintf(bdi->dev_name, sizeof(bdi->dev_name), fmt, args);
876 dev = device_create(bdi_class, NULL, MKDEV(0, 0), bdi, bdi->dev_name);
880 cgwb_bdi_register(bdi);
883 bdi_debug_register(bdi, dev_name(dev));
884 set_bit(WB_registered, &bdi->wb.state);
886 spin_lock_bh(&bdi_lock);
888 bdi->id = ++bdi_id_cursor;
890 p = bdi_lookup_rb_node(bdi->id, &parent);
891 rb_link_node(&bdi->rb_node, parent, p);
892 rb_insert_color(&bdi->rb_node, &bdi_tree);
894 list_add_tail_rcu(&bdi->bdi_list, &bdi_list);
896 spin_unlock_bh(&bdi_lock);
898 trace_writeback_bdi_register(bdi);
902 int bdi_register(struct backing_dev_info *bdi, const char *fmt, ...)
908 ret = bdi_register_va(bdi, fmt, args);
912 EXPORT_SYMBOL(bdi_register);
914 void bdi_set_owner(struct backing_dev_info *bdi, struct device *owner)
916 WARN_ON_ONCE(bdi->owner);
922 * Remove bdi from bdi_list, and ensure that it is no longer visible
924 static void bdi_remove_from_list(struct backing_dev_info *bdi)
926 spin_lock_bh(&bdi_lock);
927 rb_erase(&bdi->rb_node, &bdi_tree);
928 list_del_rcu(&bdi->bdi_list);
929 spin_unlock_bh(&bdi_lock);
931 synchronize_rcu_expedited();
934 void bdi_unregister(struct backing_dev_info *bdi)
936 del_timer_sync(&bdi->laptop_mode_wb_timer);
938 /* make sure nobody finds us on the bdi_list anymore */
939 bdi_remove_from_list(bdi);
940 wb_shutdown(&bdi->wb);
941 cgwb_bdi_unregister(bdi);
944 * If this BDI's min ratio has been set, use bdi_set_min_ratio() to
945 * update the global bdi_min_ratio.
948 bdi_set_min_ratio(bdi, 0);
951 bdi_debug_unregister(bdi);
952 device_unregister(bdi->dev);
957 put_device(bdi->owner);
962 static void release_bdi(struct kref *ref)
964 struct backing_dev_info *bdi =
965 container_of(ref, struct backing_dev_info, refcnt);
967 if (test_bit(WB_registered, &bdi->wb.state))
969 WARN_ON_ONCE(bdi->dev);
974 void bdi_put(struct backing_dev_info *bdi)
976 kref_put(&bdi->refcnt, release_bdi);
978 EXPORT_SYMBOL(bdi_put);
980 const char *bdi_dev_name(struct backing_dev_info *bdi)
982 if (!bdi || !bdi->dev)
983 return bdi_unknown_name;
984 return bdi->dev_name;
986 EXPORT_SYMBOL_GPL(bdi_dev_name);
988 static wait_queue_head_t congestion_wqh[2] = {
989 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[0]),
990 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[1])
992 static atomic_t nr_wb_congested[2];
994 void clear_bdi_congested(struct backing_dev_info *bdi, int sync)
996 wait_queue_head_t *wqh = &congestion_wqh[sync];
997 enum wb_congested_state bit;
999 bit = sync ? WB_sync_congested : WB_async_congested;
1000 if (test_and_clear_bit(bit, &bdi->wb.congested))
1001 atomic_dec(&nr_wb_congested[sync]);
1002 smp_mb__after_atomic();
1003 if (waitqueue_active(wqh))
1006 EXPORT_SYMBOL(clear_bdi_congested);
1008 void set_bdi_congested(struct backing_dev_info *bdi, int sync)
1010 enum wb_congested_state bit;
1012 bit = sync ? WB_sync_congested : WB_async_congested;
1013 if (!test_and_set_bit(bit, &bdi->wb.congested))
1014 atomic_inc(&nr_wb_congested[sync]);
1016 EXPORT_SYMBOL(set_bdi_congested);
1019 * congestion_wait - wait for a backing_dev to become uncongested
1020 * @sync: SYNC or ASYNC IO
1021 * @timeout: timeout in jiffies
1023 * Waits for up to @timeout jiffies for a backing_dev (any backing_dev) to exit
1024 * write congestion. If no backing_devs are congested then just wait for the
1025 * next write to be completed.
1027 long congestion_wait(int sync, long timeout)
1030 unsigned long start = jiffies;
1032 wait_queue_head_t *wqh = &congestion_wqh[sync];
1034 prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
1035 ret = io_schedule_timeout(timeout);
1036 finish_wait(wqh, &wait);
1038 trace_writeback_congestion_wait(jiffies_to_usecs(timeout),
1039 jiffies_to_usecs(jiffies - start));
1043 EXPORT_SYMBOL(congestion_wait);
1046 * wait_iff_congested - Conditionally wait for a backing_dev to become uncongested or a pgdat to complete writes
1047 * @sync: SYNC or ASYNC IO
1048 * @timeout: timeout in jiffies
1050 * In the event of a congested backing_dev (any backing_dev) this waits
1051 * for up to @timeout jiffies for either a BDI to exit congestion of the
1052 * given @sync queue or a write to complete.
1054 * The return value is 0 if the sleep is for the full timeout. Otherwise,
1055 * it is the number of jiffies that were still remaining when the function
1056 * returned. return_value == timeout implies the function did not sleep.
1058 long wait_iff_congested(int sync, long timeout)
1061 unsigned long start = jiffies;
1063 wait_queue_head_t *wqh = &congestion_wqh[sync];
1066 * If there is no congestion, yield if necessary instead
1067 * of sleeping on the congestion queue
1069 if (atomic_read(&nr_wb_congested[sync]) == 0) {
1072 /* In case we scheduled, work out time remaining */
1073 ret = timeout - (jiffies - start);
1080 /* Sleep until uncongested or a write happens */
1081 prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
1082 ret = io_schedule_timeout(timeout);
1083 finish_wait(wqh, &wait);
1086 trace_writeback_wait_iff_congested(jiffies_to_usecs(timeout),
1087 jiffies_to_usecs(jiffies - start));
1091 EXPORT_SYMBOL(wait_iff_congested);