blob: 4a9d4e27d0d9b0f62a29a783f524df6e7396f2d3 [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
Jan Kara2e82b842017-04-12 12:24:48 +0200232static int bdi_init(struct backing_dev_info *bdi);
233
Jens Axboe26160152009-03-17 09:35:06 +0100234static int __init default_bdi_init(void)
235{
236 int err;
237
Mika Westerberga2b90f12019-10-04 13:00:24 +0300238 bdi_wq = alloc_workqueue("writeback", WQ_MEM_RECLAIM | WQ_UNBOUND |
239 WQ_SYSFS, 0);
Tejun Heo839a8e82013-04-01 19:08:06 -0700240 if (!bdi_wq)
241 return -ENOMEM;
242
Jan Kara976e48f2010-09-21 11:48:55 +0200243 err = bdi_init(&noop_backing_dev_info);
Jens Axboe26160152009-03-17 09:35:06 +0100244
245 return err;
246}
247subsys_initcall(default_bdi_init);
248
Artem Bityutskiy64677162010-07-25 14:29:22 +0300249/*
Tejun Heof0054bb2015-05-22 17:13:30 -0400250 * This function is used when the first inode for this wb is marked dirty. It
Artem Bityutskiy64677162010-07-25 14:29:22 +0300251 * wakes-up the corresponding bdi thread which should then take care of the
252 * periodic background write-out of dirty inodes. Since the write-out would
253 * starts only 'dirty_writeback_interval' centisecs from now anyway, we just
254 * set up a timer which wakes the bdi thread up later.
255 *
256 * Note, we wouldn't bother setting up the timer, but this function is on the
257 * fast-path (used by '__mark_inode_dirty()'), so we save few context switches
258 * by delaying the wake-up.
Derek Basehore6ca738d2014-04-03 14:46:22 -0700259 *
260 * We have to be careful not to postpone flush work if it is scheduled for
261 * earlier. Thus we use queue_delayed_work().
Artem Bityutskiy64677162010-07-25 14:29:22 +0300262 */
Tejun Heof0054bb2015-05-22 17:13:30 -0400263void wb_wakeup_delayed(struct bdi_writeback *wb)
Artem Bityutskiy64677162010-07-25 14:29:22 +0300264{
265 unsigned long timeout;
266
267 timeout = msecs_to_jiffies(dirty_writeback_interval * 10);
Tejun Heof0054bb2015-05-22 17:13:30 -0400268 spin_lock_bh(&wb->work_lock);
269 if (test_bit(WB_registered, &wb->state))
270 queue_delayed_work(bdi_wq, &wb->dwork, timeout);
271 spin_unlock_bh(&wb->work_lock);
Jens Axboe03ba3782009-09-09 09:08:54 +0200272}
273
Jan Kara45a29662021-09-02 14:53:09 -0700274static void wb_update_bandwidth_workfn(struct work_struct *work)
275{
276 struct bdi_writeback *wb = container_of(to_delayed_work(work),
277 struct bdi_writeback, bw_dwork);
278
279 wb_update_bandwidth(wb);
280}
281
Jens Axboecfc4ba52009-09-14 13:12:40 +0200282/*
Tejun Heoa88a3412015-05-22 17:13:28 -0400283 * Initial write bandwidth: 100 MB/s
Jens Axboecfc4ba52009-09-14 13:12:40 +0200284 */
Tejun Heoa88a3412015-05-22 17:13:28 -0400285#define INIT_BW (100 << (20 - PAGE_SHIFT))
Jens Axboecfc4ba52009-09-14 13:12:40 +0200286
Tejun Heo8395cd92015-05-22 17:13:34 -0400287static int wb_init(struct bdi_writeback *wb, struct backing_dev_info *bdi,
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200288 gfp_t gfp)
Artem Bityutskiy64677162010-07-25 14:29:22 +0300289{
Tejun Heo93f78d82015-05-22 17:13:27 -0400290 int i, err;
291
Artem Bityutskiy64677162010-07-25 14:29:22 +0300292 memset(wb, 0, sizeof(*wb));
293
Jan Kara810df542017-03-23 01:36:55 +0100294 if (wb != &bdi->wb)
295 bdi_get(bdi);
Artem Bityutskiy64677162010-07-25 14:29:22 +0300296 wb->bdi = bdi;
297 wb->last_old_flush = jiffies;
298 INIT_LIST_HEAD(&wb->b_dirty);
299 INIT_LIST_HEAD(&wb->b_io);
300 INIT_LIST_HEAD(&wb->b_more_io);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500301 INIT_LIST_HEAD(&wb->b_dirty_time);
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600302 spin_lock_init(&wb->list_lock);
Tejun Heo93f78d82015-05-22 17:13:27 -0400303
Jan Kara633a2ab2021-09-02 14:53:04 -0700304 atomic_set(&wb->writeback_inodes, 0);
Tejun Heoa88a3412015-05-22 17:13:28 -0400305 wb->bw_time_stamp = jiffies;
306 wb->balanced_dirty_ratelimit = INIT_BW;
307 wb->dirty_ratelimit = INIT_BW;
308 wb->write_bandwidth = INIT_BW;
309 wb->avg_write_bandwidth = INIT_BW;
310
Tejun Heof0054bb2015-05-22 17:13:30 -0400311 spin_lock_init(&wb->work_lock);
312 INIT_LIST_HEAD(&wb->work_list);
313 INIT_DELAYED_WORK(&wb->dwork, wb_workfn);
Jan Kara45a29662021-09-02 14:53:09 -0700314 INIT_DELAYED_WORK(&wb->bw_dwork, wb_update_bandwidth_workfn);
Jens Axboeb57d74a2016-09-01 10:20:33 -0600315 wb->dirty_sleep = jiffies;
Tejun Heof0054bb2015-05-22 17:13:30 -0400316
Tejun Heo8395cd92015-05-22 17:13:34 -0400317 err = fprop_local_init_percpu(&wb->completions, gfp);
Tejun Heoa88a3412015-05-22 17:13:28 -0400318 if (err)
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200319 goto out_put_bdi;
Tejun Heoa88a3412015-05-22 17:13:28 -0400320
Tejun Heo93f78d82015-05-22 17:13:27 -0400321 for (i = 0; i < NR_WB_STAT_ITEMS; i++) {
Tejun Heo8395cd92015-05-22 17:13:34 -0400322 err = percpu_counter_init(&wb->stat[i], 0, gfp);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600323 if (err)
324 goto out_destroy_stat;
Tejun Heo93f78d82015-05-22 17:13:27 -0400325 }
326
327 return 0;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600328
329out_destroy_stat:
Rasmus Villemoes078c6c32016-02-11 16:13:06 -0800330 while (i--)
Tejun Heoa13f35e2015-07-02 08:44:34 -0600331 percpu_counter_destroy(&wb->stat[i]);
332 fprop_local_destroy_percpu(&wb->completions);
Jan Kara810df542017-03-23 01:36:55 +0100333out_put_bdi:
334 if (wb != &bdi->wb)
335 bdi_put(bdi);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600336 return err;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700337}
Jens Axboe03ba3782009-09-09 09:08:54 +0200338
Jan Karae8cb72b2017-03-23 01:36:56 +0100339static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb);
340
Tejun Heo46100072015-05-22 17:13:31 -0400341/*
342 * Remove bdi from the global list and shutdown any threads we have running
343 */
344static void wb_shutdown(struct bdi_writeback *wb)
345{
346 /* Make sure nobody queues further work */
347 spin_lock_bh(&wb->work_lock);
348 if (!test_and_clear_bit(WB_registered, &wb->state)) {
349 spin_unlock_bh(&wb->work_lock);
350 return;
351 }
352 spin_unlock_bh(&wb->work_lock);
353
Jan Karae8cb72b2017-03-23 01:36:56 +0100354 cgwb_remove_from_bdi_list(wb);
Tejun Heo46100072015-05-22 17:13:31 -0400355 /*
356 * Drain work list and shutdown the delayed_work. !WB_registered
357 * tells wb_workfn() that @wb is dying and its work_list needs to
358 * be drained no matter what.
359 */
360 mod_delayed_work(bdi_wq, &wb->dwork, 0);
361 flush_delayed_work(&wb->dwork);
362 WARN_ON(!list_empty(&wb->work_list));
Jan Kara45a29662021-09-02 14:53:09 -0700363 flush_delayed_work(&wb->bw_dwork);
Tejun Heo46100072015-05-22 17:13:31 -0400364}
365
Tejun Heof0054bb2015-05-22 17:13:30 -0400366static void wb_exit(struct bdi_writeback *wb)
Tejun Heo93f78d82015-05-22 17:13:27 -0400367{
368 int i;
369
370 WARN_ON(delayed_work_pending(&wb->dwork));
371
372 for (i = 0; i < NR_WB_STAT_ITEMS; i++)
373 percpu_counter_destroy(&wb->stat[i]);
Artem Bityutskiy64677162010-07-25 14:29:22 +0300374
Tejun Heoa88a3412015-05-22 17:13:28 -0400375 fprop_local_destroy_percpu(&wb->completions);
Jan Kara810df542017-03-23 01:36:55 +0100376 if (wb != &wb->bdi->wb)
377 bdi_put(wb->bdi);
Tejun Heoa88a3412015-05-22 17:13:28 -0400378}
Wu Fengguange98be2d2010-08-29 11:22:30 -0600379
Tejun Heo52ebea72015-05-22 17:13:37 -0400380#ifdef CONFIG_CGROUP_WRITEBACK
381
382#include <linux/memcontrol.h>
383
384/*
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700385 * cgwb_lock protects bdi->cgwb_tree, blkcg->cgwb_list, offline_cgwbs and
386 * memcg->cgwb_list. bdi->cgwb_tree is also RCU protected.
Tejun Heo52ebea72015-05-22 17:13:37 -0400387 */
388static DEFINE_SPINLOCK(cgwb_lock);
Tejun Heof1834642018-05-23 10:56:32 -0700389static struct workqueue_struct *cgwb_release_wq;
Tejun Heo52ebea72015-05-22 17:13:37 -0400390
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700391static LIST_HEAD(offline_cgwbs);
392static void cleanup_offline_cgwbs_workfn(struct work_struct *work);
393static DECLARE_WORK(cleanup_offline_cgwbs_work, cleanup_offline_cgwbs_workfn);
394
Tejun Heo52ebea72015-05-22 17:13:37 -0400395static void cgwb_release_workfn(struct work_struct *work)
396{
397 struct bdi_writeback *wb = container_of(work, struct bdi_writeback,
398 release_work);
Dennis Zhou (Facebook)59b57712018-08-31 16:22:43 -0400399 struct blkcg *blkcg = css_to_blkcg(wb->blkcg_css);
Tejun Heo52ebea72015-05-22 17:13:37 -0400400
Jan Kara3ee7e862018-06-18 15:46:58 +0200401 mutex_lock(&wb->bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400402 wb_shutdown(wb);
403
404 css_put(wb->memcg_css);
405 css_put(wb->blkcg_css);
Jan Kara3ee7e862018-06-18 15:46:58 +0200406 mutex_unlock(&wb->bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400407
Tejun Heod866dbf2019-07-24 10:37:22 -0700408 /* triggers blkg destruction if no online users left */
409 blkcg_unpin_online(blkcg);
Dennis Zhou (Facebook)59b57712018-08-31 16:22:43 -0400410
Tejun Heo841710a2015-05-22 18:23:33 -0400411 fprop_local_destroy_percpu(&wb->memcg_completions);
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700412
413 spin_lock_irq(&cgwb_lock);
414 list_del(&wb->offline_node);
415 spin_unlock_irq(&cgwb_lock);
416
Roman Gushchinb43a9e72021-07-23 15:50:29 -0700417 percpu_ref_exit(&wb->refcnt);
Tejun Heo52ebea72015-05-22 17:13:37 -0400418 wb_exit(wb);
Roman Gushchinf3b6a6d2021-06-28 19:35:53 -0700419 WARN_ON_ONCE(!list_empty(&wb->b_attached));
Tejun Heo52ebea72015-05-22 17:13:37 -0400420 kfree_rcu(wb, rcu);
Tejun Heo52ebea72015-05-22 17:13:37 -0400421}
422
423static void cgwb_release(struct percpu_ref *refcnt)
424{
425 struct bdi_writeback *wb = container_of(refcnt, struct bdi_writeback,
426 refcnt);
Tejun Heof1834642018-05-23 10:56:32 -0700427 queue_work(cgwb_release_wq, &wb->release_work);
Tejun Heo52ebea72015-05-22 17:13:37 -0400428}
429
430static void cgwb_kill(struct bdi_writeback *wb)
431{
432 lockdep_assert_held(&cgwb_lock);
433
434 WARN_ON(!radix_tree_delete(&wb->bdi->cgwb_tree, wb->memcg_css->id));
435 list_del(&wb->memcg_node);
436 list_del(&wb->blkcg_node);
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700437 list_add(&wb->offline_node, &offline_cgwbs);
Tejun Heo52ebea72015-05-22 17:13:37 -0400438 percpu_ref_kill(&wb->refcnt);
439}
440
Jan Karae8cb72b2017-03-23 01:36:56 +0100441static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
442{
443 spin_lock_irq(&cgwb_lock);
444 list_del_rcu(&wb->bdi_node);
445 spin_unlock_irq(&cgwb_lock);
446}
447
Tejun Heo52ebea72015-05-22 17:13:37 -0400448static int cgwb_create(struct backing_dev_info *bdi,
449 struct cgroup_subsys_state *memcg_css, gfp_t gfp)
450{
451 struct mem_cgroup *memcg;
452 struct cgroup_subsys_state *blkcg_css;
453 struct blkcg *blkcg;
454 struct list_head *memcg_cgwb_list, *blkcg_cgwb_list;
455 struct bdi_writeback *wb;
456 unsigned long flags;
457 int ret = 0;
458
459 memcg = mem_cgroup_from_css(memcg_css);
Tejun Heoc165b3e2015-08-18 14:55:29 -0700460 blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
Tejun Heo52ebea72015-05-22 17:13:37 -0400461 blkcg = css_to_blkcg(blkcg_css);
Wang Long9ccc3612018-06-07 17:07:19 -0700462 memcg_cgwb_list = &memcg->cgwb_list;
Tejun Heo52ebea72015-05-22 17:13:37 -0400463 blkcg_cgwb_list = &blkcg->cgwb_list;
464
465 /* look up again under lock and discard on blkcg mismatch */
466 spin_lock_irqsave(&cgwb_lock, flags);
467 wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
468 if (wb && wb->blkcg_css != blkcg_css) {
469 cgwb_kill(wb);
470 wb = NULL;
471 }
472 spin_unlock_irqrestore(&cgwb_lock, flags);
473 if (wb)
474 goto out_put;
475
476 /* need to create a new one */
477 wb = kmalloc(sizeof(*wb), gfp);
Christophe JAILLET0b045bd2017-09-11 21:43:23 +0200478 if (!wb) {
479 ret = -ENOMEM;
480 goto out_put;
481 }
Tejun Heo52ebea72015-05-22 17:13:37 -0400482
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200483 ret = wb_init(wb, bdi, gfp);
Tejun Heo52ebea72015-05-22 17:13:37 -0400484 if (ret)
485 goto err_free;
486
487 ret = percpu_ref_init(&wb->refcnt, cgwb_release, 0, gfp);
488 if (ret)
489 goto err_wb_exit;
490
Tejun Heo841710a2015-05-22 18:23:33 -0400491 ret = fprop_local_init_percpu(&wb->memcg_completions, gfp);
492 if (ret)
493 goto err_ref_exit;
494
Tejun Heo52ebea72015-05-22 17:13:37 -0400495 wb->memcg_css = memcg_css;
496 wb->blkcg_css = blkcg_css;
Roman Gushchinf3b6a6d2021-06-28 19:35:53 -0700497 INIT_LIST_HEAD(&wb->b_attached);
Tejun Heo52ebea72015-05-22 17:13:37 -0400498 INIT_WORK(&wb->release_work, cgwb_release_workfn);
499 set_bit(WB_registered, &wb->state);
500
501 /*
502 * The root wb determines the registered state of the whole bdi and
503 * memcg_cgwb_list and blkcg_cgwb_list's next pointers indicate
504 * whether they're still online. Don't link @wb if any is dead.
505 * See wb_memcg_offline() and wb_blkcg_offline().
506 */
507 ret = -ENODEV;
508 spin_lock_irqsave(&cgwb_lock, flags);
509 if (test_bit(WB_registered, &bdi->wb.state) &&
510 blkcg_cgwb_list->next && memcg_cgwb_list->next) {
511 /* we might have raced another instance of this function */
512 ret = radix_tree_insert(&bdi->cgwb_tree, memcg_css->id, wb);
513 if (!ret) {
Tejun Heob8175252015-10-02 14:47:05 -0400514 list_add_tail_rcu(&wb->bdi_node, &bdi->wb_list);
Tejun Heo52ebea72015-05-22 17:13:37 -0400515 list_add(&wb->memcg_node, memcg_cgwb_list);
516 list_add(&wb->blkcg_node, blkcg_cgwb_list);
Tejun Heod866dbf2019-07-24 10:37:22 -0700517 blkcg_pin_online(blkcg);
Tejun Heo52ebea72015-05-22 17:13:37 -0400518 css_get(memcg_css);
519 css_get(blkcg_css);
520 }
521 }
522 spin_unlock_irqrestore(&cgwb_lock, flags);
523 if (ret) {
524 if (ret == -EEXIST)
525 ret = 0;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600526 goto err_fprop_exit;
Tejun Heo52ebea72015-05-22 17:13:37 -0400527 }
528 goto out_put;
529
Tejun Heo841710a2015-05-22 18:23:33 -0400530err_fprop_exit:
531 fprop_local_destroy_percpu(&wb->memcg_completions);
Tejun Heo52ebea72015-05-22 17:13:37 -0400532err_ref_exit:
533 percpu_ref_exit(&wb->refcnt);
534err_wb_exit:
535 wb_exit(wb);
536err_free:
537 kfree(wb);
538out_put:
539 css_put(blkcg_css);
540 return ret;
541}
542
543/**
Tejun Heoed288dc2019-08-26 09:06:54 -0700544 * wb_get_lookup - get wb for a given memcg
Tejun Heo52ebea72015-05-22 17:13:37 -0400545 * @bdi: target bdi
546 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
Tejun Heo52ebea72015-05-22 17:13:37 -0400547 *
Tejun Heoed288dc2019-08-26 09:06:54 -0700548 * Try to get the wb for @memcg_css on @bdi. The returned wb has its
549 * refcount incremented.
Tejun Heo52ebea72015-05-22 17:13:37 -0400550 *
551 * This function uses css_get() on @memcg_css and thus expects its refcnt
552 * to be positive on invocation. IOW, rcu_read_lock() protection on
553 * @memcg_css isn't enough. try_get it before calling this function.
554 *
555 * A wb is keyed by its associated memcg. As blkcg implicitly enables
556 * memcg on the default hierarchy, memcg association is guaranteed to be
557 * more specific (equal or descendant to the associated blkcg) and thus can
558 * identify both the memcg and blkcg associations.
559 *
560 * Because the blkcg associated with a memcg may change as blkcg is enabled
561 * and disabled closer to root in the hierarchy, each wb keeps track of
562 * both the memcg and blkcg associated with it and verifies the blkcg on
563 * each lookup. On mismatch, the existing wb is discarded and a new one is
564 * created.
565 */
Tejun Heoed288dc2019-08-26 09:06:54 -0700566struct bdi_writeback *wb_get_lookup(struct backing_dev_info *bdi,
567 struct cgroup_subsys_state *memcg_css)
568{
569 struct bdi_writeback *wb;
570
571 if (!memcg_css->parent)
572 return &bdi->wb;
573
574 rcu_read_lock();
575 wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
576 if (wb) {
577 struct cgroup_subsys_state *blkcg_css;
578
579 /* see whether the blkcg association has changed */
580 blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
581 if (unlikely(wb->blkcg_css != blkcg_css || !wb_tryget(wb)))
582 wb = NULL;
583 css_put(blkcg_css);
584 }
585 rcu_read_unlock();
586
587 return wb;
588}
589
590/**
591 * wb_get_create - get wb for a given memcg, create if necessary
592 * @bdi: target bdi
593 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
594 * @gfp: allocation mask to use
595 *
596 * Try to get the wb for @memcg_css on @bdi. If it doesn't exist, try to
597 * create one. See wb_get_lookup() for more details.
598 */
Tejun Heo52ebea72015-05-22 17:13:37 -0400599struct bdi_writeback *wb_get_create(struct backing_dev_info *bdi,
600 struct cgroup_subsys_state *memcg_css,
601 gfp_t gfp)
602{
603 struct bdi_writeback *wb;
604
Daniel Vetterc1ca59a2021-02-25 17:18:45 -0800605 might_alloc(gfp);
Tejun Heo52ebea72015-05-22 17:13:37 -0400606
607 if (!memcg_css->parent)
608 return &bdi->wb;
609
610 do {
Tejun Heoed288dc2019-08-26 09:06:54 -0700611 wb = wb_get_lookup(bdi, memcg_css);
Tejun Heo52ebea72015-05-22 17:13:37 -0400612 } while (!wb && !cgwb_create(bdi, memcg_css, gfp));
613
614 return wb;
615}
616
Tejun Heoa13f35e2015-07-02 08:44:34 -0600617static int cgwb_bdi_init(struct backing_dev_info *bdi)
Tejun Heo52ebea72015-05-22 17:13:37 -0400618{
Tejun Heoa13f35e2015-07-02 08:44:34 -0600619 int ret;
620
Tejun Heo52ebea72015-05-22 17:13:37 -0400621 INIT_RADIX_TREE(&bdi->cgwb_tree, GFP_ATOMIC);
Jan Kara3ee7e862018-06-18 15:46:58 +0200622 mutex_init(&bdi->cgwb_release_mutex);
Tejun Heo7fc58542017-12-12 08:38:30 -0800623 init_rwsem(&bdi->wb_switch_rwsem);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600624
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200625 ret = wb_init(&bdi->wb, bdi, GFP_KERNEL);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600626 if (!ret) {
Johannes Weiner7d828602016-01-14 15:20:56 -0800627 bdi->wb.memcg_css = &root_mem_cgroup->css;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600628 bdi->wb.blkcg_css = blkcg_root_css;
629 }
630 return ret;
Tejun Heo52ebea72015-05-22 17:13:37 -0400631}
632
Jan Karab1c51af2017-03-23 01:36:59 +0100633static void cgwb_bdi_unregister(struct backing_dev_info *bdi)
Tejun Heo52ebea72015-05-22 17:13:37 -0400634{
635 struct radix_tree_iter iter;
636 void **slot;
Jan Kara5318ce72017-03-23 01:36:57 +0100637 struct bdi_writeback *wb;
Tejun Heo52ebea72015-05-22 17:13:37 -0400638
639 WARN_ON(test_bit(WB_registered, &bdi->wb.state));
640
641 spin_lock_irq(&cgwb_lock);
642 radix_tree_for_each_slot(slot, &bdi->cgwb_tree, &iter, 0)
643 cgwb_kill(*slot);
Jan Kara3ee7e862018-06-18 15:46:58 +0200644 spin_unlock_irq(&cgwb_lock);
Jan Kara5318ce72017-03-23 01:36:57 +0100645
Jan Kara3ee7e862018-06-18 15:46:58 +0200646 mutex_lock(&bdi->cgwb_release_mutex);
647 spin_lock_irq(&cgwb_lock);
Jan Kara5318ce72017-03-23 01:36:57 +0100648 while (!list_empty(&bdi->wb_list)) {
649 wb = list_first_entry(&bdi->wb_list, struct bdi_writeback,
650 bdi_node);
651 spin_unlock_irq(&cgwb_lock);
652 wb_shutdown(wb);
653 spin_lock_irq(&cgwb_lock);
654 }
Tejun Heo52ebea72015-05-22 17:13:37 -0400655 spin_unlock_irq(&cgwb_lock);
Jan Kara3ee7e862018-06-18 15:46:58 +0200656 mutex_unlock(&bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400657}
658
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700659/*
660 * cleanup_offline_cgwbs_workfn - try to release dying cgwbs
661 *
662 * Try to release dying cgwbs by switching attached inodes to the nearest
663 * living ancestor's writeback. Processed wbs are placed at the end
664 * of the list to guarantee the forward progress.
665 */
666static void cleanup_offline_cgwbs_workfn(struct work_struct *work)
667{
668 struct bdi_writeback *wb;
669 LIST_HEAD(processed);
670
671 spin_lock_irq(&cgwb_lock);
672
673 while (!list_empty(&offline_cgwbs)) {
674 wb = list_first_entry(&offline_cgwbs, struct bdi_writeback,
675 offline_node);
676 list_move(&wb->offline_node, &processed);
677
678 /*
679 * If wb is dirty, cleaning up the writeback by switching
680 * attached inodes will result in an effective removal of any
681 * bandwidth restrictions, which isn't the goal. Instead,
682 * it can be postponed until the next time, when all io
683 * will be likely completed. If in the meantime some inodes
684 * will get re-dirtied, they should be eventually switched to
685 * a new cgwb.
686 */
687 if (wb_has_dirty_io(wb))
688 continue;
689
690 if (!wb_tryget(wb))
691 continue;
692
693 spin_unlock_irq(&cgwb_lock);
694 while (cleanup_offline_cgwb(wb))
695 cond_resched();
696 spin_lock_irq(&cgwb_lock);
697
698 wb_put(wb);
699 }
700
701 if (!list_empty(&processed))
702 list_splice_tail(&processed, &offline_cgwbs);
703
704 spin_unlock_irq(&cgwb_lock);
705}
706
Tejun Heo52ebea72015-05-22 17:13:37 -0400707/**
708 * wb_memcg_offline - kill all wb's associated with a memcg being offlined
709 * @memcg: memcg being offlined
710 *
711 * Also prevents creation of any new wb's associated with @memcg.
712 */
713void wb_memcg_offline(struct mem_cgroup *memcg)
714{
Wang Long9ccc3612018-06-07 17:07:19 -0700715 struct list_head *memcg_cgwb_list = &memcg->cgwb_list;
Tejun Heo52ebea72015-05-22 17:13:37 -0400716 struct bdi_writeback *wb, *next;
717
718 spin_lock_irq(&cgwb_lock);
719 list_for_each_entry_safe(wb, next, memcg_cgwb_list, memcg_node)
720 cgwb_kill(wb);
721 memcg_cgwb_list->next = NULL; /* prevent new wb's */
722 spin_unlock_irq(&cgwb_lock);
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700723
724 queue_work(system_unbound_wq, &cleanup_offline_cgwbs_work);
Tejun Heo52ebea72015-05-22 17:13:37 -0400725}
726
727/**
728 * wb_blkcg_offline - kill all wb's associated with a blkcg being offlined
729 * @blkcg: blkcg being offlined
730 *
731 * Also prevents creation of any new wb's associated with @blkcg.
732 */
733void wb_blkcg_offline(struct blkcg *blkcg)
734{
Tejun Heo52ebea72015-05-22 17:13:37 -0400735 struct bdi_writeback *wb, *next;
736
737 spin_lock_irq(&cgwb_lock);
738 list_for_each_entry_safe(wb, next, &blkcg->cgwb_list, blkcg_node)
739 cgwb_kill(wb);
740 blkcg->cgwb_list.next = NULL; /* prevent new wb's */
741 spin_unlock_irq(&cgwb_lock);
742}
743
Jan Karae8cb72b2017-03-23 01:36:56 +0100744static void cgwb_bdi_register(struct backing_dev_info *bdi)
745{
746 spin_lock_irq(&cgwb_lock);
747 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
748 spin_unlock_irq(&cgwb_lock);
749}
750
Tejun Heof1834642018-05-23 10:56:32 -0700751static int __init cgwb_init(void)
752{
753 /*
754 * There can be many concurrent release work items overwhelming
755 * system_wq. Put them in a separate wq and limit concurrency.
756 * There's no point in executing many of these in parallel.
757 */
758 cgwb_release_wq = alloc_workqueue("cgwb_release", 0, 1);
759 if (!cgwb_release_wq)
760 return -ENOMEM;
761
762 return 0;
763}
764subsys_initcall(cgwb_init);
765
Tejun Heo52ebea72015-05-22 17:13:37 -0400766#else /* CONFIG_CGROUP_WRITEBACK */
767
Tejun Heoa13f35e2015-07-02 08:44:34 -0600768static int cgwb_bdi_init(struct backing_dev_info *bdi)
769{
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200770 return wb_init(&bdi->wb, bdi, GFP_KERNEL);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600771}
772
Jan Karab1c51af2017-03-23 01:36:59 +0100773static void cgwb_bdi_unregister(struct backing_dev_info *bdi) { }
Jan Karadf23de52017-03-08 17:48:32 +0100774
Jan Karae8cb72b2017-03-23 01:36:56 +0100775static void cgwb_bdi_register(struct backing_dev_info *bdi)
776{
777 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
778}
779
780static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
781{
782 list_del_rcu(&wb->bdi_node);
783}
784
Tejun Heo52ebea72015-05-22 17:13:37 -0400785#endif /* CONFIG_CGROUP_WRITEBACK */
786
Jan Kara2e82b842017-04-12 12:24:48 +0200787static int bdi_init(struct backing_dev_info *bdi)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700788{
Tejun Heob8175252015-10-02 14:47:05 -0400789 int ret;
790
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700791 bdi->dev = NULL;
792
Jan Karad03f6cd2017-02-02 15:56:51 +0100793 kref_init(&bdi->refcnt);
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700794 bdi->min_ratio = 0;
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700795 bdi->max_ratio = 100;
Jan Karaeb608e32012-05-24 18:59:11 +0200796 bdi->max_prop_frac = FPROP_FRAC_BASE;
Jens Axboe66f3b8e2009-09-02 09:19:46 +0200797 INIT_LIST_HEAD(&bdi->bdi_list);
Tejun Heob8175252015-10-02 14:47:05 -0400798 INIT_LIST_HEAD(&bdi->wb_list);
Tejun Heocc395d72015-05-22 17:13:58 -0400799 init_waitqueue_head(&bdi->wb_waitq);
Jens Axboe03ba3782009-09-09 09:08:54 +0200800
Tejun Heob8175252015-10-02 14:47:05 -0400801 ret = cgwb_bdi_init(bdi);
802
Tejun Heob8175252015-10-02 14:47:05 -0400803 return ret;
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700804}
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700805
Christoph Hellwigaef33c22020-05-04 14:48:00 +0200806struct backing_dev_info *bdi_alloc(int node_id)
Jan Karad03f6cd2017-02-02 15:56:51 +0100807{
808 struct backing_dev_info *bdi;
809
Christoph Hellwigaef33c22020-05-04 14:48:00 +0200810 bdi = kzalloc_node(sizeof(*bdi), GFP_KERNEL, node_id);
Jan Karad03f6cd2017-02-02 15:56:51 +0100811 if (!bdi)
812 return NULL;
813
814 if (bdi_init(bdi)) {
815 kfree(bdi);
816 return NULL;
817 }
Christoph Hellwigf56753a2020-09-24 08:51:40 +0200818 bdi->capabilities = BDI_CAP_WRITEBACK | BDI_CAP_WRITEBACK_ACCT;
Christoph Hellwig55b25982020-09-24 08:51:32 +0200819 bdi->ra_pages = VM_READAHEAD_PAGES;
820 bdi->io_pages = VM_READAHEAD_PAGES;
Christoph Hellwig5ed964f2021-08-09 16:17:40 +0200821 timer_setup(&bdi->laptop_mode_wb_timer, laptop_mode_timer_fn, 0);
Jan Karad03f6cd2017-02-02 15:56:51 +0100822 return bdi;
823}
Christoph Hellwigaef33c22020-05-04 14:48:00 +0200824EXPORT_SYMBOL(bdi_alloc);
Jan Karad03f6cd2017-02-02 15:56:51 +0100825
Tejun Heo34f8fe52019-08-26 09:06:53 -0700826static struct rb_node **bdi_lookup_rb_node(u64 id, struct rb_node **parentp)
827{
828 struct rb_node **p = &bdi_tree.rb_node;
829 struct rb_node *parent = NULL;
830 struct backing_dev_info *bdi;
831
832 lockdep_assert_held(&bdi_lock);
833
834 while (*p) {
835 parent = *p;
836 bdi = rb_entry(parent, struct backing_dev_info, rb_node);
837
838 if (bdi->id > id)
839 p = &(*p)->rb_left;
840 else if (bdi->id < id)
841 p = &(*p)->rb_right;
842 else
843 break;
844 }
845
846 if (parentp)
847 *parentp = parent;
848 return p;
849}
850
851/**
852 * bdi_get_by_id - lookup and get bdi from its id
853 * @id: bdi id to lookup
854 *
855 * Find bdi matching @id and get it. Returns NULL if the matching bdi
856 * doesn't exist or is already unregistered.
857 */
858struct backing_dev_info *bdi_get_by_id(u64 id)
859{
860 struct backing_dev_info *bdi = NULL;
861 struct rb_node **p;
862
863 spin_lock_bh(&bdi_lock);
864 p = bdi_lookup_rb_node(id, NULL);
865 if (*p) {
866 bdi = rb_entry(*p, struct backing_dev_info, rb_node);
867 bdi_get(bdi);
868 }
869 spin_unlock_bh(&bdi_lock);
870
871 return bdi;
872}
873
Jan Kara7c4cc302017-04-12 12:24:49 +0200874int bdi_register_va(struct backing_dev_info *bdi, const char *fmt, va_list args)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700875{
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700876 struct device *dev;
Tejun Heo34f8fe52019-08-26 09:06:53 -0700877 struct rb_node *parent, **p;
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700878
879 if (bdi->dev) /* The driver needs to use separate queues per device */
880 return 0;
881
Christoph Hellwig6bd87ee2020-05-04 14:47:56 +0200882 vsnprintf(bdi->dev_name, sizeof(bdi->dev_name), fmt, args);
883 dev = device_create(bdi_class, NULL, MKDEV(0, 0), bdi, bdi->dev_name);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700884 if (IS_ERR(dev))
885 return PTR_ERR(dev);
886
Jan Karae8cb72b2017-03-23 01:36:56 +0100887 cgwb_bdi_register(bdi);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700888 bdi->dev = dev;
889
Jens Axboe6d0e4822017-12-21 10:01:30 -0700890 bdi_debug_register(bdi, dev_name(dev));
Tejun Heo46100072015-05-22 17:13:31 -0400891 set_bit(WB_registered, &bdi->wb.state);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700892
893 spin_lock_bh(&bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700894
895 bdi->id = ++bdi_id_cursor;
896
897 p = bdi_lookup_rb_node(bdi->id, &parent);
898 rb_link_node(&bdi->rb_node, parent, p);
899 rb_insert_color(&bdi->rb_node, &bdi_tree);
900
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700901 list_add_tail_rcu(&bdi->bdi_list, &bdi_list);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700902
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700903 spin_unlock_bh(&bdi_lock);
904
905 trace_writeback_bdi_register(bdi);
906 return 0;
907}
Jan Karabaf7a612017-04-12 12:24:25 +0200908
Jan Kara7c4cc302017-04-12 12:24:49 +0200909int bdi_register(struct backing_dev_info *bdi, const char *fmt, ...)
Jan Karabaf7a612017-04-12 12:24:25 +0200910{
911 va_list args;
912 int ret;
913
914 va_start(args, fmt);
Jan Kara7c4cc302017-04-12 12:24:49 +0200915 ret = bdi_register_va(bdi, fmt, args);
Jan Karabaf7a612017-04-12 12:24:25 +0200916 va_end(args);
917 return ret;
918}
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700919EXPORT_SYMBOL(bdi_register);
920
Christoph Hellwig3c5d2022020-05-04 14:47:59 +0200921void bdi_set_owner(struct backing_dev_info *bdi, struct device *owner)
Dan Williamsdf08c322016-07-31 11:15:13 -0700922{
Christoph Hellwig3c5d2022020-05-04 14:47:59 +0200923 WARN_ON_ONCE(bdi->owner);
Dan Williamsdf08c322016-07-31 11:15:13 -0700924 bdi->owner = owner;
925 get_device(owner);
Dan Williamsdf08c322016-07-31 11:15:13 -0700926}
Dan Williamsdf08c322016-07-31 11:15:13 -0700927
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700928/*
Tejun Heo46100072015-05-22 17:13:31 -0400929 * Remove bdi from bdi_list, and ensure that it is no longer visible
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700930 */
Tejun Heo46100072015-05-22 17:13:31 -0400931static void bdi_remove_from_list(struct backing_dev_info *bdi)
Peter Zijlstra04fbfdc2007-10-16 23:25:50 -0700932{
Tejun Heo46100072015-05-22 17:13:31 -0400933 spin_lock_bh(&bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700934 rb_erase(&bdi->rb_node, &bdi_tree);
Tejun Heo46100072015-05-22 17:13:31 -0400935 list_del_rcu(&bdi->bdi_list);
936 spin_unlock_bh(&bdi_lock);
Andrew Morton3fcfab12006-10-19 23:28:16 -0700937
Tejun Heo46100072015-05-22 17:13:31 -0400938 synchronize_rcu_expedited();
Andrew Morton3fcfab12006-10-19 23:28:16 -0700939}
940
Tejun Heob02176f2015-09-08 12:20:22 -0400941void bdi_unregister(struct backing_dev_info *bdi)
Andrew Morton3fcfab12006-10-19 23:28:16 -0700942{
Christoph Hellwig5ed964f2021-08-09 16:17:40 +0200943 del_timer_sync(&bdi->laptop_mode_wb_timer);
944
Tejun Heof0054bb2015-05-22 17:13:30 -0400945 /* make sure nobody finds us on the bdi_list anymore */
946 bdi_remove_from_list(bdi);
947 wb_shutdown(&bdi->wb);
Jan Karab1c51af2017-03-23 01:36:59 +0100948 cgwb_bdi_unregister(bdi);
Rabin Vincent7a401a92011-11-11 13:29:04 +0100949
Christoph Hellwigc4db59d2015-01-20 14:05:00 -0700950 if (bdi->dev) {
951 bdi_debug_unregister(bdi);
952 device_unregister(bdi->dev);
953 bdi->dev = NULL;
954 }
Dan Williamsdf08c322016-07-31 11:15:13 -0700955
956 if (bdi->owner) {
957 put_device(bdi->owner);
958 bdi->owner = NULL;
959 }
Tejun Heob02176f2015-09-08 12:20:22 -0400960}
Christoph Hellwigc4db59d2015-01-20 14:05:00 -0700961
Jan Karad03f6cd2017-02-02 15:56:51 +0100962static void release_bdi(struct kref *ref)
963{
964 struct backing_dev_info *bdi =
965 container_of(ref, struct backing_dev_info, refcnt);
966
Jan Kara5af110b2017-04-12 12:24:26 +0200967 if (test_bit(WB_registered, &bdi->wb.state))
968 bdi_unregister(bdi);
Jan Kara2e82b842017-04-12 12:24:48 +0200969 WARN_ON_ONCE(bdi->dev);
970 wb_exit(&bdi->wb);
Jan Karad03f6cd2017-02-02 15:56:51 +0100971 kfree(bdi);
972}
973
974void bdi_put(struct backing_dev_info *bdi)
975{
976 kref_put(&bdi->refcnt, release_bdi);
977}
Jan Kara62bf42a2017-04-12 12:24:27 +0200978EXPORT_SYMBOL(bdi_put);
Jan Karad03f6cd2017-02-02 15:56:51 +0100979
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +0200980const char *bdi_dev_name(struct backing_dev_info *bdi)
981{
982 if (!bdi || !bdi->dev)
983 return bdi_unknown_name;
Christoph Hellwig6bd87ee2020-05-04 14:47:56 +0200984 return bdi->dev_name;
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +0200985}
986EXPORT_SYMBOL_GPL(bdi_dev_name);
987
Andrew Morton3fcfab12006-10-19 23:28:16 -0700988static wait_queue_head_t congestion_wqh[2] = {
989 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[0]),
990 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[1])
991 };
Tejun Heoec8a6f22015-05-22 17:13:41 -0400992static atomic_t nr_wb_congested[2];
Andrew Morton3fcfab12006-10-19 23:28:16 -0700993
Christoph Hellwig492d76b2020-07-01 11:06:20 +0200994void clear_bdi_congested(struct backing_dev_info *bdi, int sync)
Andrew Morton3fcfab12006-10-19 23:28:16 -0700995{
Jens Axboe1faa16d2009-04-06 14:48:01 +0200996 wait_queue_head_t *wqh = &congestion_wqh[sync];
Kaixu Xiac877ef82016-03-31 13:19:41 +0000997 enum wb_congested_state bit;
Andrew Morton3fcfab12006-10-19 23:28:16 -0700998
Tejun Heo44522262015-05-22 17:13:26 -0400999 bit = sync ? WB_sync_congested : WB_async_congested;
Christoph Hellwig8c911f32020-07-01 11:06:21 +02001000 if (test_and_clear_bit(bit, &bdi->wb.congested))
Tejun Heoec8a6f22015-05-22 17:13:41 -04001001 atomic_dec(&nr_wb_congested[sync]);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001002 smp_mb__after_atomic();
Andrew Morton3fcfab12006-10-19 23:28:16 -07001003 if (waitqueue_active(wqh))
1004 wake_up(wqh);
1005}
Christoph Hellwig492d76b2020-07-01 11:06:20 +02001006EXPORT_SYMBOL(clear_bdi_congested);
Andrew Morton3fcfab12006-10-19 23:28:16 -07001007
Christoph Hellwig492d76b2020-07-01 11:06:20 +02001008void set_bdi_congested(struct backing_dev_info *bdi, int sync)
Andrew Morton3fcfab12006-10-19 23:28:16 -07001009{
Kaixu Xiac877ef82016-03-31 13:19:41 +00001010 enum wb_congested_state bit;
Andrew Morton3fcfab12006-10-19 23:28:16 -07001011
Tejun Heo44522262015-05-22 17:13:26 -04001012 bit = sync ? WB_sync_congested : WB_async_congested;
Christoph Hellwig8c911f32020-07-01 11:06:21 +02001013 if (!test_and_set_bit(bit, &bdi->wb.congested))
Tejun Heoec8a6f22015-05-22 17:13:41 -04001014 atomic_inc(&nr_wb_congested[sync]);
Andrew Morton3fcfab12006-10-19 23:28:16 -07001015}
Christoph Hellwig492d76b2020-07-01 11:06:20 +02001016EXPORT_SYMBOL(set_bdi_congested);
Andrew Morton3fcfab12006-10-19 23:28:16 -07001017
1018/**
1019 * congestion_wait - wait for a backing_dev to become uncongested
Jens Axboe8aa7e842009-07-09 14:52:32 +02001020 * @sync: SYNC or ASYNC IO
Andrew Morton3fcfab12006-10-19 23:28:16 -07001021 * @timeout: timeout in jiffies
1022 *
1023 * Waits for up to @timeout jiffies for a backing_dev (any backing_dev) to exit
1024 * write congestion. If no backing_devs are congested then just wait for the
1025 * next write to be completed.
1026 */
Jens Axboe8aa7e842009-07-09 14:52:32 +02001027long congestion_wait(int sync, long timeout)
Andrew Morton3fcfab12006-10-19 23:28:16 -07001028{
1029 long ret;
Mel Gorman52bb9192010-10-26 14:21:41 -07001030 unsigned long start = jiffies;
Andrew Morton3fcfab12006-10-19 23:28:16 -07001031 DEFINE_WAIT(wait);
Jens Axboe8aa7e842009-07-09 14:52:32 +02001032 wait_queue_head_t *wqh = &congestion_wqh[sync];
Andrew Morton3fcfab12006-10-19 23:28:16 -07001033
1034 prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
1035 ret = io_schedule_timeout(timeout);
1036 finish_wait(wqh, &wait);
Mel Gorman52bb9192010-10-26 14:21:41 -07001037
1038 trace_writeback_congestion_wait(jiffies_to_usecs(timeout),
1039 jiffies_to_usecs(jiffies - start));
1040
Andrew Morton3fcfab12006-10-19 23:28:16 -07001041 return ret;
1042}
1043EXPORT_SYMBOL(congestion_wait);
1044
Mel Gorman0e093d992010-10-26 14:21:45 -07001045/**
Mel Gorman599d0c92016-07-28 15:45:31 -07001046 * 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 -07001047 * @sync: SYNC or ASYNC IO
1048 * @timeout: timeout in jiffies
1049 *
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -07001050 * In the event of a congested backing_dev (any backing_dev) this waits
1051 * for up to @timeout jiffies for either a BDI to exit congestion of the
1052 * given @sync queue or a write to complete.
Mel Gorman0e093d992010-10-26 14:21:45 -07001053 *
1054 * The return value is 0 if the sleep is for the full timeout. Otherwise,
1055 * it is the number of jiffies that were still remaining when the function
1056 * returned. return_value == timeout implies the function did not sleep.
1057 */
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -07001058long wait_iff_congested(int sync, long timeout)
Mel Gorman0e093d992010-10-26 14:21:45 -07001059{
1060 long ret;
1061 unsigned long start = jiffies;
1062 DEFINE_WAIT(wait);
1063 wait_queue_head_t *wqh = &congestion_wqh[sync];
1064
1065 /*
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -07001066 * If there is no congestion, yield if necessary instead
Mel Gorman0e093d992010-10-26 14:21:45 -07001067 * of sleeping on the congestion queue
1068 */
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -07001069 if (atomic_read(&nr_wb_congested[sync]) == 0) {
Michal Hockoede37712016-05-20 16:57:03 -07001070 cond_resched();
Mel Gorman599d0c92016-07-28 15:45:31 -07001071
Mel Gorman0e093d992010-10-26 14:21:45 -07001072 /* In case we scheduled, work out time remaining */
1073 ret = timeout - (jiffies - start);
1074 if (ret < 0)
1075 ret = 0;
1076
1077 goto out;
1078 }
1079
1080 /* Sleep until uncongested or a write happens */
1081 prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
1082 ret = io_schedule_timeout(timeout);
1083 finish_wait(wqh, &wait);
1084
1085out:
1086 trace_writeback_wait_iff_congested(jiffies_to_usecs(timeout),
1087 jiffies_to_usecs(jiffies - start));
1088
1089 return ret;
1090}
1091EXPORT_SYMBOL(wait_iff_congested);