blob: 2dac3be61271278c60ec9cdbb128d40a9831ce86 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Andrew Morton3fcfab12006-10-19 23:28:16 -07002
3#include <linux/wait.h>
Tejun Heo34f8fe52019-08-26 09:06:53 -07004#include <linux/rbtree.h>
Andrew Morton3fcfab12006-10-19 23:28:16 -07005#include <linux/backing-dev.h>
Jens Axboe03ba3782009-09-09 09:08:54 +02006#include <linux/kthread.h>
7#include <linux/freezer.h>
Andrew Morton3fcfab12006-10-19 23:28:16 -07008#include <linux/fs.h>
Jens Axboe26160152009-03-17 09:35:06 +01009#include <linux/pagemap.h>
Jens Axboe03ba3782009-09-09 09:08:54 +020010#include <linux/mm.h>
Andrew Morton3fcfab12006-10-19 23:28:16 -070011#include <linux/sched.h>
12#include <linux/module.h>
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070013#include <linux/writeback.h>
14#include <linux/device.h>
Dave Chinner455b2862010-07-07 13:24:06 +100015#include <trace/events/writeback.h>
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070016
Jörn Engel5129a462010-04-25 08:54:42 +020017struct backing_dev_info noop_backing_dev_info = {
Jan Kara976e48f2010-09-21 11:48:55 +020018 .capabilities = BDI_CAP_NO_ACCT_AND_WRITEBACK,
Jörn Engel5129a462010-04-25 08:54:42 +020019};
Tejun Heoa212b102015-05-22 17:13:33 -040020EXPORT_SYMBOL_GPL(noop_backing_dev_info);
Jörn Engel5129a462010-04-25 08:54:42 +020021
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070022static struct class *bdi_class;
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +020023static const char *bdi_unknown_name = "(unknown)";
Jens Axboecfc4ba52009-09-14 13:12:40 +020024
25/*
Tejun Heo34f8fe52019-08-26 09:06:53 -070026 * bdi_lock protects bdi_tree and updates to bdi_list. bdi_list has RCU
27 * reader side locking.
Jens Axboecfc4ba52009-09-14 13:12:40 +020028 */
Jens Axboe03ba3782009-09-09 09:08:54 +020029DEFINE_SPINLOCK(bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -070030static u64 bdi_id_cursor;
31static struct rb_root bdi_tree = RB_ROOT;
Jens Axboe66f3b8e2009-09-02 09:19:46 +020032LIST_HEAD(bdi_list);
Jens Axboe03ba3782009-09-09 09:08:54 +020033
Tejun Heo839a8e82013-04-01 19:08:06 -070034/* bdi_wq serves all asynchronous writeback tasks */
35struct workqueue_struct *bdi_wq;
36
Miklos Szeredi76f14182008-04-30 00:54:36 -070037#ifdef CONFIG_DEBUG_FS
38#include <linux/debugfs.h>
39#include <linux/seq_file.h>
40
41static struct dentry *bdi_debug_root;
42
43static void bdi_debug_init(void)
44{
45 bdi_debug_root = debugfs_create_dir("bdi", NULL);
46}
47
48static int bdi_debug_stats_show(struct seq_file *m, void *v)
49{
50 struct backing_dev_info *bdi = m->private;
Christoph Hellwigc1955ce2010-06-19 23:08:06 +020051 struct bdi_writeback *wb = &bdi->wb;
David Rientjes364aeb22009-01-06 14:39:29 -080052 unsigned long background_thresh;
53 unsigned long dirty_thresh;
Tejun Heo0d960a32015-05-22 18:23:19 -040054 unsigned long wb_thresh;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050055 unsigned long nr_dirty, nr_io, nr_more_io, nr_dirty_time;
Jens Axboef09b00d2009-05-25 09:08:21 +020056 struct inode *inode;
57
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050058 nr_dirty = nr_io = nr_more_io = nr_dirty_time = 0;
Christoph Hellwigf758eea2011-04-21 18:19:44 -060059 spin_lock(&wb->list_lock);
Dave Chinnerc7f54082015-03-04 14:07:22 -050060 list_for_each_entry(inode, &wb->b_dirty, i_io_list)
Christoph Hellwigc1955ce2010-06-19 23:08:06 +020061 nr_dirty++;
Dave Chinnerc7f54082015-03-04 14:07:22 -050062 list_for_each_entry(inode, &wb->b_io, i_io_list)
Christoph Hellwigc1955ce2010-06-19 23:08:06 +020063 nr_io++;
Dave Chinnerc7f54082015-03-04 14:07:22 -050064 list_for_each_entry(inode, &wb->b_more_io, i_io_list)
Christoph Hellwigc1955ce2010-06-19 23:08:06 +020065 nr_more_io++;
Dave Chinnerc7f54082015-03-04 14:07:22 -050066 list_for_each_entry(inode, &wb->b_dirty_time, i_io_list)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050067 if (inode->i_state & I_DIRTY_TIME)
68 nr_dirty_time++;
Christoph Hellwigf758eea2011-04-21 18:19:44 -060069 spin_unlock(&wb->list_lock);
Miklos Szeredi76f14182008-04-30 00:54:36 -070070
Wu Fengguang16c40422010-08-11 14:17:39 -070071 global_dirty_limits(&background_thresh, &dirty_thresh);
Tejun Heo0d960a32015-05-22 18:23:19 -040072 wb_thresh = wb_calc_thresh(wb, dirty_thresh);
Miklos Szeredi76f14182008-04-30 00:54:36 -070073
74#define K(x) ((x) << (PAGE_SHIFT - 10))
75 seq_printf(m,
Wu Fengguang00821b02010-08-29 11:28:45 -060076 "BdiWriteback: %10lu kB\n"
77 "BdiReclaimable: %10lu kB\n"
78 "BdiDirtyThresh: %10lu kB\n"
79 "DirtyThresh: %10lu kB\n"
80 "BackgroundThresh: %10lu kB\n"
Wu Fengguangc8e28ce2011-01-23 10:07:47 -060081 "BdiDirtied: %10lu kB\n"
Wu Fengguang00821b02010-08-29 11:28:45 -060082 "BdiWritten: %10lu kB\n"
83 "BdiWriteBandwidth: %10lu kBps\n"
84 "b_dirty: %10lu\n"
85 "b_io: %10lu\n"
86 "b_more_io: %10lu\n"
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050087 "b_dirty_time: %10lu\n"
Wu Fengguang00821b02010-08-29 11:28:45 -060088 "bdi_list: %10u\n"
89 "state: %10lx\n",
Tejun Heo93f78d82015-05-22 17:13:27 -040090 (unsigned long) K(wb_stat(wb, WB_WRITEBACK)),
91 (unsigned long) K(wb_stat(wb, WB_RECLAIMABLE)),
Tejun Heo0d960a32015-05-22 18:23:19 -040092 K(wb_thresh),
Jan Karaf7d2b1e2010-12-08 22:44:24 -060093 K(dirty_thresh),
94 K(background_thresh),
Tejun Heo93f78d82015-05-22 17:13:27 -040095 (unsigned long) K(wb_stat(wb, WB_DIRTIED)),
96 (unsigned long) K(wb_stat(wb, WB_WRITTEN)),
Tejun Heoa88a3412015-05-22 17:13:28 -040097 (unsigned long) K(wb->write_bandwidth),
Jan Karaf7d2b1e2010-12-08 22:44:24 -060098 nr_dirty,
99 nr_io,
100 nr_more_io,
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500101 nr_dirty_time,
Tejun Heo44522262015-05-22 17:13:26 -0400102 !list_empty(&bdi->bdi_list), bdi->wb.state);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700103#undef K
104
105 return 0;
106}
Andy Shevchenko5ad35092018-04-05 16:23:16 -0700107DEFINE_SHOW_ATTRIBUTE(bdi_debug_stats);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700108
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100109static void bdi_debug_register(struct backing_dev_info *bdi, const char *name)
Miklos Szeredi76f14182008-04-30 00:54:36 -0700110{
111 bdi->debug_dir = debugfs_create_dir(name, bdi_debug_root);
weiping zhang97f07692017-10-31 18:37:54 +0800112
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100113 debugfs_create_file("stats", 0444, bdi->debug_dir, bdi,
114 &bdi_debug_stats_fops);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700115}
116
117static void bdi_debug_unregister(struct backing_dev_info *bdi)
118{
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100119 debugfs_remove_recursive(bdi->debug_dir);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700120}
121#else
122static inline void bdi_debug_init(void)
123{
124}
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100125static inline void bdi_debug_register(struct backing_dev_info *bdi,
Miklos Szeredi76f14182008-04-30 00:54:36 -0700126 const char *name)
127{
128}
129static inline void bdi_debug_unregister(struct backing_dev_info *bdi)
130{
131}
132#endif
133
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700134static ssize_t read_ahead_kb_store(struct device *dev,
135 struct device_attribute *attr,
136 const char *buf, size_t count)
137{
138 struct backing_dev_info *bdi = dev_get_drvdata(dev);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700139 unsigned long read_ahead_kb;
Namjae Jeon7034ed12012-08-25 16:57:27 +0800140 ssize_t ret;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700141
Namjae Jeon7034ed12012-08-25 16:57:27 +0800142 ret = kstrtoul(buf, 10, &read_ahead_kb);
143 if (ret < 0)
144 return ret;
145
146 bdi->ra_pages = read_ahead_kb >> (PAGE_SHIFT - 10);
147
148 return count;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700149}
150
151#define K(pages) ((pages) << (PAGE_SHIFT - 10))
152
153#define BDI_SHOW(name, expr) \
154static ssize_t name##_show(struct device *dev, \
155 struct device_attribute *attr, char *page) \
156{ \
157 struct backing_dev_info *bdi = dev_get_drvdata(dev); \
158 \
159 return snprintf(page, PAGE_SIZE-1, "%lld\n", (long long)expr); \
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700160} \
161static DEVICE_ATTR_RW(name);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700162
163BDI_SHOW(read_ahead_kb, K(bdi->ra_pages))
164
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700165static ssize_t min_ratio_store(struct device *dev,
166 struct device_attribute *attr, const char *buf, size_t count)
167{
168 struct backing_dev_info *bdi = dev_get_drvdata(dev);
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700169 unsigned int ratio;
Namjae Jeon7034ed12012-08-25 16:57:27 +0800170 ssize_t ret;
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700171
Namjae Jeon7034ed12012-08-25 16:57:27 +0800172 ret = kstrtouint(buf, 10, &ratio);
173 if (ret < 0)
174 return ret;
175
176 ret = bdi_set_min_ratio(bdi, ratio);
177 if (!ret)
178 ret = count;
179
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700180 return ret;
181}
182BDI_SHOW(min_ratio, bdi->min_ratio)
183
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700184static ssize_t max_ratio_store(struct device *dev,
185 struct device_attribute *attr, const char *buf, size_t count)
186{
187 struct backing_dev_info *bdi = dev_get_drvdata(dev);
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700188 unsigned int ratio;
Namjae Jeon7034ed12012-08-25 16:57:27 +0800189 ssize_t ret;
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700190
Namjae Jeon7034ed12012-08-25 16:57:27 +0800191 ret = kstrtouint(buf, 10, &ratio);
192 if (ret < 0)
193 return ret;
194
195 ret = bdi_set_max_ratio(bdi, ratio);
196 if (!ret)
197 ret = count;
198
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700199 return ret;
200}
201BDI_SHOW(max_ratio, bdi->max_ratio)
202
Darrick J. Wong7d311cd2013-02-21 16:42:48 -0800203static ssize_t stable_pages_required_show(struct device *dev,
204 struct device_attribute *attr,
205 char *page)
206{
207 struct backing_dev_info *bdi = dev_get_drvdata(dev);
208
209 return snprintf(page, PAGE_SIZE-1, "%d\n",
210 bdi_cap_stable_pages_required(bdi) ? 1 : 0);
211}
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700212static DEVICE_ATTR_RO(stable_pages_required);
Darrick J. Wong7d311cd2013-02-21 16:42:48 -0800213
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700214static struct attribute *bdi_dev_attrs[] = {
215 &dev_attr_read_ahead_kb.attr,
216 &dev_attr_min_ratio.attr,
217 &dev_attr_max_ratio.attr,
218 &dev_attr_stable_pages_required.attr,
219 NULL,
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700220};
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700221ATTRIBUTE_GROUPS(bdi_dev);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700222
223static __init int bdi_class_init(void)
224{
225 bdi_class = class_create(THIS_MODULE, "bdi");
Anton Blanchard14421452010-04-02 09:46:55 +0200226 if (IS_ERR(bdi_class))
227 return PTR_ERR(bdi_class);
228
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700229 bdi_class->dev_groups = bdi_dev_groups;
Miklos Szeredi76f14182008-04-30 00:54:36 -0700230 bdi_debug_init();
Jan Karad03f6cd2017-02-02 15:56:51 +0100231
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700232 return 0;
233}
Miklos Szeredi76f14182008-04-30 00:54:36 -0700234postcore_initcall(bdi_class_init);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700235
Jan Kara2e82b842017-04-12 12:24:48 +0200236static int bdi_init(struct backing_dev_info *bdi);
237
Jens Axboe26160152009-03-17 09:35:06 +0100238static int __init default_bdi_init(void)
239{
240 int err;
241
Mika Westerberga2b90f12019-10-04 13:00:24 +0300242 bdi_wq = alloc_workqueue("writeback", WQ_MEM_RECLAIM | WQ_UNBOUND |
243 WQ_SYSFS, 0);
Tejun Heo839a8e82013-04-01 19:08:06 -0700244 if (!bdi_wq)
245 return -ENOMEM;
246
Jan Kara976e48f2010-09-21 11:48:55 +0200247 err = bdi_init(&noop_backing_dev_info);
Jens Axboe26160152009-03-17 09:35:06 +0100248
249 return err;
250}
251subsys_initcall(default_bdi_init);
252
Artem Bityutskiy64677162010-07-25 14:29:22 +0300253/*
Tejun Heof0054bb2015-05-22 17:13:30 -0400254 * This function is used when the first inode for this wb is marked dirty. It
Artem Bityutskiy64677162010-07-25 14:29:22 +0300255 * wakes-up the corresponding bdi thread which should then take care of the
256 * periodic background write-out of dirty inodes. Since the write-out would
257 * starts only 'dirty_writeback_interval' centisecs from now anyway, we just
258 * set up a timer which wakes the bdi thread up later.
259 *
260 * Note, we wouldn't bother setting up the timer, but this function is on the
261 * fast-path (used by '__mark_inode_dirty()'), so we save few context switches
262 * by delaying the wake-up.
Derek Basehore6ca738d2014-04-03 14:46:22 -0700263 *
264 * We have to be careful not to postpone flush work if it is scheduled for
265 * earlier. Thus we use queue_delayed_work().
Artem Bityutskiy64677162010-07-25 14:29:22 +0300266 */
Tejun Heof0054bb2015-05-22 17:13:30 -0400267void wb_wakeup_delayed(struct bdi_writeback *wb)
Artem Bityutskiy64677162010-07-25 14:29:22 +0300268{
269 unsigned long timeout;
270
271 timeout = msecs_to_jiffies(dirty_writeback_interval * 10);
Tejun Heof0054bb2015-05-22 17:13:30 -0400272 spin_lock_bh(&wb->work_lock);
273 if (test_bit(WB_registered, &wb->state))
274 queue_delayed_work(bdi_wq, &wb->dwork, timeout);
275 spin_unlock_bh(&wb->work_lock);
Jens Axboe03ba3782009-09-09 09:08:54 +0200276}
277
Jens Axboecfc4ba52009-09-14 13:12:40 +0200278/*
Tejun Heoa88a3412015-05-22 17:13:28 -0400279 * Initial write bandwidth: 100 MB/s
Jens Axboecfc4ba52009-09-14 13:12:40 +0200280 */
Tejun Heoa88a3412015-05-22 17:13:28 -0400281#define INIT_BW (100 << (20 - PAGE_SHIFT))
Jens Axboecfc4ba52009-09-14 13:12:40 +0200282
Tejun Heo8395cd92015-05-22 17:13:34 -0400283static int wb_init(struct bdi_writeback *wb, struct backing_dev_info *bdi,
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200284 gfp_t gfp)
Artem Bityutskiy64677162010-07-25 14:29:22 +0300285{
Tejun Heo93f78d82015-05-22 17:13:27 -0400286 int i, err;
287
Artem Bityutskiy64677162010-07-25 14:29:22 +0300288 memset(wb, 0, sizeof(*wb));
289
Jan Kara810df542017-03-23 01:36:55 +0100290 if (wb != &bdi->wb)
291 bdi_get(bdi);
Artem Bityutskiy64677162010-07-25 14:29:22 +0300292 wb->bdi = bdi;
293 wb->last_old_flush = jiffies;
294 INIT_LIST_HEAD(&wb->b_dirty);
295 INIT_LIST_HEAD(&wb->b_io);
296 INIT_LIST_HEAD(&wb->b_more_io);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500297 INIT_LIST_HEAD(&wb->b_dirty_time);
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600298 spin_lock_init(&wb->list_lock);
Tejun Heo93f78d82015-05-22 17:13:27 -0400299
Tejun Heoa88a3412015-05-22 17:13:28 -0400300 wb->bw_time_stamp = jiffies;
301 wb->balanced_dirty_ratelimit = INIT_BW;
302 wb->dirty_ratelimit = INIT_BW;
303 wb->write_bandwidth = INIT_BW;
304 wb->avg_write_bandwidth = INIT_BW;
305
Tejun Heof0054bb2015-05-22 17:13:30 -0400306 spin_lock_init(&wb->work_lock);
307 INIT_LIST_HEAD(&wb->work_list);
308 INIT_DELAYED_WORK(&wb->dwork, wb_workfn);
Jens Axboeb57d74a2016-09-01 10:20:33 -0600309 wb->dirty_sleep = jiffies;
Tejun Heof0054bb2015-05-22 17:13:30 -0400310
Tejun Heo8395cd92015-05-22 17:13:34 -0400311 err = fprop_local_init_percpu(&wb->completions, gfp);
Tejun Heoa88a3412015-05-22 17:13:28 -0400312 if (err)
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200313 goto out_put_bdi;
Tejun Heoa88a3412015-05-22 17:13:28 -0400314
Tejun Heo93f78d82015-05-22 17:13:27 -0400315 for (i = 0; i < NR_WB_STAT_ITEMS; i++) {
Tejun Heo8395cd92015-05-22 17:13:34 -0400316 err = percpu_counter_init(&wb->stat[i], 0, gfp);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600317 if (err)
318 goto out_destroy_stat;
Tejun Heo93f78d82015-05-22 17:13:27 -0400319 }
320
321 return 0;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600322
323out_destroy_stat:
Rasmus Villemoes078c6c32016-02-11 16:13:06 -0800324 while (i--)
Tejun Heoa13f35e2015-07-02 08:44:34 -0600325 percpu_counter_destroy(&wb->stat[i]);
326 fprop_local_destroy_percpu(&wb->completions);
Jan Kara810df542017-03-23 01:36:55 +0100327out_put_bdi:
328 if (wb != &bdi->wb)
329 bdi_put(bdi);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600330 return err;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700331}
Jens Axboe03ba3782009-09-09 09:08:54 +0200332
Jan Karae8cb72b2017-03-23 01:36:56 +0100333static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb);
334
Tejun Heo46100072015-05-22 17:13:31 -0400335/*
336 * Remove bdi from the global list and shutdown any threads we have running
337 */
338static void wb_shutdown(struct bdi_writeback *wb)
339{
340 /* Make sure nobody queues further work */
341 spin_lock_bh(&wb->work_lock);
342 if (!test_and_clear_bit(WB_registered, &wb->state)) {
343 spin_unlock_bh(&wb->work_lock);
344 return;
345 }
346 spin_unlock_bh(&wb->work_lock);
347
Jan Karae8cb72b2017-03-23 01:36:56 +0100348 cgwb_remove_from_bdi_list(wb);
Tejun Heo46100072015-05-22 17:13:31 -0400349 /*
350 * Drain work list and shutdown the delayed_work. !WB_registered
351 * tells wb_workfn() that @wb is dying and its work_list needs to
352 * be drained no matter what.
353 */
354 mod_delayed_work(bdi_wq, &wb->dwork, 0);
355 flush_delayed_work(&wb->dwork);
356 WARN_ON(!list_empty(&wb->work_list));
357}
358
Tejun Heof0054bb2015-05-22 17:13:30 -0400359static void wb_exit(struct bdi_writeback *wb)
Tejun Heo93f78d82015-05-22 17:13:27 -0400360{
361 int i;
362
363 WARN_ON(delayed_work_pending(&wb->dwork));
364
365 for (i = 0; i < NR_WB_STAT_ITEMS; i++)
366 percpu_counter_destroy(&wb->stat[i]);
Artem Bityutskiy64677162010-07-25 14:29:22 +0300367
Tejun Heoa88a3412015-05-22 17:13:28 -0400368 fprop_local_destroy_percpu(&wb->completions);
Jan Kara810df542017-03-23 01:36:55 +0100369 if (wb != &wb->bdi->wb)
370 bdi_put(wb->bdi);
Tejun Heoa88a3412015-05-22 17:13:28 -0400371}
Wu Fengguange98be2d2010-08-29 11:22:30 -0600372
Tejun Heo52ebea72015-05-22 17:13:37 -0400373#ifdef CONFIG_CGROUP_WRITEBACK
374
375#include <linux/memcontrol.h>
376
377/*
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200378 * cgwb_lock protects bdi->cgwb_tree, blkcg->cgwb_list, and memcg->cgwb_list.
379 * bdi->cgwb_tree is also RCU protected.
Tejun Heo52ebea72015-05-22 17:13:37 -0400380 */
381static DEFINE_SPINLOCK(cgwb_lock);
Tejun Heof1834642018-05-23 10:56:32 -0700382static struct workqueue_struct *cgwb_release_wq;
Tejun Heo52ebea72015-05-22 17:13:37 -0400383
Tejun Heo52ebea72015-05-22 17:13:37 -0400384static void cgwb_release_workfn(struct work_struct *work)
385{
386 struct bdi_writeback *wb = container_of(work, struct bdi_writeback,
387 release_work);
Dennis Zhou (Facebook)59b57712018-08-31 16:22:43 -0400388 struct blkcg *blkcg = css_to_blkcg(wb->blkcg_css);
Tejun Heo52ebea72015-05-22 17:13:37 -0400389
Jan Kara3ee7e862018-06-18 15:46:58 +0200390 mutex_lock(&wb->bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400391 wb_shutdown(wb);
392
393 css_put(wb->memcg_css);
394 css_put(wb->blkcg_css);
Jan Kara3ee7e862018-06-18 15:46:58 +0200395 mutex_unlock(&wb->bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400396
Tejun Heod866dbf2019-07-24 10:37:22 -0700397 /* triggers blkg destruction if no online users left */
398 blkcg_unpin_online(blkcg);
Dennis Zhou (Facebook)59b57712018-08-31 16:22:43 -0400399
Tejun Heo841710a2015-05-22 18:23:33 -0400400 fprop_local_destroy_percpu(&wb->memcg_completions);
Tejun Heo52ebea72015-05-22 17:13:37 -0400401 percpu_ref_exit(&wb->refcnt);
402 wb_exit(wb);
403 kfree_rcu(wb, rcu);
Tejun Heo52ebea72015-05-22 17:13:37 -0400404}
405
406static void cgwb_release(struct percpu_ref *refcnt)
407{
408 struct bdi_writeback *wb = container_of(refcnt, struct bdi_writeback,
409 refcnt);
Tejun Heof1834642018-05-23 10:56:32 -0700410 queue_work(cgwb_release_wq, &wb->release_work);
Tejun Heo52ebea72015-05-22 17:13:37 -0400411}
412
413static void cgwb_kill(struct bdi_writeback *wb)
414{
415 lockdep_assert_held(&cgwb_lock);
416
417 WARN_ON(!radix_tree_delete(&wb->bdi->cgwb_tree, wb->memcg_css->id));
418 list_del(&wb->memcg_node);
419 list_del(&wb->blkcg_node);
420 percpu_ref_kill(&wb->refcnt);
421}
422
Jan Karae8cb72b2017-03-23 01:36:56 +0100423static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
424{
425 spin_lock_irq(&cgwb_lock);
426 list_del_rcu(&wb->bdi_node);
427 spin_unlock_irq(&cgwb_lock);
428}
429
Tejun Heo52ebea72015-05-22 17:13:37 -0400430static int cgwb_create(struct backing_dev_info *bdi,
431 struct cgroup_subsys_state *memcg_css, gfp_t gfp)
432{
433 struct mem_cgroup *memcg;
434 struct cgroup_subsys_state *blkcg_css;
435 struct blkcg *blkcg;
436 struct list_head *memcg_cgwb_list, *blkcg_cgwb_list;
437 struct bdi_writeback *wb;
438 unsigned long flags;
439 int ret = 0;
440
441 memcg = mem_cgroup_from_css(memcg_css);
Tejun Heoc165b3e2015-08-18 14:55:29 -0700442 blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
Tejun Heo52ebea72015-05-22 17:13:37 -0400443 blkcg = css_to_blkcg(blkcg_css);
Wang Long9ccc3612018-06-07 17:07:19 -0700444 memcg_cgwb_list = &memcg->cgwb_list;
Tejun Heo52ebea72015-05-22 17:13:37 -0400445 blkcg_cgwb_list = &blkcg->cgwb_list;
446
447 /* look up again under lock and discard on blkcg mismatch */
448 spin_lock_irqsave(&cgwb_lock, flags);
449 wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
450 if (wb && wb->blkcg_css != blkcg_css) {
451 cgwb_kill(wb);
452 wb = NULL;
453 }
454 spin_unlock_irqrestore(&cgwb_lock, flags);
455 if (wb)
456 goto out_put;
457
458 /* need to create a new one */
459 wb = kmalloc(sizeof(*wb), gfp);
Christophe JAILLET0b045bd2017-09-11 21:43:23 +0200460 if (!wb) {
461 ret = -ENOMEM;
462 goto out_put;
463 }
Tejun Heo52ebea72015-05-22 17:13:37 -0400464
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200465 ret = wb_init(wb, bdi, gfp);
Tejun Heo52ebea72015-05-22 17:13:37 -0400466 if (ret)
467 goto err_free;
468
469 ret = percpu_ref_init(&wb->refcnt, cgwb_release, 0, gfp);
470 if (ret)
471 goto err_wb_exit;
472
Tejun Heo841710a2015-05-22 18:23:33 -0400473 ret = fprop_local_init_percpu(&wb->memcg_completions, gfp);
474 if (ret)
475 goto err_ref_exit;
476
Tejun Heo52ebea72015-05-22 17:13:37 -0400477 wb->memcg_css = memcg_css;
478 wb->blkcg_css = blkcg_css;
479 INIT_WORK(&wb->release_work, cgwb_release_workfn);
480 set_bit(WB_registered, &wb->state);
481
482 /*
483 * The root wb determines the registered state of the whole bdi and
484 * memcg_cgwb_list and blkcg_cgwb_list's next pointers indicate
485 * whether they're still online. Don't link @wb if any is dead.
486 * See wb_memcg_offline() and wb_blkcg_offline().
487 */
488 ret = -ENODEV;
489 spin_lock_irqsave(&cgwb_lock, flags);
490 if (test_bit(WB_registered, &bdi->wb.state) &&
491 blkcg_cgwb_list->next && memcg_cgwb_list->next) {
492 /* we might have raced another instance of this function */
493 ret = radix_tree_insert(&bdi->cgwb_tree, memcg_css->id, wb);
494 if (!ret) {
Tejun Heob8175252015-10-02 14:47:05 -0400495 list_add_tail_rcu(&wb->bdi_node, &bdi->wb_list);
Tejun Heo52ebea72015-05-22 17:13:37 -0400496 list_add(&wb->memcg_node, memcg_cgwb_list);
497 list_add(&wb->blkcg_node, blkcg_cgwb_list);
Tejun Heod866dbf2019-07-24 10:37:22 -0700498 blkcg_pin_online(blkcg);
Tejun Heo52ebea72015-05-22 17:13:37 -0400499 css_get(memcg_css);
500 css_get(blkcg_css);
501 }
502 }
503 spin_unlock_irqrestore(&cgwb_lock, flags);
504 if (ret) {
505 if (ret == -EEXIST)
506 ret = 0;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600507 goto err_fprop_exit;
Tejun Heo52ebea72015-05-22 17:13:37 -0400508 }
509 goto out_put;
510
Tejun Heo841710a2015-05-22 18:23:33 -0400511err_fprop_exit:
512 fprop_local_destroy_percpu(&wb->memcg_completions);
Tejun Heo52ebea72015-05-22 17:13:37 -0400513err_ref_exit:
514 percpu_ref_exit(&wb->refcnt);
515err_wb_exit:
516 wb_exit(wb);
517err_free:
518 kfree(wb);
519out_put:
520 css_put(blkcg_css);
521 return ret;
522}
523
524/**
Tejun Heoed288dc2019-08-26 09:06:54 -0700525 * wb_get_lookup - get wb for a given memcg
Tejun Heo52ebea72015-05-22 17:13:37 -0400526 * @bdi: target bdi
527 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
Tejun Heo52ebea72015-05-22 17:13:37 -0400528 *
Tejun Heoed288dc2019-08-26 09:06:54 -0700529 * Try to get the wb for @memcg_css on @bdi. The returned wb has its
530 * refcount incremented.
Tejun Heo52ebea72015-05-22 17:13:37 -0400531 *
532 * This function uses css_get() on @memcg_css and thus expects its refcnt
533 * to be positive on invocation. IOW, rcu_read_lock() protection on
534 * @memcg_css isn't enough. try_get it before calling this function.
535 *
536 * A wb is keyed by its associated memcg. As blkcg implicitly enables
537 * memcg on the default hierarchy, memcg association is guaranteed to be
538 * more specific (equal or descendant to the associated blkcg) and thus can
539 * identify both the memcg and blkcg associations.
540 *
541 * Because the blkcg associated with a memcg may change as blkcg is enabled
542 * and disabled closer to root in the hierarchy, each wb keeps track of
543 * both the memcg and blkcg associated with it and verifies the blkcg on
544 * each lookup. On mismatch, the existing wb is discarded and a new one is
545 * created.
546 */
Tejun Heoed288dc2019-08-26 09:06:54 -0700547struct bdi_writeback *wb_get_lookup(struct backing_dev_info *bdi,
548 struct cgroup_subsys_state *memcg_css)
549{
550 struct bdi_writeback *wb;
551
552 if (!memcg_css->parent)
553 return &bdi->wb;
554
555 rcu_read_lock();
556 wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
557 if (wb) {
558 struct cgroup_subsys_state *blkcg_css;
559
560 /* see whether the blkcg association has changed */
561 blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
562 if (unlikely(wb->blkcg_css != blkcg_css || !wb_tryget(wb)))
563 wb = NULL;
564 css_put(blkcg_css);
565 }
566 rcu_read_unlock();
567
568 return wb;
569}
570
571/**
572 * wb_get_create - get wb for a given memcg, create if necessary
573 * @bdi: target bdi
574 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
575 * @gfp: allocation mask to use
576 *
577 * Try to get the wb for @memcg_css on @bdi. If it doesn't exist, try to
578 * create one. See wb_get_lookup() for more details.
579 */
Tejun Heo52ebea72015-05-22 17:13:37 -0400580struct bdi_writeback *wb_get_create(struct backing_dev_info *bdi,
581 struct cgroup_subsys_state *memcg_css,
582 gfp_t gfp)
583{
584 struct bdi_writeback *wb;
585
Mel Gormand0164ad2015-11-06 16:28:21 -0800586 might_sleep_if(gfpflags_allow_blocking(gfp));
Tejun Heo52ebea72015-05-22 17:13:37 -0400587
588 if (!memcg_css->parent)
589 return &bdi->wb;
590
591 do {
Tejun Heoed288dc2019-08-26 09:06:54 -0700592 wb = wb_get_lookup(bdi, memcg_css);
Tejun Heo52ebea72015-05-22 17:13:37 -0400593 } while (!wb && !cgwb_create(bdi, memcg_css, gfp));
594
595 return wb;
596}
597
Tejun Heoa13f35e2015-07-02 08:44:34 -0600598static int cgwb_bdi_init(struct backing_dev_info *bdi)
Tejun Heo52ebea72015-05-22 17:13:37 -0400599{
Tejun Heoa13f35e2015-07-02 08:44:34 -0600600 int ret;
601
Tejun Heo52ebea72015-05-22 17:13:37 -0400602 INIT_RADIX_TREE(&bdi->cgwb_tree, GFP_ATOMIC);
Jan Kara3ee7e862018-06-18 15:46:58 +0200603 mutex_init(&bdi->cgwb_release_mutex);
Tejun Heo7fc58542017-12-12 08:38:30 -0800604 init_rwsem(&bdi->wb_switch_rwsem);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600605
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200606 ret = wb_init(&bdi->wb, bdi, GFP_KERNEL);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600607 if (!ret) {
Johannes Weiner7d828602016-01-14 15:20:56 -0800608 bdi->wb.memcg_css = &root_mem_cgroup->css;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600609 bdi->wb.blkcg_css = blkcg_root_css;
610 }
611 return ret;
Tejun Heo52ebea72015-05-22 17:13:37 -0400612}
613
Jan Karab1c51af2017-03-23 01:36:59 +0100614static void cgwb_bdi_unregister(struct backing_dev_info *bdi)
Tejun Heo52ebea72015-05-22 17:13:37 -0400615{
616 struct radix_tree_iter iter;
617 void **slot;
Jan Kara5318ce72017-03-23 01:36:57 +0100618 struct bdi_writeback *wb;
Tejun Heo52ebea72015-05-22 17:13:37 -0400619
620 WARN_ON(test_bit(WB_registered, &bdi->wb.state));
621
622 spin_lock_irq(&cgwb_lock);
623 radix_tree_for_each_slot(slot, &bdi->cgwb_tree, &iter, 0)
624 cgwb_kill(*slot);
Jan Kara3ee7e862018-06-18 15:46:58 +0200625 spin_unlock_irq(&cgwb_lock);
Jan Kara5318ce72017-03-23 01:36:57 +0100626
Jan Kara3ee7e862018-06-18 15:46:58 +0200627 mutex_lock(&bdi->cgwb_release_mutex);
628 spin_lock_irq(&cgwb_lock);
Jan Kara5318ce72017-03-23 01:36:57 +0100629 while (!list_empty(&bdi->wb_list)) {
630 wb = list_first_entry(&bdi->wb_list, struct bdi_writeback,
631 bdi_node);
632 spin_unlock_irq(&cgwb_lock);
633 wb_shutdown(wb);
634 spin_lock_irq(&cgwb_lock);
635 }
Tejun Heo52ebea72015-05-22 17:13:37 -0400636 spin_unlock_irq(&cgwb_lock);
Jan Kara3ee7e862018-06-18 15:46:58 +0200637 mutex_unlock(&bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400638}
639
640/**
641 * wb_memcg_offline - kill all wb's associated with a memcg being offlined
642 * @memcg: memcg being offlined
643 *
644 * Also prevents creation of any new wb's associated with @memcg.
645 */
646void wb_memcg_offline(struct mem_cgroup *memcg)
647{
Wang Long9ccc3612018-06-07 17:07:19 -0700648 struct list_head *memcg_cgwb_list = &memcg->cgwb_list;
Tejun Heo52ebea72015-05-22 17:13:37 -0400649 struct bdi_writeback *wb, *next;
650
651 spin_lock_irq(&cgwb_lock);
652 list_for_each_entry_safe(wb, next, memcg_cgwb_list, memcg_node)
653 cgwb_kill(wb);
654 memcg_cgwb_list->next = NULL; /* prevent new wb's */
655 spin_unlock_irq(&cgwb_lock);
656}
657
658/**
659 * wb_blkcg_offline - kill all wb's associated with a blkcg being offlined
660 * @blkcg: blkcg being offlined
661 *
662 * Also prevents creation of any new wb's associated with @blkcg.
663 */
664void wb_blkcg_offline(struct blkcg *blkcg)
665{
Tejun Heo52ebea72015-05-22 17:13:37 -0400666 struct bdi_writeback *wb, *next;
667
668 spin_lock_irq(&cgwb_lock);
669 list_for_each_entry_safe(wb, next, &blkcg->cgwb_list, blkcg_node)
670 cgwb_kill(wb);
671 blkcg->cgwb_list.next = NULL; /* prevent new wb's */
672 spin_unlock_irq(&cgwb_lock);
673}
674
Jan Karae8cb72b2017-03-23 01:36:56 +0100675static void cgwb_bdi_register(struct backing_dev_info *bdi)
676{
677 spin_lock_irq(&cgwb_lock);
678 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
679 spin_unlock_irq(&cgwb_lock);
680}
681
Tejun Heof1834642018-05-23 10:56:32 -0700682static int __init cgwb_init(void)
683{
684 /*
685 * There can be many concurrent release work items overwhelming
686 * system_wq. Put them in a separate wq and limit concurrency.
687 * There's no point in executing many of these in parallel.
688 */
689 cgwb_release_wq = alloc_workqueue("cgwb_release", 0, 1);
690 if (!cgwb_release_wq)
691 return -ENOMEM;
692
693 return 0;
694}
695subsys_initcall(cgwb_init);
696
Tejun Heo52ebea72015-05-22 17:13:37 -0400697#else /* CONFIG_CGROUP_WRITEBACK */
698
Tejun Heoa13f35e2015-07-02 08:44:34 -0600699static int cgwb_bdi_init(struct backing_dev_info *bdi)
700{
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200701 return wb_init(&bdi->wb, bdi, GFP_KERNEL);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600702}
703
Jan Karab1c51af2017-03-23 01:36:59 +0100704static void cgwb_bdi_unregister(struct backing_dev_info *bdi) { }
Jan Karadf23de52017-03-08 17:48:32 +0100705
Jan Karae8cb72b2017-03-23 01:36:56 +0100706static void cgwb_bdi_register(struct backing_dev_info *bdi)
707{
708 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
709}
710
711static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
712{
713 list_del_rcu(&wb->bdi_node);
714}
715
Tejun Heo52ebea72015-05-22 17:13:37 -0400716#endif /* CONFIG_CGROUP_WRITEBACK */
717
Jan Kara2e82b842017-04-12 12:24:48 +0200718static int bdi_init(struct backing_dev_info *bdi)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700719{
Tejun Heob8175252015-10-02 14:47:05 -0400720 int ret;
721
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700722 bdi->dev = NULL;
723
Jan Karad03f6cd2017-02-02 15:56:51 +0100724 kref_init(&bdi->refcnt);
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700725 bdi->min_ratio = 0;
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700726 bdi->max_ratio = 100;
Jan Karaeb608e32012-05-24 18:59:11 +0200727 bdi->max_prop_frac = FPROP_FRAC_BASE;
Jens Axboe66f3b8e2009-09-02 09:19:46 +0200728 INIT_LIST_HEAD(&bdi->bdi_list);
Tejun Heob8175252015-10-02 14:47:05 -0400729 INIT_LIST_HEAD(&bdi->wb_list);
Tejun Heocc395d72015-05-22 17:13:58 -0400730 init_waitqueue_head(&bdi->wb_waitq);
Jens Axboe03ba3782009-09-09 09:08:54 +0200731
Tejun Heob8175252015-10-02 14:47:05 -0400732 ret = cgwb_bdi_init(bdi);
733
Tejun Heob8175252015-10-02 14:47:05 -0400734 return ret;
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700735}
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700736
Christoph Hellwigaef33c22020-05-04 14:48:00 +0200737struct backing_dev_info *bdi_alloc(int node_id)
Jan Karad03f6cd2017-02-02 15:56:51 +0100738{
739 struct backing_dev_info *bdi;
740
Christoph Hellwigaef33c22020-05-04 14:48:00 +0200741 bdi = kzalloc_node(sizeof(*bdi), GFP_KERNEL, node_id);
Jan Karad03f6cd2017-02-02 15:56:51 +0100742 if (!bdi)
743 return NULL;
744
745 if (bdi_init(bdi)) {
746 kfree(bdi);
747 return NULL;
748 }
Christoph Hellwig55b25982020-09-24 08:51:32 +0200749 bdi->ra_pages = VM_READAHEAD_PAGES;
750 bdi->io_pages = VM_READAHEAD_PAGES;
Jan Karad03f6cd2017-02-02 15:56:51 +0100751 return bdi;
752}
Christoph Hellwigaef33c22020-05-04 14:48:00 +0200753EXPORT_SYMBOL(bdi_alloc);
Jan Karad03f6cd2017-02-02 15:56:51 +0100754
Tejun Heo34f8fe52019-08-26 09:06:53 -0700755static struct rb_node **bdi_lookup_rb_node(u64 id, struct rb_node **parentp)
756{
757 struct rb_node **p = &bdi_tree.rb_node;
758 struct rb_node *parent = NULL;
759 struct backing_dev_info *bdi;
760
761 lockdep_assert_held(&bdi_lock);
762
763 while (*p) {
764 parent = *p;
765 bdi = rb_entry(parent, struct backing_dev_info, rb_node);
766
767 if (bdi->id > id)
768 p = &(*p)->rb_left;
769 else if (bdi->id < id)
770 p = &(*p)->rb_right;
771 else
772 break;
773 }
774
775 if (parentp)
776 *parentp = parent;
777 return p;
778}
779
780/**
781 * bdi_get_by_id - lookup and get bdi from its id
782 * @id: bdi id to lookup
783 *
784 * Find bdi matching @id and get it. Returns NULL if the matching bdi
785 * doesn't exist or is already unregistered.
786 */
787struct backing_dev_info *bdi_get_by_id(u64 id)
788{
789 struct backing_dev_info *bdi = NULL;
790 struct rb_node **p;
791
792 spin_lock_bh(&bdi_lock);
793 p = bdi_lookup_rb_node(id, NULL);
794 if (*p) {
795 bdi = rb_entry(*p, struct backing_dev_info, rb_node);
796 bdi_get(bdi);
797 }
798 spin_unlock_bh(&bdi_lock);
799
800 return bdi;
801}
802
Jan Kara7c4cc302017-04-12 12:24:49 +0200803int bdi_register_va(struct backing_dev_info *bdi, const char *fmt, va_list args)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700804{
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700805 struct device *dev;
Tejun Heo34f8fe52019-08-26 09:06:53 -0700806 struct rb_node *parent, **p;
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700807
808 if (bdi->dev) /* The driver needs to use separate queues per device */
809 return 0;
810
Christoph Hellwig6bd87ee2020-05-04 14:47:56 +0200811 vsnprintf(bdi->dev_name, sizeof(bdi->dev_name), fmt, args);
812 dev = device_create(bdi_class, NULL, MKDEV(0, 0), bdi, bdi->dev_name);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700813 if (IS_ERR(dev))
814 return PTR_ERR(dev);
815
Jan Karae8cb72b2017-03-23 01:36:56 +0100816 cgwb_bdi_register(bdi);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700817 bdi->dev = dev;
818
Jens Axboe6d0e4822017-12-21 10:01:30 -0700819 bdi_debug_register(bdi, dev_name(dev));
Tejun Heo46100072015-05-22 17:13:31 -0400820 set_bit(WB_registered, &bdi->wb.state);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700821
822 spin_lock_bh(&bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700823
824 bdi->id = ++bdi_id_cursor;
825
826 p = bdi_lookup_rb_node(bdi->id, &parent);
827 rb_link_node(&bdi->rb_node, parent, p);
828 rb_insert_color(&bdi->rb_node, &bdi_tree);
829
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700830 list_add_tail_rcu(&bdi->bdi_list, &bdi_list);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700831
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700832 spin_unlock_bh(&bdi_lock);
833
834 trace_writeback_bdi_register(bdi);
835 return 0;
836}
Jan Karabaf7a612017-04-12 12:24:25 +0200837
Jan Kara7c4cc302017-04-12 12:24:49 +0200838int bdi_register(struct backing_dev_info *bdi, const char *fmt, ...)
Jan Karabaf7a612017-04-12 12:24:25 +0200839{
840 va_list args;
841 int ret;
842
843 va_start(args, fmt);
Jan Kara7c4cc302017-04-12 12:24:49 +0200844 ret = bdi_register_va(bdi, fmt, args);
Jan Karabaf7a612017-04-12 12:24:25 +0200845 va_end(args);
846 return ret;
847}
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700848EXPORT_SYMBOL(bdi_register);
849
Christoph Hellwig3c5d2022020-05-04 14:47:59 +0200850void bdi_set_owner(struct backing_dev_info *bdi, struct device *owner)
Dan Williamsdf08c322016-07-31 11:15:13 -0700851{
Christoph Hellwig3c5d2022020-05-04 14:47:59 +0200852 WARN_ON_ONCE(bdi->owner);
Dan Williamsdf08c322016-07-31 11:15:13 -0700853 bdi->owner = owner;
854 get_device(owner);
Dan Williamsdf08c322016-07-31 11:15:13 -0700855}
Dan Williamsdf08c322016-07-31 11:15:13 -0700856
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700857/*
Tejun Heo46100072015-05-22 17:13:31 -0400858 * Remove bdi from bdi_list, and ensure that it is no longer visible
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700859 */
Tejun Heo46100072015-05-22 17:13:31 -0400860static void bdi_remove_from_list(struct backing_dev_info *bdi)
Peter Zijlstra04fbfdc2007-10-16 23:25:50 -0700861{
Tejun Heo46100072015-05-22 17:13:31 -0400862 spin_lock_bh(&bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700863 rb_erase(&bdi->rb_node, &bdi_tree);
Tejun Heo46100072015-05-22 17:13:31 -0400864 list_del_rcu(&bdi->bdi_list);
865 spin_unlock_bh(&bdi_lock);
Andrew Morton3fcfab12006-10-19 23:28:16 -0700866
Tejun Heo46100072015-05-22 17:13:31 -0400867 synchronize_rcu_expedited();
Andrew Morton3fcfab12006-10-19 23:28:16 -0700868}
869
Tejun Heob02176f2015-09-08 12:20:22 -0400870void bdi_unregister(struct backing_dev_info *bdi)
Andrew Morton3fcfab12006-10-19 23:28:16 -0700871{
Tejun Heof0054bb2015-05-22 17:13:30 -0400872 /* make sure nobody finds us on the bdi_list anymore */
873 bdi_remove_from_list(bdi);
874 wb_shutdown(&bdi->wb);
Jan Karab1c51af2017-03-23 01:36:59 +0100875 cgwb_bdi_unregister(bdi);
Rabin Vincent7a401a92011-11-11 13:29:04 +0100876
Christoph Hellwigc4db59d2015-01-20 14:05:00 -0700877 if (bdi->dev) {
878 bdi_debug_unregister(bdi);
879 device_unregister(bdi->dev);
880 bdi->dev = NULL;
881 }
Dan Williamsdf08c322016-07-31 11:15:13 -0700882
883 if (bdi->owner) {
884 put_device(bdi->owner);
885 bdi->owner = NULL;
886 }
Tejun Heob02176f2015-09-08 12:20:22 -0400887}
Christoph Hellwigc4db59d2015-01-20 14:05:00 -0700888
Jan Karad03f6cd2017-02-02 15:56:51 +0100889static void release_bdi(struct kref *ref)
890{
891 struct backing_dev_info *bdi =
892 container_of(ref, struct backing_dev_info, refcnt);
893
Jan Kara5af110b2017-04-12 12:24:26 +0200894 if (test_bit(WB_registered, &bdi->wb.state))
895 bdi_unregister(bdi);
Jan Kara2e82b842017-04-12 12:24:48 +0200896 WARN_ON_ONCE(bdi->dev);
897 wb_exit(&bdi->wb);
Jan Karad03f6cd2017-02-02 15:56:51 +0100898 kfree(bdi);
899}
900
901void bdi_put(struct backing_dev_info *bdi)
902{
903 kref_put(&bdi->refcnt, release_bdi);
904}
Jan Kara62bf42a2017-04-12 12:24:27 +0200905EXPORT_SYMBOL(bdi_put);
Jan Karad03f6cd2017-02-02 15:56:51 +0100906
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +0200907const char *bdi_dev_name(struct backing_dev_info *bdi)
908{
909 if (!bdi || !bdi->dev)
910 return bdi_unknown_name;
Christoph Hellwig6bd87ee2020-05-04 14:47:56 +0200911 return bdi->dev_name;
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +0200912}
913EXPORT_SYMBOL_GPL(bdi_dev_name);
914
Andrew Morton3fcfab12006-10-19 23:28:16 -0700915static wait_queue_head_t congestion_wqh[2] = {
916 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[0]),
917 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[1])
918 };
Tejun Heoec8a6f22015-05-22 17:13:41 -0400919static atomic_t nr_wb_congested[2];
Andrew Morton3fcfab12006-10-19 23:28:16 -0700920
Christoph Hellwig492d76b2020-07-01 11:06:20 +0200921void clear_bdi_congested(struct backing_dev_info *bdi, int sync)
Andrew Morton3fcfab12006-10-19 23:28:16 -0700922{
Jens Axboe1faa16d2009-04-06 14:48:01 +0200923 wait_queue_head_t *wqh = &congestion_wqh[sync];
Kaixu Xiac877ef82016-03-31 13:19:41 +0000924 enum wb_congested_state bit;
Andrew Morton3fcfab12006-10-19 23:28:16 -0700925
Tejun Heo44522262015-05-22 17:13:26 -0400926 bit = sync ? WB_sync_congested : WB_async_congested;
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200927 if (test_and_clear_bit(bit, &bdi->wb.congested))
Tejun Heoec8a6f22015-05-22 17:13:41 -0400928 atomic_dec(&nr_wb_congested[sync]);
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100929 smp_mb__after_atomic();
Andrew Morton3fcfab12006-10-19 23:28:16 -0700930 if (waitqueue_active(wqh))
931 wake_up(wqh);
932}
Christoph Hellwig492d76b2020-07-01 11:06:20 +0200933EXPORT_SYMBOL(clear_bdi_congested);
Andrew Morton3fcfab12006-10-19 23:28:16 -0700934
Christoph Hellwig492d76b2020-07-01 11:06:20 +0200935void set_bdi_congested(struct backing_dev_info *bdi, int sync)
Andrew Morton3fcfab12006-10-19 23:28:16 -0700936{
Kaixu Xiac877ef82016-03-31 13:19:41 +0000937 enum wb_congested_state bit;
Andrew Morton3fcfab12006-10-19 23:28:16 -0700938
Tejun Heo44522262015-05-22 17:13:26 -0400939 bit = sync ? WB_sync_congested : WB_async_congested;
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200940 if (!test_and_set_bit(bit, &bdi->wb.congested))
Tejun Heoec8a6f22015-05-22 17:13:41 -0400941 atomic_inc(&nr_wb_congested[sync]);
Andrew Morton3fcfab12006-10-19 23:28:16 -0700942}
Christoph Hellwig492d76b2020-07-01 11:06:20 +0200943EXPORT_SYMBOL(set_bdi_congested);
Andrew Morton3fcfab12006-10-19 23:28:16 -0700944
945/**
946 * congestion_wait - wait for a backing_dev to become uncongested
Jens Axboe8aa7e842009-07-09 14:52:32 +0200947 * @sync: SYNC or ASYNC IO
Andrew Morton3fcfab12006-10-19 23:28:16 -0700948 * @timeout: timeout in jiffies
949 *
950 * Waits for up to @timeout jiffies for a backing_dev (any backing_dev) to exit
951 * write congestion. If no backing_devs are congested then just wait for the
952 * next write to be completed.
953 */
Jens Axboe8aa7e842009-07-09 14:52:32 +0200954long congestion_wait(int sync, long timeout)
Andrew Morton3fcfab12006-10-19 23:28:16 -0700955{
956 long ret;
Mel Gorman52bb9192010-10-26 14:21:41 -0700957 unsigned long start = jiffies;
Andrew Morton3fcfab12006-10-19 23:28:16 -0700958 DEFINE_WAIT(wait);
Jens Axboe8aa7e842009-07-09 14:52:32 +0200959 wait_queue_head_t *wqh = &congestion_wqh[sync];
Andrew Morton3fcfab12006-10-19 23:28:16 -0700960
961 prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
962 ret = io_schedule_timeout(timeout);
963 finish_wait(wqh, &wait);
Mel Gorman52bb9192010-10-26 14:21:41 -0700964
965 trace_writeback_congestion_wait(jiffies_to_usecs(timeout),
966 jiffies_to_usecs(jiffies - start));
967
Andrew Morton3fcfab12006-10-19 23:28:16 -0700968 return ret;
969}
970EXPORT_SYMBOL(congestion_wait);
971
Mel Gorman0e093d992010-10-26 14:21:45 -0700972/**
Mel Gorman599d0c92016-07-28 15:45:31 -0700973 * wait_iff_congested - Conditionally wait for a backing_dev to become uncongested or a pgdat to complete writes
Mel Gorman0e093d992010-10-26 14:21:45 -0700974 * @sync: SYNC or ASYNC IO
975 * @timeout: timeout in jiffies
976 *
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -0700977 * In the event of a congested backing_dev (any backing_dev) this waits
978 * for up to @timeout jiffies for either a BDI to exit congestion of the
979 * given @sync queue or a write to complete.
Mel Gorman0e093d992010-10-26 14:21:45 -0700980 *
981 * The return value is 0 if the sleep is for the full timeout. Otherwise,
982 * it is the number of jiffies that were still remaining when the function
983 * returned. return_value == timeout implies the function did not sleep.
984 */
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -0700985long wait_iff_congested(int sync, long timeout)
Mel Gorman0e093d992010-10-26 14:21:45 -0700986{
987 long ret;
988 unsigned long start = jiffies;
989 DEFINE_WAIT(wait);
990 wait_queue_head_t *wqh = &congestion_wqh[sync];
991
992 /*
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -0700993 * If there is no congestion, yield if necessary instead
Mel Gorman0e093d992010-10-26 14:21:45 -0700994 * of sleeping on the congestion queue
995 */
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -0700996 if (atomic_read(&nr_wb_congested[sync]) == 0) {
Michal Hockoede37712016-05-20 16:57:03 -0700997 cond_resched();
Mel Gorman599d0c92016-07-28 15:45:31 -0700998
Mel Gorman0e093d992010-10-26 14:21:45 -0700999 /* In case we scheduled, work out time remaining */
1000 ret = timeout - (jiffies - start);
1001 if (ret < 0)
1002 ret = 0;
1003
1004 goto out;
1005 }
1006
1007 /* Sleep until uncongested or a write happens */
1008 prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
1009 ret = io_schedule_timeout(timeout);
1010 finish_wait(wqh, &wait);
1011
1012out:
1013 trace_writeback_wait_iff_congested(jiffies_to_usecs(timeout),
1014 jiffies_to_usecs(jiffies - start));
1015
1016 return ret;
1017}
1018EXPORT_SYMBOL(wait_iff_congested);