blob: afdd1327684552cac20e3dcd8a8316da718ac4c1 [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>
Daniel Vetterc1ca59a2021-02-25 17:18:45 -080011#include <linux/sched/mm.h>
Andrew Morton3fcfab12006-10-19 23:28:16 -070012#include <linux/sched.h>
13#include <linux/module.h>
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070014#include <linux/writeback.h>
15#include <linux/device.h>
Dave Chinner455b2862010-07-07 13:24:06 +100016#include <trace/events/writeback.h>
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070017
Christoph Hellwigf56753a2020-09-24 08:51:40 +020018struct backing_dev_info noop_backing_dev_info;
Tejun Heoa212b102015-05-22 17:13:33 -040019EXPORT_SYMBOL_GPL(noop_backing_dev_info);
Jörn Engel5129a462010-04-25 08:54:42 +020020
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070021static struct class *bdi_class;
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +020022static const char *bdi_unknown_name = "(unknown)";
Jens Axboecfc4ba52009-09-14 13:12:40 +020023
24/*
Tejun Heo34f8fe52019-08-26 09:06:53 -070025 * bdi_lock protects bdi_tree and updates to bdi_list. bdi_list has RCU
26 * reader side locking.
Jens Axboecfc4ba52009-09-14 13:12:40 +020027 */
Jens Axboe03ba3782009-09-09 09:08:54 +020028DEFINE_SPINLOCK(bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -070029static u64 bdi_id_cursor;
30static struct rb_root bdi_tree = RB_ROOT;
Jens Axboe66f3b8e2009-09-02 09:19:46 +020031LIST_HEAD(bdi_list);
Jens Axboe03ba3782009-09-09 09:08:54 +020032
Tejun Heo839a8e82013-04-01 19:08:06 -070033/* bdi_wq serves all asynchronous writeback tasks */
34struct workqueue_struct *bdi_wq;
35
Baolin Wang6986c3e2021-02-24 12:02:52 -080036#define K(x) ((x) << (PAGE_SHIFT - 10))
37
Miklos Szeredi76f14182008-04-30 00:54:36 -070038#ifdef CONFIG_DEBUG_FS
39#include <linux/debugfs.h>
40#include <linux/seq_file.h>
41
42static struct dentry *bdi_debug_root;
43
44static void bdi_debug_init(void)
45{
46 bdi_debug_root = debugfs_create_dir("bdi", NULL);
47}
48
49static int bdi_debug_stats_show(struct seq_file *m, void *v)
50{
51 struct backing_dev_info *bdi = m->private;
Christoph Hellwigc1955ce2010-06-19 23:08:06 +020052 struct bdi_writeback *wb = &bdi->wb;
David Rientjes364aeb22009-01-06 14:39:29 -080053 unsigned long background_thresh;
54 unsigned long dirty_thresh;
Tejun Heo0d960a32015-05-22 18:23:19 -040055 unsigned long wb_thresh;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050056 unsigned long nr_dirty, nr_io, nr_more_io, nr_dirty_time;
Jens Axboef09b00d2009-05-25 09:08:21 +020057 struct inode *inode;
58
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050059 nr_dirty = nr_io = nr_more_io = nr_dirty_time = 0;
Christoph Hellwigf758eea2011-04-21 18:19:44 -060060 spin_lock(&wb->list_lock);
Dave Chinnerc7f54082015-03-04 14:07:22 -050061 list_for_each_entry(inode, &wb->b_dirty, i_io_list)
Christoph Hellwigc1955ce2010-06-19 23:08:06 +020062 nr_dirty++;
Dave Chinnerc7f54082015-03-04 14:07:22 -050063 list_for_each_entry(inode, &wb->b_io, i_io_list)
Christoph Hellwigc1955ce2010-06-19 23:08:06 +020064 nr_io++;
Dave Chinnerc7f54082015-03-04 14:07:22 -050065 list_for_each_entry(inode, &wb->b_more_io, i_io_list)
Christoph Hellwigc1955ce2010-06-19 23:08:06 +020066 nr_more_io++;
Dave Chinnerc7f54082015-03-04 14:07:22 -050067 list_for_each_entry(inode, &wb->b_dirty_time, i_io_list)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050068 if (inode->i_state & I_DIRTY_TIME)
69 nr_dirty_time++;
Christoph Hellwigf758eea2011-04-21 18:19:44 -060070 spin_unlock(&wb->list_lock);
Miklos Szeredi76f14182008-04-30 00:54:36 -070071
Wu Fengguang16c40422010-08-11 14:17:39 -070072 global_dirty_limits(&background_thresh, &dirty_thresh);
Tejun Heo0d960a32015-05-22 18:23:19 -040073 wb_thresh = wb_calc_thresh(wb, dirty_thresh);
Miklos Szeredi76f14182008-04-30 00:54:36 -070074
Miklos Szeredi76f14182008-04-30 00:54:36 -070075 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
104 return 0;
105}
Andy Shevchenko5ad35092018-04-05 16:23:16 -0700106DEFINE_SHOW_ATTRIBUTE(bdi_debug_stats);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700107
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100108static void bdi_debug_register(struct backing_dev_info *bdi, const char *name)
Miklos Szeredi76f14182008-04-30 00:54:36 -0700109{
110 bdi->debug_dir = debugfs_create_dir(name, bdi_debug_root);
weiping zhang97f07692017-10-31 18:37:54 +0800111
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100112 debugfs_create_file("stats", 0444, bdi->debug_dir, bdi,
113 &bdi_debug_stats_fops);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700114}
115
116static void bdi_debug_unregister(struct backing_dev_info *bdi)
117{
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100118 debugfs_remove_recursive(bdi->debug_dir);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700119}
120#else
121static inline void bdi_debug_init(void)
122{
123}
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100124static inline void bdi_debug_register(struct backing_dev_info *bdi,
Miklos Szeredi76f14182008-04-30 00:54:36 -0700125 const char *name)
126{
127}
128static inline void bdi_debug_unregister(struct backing_dev_info *bdi)
129{
130}
131#endif
132
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700133static ssize_t read_ahead_kb_store(struct device *dev,
134 struct device_attribute *attr,
135 const char *buf, size_t count)
136{
137 struct backing_dev_info *bdi = dev_get_drvdata(dev);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700138 unsigned long read_ahead_kb;
Namjae Jeon7034ed12012-08-25 16:57:27 +0800139 ssize_t ret;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700140
Namjae Jeon7034ed12012-08-25 16:57:27 +0800141 ret = kstrtoul(buf, 10, &read_ahead_kb);
142 if (ret < 0)
143 return ret;
144
145 bdi->ra_pages = read_ahead_kb >> (PAGE_SHIFT - 10);
146
147 return count;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700148}
149
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700150#define BDI_SHOW(name, expr) \
151static ssize_t name##_show(struct device *dev, \
Joe Perches5e4c0d82020-12-14 19:14:50 -0800152 struct device_attribute *attr, char *buf) \
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700153{ \
154 struct backing_dev_info *bdi = dev_get_drvdata(dev); \
155 \
Joe Perches5e4c0d82020-12-14 19:14:50 -0800156 return sysfs_emit(buf, "%lld\n", (long long)expr); \
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700157} \
158static DEVICE_ATTR_RW(name);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700159
160BDI_SHOW(read_ahead_kb, K(bdi->ra_pages))
161
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700162static ssize_t min_ratio_store(struct device *dev,
163 struct device_attribute *attr, const char *buf, size_t count)
164{
165 struct backing_dev_info *bdi = dev_get_drvdata(dev);
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700166 unsigned int ratio;
Namjae Jeon7034ed12012-08-25 16:57:27 +0800167 ssize_t ret;
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700168
Namjae Jeon7034ed12012-08-25 16:57:27 +0800169 ret = kstrtouint(buf, 10, &ratio);
170 if (ret < 0)
171 return ret;
172
173 ret = bdi_set_min_ratio(bdi, ratio);
174 if (!ret)
175 ret = count;
176
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700177 return ret;
178}
179BDI_SHOW(min_ratio, bdi->min_ratio)
180
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700181static ssize_t max_ratio_store(struct device *dev,
182 struct device_attribute *attr, const char *buf, size_t count)
183{
184 struct backing_dev_info *bdi = dev_get_drvdata(dev);
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700185 unsigned int ratio;
Namjae Jeon7034ed12012-08-25 16:57:27 +0800186 ssize_t ret;
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700187
Namjae Jeon7034ed12012-08-25 16:57:27 +0800188 ret = kstrtouint(buf, 10, &ratio);
189 if (ret < 0)
190 return ret;
191
192 ret = bdi_set_max_ratio(bdi, ratio);
193 if (!ret)
194 ret = count;
195
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700196 return ret;
197}
198BDI_SHOW(max_ratio, bdi->max_ratio)
199
Darrick J. Wong7d311cd2013-02-21 16:42:48 -0800200static ssize_t stable_pages_required_show(struct device *dev,
201 struct device_attribute *attr,
Joe Perches5e4c0d82020-12-14 19:14:50 -0800202 char *buf)
Darrick J. Wong7d311cd2013-02-21 16:42:48 -0800203{
Christoph Hellwig1cb039f2020-09-24 08:51:38 +0200204 dev_warn_once(dev,
205 "the stable_pages_required attribute has been removed. Use the stable_writes queue attribute instead.\n");
Joe Perches5e4c0d82020-12-14 19:14:50 -0800206 return sysfs_emit(buf, "%d\n", 0);
Darrick J. Wong7d311cd2013-02-21 16:42:48 -0800207}
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700208static DEVICE_ATTR_RO(stable_pages_required);
Darrick J. Wong7d311cd2013-02-21 16:42:48 -0800209
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700210static 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,
215 NULL,
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700216};
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700217ATTRIBUTE_GROUPS(bdi_dev);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700218
219static __init int bdi_class_init(void)
220{
221 bdi_class = class_create(THIS_MODULE, "bdi");
Anton Blanchard14421452010-04-02 09:46:55 +0200222 if (IS_ERR(bdi_class))
223 return PTR_ERR(bdi_class);
224
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700225 bdi_class->dev_groups = bdi_dev_groups;
Miklos Szeredi76f14182008-04-30 00:54:36 -0700226 bdi_debug_init();
Jan Karad03f6cd2017-02-02 15:56:51 +0100227
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700228 return 0;
229}
Miklos Szeredi76f14182008-04-30 00:54:36 -0700230postcore_initcall(bdi_class_init);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700231
Jens Axboe26160152009-03-17 09:35:06 +0100232static int __init default_bdi_init(void)
233{
Mika Westerberga2b90f12019-10-04 13:00:24 +0300234 bdi_wq = alloc_workqueue("writeback", WQ_MEM_RECLAIM | WQ_UNBOUND |
235 WQ_SYSFS, 0);
Tejun Heo839a8e82013-04-01 19:08:06 -0700236 if (!bdi_wq)
237 return -ENOMEM;
Jan Karaca678812022-06-15 15:22:29 +0200238 return 0;
Jens Axboe26160152009-03-17 09:35:06 +0100239}
240subsys_initcall(default_bdi_init);
241
Artem Bityutskiy64677162010-07-25 14:29:22 +0300242/*
Tejun Heof0054bb2015-05-22 17:13:30 -0400243 * This function is used when the first inode for this wb is marked dirty. It
Artem Bityutskiy64677162010-07-25 14:29:22 +0300244 * 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.
248 *
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.
Derek Basehore6ca738d2014-04-03 14:46:22 -0700252 *
253 * We have to be careful not to postpone flush work if it is scheduled for
254 * earlier. Thus we use queue_delayed_work().
Artem Bityutskiy64677162010-07-25 14:29:22 +0300255 */
Tejun Heof0054bb2015-05-22 17:13:30 -0400256void wb_wakeup_delayed(struct bdi_writeback *wb)
Artem Bityutskiy64677162010-07-25 14:29:22 +0300257{
258 unsigned long timeout;
259
260 timeout = msecs_to_jiffies(dirty_writeback_interval * 10);
Khazhismel Kumykovf96b9f72022-08-01 08:50:34 -0700261 spin_lock_irq(&wb->work_lock);
Tejun Heof0054bb2015-05-22 17:13:30 -0400262 if (test_bit(WB_registered, &wb->state))
263 queue_delayed_work(bdi_wq, &wb->dwork, timeout);
Khazhismel Kumykovf96b9f72022-08-01 08:50:34 -0700264 spin_unlock_irq(&wb->work_lock);
Jens Axboe03ba3782009-09-09 09:08:54 +0200265}
266
Jan Kara45a29662021-09-02 14:53:09 -0700267static void wb_update_bandwidth_workfn(struct work_struct *work)
268{
269 struct bdi_writeback *wb = container_of(to_delayed_work(work),
270 struct bdi_writeback, bw_dwork);
271
272 wb_update_bandwidth(wb);
273}
274
Jens Axboecfc4ba52009-09-14 13:12:40 +0200275/*
Tejun Heoa88a3412015-05-22 17:13:28 -0400276 * Initial write bandwidth: 100 MB/s
Jens Axboecfc4ba52009-09-14 13:12:40 +0200277 */
Tejun Heoa88a3412015-05-22 17:13:28 -0400278#define INIT_BW (100 << (20 - PAGE_SHIFT))
Jens Axboecfc4ba52009-09-14 13:12:40 +0200279
Tejun Heo8395cd92015-05-22 17:13:34 -0400280static int wb_init(struct bdi_writeback *wb, struct backing_dev_info *bdi,
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200281 gfp_t gfp)
Artem Bityutskiy64677162010-07-25 14:29:22 +0300282{
Tejun Heo93f78d82015-05-22 17:13:27 -0400283 int i, err;
284
Artem Bityutskiy64677162010-07-25 14:29:22 +0300285 memset(wb, 0, sizeof(*wb));
286
Jan Kara810df542017-03-23 01:36:55 +0100287 if (wb != &bdi->wb)
288 bdi_get(bdi);
Artem Bityutskiy64677162010-07-25 14:29:22 +0300289 wb->bdi = bdi;
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);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500294 INIT_LIST_HEAD(&wb->b_dirty_time);
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600295 spin_lock_init(&wb->list_lock);
Tejun Heo93f78d82015-05-22 17:13:27 -0400296
Jan Kara633a2ab2021-09-02 14:53:04 -0700297 atomic_set(&wb->writeback_inodes, 0);
Tejun Heoa88a3412015-05-22 17:13:28 -0400298 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;
303
Tejun Heof0054bb2015-05-22 17:13:30 -0400304 spin_lock_init(&wb->work_lock);
305 INIT_LIST_HEAD(&wb->work_list);
306 INIT_DELAYED_WORK(&wb->dwork, wb_workfn);
Jan Kara45a29662021-09-02 14:53:09 -0700307 INIT_DELAYED_WORK(&wb->bw_dwork, wb_update_bandwidth_workfn);
Jens Axboeb57d74a2016-09-01 10:20:33 -0600308 wb->dirty_sleep = jiffies;
Tejun Heof0054bb2015-05-22 17:13:30 -0400309
Tejun Heo8395cd92015-05-22 17:13:34 -0400310 err = fprop_local_init_percpu(&wb->completions, gfp);
Tejun Heoa88a3412015-05-22 17:13:28 -0400311 if (err)
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200312 goto out_put_bdi;
Tejun Heoa88a3412015-05-22 17:13:28 -0400313
Tejun Heo93f78d82015-05-22 17:13:27 -0400314 for (i = 0; i < NR_WB_STAT_ITEMS; i++) {
Tejun Heo8395cd92015-05-22 17:13:34 -0400315 err = percpu_counter_init(&wb->stat[i], 0, gfp);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600316 if (err)
317 goto out_destroy_stat;
Tejun Heo93f78d82015-05-22 17:13:27 -0400318 }
319
320 return 0;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600321
322out_destroy_stat:
Rasmus Villemoes078c6c32016-02-11 16:13:06 -0800323 while (i--)
Tejun Heoa13f35e2015-07-02 08:44:34 -0600324 percpu_counter_destroy(&wb->stat[i]);
325 fprop_local_destroy_percpu(&wb->completions);
Jan Kara810df542017-03-23 01:36:55 +0100326out_put_bdi:
327 if (wb != &bdi->wb)
328 bdi_put(bdi);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600329 return err;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700330}
Jens Axboe03ba3782009-09-09 09:08:54 +0200331
Jan Karae8cb72b2017-03-23 01:36:56 +0100332static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb);
333
Tejun Heo46100072015-05-22 17:13:31 -0400334/*
335 * Remove bdi from the global list and shutdown any threads we have running
336 */
337static void wb_shutdown(struct bdi_writeback *wb)
338{
339 /* Make sure nobody queues further work */
Khazhismel Kumykovf96b9f72022-08-01 08:50:34 -0700340 spin_lock_irq(&wb->work_lock);
Tejun Heo46100072015-05-22 17:13:31 -0400341 if (!test_and_clear_bit(WB_registered, &wb->state)) {
Khazhismel Kumykovf96b9f72022-08-01 08:50:34 -0700342 spin_unlock_irq(&wb->work_lock);
Tejun Heo46100072015-05-22 17:13:31 -0400343 return;
344 }
Khazhismel Kumykovf96b9f72022-08-01 08:50:34 -0700345 spin_unlock_irq(&wb->work_lock);
Tejun Heo46100072015-05-22 17:13:31 -0400346
Jan Karae8cb72b2017-03-23 01:36:56 +0100347 cgwb_remove_from_bdi_list(wb);
Tejun Heo46100072015-05-22 17:13:31 -0400348 /*
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.
352 */
353 mod_delayed_work(bdi_wq, &wb->dwork, 0);
354 flush_delayed_work(&wb->dwork);
355 WARN_ON(!list_empty(&wb->work_list));
Jan Kara45a29662021-09-02 14:53:09 -0700356 flush_delayed_work(&wb->bw_dwork);
Tejun Heo46100072015-05-22 17:13:31 -0400357}
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/*
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700378 * cgwb_lock protects bdi->cgwb_tree, blkcg->cgwb_list, offline_cgwbs and
379 * memcg->cgwb_list. 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
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700384static LIST_HEAD(offline_cgwbs);
385static void cleanup_offline_cgwbs_workfn(struct work_struct *work);
386static DECLARE_WORK(cleanup_offline_cgwbs_work, cleanup_offline_cgwbs_workfn);
387
Baokun Li2db4b912023-04-10 21:08:26 +0800388static void cgwb_free_rcu(struct rcu_head *rcu_head)
389{
390 struct bdi_writeback *wb = container_of(rcu_head,
391 struct bdi_writeback, rcu);
392
393 percpu_ref_exit(&wb->refcnt);
394 kfree(wb);
395}
396
Tejun Heo52ebea72015-05-22 17:13:37 -0400397static void cgwb_release_workfn(struct work_struct *work)
398{
399 struct bdi_writeback *wb = container_of(work, struct bdi_writeback,
400 release_work);
Dennis Zhou (Facebook)59b57712018-08-31 16:22:43 -0400401 struct blkcg *blkcg = css_to_blkcg(wb->blkcg_css);
Tejun Heo52ebea72015-05-22 17:13:37 -0400402
Jan Kara3ee7e862018-06-18 15:46:58 +0200403 mutex_lock(&wb->bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400404 wb_shutdown(wb);
405
406 css_put(wb->memcg_css);
407 css_put(wb->blkcg_css);
Jan Kara3ee7e862018-06-18 15:46:58 +0200408 mutex_unlock(&wb->bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400409
Tejun Heod866dbf2019-07-24 10:37:22 -0700410 /* triggers blkg destruction if no online users left */
411 blkcg_unpin_online(blkcg);
Dennis Zhou (Facebook)59b57712018-08-31 16:22:43 -0400412
Tejun Heo841710a2015-05-22 18:23:33 -0400413 fprop_local_destroy_percpu(&wb->memcg_completions);
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700414
415 spin_lock_irq(&cgwb_lock);
416 list_del(&wb->offline_node);
417 spin_unlock_irq(&cgwb_lock);
418
Tejun Heo52ebea72015-05-22 17:13:37 -0400419 wb_exit(wb);
Roman Gushchinf3b6a6d2021-06-28 19:35:53 -0700420 WARN_ON_ONCE(!list_empty(&wb->b_attached));
Baokun Li2db4b912023-04-10 21:08:26 +0800421 call_rcu(&wb->rcu, cgwb_free_rcu);
Tejun Heo52ebea72015-05-22 17:13:37 -0400422}
423
424static void cgwb_release(struct percpu_ref *refcnt)
425{
426 struct bdi_writeback *wb = container_of(refcnt, struct bdi_writeback,
427 refcnt);
Tejun Heof1834642018-05-23 10:56:32 -0700428 queue_work(cgwb_release_wq, &wb->release_work);
Tejun Heo52ebea72015-05-22 17:13:37 -0400429}
430
431static void cgwb_kill(struct bdi_writeback *wb)
432{
433 lockdep_assert_held(&cgwb_lock);
434
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);
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700438 list_add(&wb->offline_node, &offline_cgwbs);
Tejun Heo52ebea72015-05-22 17:13:37 -0400439 percpu_ref_kill(&wb->refcnt);
440}
441
Jan Karae8cb72b2017-03-23 01:36:56 +0100442static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
443{
444 spin_lock_irq(&cgwb_lock);
445 list_del_rcu(&wb->bdi_node);
446 spin_unlock_irq(&cgwb_lock);
447}
448
Tejun Heo52ebea72015-05-22 17:13:37 -0400449static int cgwb_create(struct backing_dev_info *bdi,
450 struct cgroup_subsys_state *memcg_css, gfp_t gfp)
451{
452 struct mem_cgroup *memcg;
453 struct cgroup_subsys_state *blkcg_css;
454 struct blkcg *blkcg;
455 struct list_head *memcg_cgwb_list, *blkcg_cgwb_list;
456 struct bdi_writeback *wb;
457 unsigned long flags;
458 int ret = 0;
459
460 memcg = mem_cgroup_from_css(memcg_css);
Tejun Heoc165b3e2015-08-18 14:55:29 -0700461 blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
Tejun Heo52ebea72015-05-22 17:13:37 -0400462 blkcg = css_to_blkcg(blkcg_css);
Wang Long9ccc3612018-06-07 17:07:19 -0700463 memcg_cgwb_list = &memcg->cgwb_list;
Tejun Heo52ebea72015-05-22 17:13:37 -0400464 blkcg_cgwb_list = &blkcg->cgwb_list;
465
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) {
470 cgwb_kill(wb);
471 wb = NULL;
472 }
473 spin_unlock_irqrestore(&cgwb_lock, flags);
474 if (wb)
475 goto out_put;
476
477 /* need to create a new one */
478 wb = kmalloc(sizeof(*wb), gfp);
Christophe JAILLET0b045bd2017-09-11 21:43:23 +0200479 if (!wb) {
480 ret = -ENOMEM;
481 goto out_put;
482 }
Tejun Heo52ebea72015-05-22 17:13:37 -0400483
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200484 ret = wb_init(wb, bdi, gfp);
Tejun Heo52ebea72015-05-22 17:13:37 -0400485 if (ret)
486 goto err_free;
487
488 ret = percpu_ref_init(&wb->refcnt, cgwb_release, 0, gfp);
489 if (ret)
490 goto err_wb_exit;
491
Tejun Heo841710a2015-05-22 18:23:33 -0400492 ret = fprop_local_init_percpu(&wb->memcg_completions, gfp);
493 if (ret)
494 goto err_ref_exit;
495
Tejun Heo52ebea72015-05-22 17:13:37 -0400496 wb->memcg_css = memcg_css;
497 wb->blkcg_css = blkcg_css;
Roman Gushchinf3b6a6d2021-06-28 19:35:53 -0700498 INIT_LIST_HEAD(&wb->b_attached);
Tejun Heo52ebea72015-05-22 17:13:37 -0400499 INIT_WORK(&wb->release_work, cgwb_release_workfn);
500 set_bit(WB_registered, &wb->state);
501
502 /*
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().
507 */
508 ret = -ENODEV;
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);
514 if (!ret) {
Tejun Heob8175252015-10-02 14:47:05 -0400515 list_add_tail_rcu(&wb->bdi_node, &bdi->wb_list);
Tejun Heo52ebea72015-05-22 17:13:37 -0400516 list_add(&wb->memcg_node, memcg_cgwb_list);
517 list_add(&wb->blkcg_node, blkcg_cgwb_list);
Tejun Heod866dbf2019-07-24 10:37:22 -0700518 blkcg_pin_online(blkcg);
Tejun Heo52ebea72015-05-22 17:13:37 -0400519 css_get(memcg_css);
520 css_get(blkcg_css);
521 }
522 }
523 spin_unlock_irqrestore(&cgwb_lock, flags);
524 if (ret) {
525 if (ret == -EEXIST)
526 ret = 0;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600527 goto err_fprop_exit;
Tejun Heo52ebea72015-05-22 17:13:37 -0400528 }
529 goto out_put;
530
Tejun Heo841710a2015-05-22 18:23:33 -0400531err_fprop_exit:
532 fprop_local_destroy_percpu(&wb->memcg_completions);
Tejun Heo52ebea72015-05-22 17:13:37 -0400533err_ref_exit:
534 percpu_ref_exit(&wb->refcnt);
535err_wb_exit:
536 wb_exit(wb);
537err_free:
538 kfree(wb);
539out_put:
540 css_put(blkcg_css);
541 return ret;
542}
543
544/**
Tejun Heoed288dc2019-08-26 09:06:54 -0700545 * wb_get_lookup - get wb for a given memcg
Tejun Heo52ebea72015-05-22 17:13:37 -0400546 * @bdi: target bdi
547 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
Tejun Heo52ebea72015-05-22 17:13:37 -0400548 *
Tejun Heoed288dc2019-08-26 09:06:54 -0700549 * Try to get the wb for @memcg_css on @bdi. The returned wb has its
550 * refcount incremented.
Tejun Heo52ebea72015-05-22 17:13:37 -0400551 *
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.
555 *
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.
560 *
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
565 * created.
566 */
Tejun Heoed288dc2019-08-26 09:06:54 -0700567struct bdi_writeback *wb_get_lookup(struct backing_dev_info *bdi,
568 struct cgroup_subsys_state *memcg_css)
569{
570 struct bdi_writeback *wb;
571
572 if (!memcg_css->parent)
573 return &bdi->wb;
574
575 rcu_read_lock();
576 wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
577 if (wb) {
578 struct cgroup_subsys_state *blkcg_css;
579
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)))
583 wb = NULL;
584 css_put(blkcg_css);
585 }
586 rcu_read_unlock();
587
588 return wb;
589}
590
591/**
592 * wb_get_create - get wb for a given memcg, create if necessary
593 * @bdi: target bdi
594 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
595 * @gfp: allocation mask to use
596 *
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.
599 */
Tejun Heo52ebea72015-05-22 17:13:37 -0400600struct bdi_writeback *wb_get_create(struct backing_dev_info *bdi,
601 struct cgroup_subsys_state *memcg_css,
602 gfp_t gfp)
603{
604 struct bdi_writeback *wb;
605
Daniel Vetterc1ca59a2021-02-25 17:18:45 -0800606 might_alloc(gfp);
Tejun Heo52ebea72015-05-22 17:13:37 -0400607
608 if (!memcg_css->parent)
609 return &bdi->wb;
610
611 do {
Tejun Heoed288dc2019-08-26 09:06:54 -0700612 wb = wb_get_lookup(bdi, memcg_css);
Tejun Heo52ebea72015-05-22 17:13:37 -0400613 } while (!wb && !cgwb_create(bdi, memcg_css, gfp));
614
615 return wb;
616}
617
Tejun Heoa13f35e2015-07-02 08:44:34 -0600618static int cgwb_bdi_init(struct backing_dev_info *bdi)
Tejun Heo52ebea72015-05-22 17:13:37 -0400619{
Tejun Heoa13f35e2015-07-02 08:44:34 -0600620 int ret;
621
Tejun Heo52ebea72015-05-22 17:13:37 -0400622 INIT_RADIX_TREE(&bdi->cgwb_tree, GFP_ATOMIC);
Jan Kara3ee7e862018-06-18 15:46:58 +0200623 mutex_init(&bdi->cgwb_release_mutex);
Tejun Heo7fc58542017-12-12 08:38:30 -0800624 init_rwsem(&bdi->wb_switch_rwsem);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600625
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200626 ret = wb_init(&bdi->wb, bdi, GFP_KERNEL);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600627 if (!ret) {
Johannes Weiner7d828602016-01-14 15:20:56 -0800628 bdi->wb.memcg_css = &root_mem_cgroup->css;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600629 bdi->wb.blkcg_css = blkcg_root_css;
630 }
631 return ret;
Tejun Heo52ebea72015-05-22 17:13:37 -0400632}
633
Jan Karab1c51af2017-03-23 01:36:59 +0100634static void cgwb_bdi_unregister(struct backing_dev_info *bdi)
Tejun Heo52ebea72015-05-22 17:13:37 -0400635{
636 struct radix_tree_iter iter;
637 void **slot;
Jan Kara5318ce72017-03-23 01:36:57 +0100638 struct bdi_writeback *wb;
Tejun Heo52ebea72015-05-22 17:13:37 -0400639
640 WARN_ON(test_bit(WB_registered, &bdi->wb.state));
641
642 spin_lock_irq(&cgwb_lock);
643 radix_tree_for_each_slot(slot, &bdi->cgwb_tree, &iter, 0)
644 cgwb_kill(*slot);
Jan Kara3ee7e862018-06-18 15:46:58 +0200645 spin_unlock_irq(&cgwb_lock);
Jan Kara5318ce72017-03-23 01:36:57 +0100646
Jan Kara3ee7e862018-06-18 15:46:58 +0200647 mutex_lock(&bdi->cgwb_release_mutex);
648 spin_lock_irq(&cgwb_lock);
Jan Kara5318ce72017-03-23 01:36:57 +0100649 while (!list_empty(&bdi->wb_list)) {
650 wb = list_first_entry(&bdi->wb_list, struct bdi_writeback,
651 bdi_node);
652 spin_unlock_irq(&cgwb_lock);
653 wb_shutdown(wb);
654 spin_lock_irq(&cgwb_lock);
655 }
Tejun Heo52ebea72015-05-22 17:13:37 -0400656 spin_unlock_irq(&cgwb_lock);
Jan Kara3ee7e862018-06-18 15:46:58 +0200657 mutex_unlock(&bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400658}
659
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700660/*
661 * cleanup_offline_cgwbs_workfn - try to release dying cgwbs
662 *
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.
666 */
667static void cleanup_offline_cgwbs_workfn(struct work_struct *work)
668{
669 struct bdi_writeback *wb;
670 LIST_HEAD(processed);
671
672 spin_lock_irq(&cgwb_lock);
673
674 while (!list_empty(&offline_cgwbs)) {
675 wb = list_first_entry(&offline_cgwbs, struct bdi_writeback,
676 offline_node);
677 list_move(&wb->offline_node, &processed);
678
679 /*
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
686 * a new cgwb.
687 */
688 if (wb_has_dirty_io(wb))
689 continue;
690
691 if (!wb_tryget(wb))
692 continue;
693
694 spin_unlock_irq(&cgwb_lock);
695 while (cleanup_offline_cgwb(wb))
696 cond_resched();
697 spin_lock_irq(&cgwb_lock);
698
699 wb_put(wb);
700 }
701
702 if (!list_empty(&processed))
703 list_splice_tail(&processed, &offline_cgwbs);
704
705 spin_unlock_irq(&cgwb_lock);
706}
707
Tejun Heo52ebea72015-05-22 17:13:37 -0400708/**
709 * wb_memcg_offline - kill all wb's associated with a memcg being offlined
710 * @memcg: memcg being offlined
711 *
712 * Also prevents creation of any new wb's associated with @memcg.
713 */
714void wb_memcg_offline(struct mem_cgroup *memcg)
715{
Wang Long9ccc3612018-06-07 17:07:19 -0700716 struct list_head *memcg_cgwb_list = &memcg->cgwb_list;
Tejun Heo52ebea72015-05-22 17:13:37 -0400717 struct bdi_writeback *wb, *next;
718
719 spin_lock_irq(&cgwb_lock);
720 list_for_each_entry_safe(wb, next, memcg_cgwb_list, memcg_node)
721 cgwb_kill(wb);
722 memcg_cgwb_list->next = NULL; /* prevent new wb's */
723 spin_unlock_irq(&cgwb_lock);
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700724
725 queue_work(system_unbound_wq, &cleanup_offline_cgwbs_work);
Tejun Heo52ebea72015-05-22 17:13:37 -0400726}
727
728/**
729 * wb_blkcg_offline - kill all wb's associated with a blkcg being offlined
730 * @blkcg: blkcg being offlined
731 *
732 * Also prevents creation of any new wb's associated with @blkcg.
733 */
734void wb_blkcg_offline(struct blkcg *blkcg)
735{
Tejun Heo52ebea72015-05-22 17:13:37 -0400736 struct bdi_writeback *wb, *next;
737
738 spin_lock_irq(&cgwb_lock);
739 list_for_each_entry_safe(wb, next, &blkcg->cgwb_list, blkcg_node)
740 cgwb_kill(wb);
741 blkcg->cgwb_list.next = NULL; /* prevent new wb's */
742 spin_unlock_irq(&cgwb_lock);
743}
744
Jan Karae8cb72b2017-03-23 01:36:56 +0100745static void cgwb_bdi_register(struct backing_dev_info *bdi)
746{
747 spin_lock_irq(&cgwb_lock);
748 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
749 spin_unlock_irq(&cgwb_lock);
750}
751
Tejun Heof1834642018-05-23 10:56:32 -0700752static int __init cgwb_init(void)
753{
754 /*
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.
758 */
759 cgwb_release_wq = alloc_workqueue("cgwb_release", 0, 1);
760 if (!cgwb_release_wq)
761 return -ENOMEM;
762
763 return 0;
764}
765subsys_initcall(cgwb_init);
766
Tejun Heo52ebea72015-05-22 17:13:37 -0400767#else /* CONFIG_CGROUP_WRITEBACK */
768
Tejun Heoa13f35e2015-07-02 08:44:34 -0600769static int cgwb_bdi_init(struct backing_dev_info *bdi)
770{
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200771 return wb_init(&bdi->wb, bdi, GFP_KERNEL);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600772}
773
Jan Karab1c51af2017-03-23 01:36:59 +0100774static void cgwb_bdi_unregister(struct backing_dev_info *bdi) { }
Jan Karadf23de52017-03-08 17:48:32 +0100775
Jan Karae8cb72b2017-03-23 01:36:56 +0100776static void cgwb_bdi_register(struct backing_dev_info *bdi)
777{
778 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
779}
780
781static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
782{
783 list_del_rcu(&wb->bdi_node);
784}
785
Tejun Heo52ebea72015-05-22 17:13:37 -0400786#endif /* CONFIG_CGROUP_WRITEBACK */
787
Jan Karaca678812022-06-15 15:22:29 +0200788int bdi_init(struct backing_dev_info *bdi)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700789{
Tejun Heob8175252015-10-02 14:47:05 -0400790 int ret;
791
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700792 bdi->dev = NULL;
793
Jan Karad03f6cd2017-02-02 15:56:51 +0100794 kref_init(&bdi->refcnt);
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700795 bdi->min_ratio = 0;
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700796 bdi->max_ratio = 100;
Jan Karaeb608e32012-05-24 18:59:11 +0200797 bdi->max_prop_frac = FPROP_FRAC_BASE;
Jens Axboe66f3b8e2009-09-02 09:19:46 +0200798 INIT_LIST_HEAD(&bdi->bdi_list);
Tejun Heob8175252015-10-02 14:47:05 -0400799 INIT_LIST_HEAD(&bdi->wb_list);
Tejun Heocc395d72015-05-22 17:13:58 -0400800 init_waitqueue_head(&bdi->wb_waitq);
Jens Axboe03ba3782009-09-09 09:08:54 +0200801
Tejun Heob8175252015-10-02 14:47:05 -0400802 ret = cgwb_bdi_init(bdi);
803
Tejun Heob8175252015-10-02 14:47:05 -0400804 return ret;
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700805}
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700806
Christoph Hellwigaef33c22020-05-04 14:48:00 +0200807struct backing_dev_info *bdi_alloc(int node_id)
Jan Karad03f6cd2017-02-02 15:56:51 +0100808{
809 struct backing_dev_info *bdi;
810
Christoph Hellwigaef33c22020-05-04 14:48:00 +0200811 bdi = kzalloc_node(sizeof(*bdi), GFP_KERNEL, node_id);
Jan Karad03f6cd2017-02-02 15:56:51 +0100812 if (!bdi)
813 return NULL;
814
815 if (bdi_init(bdi)) {
816 kfree(bdi);
817 return NULL;
818 }
Christoph Hellwigf56753a2020-09-24 08:51:40 +0200819 bdi->capabilities = BDI_CAP_WRITEBACK | BDI_CAP_WRITEBACK_ACCT;
Christoph Hellwig55b25982020-09-24 08:51:32 +0200820 bdi->ra_pages = VM_READAHEAD_PAGES;
821 bdi->io_pages = VM_READAHEAD_PAGES;
Christoph Hellwig5ed964f2021-08-09 16:17:40 +0200822 timer_setup(&bdi->laptop_mode_wb_timer, laptop_mode_timer_fn, 0);
Jan Karad03f6cd2017-02-02 15:56:51 +0100823 return bdi;
824}
Christoph Hellwigaef33c22020-05-04 14:48:00 +0200825EXPORT_SYMBOL(bdi_alloc);
Jan Karad03f6cd2017-02-02 15:56:51 +0100826
Tejun Heo34f8fe52019-08-26 09:06:53 -0700827static struct rb_node **bdi_lookup_rb_node(u64 id, struct rb_node **parentp)
828{
829 struct rb_node **p = &bdi_tree.rb_node;
830 struct rb_node *parent = NULL;
831 struct backing_dev_info *bdi;
832
833 lockdep_assert_held(&bdi_lock);
834
835 while (*p) {
836 parent = *p;
837 bdi = rb_entry(parent, struct backing_dev_info, rb_node);
838
839 if (bdi->id > id)
840 p = &(*p)->rb_left;
841 else if (bdi->id < id)
842 p = &(*p)->rb_right;
843 else
844 break;
845 }
846
847 if (parentp)
848 *parentp = parent;
849 return p;
850}
851
852/**
853 * bdi_get_by_id - lookup and get bdi from its id
854 * @id: bdi id to lookup
855 *
856 * Find bdi matching @id and get it. Returns NULL if the matching bdi
857 * doesn't exist or is already unregistered.
858 */
859struct backing_dev_info *bdi_get_by_id(u64 id)
860{
861 struct backing_dev_info *bdi = NULL;
862 struct rb_node **p;
863
864 spin_lock_bh(&bdi_lock);
865 p = bdi_lookup_rb_node(id, NULL);
866 if (*p) {
867 bdi = rb_entry(*p, struct backing_dev_info, rb_node);
868 bdi_get(bdi);
869 }
870 spin_unlock_bh(&bdi_lock);
871
872 return bdi;
873}
874
Jan Kara7c4cc302017-04-12 12:24:49 +0200875int bdi_register_va(struct backing_dev_info *bdi, const char *fmt, va_list args)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700876{
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700877 struct device *dev;
Tejun Heo34f8fe52019-08-26 09:06:53 -0700878 struct rb_node *parent, **p;
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700879
880 if (bdi->dev) /* The driver needs to use separate queues per device */
881 return 0;
882
Christoph Hellwig6bd87ee2020-05-04 14:47:56 +0200883 vsnprintf(bdi->dev_name, sizeof(bdi->dev_name), fmt, args);
884 dev = device_create(bdi_class, NULL, MKDEV(0, 0), bdi, bdi->dev_name);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700885 if (IS_ERR(dev))
886 return PTR_ERR(dev);
887
Jan Karae8cb72b2017-03-23 01:36:56 +0100888 cgwb_bdi_register(bdi);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700889 bdi->dev = dev;
890
Jens Axboe6d0e4822017-12-21 10:01:30 -0700891 bdi_debug_register(bdi, dev_name(dev));
Tejun Heo46100072015-05-22 17:13:31 -0400892 set_bit(WB_registered, &bdi->wb.state);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700893
894 spin_lock_bh(&bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700895
896 bdi->id = ++bdi_id_cursor;
897
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);
901
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700902 list_add_tail_rcu(&bdi->bdi_list, &bdi_list);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700903
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700904 spin_unlock_bh(&bdi_lock);
905
906 trace_writeback_bdi_register(bdi);
907 return 0;
908}
Jan Karabaf7a612017-04-12 12:24:25 +0200909
Jan Kara7c4cc302017-04-12 12:24:49 +0200910int bdi_register(struct backing_dev_info *bdi, const char *fmt, ...)
Jan Karabaf7a612017-04-12 12:24:25 +0200911{
912 va_list args;
913 int ret;
914
915 va_start(args, fmt);
Jan Kara7c4cc302017-04-12 12:24:49 +0200916 ret = bdi_register_va(bdi, fmt, args);
Jan Karabaf7a612017-04-12 12:24:25 +0200917 va_end(args);
918 return ret;
919}
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700920EXPORT_SYMBOL(bdi_register);
921
Christoph Hellwig3c5d2022020-05-04 14:47:59 +0200922void bdi_set_owner(struct backing_dev_info *bdi, struct device *owner)
Dan Williamsdf08c322016-07-31 11:15:13 -0700923{
Christoph Hellwig3c5d2022020-05-04 14:47:59 +0200924 WARN_ON_ONCE(bdi->owner);
Dan Williamsdf08c322016-07-31 11:15:13 -0700925 bdi->owner = owner;
926 get_device(owner);
Dan Williamsdf08c322016-07-31 11:15:13 -0700927}
Dan Williamsdf08c322016-07-31 11:15:13 -0700928
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700929/*
Tejun Heo46100072015-05-22 17:13:31 -0400930 * Remove bdi from bdi_list, and ensure that it is no longer visible
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700931 */
Tejun Heo46100072015-05-22 17:13:31 -0400932static void bdi_remove_from_list(struct backing_dev_info *bdi)
Peter Zijlstra04fbfdc2007-10-16 23:25:50 -0700933{
Tejun Heo46100072015-05-22 17:13:31 -0400934 spin_lock_bh(&bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700935 rb_erase(&bdi->rb_node, &bdi_tree);
Tejun Heo46100072015-05-22 17:13:31 -0400936 list_del_rcu(&bdi->bdi_list);
937 spin_unlock_bh(&bdi_lock);
Andrew Morton3fcfab12006-10-19 23:28:16 -0700938
Tejun Heo46100072015-05-22 17:13:31 -0400939 synchronize_rcu_expedited();
Andrew Morton3fcfab12006-10-19 23:28:16 -0700940}
941
Tejun Heob02176f2015-09-08 12:20:22 -0400942void bdi_unregister(struct backing_dev_info *bdi)
Andrew Morton3fcfab12006-10-19 23:28:16 -0700943{
Christoph Hellwig5ed964f2021-08-09 16:17:40 +0200944 del_timer_sync(&bdi->laptop_mode_wb_timer);
945
Tejun Heof0054bb2015-05-22 17:13:30 -0400946 /* make sure nobody finds us on the bdi_list anymore */
947 bdi_remove_from_list(bdi);
948 wb_shutdown(&bdi->wb);
Jan Karab1c51af2017-03-23 01:36:59 +0100949 cgwb_bdi_unregister(bdi);
Rabin Vincent7a401a92011-11-11 13:29:04 +0100950
Manjong Leef987b612021-12-10 14:47:11 -0800951 /*
952 * If this BDI's min ratio has been set, use bdi_set_min_ratio() to
953 * update the global bdi_min_ratio.
954 */
955 if (bdi->min_ratio)
956 bdi_set_min_ratio(bdi, 0);
957
Christoph Hellwigc4db59d2015-01-20 14:05:00 -0700958 if (bdi->dev) {
959 bdi_debug_unregister(bdi);
960 device_unregister(bdi->dev);
961 bdi->dev = NULL;
962 }
Dan Williamsdf08c322016-07-31 11:15:13 -0700963
964 if (bdi->owner) {
965 put_device(bdi->owner);
966 bdi->owner = NULL;
967 }
Tejun Heob02176f2015-09-08 12:20:22 -0400968}
Christoph Hellwigc4db59d2015-01-20 14:05:00 -0700969
Jan Karad03f6cd2017-02-02 15:56:51 +0100970static void release_bdi(struct kref *ref)
971{
972 struct backing_dev_info *bdi =
973 container_of(ref, struct backing_dev_info, refcnt);
974
Jan Kara5af110b2017-04-12 12:24:26 +0200975 if (test_bit(WB_registered, &bdi->wb.state))
976 bdi_unregister(bdi);
Jan Kara2e82b842017-04-12 12:24:48 +0200977 WARN_ON_ONCE(bdi->dev);
978 wb_exit(&bdi->wb);
Jan Karad03f6cd2017-02-02 15:56:51 +0100979 kfree(bdi);
980}
981
982void bdi_put(struct backing_dev_info *bdi)
983{
984 kref_put(&bdi->refcnt, release_bdi);
985}
Jan Kara62bf42a2017-04-12 12:24:27 +0200986EXPORT_SYMBOL(bdi_put);
Jan Karad03f6cd2017-02-02 15:56:51 +0100987
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +0200988const char *bdi_dev_name(struct backing_dev_info *bdi)
989{
990 if (!bdi || !bdi->dev)
991 return bdi_unknown_name;
Christoph Hellwig6bd87ee2020-05-04 14:47:56 +0200992 return bdi->dev_name;
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +0200993}
994EXPORT_SYMBOL_GPL(bdi_dev_name);
995
Andrew Morton3fcfab12006-10-19 23:28:16 -0700996static wait_queue_head_t congestion_wqh[2] = {
997 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[0]),
998 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[1])
999 };
Tejun Heoec8a6f22015-05-22 17:13:41 -04001000static atomic_t nr_wb_congested[2];
Andrew Morton3fcfab12006-10-19 23:28:16 -07001001
Christoph Hellwig492d76b2020-07-01 11:06:20 +02001002void clear_bdi_congested(struct backing_dev_info *bdi, int sync)
Andrew Morton3fcfab12006-10-19 23:28:16 -07001003{
Jens Axboe1faa16d2009-04-06 14:48:01 +02001004 wait_queue_head_t *wqh = &congestion_wqh[sync];
Kaixu Xiac877ef82016-03-31 13:19:41 +00001005 enum wb_congested_state bit;
Andrew Morton3fcfab12006-10-19 23:28:16 -07001006
Tejun Heo44522262015-05-22 17:13:26 -04001007 bit = sync ? WB_sync_congested : WB_async_congested;
Christoph Hellwig8c911f32020-07-01 11:06:21 +02001008 if (test_and_clear_bit(bit, &bdi->wb.congested))
Tejun Heoec8a6f22015-05-22 17:13:41 -04001009 atomic_dec(&nr_wb_congested[sync]);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001010 smp_mb__after_atomic();
Andrew Morton3fcfab12006-10-19 23:28:16 -07001011 if (waitqueue_active(wqh))
1012 wake_up(wqh);
1013}
Christoph Hellwig492d76b2020-07-01 11:06:20 +02001014EXPORT_SYMBOL(clear_bdi_congested);
Andrew Morton3fcfab12006-10-19 23:28:16 -07001015
Christoph Hellwig492d76b2020-07-01 11:06:20 +02001016void set_bdi_congested(struct backing_dev_info *bdi, int sync)
Andrew Morton3fcfab12006-10-19 23:28:16 -07001017{
Kaixu Xiac877ef82016-03-31 13:19:41 +00001018 enum wb_congested_state bit;
Andrew Morton3fcfab12006-10-19 23:28:16 -07001019
Tejun Heo44522262015-05-22 17:13:26 -04001020 bit = sync ? WB_sync_congested : WB_async_congested;
Christoph Hellwig8c911f32020-07-01 11:06:21 +02001021 if (!test_and_set_bit(bit, &bdi->wb.congested))
Tejun Heoec8a6f22015-05-22 17:13:41 -04001022 atomic_inc(&nr_wb_congested[sync]);
Andrew Morton3fcfab12006-10-19 23:28:16 -07001023}
Christoph Hellwig492d76b2020-07-01 11:06:20 +02001024EXPORT_SYMBOL(set_bdi_congested);
Andrew Morton3fcfab12006-10-19 23:28:16 -07001025
1026/**
1027 * congestion_wait - wait for a backing_dev to become uncongested
Jens Axboe8aa7e842009-07-09 14:52:32 +02001028 * @sync: SYNC or ASYNC IO
Andrew Morton3fcfab12006-10-19 23:28:16 -07001029 * @timeout: timeout in jiffies
1030 *
1031 * Waits for up to @timeout jiffies for a backing_dev (any backing_dev) to exit
1032 * write congestion. If no backing_devs are congested then just wait for the
1033 * next write to be completed.
1034 */
Jens Axboe8aa7e842009-07-09 14:52:32 +02001035long congestion_wait(int sync, long timeout)
Andrew Morton3fcfab12006-10-19 23:28:16 -07001036{
1037 long ret;
Mel Gorman52bb9192010-10-26 14:21:41 -07001038 unsigned long start = jiffies;
Andrew Morton3fcfab12006-10-19 23:28:16 -07001039 DEFINE_WAIT(wait);
Jens Axboe8aa7e842009-07-09 14:52:32 +02001040 wait_queue_head_t *wqh = &congestion_wqh[sync];
Andrew Morton3fcfab12006-10-19 23:28:16 -07001041
1042 prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
1043 ret = io_schedule_timeout(timeout);
1044 finish_wait(wqh, &wait);
Mel Gorman52bb9192010-10-26 14:21:41 -07001045
1046 trace_writeback_congestion_wait(jiffies_to_usecs(timeout),
1047 jiffies_to_usecs(jiffies - start));
1048
Andrew Morton3fcfab12006-10-19 23:28:16 -07001049 return ret;
1050}
1051EXPORT_SYMBOL(congestion_wait);
1052
Mel Gorman0e093d992010-10-26 14:21:45 -07001053/**
Mel Gorman599d0c92016-07-28 15:45:31 -07001054 * 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 -07001055 * @sync: SYNC or ASYNC IO
1056 * @timeout: timeout in jiffies
1057 *
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -07001058 * In the event of a congested backing_dev (any backing_dev) this waits
1059 * for up to @timeout jiffies for either a BDI to exit congestion of the
1060 * given @sync queue or a write to complete.
Mel Gorman0e093d992010-10-26 14:21:45 -07001061 *
1062 * The return value is 0 if the sleep is for the full timeout. Otherwise,
1063 * it is the number of jiffies that were still remaining when the function
1064 * returned. return_value == timeout implies the function did not sleep.
1065 */
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -07001066long wait_iff_congested(int sync, long timeout)
Mel Gorman0e093d992010-10-26 14:21:45 -07001067{
1068 long ret;
1069 unsigned long start = jiffies;
1070 DEFINE_WAIT(wait);
1071 wait_queue_head_t *wqh = &congestion_wqh[sync];
1072
1073 /*
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -07001074 * If there is no congestion, yield if necessary instead
Mel Gorman0e093d992010-10-26 14:21:45 -07001075 * of sleeping on the congestion queue
1076 */
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -07001077 if (atomic_read(&nr_wb_congested[sync]) == 0) {
Michal Hockoede37712016-05-20 16:57:03 -07001078 cond_resched();
Mel Gorman599d0c92016-07-28 15:45:31 -07001079
Mel Gorman0e093d992010-10-26 14:21:45 -07001080 /* In case we scheduled, work out time remaining */
1081 ret = timeout - (jiffies - start);
1082 if (ret < 0)
1083 ret = 0;
1084
1085 goto out;
1086 }
1087
1088 /* Sleep until uncongested or a write happens */
1089 prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
1090 ret = io_schedule_timeout(timeout);
1091 finish_wait(wqh, &wait);
1092
1093out:
1094 trace_writeback_wait_iff_congested(jiffies_to_usecs(timeout),
1095 jiffies_to_usecs(jiffies - start));
1096
1097 return ret;
1098}
1099EXPORT_SYMBOL(wait_iff_congested);