blob: 1eead47610112257ca01c5ff306c64716959af8f [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>
Jens Axboe03ba3782009-09-09 09:08:54 +02005#include <linux/kthread.h>
Christoph Hellwige41d12f2021-09-20 14:33:13 +02006#include <linux/backing-dev.h>
7#include <linux/blk-cgroup.h>
Jens Axboe03ba3782009-09-09 09:08:54 +02008#include <linux/freezer.h>
Andrew Morton3fcfab12006-10-19 23:28:16 -07009#include <linux/fs.h>
Jens Axboe26160152009-03-17 09:35:06 +010010#include <linux/pagemap.h>
Jens Axboe03ba3782009-09-09 09:08:54 +020011#include <linux/mm.h>
Daniel Vetterc1ca59a2021-02-25 17:18:45 -080012#include <linux/sched/mm.h>
Andrew Morton3fcfab12006-10-19 23:28:16 -070013#include <linux/sched.h>
14#include <linux/module.h>
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070015#include <linux/writeback.h>
16#include <linux/device.h>
Dave Chinner455b2862010-07-07 13:24:06 +100017#include <trace/events/writeback.h>
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070018
Christoph Hellwigf56753a2020-09-24 08:51:40 +020019struct backing_dev_info noop_backing_dev_info;
Tejun Heoa212b102015-05-22 17:13:33 -040020EXPORT_SYMBOL_GPL(noop_backing_dev_info);
Jörn Engel5129a462010-04-25 08:54:42 +020021
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070022static struct class *bdi_class;
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +020023static const char *bdi_unknown_name = "(unknown)";
Jens Axboecfc4ba52009-09-14 13:12:40 +020024
25/*
Tejun Heo34f8fe52019-08-26 09:06:53 -070026 * bdi_lock protects bdi_tree and updates to bdi_list. bdi_list has RCU
27 * reader side locking.
Jens Axboecfc4ba52009-09-14 13:12:40 +020028 */
Jens Axboe03ba3782009-09-09 09:08:54 +020029DEFINE_SPINLOCK(bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -070030static u64 bdi_id_cursor;
31static struct rb_root bdi_tree = RB_ROOT;
Jens Axboe66f3b8e2009-09-02 09:19:46 +020032LIST_HEAD(bdi_list);
Jens Axboe03ba3782009-09-09 09:08:54 +020033
Tejun Heo839a8e82013-04-01 19:08:06 -070034/* bdi_wq serves all asynchronous writeback tasks */
35struct workqueue_struct *bdi_wq;
36
Baolin Wang6986c3e2021-02-24 12:02:52 -080037#define K(x) ((x) << (PAGE_SHIFT - 10))
38
Miklos Szeredi76f14182008-04-30 00:54:36 -070039#ifdef CONFIG_DEBUG_FS
40#include <linux/debugfs.h>
41#include <linux/seq_file.h>
42
43static struct dentry *bdi_debug_root;
44
45static void bdi_debug_init(void)
46{
47 bdi_debug_root = debugfs_create_dir("bdi", NULL);
48}
49
50static int bdi_debug_stats_show(struct seq_file *m, void *v)
51{
52 struct backing_dev_info *bdi = m->private;
Christoph Hellwigc1955ce2010-06-19 23:08:06 +020053 struct bdi_writeback *wb = &bdi->wb;
David Rientjes364aeb22009-01-06 14:39:29 -080054 unsigned long background_thresh;
55 unsigned long dirty_thresh;
Tejun Heo0d960a32015-05-22 18:23:19 -040056 unsigned long wb_thresh;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050057 unsigned long nr_dirty, nr_io, nr_more_io, nr_dirty_time;
Jens Axboef09b00d2009-05-25 09:08:21 +020058 struct inode *inode;
59
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050060 nr_dirty = nr_io = nr_more_io = nr_dirty_time = 0;
Christoph Hellwigf758eea2011-04-21 18:19:44 -060061 spin_lock(&wb->list_lock);
Dave Chinnerc7f54082015-03-04 14:07:22 -050062 list_for_each_entry(inode, &wb->b_dirty, i_io_list)
Christoph Hellwigc1955ce2010-06-19 23:08:06 +020063 nr_dirty++;
Dave Chinnerc7f54082015-03-04 14:07:22 -050064 list_for_each_entry(inode, &wb->b_io, i_io_list)
Christoph Hellwigc1955ce2010-06-19 23:08:06 +020065 nr_io++;
Dave Chinnerc7f54082015-03-04 14:07:22 -050066 list_for_each_entry(inode, &wb->b_more_io, i_io_list)
Christoph Hellwigc1955ce2010-06-19 23:08:06 +020067 nr_more_io++;
Dave Chinnerc7f54082015-03-04 14:07:22 -050068 list_for_each_entry(inode, &wb->b_dirty_time, i_io_list)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050069 if (inode->i_state & I_DIRTY_TIME)
70 nr_dirty_time++;
Christoph Hellwigf758eea2011-04-21 18:19:44 -060071 spin_unlock(&wb->list_lock);
Miklos Szeredi76f14182008-04-30 00:54:36 -070072
Wu Fengguang16c40422010-08-11 14:17:39 -070073 global_dirty_limits(&background_thresh, &dirty_thresh);
Tejun Heo0d960a32015-05-22 18:23:19 -040074 wb_thresh = wb_calc_thresh(wb, dirty_thresh);
Miklos Szeredi76f14182008-04-30 00:54:36 -070075
Miklos Szeredi76f14182008-04-30 00:54:36 -070076 seq_printf(m,
Wu Fengguang00821b02010-08-29 11:28:45 -060077 "BdiWriteback: %10lu kB\n"
78 "BdiReclaimable: %10lu kB\n"
79 "BdiDirtyThresh: %10lu kB\n"
80 "DirtyThresh: %10lu kB\n"
81 "BackgroundThresh: %10lu kB\n"
Wu Fengguangc8e28ce2011-01-23 10:07:47 -060082 "BdiDirtied: %10lu kB\n"
Wu Fengguang00821b02010-08-29 11:28:45 -060083 "BdiWritten: %10lu kB\n"
84 "BdiWriteBandwidth: %10lu kBps\n"
85 "b_dirty: %10lu\n"
86 "b_io: %10lu\n"
87 "b_more_io: %10lu\n"
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050088 "b_dirty_time: %10lu\n"
Wu Fengguang00821b02010-08-29 11:28:45 -060089 "bdi_list: %10u\n"
90 "state: %10lx\n",
Tejun Heo93f78d82015-05-22 17:13:27 -040091 (unsigned long) K(wb_stat(wb, WB_WRITEBACK)),
92 (unsigned long) K(wb_stat(wb, WB_RECLAIMABLE)),
Tejun Heo0d960a32015-05-22 18:23:19 -040093 K(wb_thresh),
Jan Karaf7d2b1e2010-12-08 22:44:24 -060094 K(dirty_thresh),
95 K(background_thresh),
Tejun Heo93f78d82015-05-22 17:13:27 -040096 (unsigned long) K(wb_stat(wb, WB_DIRTIED)),
97 (unsigned long) K(wb_stat(wb, WB_WRITTEN)),
Tejun Heoa88a3412015-05-22 17:13:28 -040098 (unsigned long) K(wb->write_bandwidth),
Jan Karaf7d2b1e2010-12-08 22:44:24 -060099 nr_dirty,
100 nr_io,
101 nr_more_io,
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500102 nr_dirty_time,
Tejun Heo44522262015-05-22 17:13:26 -0400103 !list_empty(&bdi->bdi_list), bdi->wb.state);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700104
105 return 0;
106}
Andy Shevchenko5ad35092018-04-05 16:23:16 -0700107DEFINE_SHOW_ATTRIBUTE(bdi_debug_stats);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700108
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100109static void bdi_debug_register(struct backing_dev_info *bdi, const char *name)
Miklos Szeredi76f14182008-04-30 00:54:36 -0700110{
111 bdi->debug_dir = debugfs_create_dir(name, bdi_debug_root);
weiping zhang97f07692017-10-31 18:37:54 +0800112
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100113 debugfs_create_file("stats", 0444, bdi->debug_dir, bdi,
114 &bdi_debug_stats_fops);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700115}
116
117static void bdi_debug_unregister(struct backing_dev_info *bdi)
118{
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100119 debugfs_remove_recursive(bdi->debug_dir);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700120}
121#else
122static inline void bdi_debug_init(void)
123{
124}
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100125static inline void bdi_debug_register(struct backing_dev_info *bdi,
Miklos Szeredi76f14182008-04-30 00:54:36 -0700126 const char *name)
127{
128}
129static inline void bdi_debug_unregister(struct backing_dev_info *bdi)
130{
131}
132#endif
133
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700134static ssize_t read_ahead_kb_store(struct device *dev,
135 struct device_attribute *attr,
136 const char *buf, size_t count)
137{
138 struct backing_dev_info *bdi = dev_get_drvdata(dev);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700139 unsigned long read_ahead_kb;
Namjae Jeon7034ed12012-08-25 16:57:27 +0800140 ssize_t ret;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700141
Namjae Jeon7034ed12012-08-25 16:57:27 +0800142 ret = kstrtoul(buf, 10, &read_ahead_kb);
143 if (ret < 0)
144 return ret;
145
146 bdi->ra_pages = read_ahead_kb >> (PAGE_SHIFT - 10);
147
148 return count;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700149}
150
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700151#define BDI_SHOW(name, expr) \
152static ssize_t name##_show(struct device *dev, \
Joe Perches5e4c0d82020-12-14 19:14:50 -0800153 struct device_attribute *attr, char *buf) \
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700154{ \
155 struct backing_dev_info *bdi = dev_get_drvdata(dev); \
156 \
Joe Perches5e4c0d82020-12-14 19:14:50 -0800157 return sysfs_emit(buf, "%lld\n", (long long)expr); \
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700158} \
159static DEVICE_ATTR_RW(name);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700160
161BDI_SHOW(read_ahead_kb, K(bdi->ra_pages))
162
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700163static ssize_t min_ratio_store(struct device *dev,
164 struct device_attribute *attr, const char *buf, size_t count)
165{
166 struct backing_dev_info *bdi = dev_get_drvdata(dev);
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700167 unsigned int ratio;
Namjae Jeon7034ed12012-08-25 16:57:27 +0800168 ssize_t ret;
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700169
Namjae Jeon7034ed12012-08-25 16:57:27 +0800170 ret = kstrtouint(buf, 10, &ratio);
171 if (ret < 0)
172 return ret;
173
174 ret = bdi_set_min_ratio(bdi, ratio);
175 if (!ret)
176 ret = count;
177
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700178 return ret;
179}
180BDI_SHOW(min_ratio, bdi->min_ratio)
181
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700182static ssize_t max_ratio_store(struct device *dev,
183 struct device_attribute *attr, const char *buf, size_t count)
184{
185 struct backing_dev_info *bdi = dev_get_drvdata(dev);
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700186 unsigned int ratio;
Namjae Jeon7034ed12012-08-25 16:57:27 +0800187 ssize_t ret;
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700188
Namjae Jeon7034ed12012-08-25 16:57:27 +0800189 ret = kstrtouint(buf, 10, &ratio);
190 if (ret < 0)
191 return ret;
192
193 ret = bdi_set_max_ratio(bdi, ratio);
194 if (!ret)
195 ret = count;
196
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700197 return ret;
198}
199BDI_SHOW(max_ratio, bdi->max_ratio)
200
Darrick J. Wong7d311cd2013-02-21 16:42:48 -0800201static ssize_t stable_pages_required_show(struct device *dev,
202 struct device_attribute *attr,
Joe Perches5e4c0d82020-12-14 19:14:50 -0800203 char *buf)
Darrick J. Wong7d311cd2013-02-21 16:42:48 -0800204{
Christoph Hellwig1cb039f2020-09-24 08:51:38 +0200205 dev_warn_once(dev,
206 "the stable_pages_required attribute has been removed. Use the stable_writes queue attribute instead.\n");
Joe Perches5e4c0d82020-12-14 19:14:50 -0800207 return sysfs_emit(buf, "%d\n", 0);
Darrick J. Wong7d311cd2013-02-21 16:42:48 -0800208}
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700209static DEVICE_ATTR_RO(stable_pages_required);
Darrick J. Wong7d311cd2013-02-21 16:42:48 -0800210
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700211static struct attribute *bdi_dev_attrs[] = {
212 &dev_attr_read_ahead_kb.attr,
213 &dev_attr_min_ratio.attr,
214 &dev_attr_max_ratio.attr,
215 &dev_attr_stable_pages_required.attr,
216 NULL,
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700217};
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700218ATTRIBUTE_GROUPS(bdi_dev);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700219
220static __init int bdi_class_init(void)
221{
222 bdi_class = class_create(THIS_MODULE, "bdi");
Anton Blanchard14421452010-04-02 09:46:55 +0200223 if (IS_ERR(bdi_class))
224 return PTR_ERR(bdi_class);
225
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700226 bdi_class->dev_groups = bdi_dev_groups;
Miklos Szeredi76f14182008-04-30 00:54:36 -0700227 bdi_debug_init();
Jan Karad03f6cd2017-02-02 15:56:51 +0100228
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700229 return 0;
230}
Miklos Szeredi76f14182008-04-30 00:54:36 -0700231postcore_initcall(bdi_class_init);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700232
Jan Kara2e82b842017-04-12 12:24:48 +0200233static int bdi_init(struct backing_dev_info *bdi);
234
Jens Axboe26160152009-03-17 09:35:06 +0100235static int __init default_bdi_init(void)
236{
237 int err;
238
Mika Westerberga2b90f12019-10-04 13:00:24 +0300239 bdi_wq = alloc_workqueue("writeback", WQ_MEM_RECLAIM | WQ_UNBOUND |
240 WQ_SYSFS, 0);
Tejun Heo839a8e82013-04-01 19:08:06 -0700241 if (!bdi_wq)
242 return -ENOMEM;
243
Jan Kara976e48f2010-09-21 11:48:55 +0200244 err = bdi_init(&noop_backing_dev_info);
Jens Axboe26160152009-03-17 09:35:06 +0100245
246 return err;
247}
248subsys_initcall(default_bdi_init);
249
Artem Bityutskiy64677162010-07-25 14:29:22 +0300250/*
Tejun Heof0054bb2015-05-22 17:13:30 -0400251 * This function is used when the first inode for this wb is marked dirty. It
Artem Bityutskiy64677162010-07-25 14:29:22 +0300252 * wakes-up the corresponding bdi thread which should then take care of the
253 * periodic background write-out of dirty inodes. Since the write-out would
254 * starts only 'dirty_writeback_interval' centisecs from now anyway, we just
255 * set up a timer which wakes the bdi thread up later.
256 *
257 * Note, we wouldn't bother setting up the timer, but this function is on the
258 * fast-path (used by '__mark_inode_dirty()'), so we save few context switches
259 * by delaying the wake-up.
Derek Basehore6ca738d2014-04-03 14:46:22 -0700260 *
261 * We have to be careful not to postpone flush work if it is scheduled for
262 * earlier. Thus we use queue_delayed_work().
Artem Bityutskiy64677162010-07-25 14:29:22 +0300263 */
Tejun Heof0054bb2015-05-22 17:13:30 -0400264void wb_wakeup_delayed(struct bdi_writeback *wb)
Artem Bityutskiy64677162010-07-25 14:29:22 +0300265{
266 unsigned long timeout;
267
268 timeout = msecs_to_jiffies(dirty_writeback_interval * 10);
Tejun Heof0054bb2015-05-22 17:13:30 -0400269 spin_lock_bh(&wb->work_lock);
270 if (test_bit(WB_registered, &wb->state))
271 queue_delayed_work(bdi_wq, &wb->dwork, timeout);
272 spin_unlock_bh(&wb->work_lock);
Jens Axboe03ba3782009-09-09 09:08:54 +0200273}
274
Jan Kara45a29662021-09-02 14:53:09 -0700275static void wb_update_bandwidth_workfn(struct work_struct *work)
276{
277 struct bdi_writeback *wb = container_of(to_delayed_work(work),
278 struct bdi_writeback, bw_dwork);
279
280 wb_update_bandwidth(wb);
281}
282
Jens Axboecfc4ba52009-09-14 13:12:40 +0200283/*
Tejun Heoa88a3412015-05-22 17:13:28 -0400284 * Initial write bandwidth: 100 MB/s
Jens Axboecfc4ba52009-09-14 13:12:40 +0200285 */
Tejun Heoa88a3412015-05-22 17:13:28 -0400286#define INIT_BW (100 << (20 - PAGE_SHIFT))
Jens Axboecfc4ba52009-09-14 13:12:40 +0200287
Tejun Heo8395cd92015-05-22 17:13:34 -0400288static int wb_init(struct bdi_writeback *wb, struct backing_dev_info *bdi,
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200289 gfp_t gfp)
Artem Bityutskiy64677162010-07-25 14:29:22 +0300290{
Tejun Heo93f78d82015-05-22 17:13:27 -0400291 int i, err;
292
Artem Bityutskiy64677162010-07-25 14:29:22 +0300293 memset(wb, 0, sizeof(*wb));
294
295 wb->bdi = bdi;
296 wb->last_old_flush = jiffies;
297 INIT_LIST_HEAD(&wb->b_dirty);
298 INIT_LIST_HEAD(&wb->b_io);
299 INIT_LIST_HEAD(&wb->b_more_io);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500300 INIT_LIST_HEAD(&wb->b_dirty_time);
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600301 spin_lock_init(&wb->list_lock);
Tejun Heo93f78d82015-05-22 17:13:27 -0400302
Jan Kara633a2ab2021-09-02 14:53:04 -0700303 atomic_set(&wb->writeback_inodes, 0);
Tejun Heoa88a3412015-05-22 17:13:28 -0400304 wb->bw_time_stamp = jiffies;
305 wb->balanced_dirty_ratelimit = INIT_BW;
306 wb->dirty_ratelimit = INIT_BW;
307 wb->write_bandwidth = INIT_BW;
308 wb->avg_write_bandwidth = INIT_BW;
309
Tejun Heof0054bb2015-05-22 17:13:30 -0400310 spin_lock_init(&wb->work_lock);
311 INIT_LIST_HEAD(&wb->work_list);
312 INIT_DELAYED_WORK(&wb->dwork, wb_workfn);
Jan Kara45a29662021-09-02 14:53:09 -0700313 INIT_DELAYED_WORK(&wb->bw_dwork, wb_update_bandwidth_workfn);
Jens Axboeb57d74a2016-09-01 10:20:33 -0600314 wb->dirty_sleep = jiffies;
Tejun Heof0054bb2015-05-22 17:13:30 -0400315
Tejun Heo8395cd92015-05-22 17:13:34 -0400316 err = fprop_local_init_percpu(&wb->completions, gfp);
Tejun Heoa88a3412015-05-22 17:13:28 -0400317 if (err)
Christoph Hellwigefee1712021-11-05 13:37:04 -0700318 return err;
Tejun Heoa88a3412015-05-22 17:13:28 -0400319
Tejun Heo93f78d82015-05-22 17:13:27 -0400320 for (i = 0; i < NR_WB_STAT_ITEMS; i++) {
Tejun Heo8395cd92015-05-22 17:13:34 -0400321 err = percpu_counter_init(&wb->stat[i], 0, gfp);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600322 if (err)
323 goto out_destroy_stat;
Tejun Heo93f78d82015-05-22 17:13:27 -0400324 }
325
326 return 0;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600327
328out_destroy_stat:
Rasmus Villemoes078c6c32016-02-11 16:13:06 -0800329 while (i--)
Tejun Heoa13f35e2015-07-02 08:44:34 -0600330 percpu_counter_destroy(&wb->stat[i]);
331 fprop_local_destroy_percpu(&wb->completions);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600332 return err;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700333}
Jens Axboe03ba3782009-09-09 09:08:54 +0200334
Jan Karae8cb72b2017-03-23 01:36:56 +0100335static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb);
336
Tejun Heo46100072015-05-22 17:13:31 -0400337/*
338 * Remove bdi from the global list and shutdown any threads we have running
339 */
340static void wb_shutdown(struct bdi_writeback *wb)
341{
342 /* Make sure nobody queues further work */
343 spin_lock_bh(&wb->work_lock);
344 if (!test_and_clear_bit(WB_registered, &wb->state)) {
345 spin_unlock_bh(&wb->work_lock);
346 return;
347 }
348 spin_unlock_bh(&wb->work_lock);
349
Jan Karae8cb72b2017-03-23 01:36:56 +0100350 cgwb_remove_from_bdi_list(wb);
Tejun Heo46100072015-05-22 17:13:31 -0400351 /*
352 * Drain work list and shutdown the delayed_work. !WB_registered
353 * tells wb_workfn() that @wb is dying and its work_list needs to
354 * be drained no matter what.
355 */
356 mod_delayed_work(bdi_wq, &wb->dwork, 0);
357 flush_delayed_work(&wb->dwork);
358 WARN_ON(!list_empty(&wb->work_list));
Jan Kara45a29662021-09-02 14:53:09 -0700359 flush_delayed_work(&wb->bw_dwork);
Tejun Heo46100072015-05-22 17:13:31 -0400360}
361
Tejun Heof0054bb2015-05-22 17:13:30 -0400362static void wb_exit(struct bdi_writeback *wb)
Tejun Heo93f78d82015-05-22 17:13:27 -0400363{
364 int i;
365
366 WARN_ON(delayed_work_pending(&wb->dwork));
367
368 for (i = 0; i < NR_WB_STAT_ITEMS; i++)
369 percpu_counter_destroy(&wb->stat[i]);
Artem Bityutskiy64677162010-07-25 14:29:22 +0300370
Tejun Heoa88a3412015-05-22 17:13:28 -0400371 fprop_local_destroy_percpu(&wb->completions);
372}
Wu Fengguange98be2d2010-08-29 11:22:30 -0600373
Tejun Heo52ebea72015-05-22 17:13:37 -0400374#ifdef CONFIG_CGROUP_WRITEBACK
375
376#include <linux/memcontrol.h>
377
378/*
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700379 * cgwb_lock protects bdi->cgwb_tree, blkcg->cgwb_list, offline_cgwbs and
380 * memcg->cgwb_list. bdi->cgwb_tree is also RCU protected.
Tejun Heo52ebea72015-05-22 17:13:37 -0400381 */
382static DEFINE_SPINLOCK(cgwb_lock);
Tejun Heof1834642018-05-23 10:56:32 -0700383static struct workqueue_struct *cgwb_release_wq;
Tejun Heo52ebea72015-05-22 17:13:37 -0400384
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700385static LIST_HEAD(offline_cgwbs);
386static void cleanup_offline_cgwbs_workfn(struct work_struct *work);
387static DECLARE_WORK(cleanup_offline_cgwbs_work, cleanup_offline_cgwbs_workfn);
388
Tejun Heo52ebea72015-05-22 17:13:37 -0400389static void cgwb_release_workfn(struct work_struct *work)
390{
391 struct bdi_writeback *wb = container_of(work, struct bdi_writeback,
392 release_work);
Dennis Zhou (Facebook)59b57712018-08-31 16:22:43 -0400393 struct blkcg *blkcg = css_to_blkcg(wb->blkcg_css);
Christoph Hellwigefee1712021-11-05 13:37:04 -0700394 struct backing_dev_info *bdi = wb->bdi;
Tejun Heo52ebea72015-05-22 17:13:37 -0400395
Jan Kara3ee7e862018-06-18 15:46:58 +0200396 mutex_lock(&wb->bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400397 wb_shutdown(wb);
398
399 css_put(wb->memcg_css);
400 css_put(wb->blkcg_css);
Jan Kara3ee7e862018-06-18 15:46:58 +0200401 mutex_unlock(&wb->bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400402
Tejun Heod866dbf2019-07-24 10:37:22 -0700403 /* triggers blkg destruction if no online users left */
404 blkcg_unpin_online(blkcg);
Dennis Zhou (Facebook)59b57712018-08-31 16:22:43 -0400405
Tejun Heo841710a2015-05-22 18:23:33 -0400406 fprop_local_destroy_percpu(&wb->memcg_completions);
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700407
408 spin_lock_irq(&cgwb_lock);
409 list_del(&wb->offline_node);
410 spin_unlock_irq(&cgwb_lock);
411
Roman Gushchinb43a9e72021-07-23 15:50:29 -0700412 percpu_ref_exit(&wb->refcnt);
Tejun Heo52ebea72015-05-22 17:13:37 -0400413 wb_exit(wb);
Christoph Hellwigefee1712021-11-05 13:37:04 -0700414 bdi_put(bdi);
Roman Gushchinf3b6a6d2021-06-28 19:35:53 -0700415 WARN_ON_ONCE(!list_empty(&wb->b_attached));
Tejun Heo52ebea72015-05-22 17:13:37 -0400416 kfree_rcu(wb, rcu);
Tejun Heo52ebea72015-05-22 17:13:37 -0400417}
418
419static void cgwb_release(struct percpu_ref *refcnt)
420{
421 struct bdi_writeback *wb = container_of(refcnt, struct bdi_writeback,
422 refcnt);
Tejun Heof1834642018-05-23 10:56:32 -0700423 queue_work(cgwb_release_wq, &wb->release_work);
Tejun Heo52ebea72015-05-22 17:13:37 -0400424}
425
426static void cgwb_kill(struct bdi_writeback *wb)
427{
428 lockdep_assert_held(&cgwb_lock);
429
430 WARN_ON(!radix_tree_delete(&wb->bdi->cgwb_tree, wb->memcg_css->id));
431 list_del(&wb->memcg_node);
432 list_del(&wb->blkcg_node);
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700433 list_add(&wb->offline_node, &offline_cgwbs);
Tejun Heo52ebea72015-05-22 17:13:37 -0400434 percpu_ref_kill(&wb->refcnt);
435}
436
Jan Karae8cb72b2017-03-23 01:36:56 +0100437static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
438{
439 spin_lock_irq(&cgwb_lock);
440 list_del_rcu(&wb->bdi_node);
441 spin_unlock_irq(&cgwb_lock);
442}
443
Tejun Heo52ebea72015-05-22 17:13:37 -0400444static int cgwb_create(struct backing_dev_info *bdi,
445 struct cgroup_subsys_state *memcg_css, gfp_t gfp)
446{
447 struct mem_cgroup *memcg;
448 struct cgroup_subsys_state *blkcg_css;
449 struct blkcg *blkcg;
450 struct list_head *memcg_cgwb_list, *blkcg_cgwb_list;
451 struct bdi_writeback *wb;
452 unsigned long flags;
453 int ret = 0;
454
455 memcg = mem_cgroup_from_css(memcg_css);
Tejun Heoc165b3e2015-08-18 14:55:29 -0700456 blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
Tejun Heo52ebea72015-05-22 17:13:37 -0400457 blkcg = css_to_blkcg(blkcg_css);
Wang Long9ccc3612018-06-07 17:07:19 -0700458 memcg_cgwb_list = &memcg->cgwb_list;
Tejun Heo52ebea72015-05-22 17:13:37 -0400459 blkcg_cgwb_list = &blkcg->cgwb_list;
460
461 /* look up again under lock and discard on blkcg mismatch */
462 spin_lock_irqsave(&cgwb_lock, flags);
463 wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
464 if (wb && wb->blkcg_css != blkcg_css) {
465 cgwb_kill(wb);
466 wb = NULL;
467 }
468 spin_unlock_irqrestore(&cgwb_lock, flags);
469 if (wb)
470 goto out_put;
471
472 /* need to create a new one */
473 wb = kmalloc(sizeof(*wb), gfp);
Christophe JAILLET0b045bd2017-09-11 21:43:23 +0200474 if (!wb) {
475 ret = -ENOMEM;
476 goto out_put;
477 }
Tejun Heo52ebea72015-05-22 17:13:37 -0400478
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200479 ret = wb_init(wb, bdi, gfp);
Tejun Heo52ebea72015-05-22 17:13:37 -0400480 if (ret)
481 goto err_free;
482
483 ret = percpu_ref_init(&wb->refcnt, cgwb_release, 0, gfp);
484 if (ret)
485 goto err_wb_exit;
486
Tejun Heo841710a2015-05-22 18:23:33 -0400487 ret = fprop_local_init_percpu(&wb->memcg_completions, gfp);
488 if (ret)
489 goto err_ref_exit;
490
Tejun Heo52ebea72015-05-22 17:13:37 -0400491 wb->memcg_css = memcg_css;
492 wb->blkcg_css = blkcg_css;
Roman Gushchinf3b6a6d2021-06-28 19:35:53 -0700493 INIT_LIST_HEAD(&wb->b_attached);
Tejun Heo52ebea72015-05-22 17:13:37 -0400494 INIT_WORK(&wb->release_work, cgwb_release_workfn);
495 set_bit(WB_registered, &wb->state);
Christoph Hellwigefee1712021-11-05 13:37:04 -0700496 bdi_get(bdi);
Tejun Heo52ebea72015-05-22 17:13:37 -0400497
498 /*
499 * The root wb determines the registered state of the whole bdi and
500 * memcg_cgwb_list and blkcg_cgwb_list's next pointers indicate
501 * whether they're still online. Don't link @wb if any is dead.
502 * See wb_memcg_offline() and wb_blkcg_offline().
503 */
504 ret = -ENODEV;
505 spin_lock_irqsave(&cgwb_lock, flags);
506 if (test_bit(WB_registered, &bdi->wb.state) &&
507 blkcg_cgwb_list->next && memcg_cgwb_list->next) {
508 /* we might have raced another instance of this function */
509 ret = radix_tree_insert(&bdi->cgwb_tree, memcg_css->id, wb);
510 if (!ret) {
Tejun Heob8175252015-10-02 14:47:05 -0400511 list_add_tail_rcu(&wb->bdi_node, &bdi->wb_list);
Tejun Heo52ebea72015-05-22 17:13:37 -0400512 list_add(&wb->memcg_node, memcg_cgwb_list);
513 list_add(&wb->blkcg_node, blkcg_cgwb_list);
Tejun Heod866dbf2019-07-24 10:37:22 -0700514 blkcg_pin_online(blkcg);
Tejun Heo52ebea72015-05-22 17:13:37 -0400515 css_get(memcg_css);
516 css_get(blkcg_css);
517 }
518 }
519 spin_unlock_irqrestore(&cgwb_lock, flags);
520 if (ret) {
521 if (ret == -EEXIST)
522 ret = 0;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600523 goto err_fprop_exit;
Tejun Heo52ebea72015-05-22 17:13:37 -0400524 }
525 goto out_put;
526
Tejun Heo841710a2015-05-22 18:23:33 -0400527err_fprop_exit:
Christoph Hellwigefee1712021-11-05 13:37:04 -0700528 bdi_put(bdi);
Tejun Heo841710a2015-05-22 18:23:33 -0400529 fprop_local_destroy_percpu(&wb->memcg_completions);
Tejun Heo52ebea72015-05-22 17:13:37 -0400530err_ref_exit:
531 percpu_ref_exit(&wb->refcnt);
532err_wb_exit:
533 wb_exit(wb);
534err_free:
535 kfree(wb);
536out_put:
537 css_put(blkcg_css);
538 return ret;
539}
540
541/**
Tejun Heoed288dc2019-08-26 09:06:54 -0700542 * wb_get_lookup - get wb for a given memcg
Tejun Heo52ebea72015-05-22 17:13:37 -0400543 * @bdi: target bdi
544 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
Tejun Heo52ebea72015-05-22 17:13:37 -0400545 *
Tejun Heoed288dc2019-08-26 09:06:54 -0700546 * Try to get the wb for @memcg_css on @bdi. The returned wb has its
547 * refcount incremented.
Tejun Heo52ebea72015-05-22 17:13:37 -0400548 *
549 * This function uses css_get() on @memcg_css and thus expects its refcnt
550 * to be positive on invocation. IOW, rcu_read_lock() protection on
551 * @memcg_css isn't enough. try_get it before calling this function.
552 *
553 * A wb is keyed by its associated memcg. As blkcg implicitly enables
554 * memcg on the default hierarchy, memcg association is guaranteed to be
555 * more specific (equal or descendant to the associated blkcg) and thus can
556 * identify both the memcg and blkcg associations.
557 *
558 * Because the blkcg associated with a memcg may change as blkcg is enabled
559 * and disabled closer to root in the hierarchy, each wb keeps track of
560 * both the memcg and blkcg associated with it and verifies the blkcg on
561 * each lookup. On mismatch, the existing wb is discarded and a new one is
562 * created.
563 */
Tejun Heoed288dc2019-08-26 09:06:54 -0700564struct bdi_writeback *wb_get_lookup(struct backing_dev_info *bdi,
565 struct cgroup_subsys_state *memcg_css)
566{
567 struct bdi_writeback *wb;
568
569 if (!memcg_css->parent)
570 return &bdi->wb;
571
572 rcu_read_lock();
573 wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
574 if (wb) {
575 struct cgroup_subsys_state *blkcg_css;
576
577 /* see whether the blkcg association has changed */
578 blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
579 if (unlikely(wb->blkcg_css != blkcg_css || !wb_tryget(wb)))
580 wb = NULL;
581 css_put(blkcg_css);
582 }
583 rcu_read_unlock();
584
585 return wb;
586}
587
588/**
589 * wb_get_create - get wb for a given memcg, create if necessary
590 * @bdi: target bdi
591 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
592 * @gfp: allocation mask to use
593 *
594 * Try to get the wb for @memcg_css on @bdi. If it doesn't exist, try to
595 * create one. See wb_get_lookup() for more details.
596 */
Tejun Heo52ebea72015-05-22 17:13:37 -0400597struct bdi_writeback *wb_get_create(struct backing_dev_info *bdi,
598 struct cgroup_subsys_state *memcg_css,
599 gfp_t gfp)
600{
601 struct bdi_writeback *wb;
602
Daniel Vetterc1ca59a2021-02-25 17:18:45 -0800603 might_alloc(gfp);
Tejun Heo52ebea72015-05-22 17:13:37 -0400604
605 if (!memcg_css->parent)
606 return &bdi->wb;
607
608 do {
Tejun Heoed288dc2019-08-26 09:06:54 -0700609 wb = wb_get_lookup(bdi, memcg_css);
Tejun Heo52ebea72015-05-22 17:13:37 -0400610 } while (!wb && !cgwb_create(bdi, memcg_css, gfp));
611
612 return wb;
613}
614
Tejun Heoa13f35e2015-07-02 08:44:34 -0600615static int cgwb_bdi_init(struct backing_dev_info *bdi)
Tejun Heo52ebea72015-05-22 17:13:37 -0400616{
Tejun Heoa13f35e2015-07-02 08:44:34 -0600617 int ret;
618
Tejun Heo52ebea72015-05-22 17:13:37 -0400619 INIT_RADIX_TREE(&bdi->cgwb_tree, GFP_ATOMIC);
Jan Kara3ee7e862018-06-18 15:46:58 +0200620 mutex_init(&bdi->cgwb_release_mutex);
Tejun Heo7fc58542017-12-12 08:38:30 -0800621 init_rwsem(&bdi->wb_switch_rwsem);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600622
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200623 ret = wb_init(&bdi->wb, bdi, GFP_KERNEL);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600624 if (!ret) {
Johannes Weiner7d828602016-01-14 15:20:56 -0800625 bdi->wb.memcg_css = &root_mem_cgroup->css;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600626 bdi->wb.blkcg_css = blkcg_root_css;
627 }
628 return ret;
Tejun Heo52ebea72015-05-22 17:13:37 -0400629}
630
Jan Karab1c51af2017-03-23 01:36:59 +0100631static void cgwb_bdi_unregister(struct backing_dev_info *bdi)
Tejun Heo52ebea72015-05-22 17:13:37 -0400632{
633 struct radix_tree_iter iter;
634 void **slot;
Jan Kara5318ce72017-03-23 01:36:57 +0100635 struct bdi_writeback *wb;
Tejun Heo52ebea72015-05-22 17:13:37 -0400636
637 WARN_ON(test_bit(WB_registered, &bdi->wb.state));
638
639 spin_lock_irq(&cgwb_lock);
640 radix_tree_for_each_slot(slot, &bdi->cgwb_tree, &iter, 0)
641 cgwb_kill(*slot);
Jan Kara3ee7e862018-06-18 15:46:58 +0200642 spin_unlock_irq(&cgwb_lock);
Jan Kara5318ce72017-03-23 01:36:57 +0100643
Jan Kara3ee7e862018-06-18 15:46:58 +0200644 mutex_lock(&bdi->cgwb_release_mutex);
645 spin_lock_irq(&cgwb_lock);
Jan Kara5318ce72017-03-23 01:36:57 +0100646 while (!list_empty(&bdi->wb_list)) {
647 wb = list_first_entry(&bdi->wb_list, struct bdi_writeback,
648 bdi_node);
649 spin_unlock_irq(&cgwb_lock);
650 wb_shutdown(wb);
651 spin_lock_irq(&cgwb_lock);
652 }
Tejun Heo52ebea72015-05-22 17:13:37 -0400653 spin_unlock_irq(&cgwb_lock);
Jan Kara3ee7e862018-06-18 15:46:58 +0200654 mutex_unlock(&bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400655}
656
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700657/*
658 * cleanup_offline_cgwbs_workfn - try to release dying cgwbs
659 *
660 * Try to release dying cgwbs by switching attached inodes to the nearest
661 * living ancestor's writeback. Processed wbs are placed at the end
662 * of the list to guarantee the forward progress.
663 */
664static void cleanup_offline_cgwbs_workfn(struct work_struct *work)
665{
666 struct bdi_writeback *wb;
667 LIST_HEAD(processed);
668
669 spin_lock_irq(&cgwb_lock);
670
671 while (!list_empty(&offline_cgwbs)) {
672 wb = list_first_entry(&offline_cgwbs, struct bdi_writeback,
673 offline_node);
674 list_move(&wb->offline_node, &processed);
675
676 /*
677 * If wb is dirty, cleaning up the writeback by switching
678 * attached inodes will result in an effective removal of any
679 * bandwidth restrictions, which isn't the goal. Instead,
680 * it can be postponed until the next time, when all io
681 * will be likely completed. If in the meantime some inodes
682 * will get re-dirtied, they should be eventually switched to
683 * a new cgwb.
684 */
685 if (wb_has_dirty_io(wb))
686 continue;
687
688 if (!wb_tryget(wb))
689 continue;
690
691 spin_unlock_irq(&cgwb_lock);
692 while (cleanup_offline_cgwb(wb))
693 cond_resched();
694 spin_lock_irq(&cgwb_lock);
695
696 wb_put(wb);
697 }
698
699 if (!list_empty(&processed))
700 list_splice_tail(&processed, &offline_cgwbs);
701
702 spin_unlock_irq(&cgwb_lock);
703}
704
Tejun Heo52ebea72015-05-22 17:13:37 -0400705/**
706 * wb_memcg_offline - kill all wb's associated with a memcg being offlined
707 * @memcg: memcg being offlined
708 *
709 * Also prevents creation of any new wb's associated with @memcg.
710 */
711void wb_memcg_offline(struct mem_cgroup *memcg)
712{
Wang Long9ccc3612018-06-07 17:07:19 -0700713 struct list_head *memcg_cgwb_list = &memcg->cgwb_list;
Tejun Heo52ebea72015-05-22 17:13:37 -0400714 struct bdi_writeback *wb, *next;
715
716 spin_lock_irq(&cgwb_lock);
717 list_for_each_entry_safe(wb, next, memcg_cgwb_list, memcg_node)
718 cgwb_kill(wb);
719 memcg_cgwb_list->next = NULL; /* prevent new wb's */
720 spin_unlock_irq(&cgwb_lock);
Roman Gushchinc22d70a2021-06-28 19:36:03 -0700721
722 queue_work(system_unbound_wq, &cleanup_offline_cgwbs_work);
Tejun Heo52ebea72015-05-22 17:13:37 -0400723}
724
725/**
726 * wb_blkcg_offline - kill all wb's associated with a blkcg being offlined
727 * @blkcg: blkcg being offlined
728 *
729 * Also prevents creation of any new wb's associated with @blkcg.
730 */
731void wb_blkcg_offline(struct blkcg *blkcg)
732{
Tejun Heo52ebea72015-05-22 17:13:37 -0400733 struct bdi_writeback *wb, *next;
734
735 spin_lock_irq(&cgwb_lock);
736 list_for_each_entry_safe(wb, next, &blkcg->cgwb_list, blkcg_node)
737 cgwb_kill(wb);
738 blkcg->cgwb_list.next = NULL; /* prevent new wb's */
739 spin_unlock_irq(&cgwb_lock);
740}
741
Jan Karae8cb72b2017-03-23 01:36:56 +0100742static void cgwb_bdi_register(struct backing_dev_info *bdi)
743{
744 spin_lock_irq(&cgwb_lock);
745 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
746 spin_unlock_irq(&cgwb_lock);
747}
748
Tejun Heof1834642018-05-23 10:56:32 -0700749static int __init cgwb_init(void)
750{
751 /*
752 * There can be many concurrent release work items overwhelming
753 * system_wq. Put them in a separate wq and limit concurrency.
754 * There's no point in executing many of these in parallel.
755 */
756 cgwb_release_wq = alloc_workqueue("cgwb_release", 0, 1);
757 if (!cgwb_release_wq)
758 return -ENOMEM;
759
760 return 0;
761}
762subsys_initcall(cgwb_init);
763
Tejun Heo52ebea72015-05-22 17:13:37 -0400764#else /* CONFIG_CGROUP_WRITEBACK */
765
Tejun Heoa13f35e2015-07-02 08:44:34 -0600766static int cgwb_bdi_init(struct backing_dev_info *bdi)
767{
Christoph Hellwig8c911f32020-07-01 11:06:21 +0200768 return wb_init(&bdi->wb, bdi, GFP_KERNEL);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600769}
770
Jan Karab1c51af2017-03-23 01:36:59 +0100771static void cgwb_bdi_unregister(struct backing_dev_info *bdi) { }
Jan Karadf23de52017-03-08 17:48:32 +0100772
Jan Karae8cb72b2017-03-23 01:36:56 +0100773static void cgwb_bdi_register(struct backing_dev_info *bdi)
774{
775 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
776}
777
778static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
779{
780 list_del_rcu(&wb->bdi_node);
781}
782
Tejun Heo52ebea72015-05-22 17:13:37 -0400783#endif /* CONFIG_CGROUP_WRITEBACK */
784
Jan Kara2e82b842017-04-12 12:24:48 +0200785static int bdi_init(struct backing_dev_info *bdi)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700786{
Tejun Heob8175252015-10-02 14:47:05 -0400787 int ret;
788
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700789 bdi->dev = NULL;
790
Jan Karad03f6cd2017-02-02 15:56:51 +0100791 kref_init(&bdi->refcnt);
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700792 bdi->min_ratio = 0;
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700793 bdi->max_ratio = 100;
Jan Karaeb608e32012-05-24 18:59:11 +0200794 bdi->max_prop_frac = FPROP_FRAC_BASE;
Jens Axboe66f3b8e2009-09-02 09:19:46 +0200795 INIT_LIST_HEAD(&bdi->bdi_list);
Tejun Heob8175252015-10-02 14:47:05 -0400796 INIT_LIST_HEAD(&bdi->wb_list);
Tejun Heocc395d72015-05-22 17:13:58 -0400797 init_waitqueue_head(&bdi->wb_waitq);
Jens Axboe03ba3782009-09-09 09:08:54 +0200798
Tejun Heob8175252015-10-02 14:47:05 -0400799 ret = cgwb_bdi_init(bdi);
800
Tejun Heob8175252015-10-02 14:47:05 -0400801 return ret;
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700802}
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700803
Christoph Hellwigaef33c22020-05-04 14:48:00 +0200804struct backing_dev_info *bdi_alloc(int node_id)
Jan Karad03f6cd2017-02-02 15:56:51 +0100805{
806 struct backing_dev_info *bdi;
807
Christoph Hellwigaef33c22020-05-04 14:48:00 +0200808 bdi = kzalloc_node(sizeof(*bdi), GFP_KERNEL, node_id);
Jan Karad03f6cd2017-02-02 15:56:51 +0100809 if (!bdi)
810 return NULL;
811
812 if (bdi_init(bdi)) {
813 kfree(bdi);
814 return NULL;
815 }
Christoph Hellwigf56753a2020-09-24 08:51:40 +0200816 bdi->capabilities = BDI_CAP_WRITEBACK | BDI_CAP_WRITEBACK_ACCT;
Christoph Hellwig55b25982020-09-24 08:51:32 +0200817 bdi->ra_pages = VM_READAHEAD_PAGES;
818 bdi->io_pages = VM_READAHEAD_PAGES;
Christoph Hellwig5ed964f2021-08-09 16:17:40 +0200819 timer_setup(&bdi->laptop_mode_wb_timer, laptop_mode_timer_fn, 0);
Jan Karad03f6cd2017-02-02 15:56:51 +0100820 return bdi;
821}
Christoph Hellwigaef33c22020-05-04 14:48:00 +0200822EXPORT_SYMBOL(bdi_alloc);
Jan Karad03f6cd2017-02-02 15:56:51 +0100823
Tejun Heo34f8fe52019-08-26 09:06:53 -0700824static struct rb_node **bdi_lookup_rb_node(u64 id, struct rb_node **parentp)
825{
826 struct rb_node **p = &bdi_tree.rb_node;
827 struct rb_node *parent = NULL;
828 struct backing_dev_info *bdi;
829
830 lockdep_assert_held(&bdi_lock);
831
832 while (*p) {
833 parent = *p;
834 bdi = rb_entry(parent, struct backing_dev_info, rb_node);
835
836 if (bdi->id > id)
837 p = &(*p)->rb_left;
838 else if (bdi->id < id)
839 p = &(*p)->rb_right;
840 else
841 break;
842 }
843
844 if (parentp)
845 *parentp = parent;
846 return p;
847}
848
849/**
850 * bdi_get_by_id - lookup and get bdi from its id
851 * @id: bdi id to lookup
852 *
853 * Find bdi matching @id and get it. Returns NULL if the matching bdi
854 * doesn't exist or is already unregistered.
855 */
856struct backing_dev_info *bdi_get_by_id(u64 id)
857{
858 struct backing_dev_info *bdi = NULL;
859 struct rb_node **p;
860
861 spin_lock_bh(&bdi_lock);
862 p = bdi_lookup_rb_node(id, NULL);
863 if (*p) {
864 bdi = rb_entry(*p, struct backing_dev_info, rb_node);
865 bdi_get(bdi);
866 }
867 spin_unlock_bh(&bdi_lock);
868
869 return bdi;
870}
871
Jan Kara7c4cc302017-04-12 12:24:49 +0200872int bdi_register_va(struct backing_dev_info *bdi, const char *fmt, va_list args)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700873{
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700874 struct device *dev;
Tejun Heo34f8fe52019-08-26 09:06:53 -0700875 struct rb_node *parent, **p;
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700876
877 if (bdi->dev) /* The driver needs to use separate queues per device */
878 return 0;
879
Christoph Hellwig6bd87ee2020-05-04 14:47:56 +0200880 vsnprintf(bdi->dev_name, sizeof(bdi->dev_name), fmt, args);
881 dev = device_create(bdi_class, NULL, MKDEV(0, 0), bdi, bdi->dev_name);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700882 if (IS_ERR(dev))
883 return PTR_ERR(dev);
884
Jan Karae8cb72b2017-03-23 01:36:56 +0100885 cgwb_bdi_register(bdi);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700886 bdi->dev = dev;
887
Jens Axboe6d0e4822017-12-21 10:01:30 -0700888 bdi_debug_register(bdi, dev_name(dev));
Tejun Heo46100072015-05-22 17:13:31 -0400889 set_bit(WB_registered, &bdi->wb.state);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700890
891 spin_lock_bh(&bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700892
893 bdi->id = ++bdi_id_cursor;
894
895 p = bdi_lookup_rb_node(bdi->id, &parent);
896 rb_link_node(&bdi->rb_node, parent, p);
897 rb_insert_color(&bdi->rb_node, &bdi_tree);
898
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700899 list_add_tail_rcu(&bdi->bdi_list, &bdi_list);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700900
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700901 spin_unlock_bh(&bdi_lock);
902
903 trace_writeback_bdi_register(bdi);
904 return 0;
905}
Jan Karabaf7a612017-04-12 12:24:25 +0200906
Jan Kara7c4cc302017-04-12 12:24:49 +0200907int bdi_register(struct backing_dev_info *bdi, const char *fmt, ...)
Jan Karabaf7a612017-04-12 12:24:25 +0200908{
909 va_list args;
910 int ret;
911
912 va_start(args, fmt);
Jan Kara7c4cc302017-04-12 12:24:49 +0200913 ret = bdi_register_va(bdi, fmt, args);
Jan Karabaf7a612017-04-12 12:24:25 +0200914 va_end(args);
915 return ret;
916}
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700917EXPORT_SYMBOL(bdi_register);
918
Christoph Hellwig3c5d2022020-05-04 14:47:59 +0200919void bdi_set_owner(struct backing_dev_info *bdi, struct device *owner)
Dan Williamsdf08c322016-07-31 11:15:13 -0700920{
Christoph Hellwig3c5d2022020-05-04 14:47:59 +0200921 WARN_ON_ONCE(bdi->owner);
Dan Williamsdf08c322016-07-31 11:15:13 -0700922 bdi->owner = owner;
923 get_device(owner);
Dan Williamsdf08c322016-07-31 11:15:13 -0700924}
Dan Williamsdf08c322016-07-31 11:15:13 -0700925
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700926/*
Tejun Heo46100072015-05-22 17:13:31 -0400927 * Remove bdi from bdi_list, and ensure that it is no longer visible
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700928 */
Tejun Heo46100072015-05-22 17:13:31 -0400929static void bdi_remove_from_list(struct backing_dev_info *bdi)
Peter Zijlstra04fbfdc2007-10-16 23:25:50 -0700930{
Tejun Heo46100072015-05-22 17:13:31 -0400931 spin_lock_bh(&bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700932 rb_erase(&bdi->rb_node, &bdi_tree);
Tejun Heo46100072015-05-22 17:13:31 -0400933 list_del_rcu(&bdi->bdi_list);
934 spin_unlock_bh(&bdi_lock);
Andrew Morton3fcfab12006-10-19 23:28:16 -0700935
Tejun Heo46100072015-05-22 17:13:31 -0400936 synchronize_rcu_expedited();
Andrew Morton3fcfab12006-10-19 23:28:16 -0700937}
938
Tejun Heob02176f2015-09-08 12:20:22 -0400939void bdi_unregister(struct backing_dev_info *bdi)
Andrew Morton3fcfab12006-10-19 23:28:16 -0700940{
Christoph Hellwig5ed964f2021-08-09 16:17:40 +0200941 del_timer_sync(&bdi->laptop_mode_wb_timer);
942
Tejun Heof0054bb2015-05-22 17:13:30 -0400943 /* make sure nobody finds us on the bdi_list anymore */
944 bdi_remove_from_list(bdi);
945 wb_shutdown(&bdi->wb);
Jan Karab1c51af2017-03-23 01:36:59 +0100946 cgwb_bdi_unregister(bdi);
Rabin Vincent7a401a92011-11-11 13:29:04 +0100947
Christoph Hellwigc4db59d2015-01-20 14:05:00 -0700948 if (bdi->dev) {
949 bdi_debug_unregister(bdi);
950 device_unregister(bdi->dev);
951 bdi->dev = NULL;
952 }
Dan Williamsdf08c322016-07-31 11:15:13 -0700953
954 if (bdi->owner) {
955 put_device(bdi->owner);
956 bdi->owner = NULL;
957 }
Tejun Heob02176f2015-09-08 12:20:22 -0400958}
Christoph Hellwigc6fd3ac2021-11-05 13:36:52 -0700959EXPORT_SYMBOL(bdi_unregister);
Christoph Hellwigc4db59d2015-01-20 14:05:00 -0700960
Jan Karad03f6cd2017-02-02 15:56:51 +0100961static void release_bdi(struct kref *ref)
962{
963 struct backing_dev_info *bdi =
964 container_of(ref, struct backing_dev_info, refcnt);
965
Christoph Hellwig702f2d12021-11-05 13:37:01 -0700966 WARN_ON_ONCE(test_bit(WB_registered, &bdi->wb.state));
Jan Kara2e82b842017-04-12 12:24:48 +0200967 WARN_ON_ONCE(bdi->dev);
968 wb_exit(&bdi->wb);
Jan Karad03f6cd2017-02-02 15:56:51 +0100969 kfree(bdi);
970}
971
972void bdi_put(struct backing_dev_info *bdi)
973{
974 kref_put(&bdi->refcnt, release_bdi);
975}
Jan Kara62bf42a2017-04-12 12:24:27 +0200976EXPORT_SYMBOL(bdi_put);
Jan Karad03f6cd2017-02-02 15:56:51 +0100977
Christoph Hellwigccdf7742021-09-20 14:33:14 +0200978struct backing_dev_info *inode_to_bdi(struct inode *inode)
979{
980 struct super_block *sb;
981
982 if (!inode)
983 return &noop_backing_dev_info;
984
985 sb = inode->i_sb;
986#ifdef CONFIG_BLOCK
987 if (sb_is_blkdev_sb(sb))
988 return I_BDEV(inode)->bd_disk->bdi;
989#endif
990 return sb->s_bdi;
991}
992EXPORT_SYMBOL(inode_to_bdi);
993
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +0200994const char *bdi_dev_name(struct backing_dev_info *bdi)
995{
996 if (!bdi || !bdi->dev)
997 return bdi_unknown_name;
Christoph Hellwig6bd87ee2020-05-04 14:47:56 +0200998 return bdi->dev_name;
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +0200999}
1000EXPORT_SYMBOL_GPL(bdi_dev_name);
1001
Andrew Morton3fcfab12006-10-19 23:28:16 -07001002static wait_queue_head_t congestion_wqh[2] = {
1003 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[0]),
1004 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[1])
1005 };
Tejun Heoec8a6f22015-05-22 17:13:41 -04001006static atomic_t nr_wb_congested[2];
Andrew Morton3fcfab12006-10-19 23:28:16 -07001007
Christoph Hellwig492d76b2020-07-01 11:06:20 +02001008void clear_bdi_congested(struct backing_dev_info *bdi, int sync)
Andrew Morton3fcfab12006-10-19 23:28:16 -07001009{
Jens Axboe1faa16d2009-04-06 14:48:01 +02001010 wait_queue_head_t *wqh = &congestion_wqh[sync];
Kaixu Xiac877ef82016-03-31 13:19:41 +00001011 enum wb_congested_state bit;
Andrew Morton3fcfab12006-10-19 23:28:16 -07001012
Tejun Heo44522262015-05-22 17:13:26 -04001013 bit = sync ? WB_sync_congested : WB_async_congested;
Christoph Hellwig8c911f32020-07-01 11:06:21 +02001014 if (test_and_clear_bit(bit, &bdi->wb.congested))
Tejun Heoec8a6f22015-05-22 17:13:41 -04001015 atomic_dec(&nr_wb_congested[sync]);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001016 smp_mb__after_atomic();
Andrew Morton3fcfab12006-10-19 23:28:16 -07001017 if (waitqueue_active(wqh))
1018 wake_up(wqh);
1019}
Christoph Hellwig492d76b2020-07-01 11:06:20 +02001020EXPORT_SYMBOL(clear_bdi_congested);
Andrew Morton3fcfab12006-10-19 23:28:16 -07001021
Christoph Hellwig492d76b2020-07-01 11:06:20 +02001022void set_bdi_congested(struct backing_dev_info *bdi, int sync)
Andrew Morton3fcfab12006-10-19 23:28:16 -07001023{
Kaixu Xiac877ef82016-03-31 13:19:41 +00001024 enum wb_congested_state bit;
Andrew Morton3fcfab12006-10-19 23:28:16 -07001025
Tejun Heo44522262015-05-22 17:13:26 -04001026 bit = sync ? WB_sync_congested : WB_async_congested;
Christoph Hellwig8c911f32020-07-01 11:06:21 +02001027 if (!test_and_set_bit(bit, &bdi->wb.congested))
Tejun Heoec8a6f22015-05-22 17:13:41 -04001028 atomic_inc(&nr_wb_congested[sync]);
Andrew Morton3fcfab12006-10-19 23:28:16 -07001029}
Christoph Hellwig492d76b2020-07-01 11:06:20 +02001030EXPORT_SYMBOL(set_bdi_congested);
Andrew Morton3fcfab12006-10-19 23:28:16 -07001031
1032/**
1033 * congestion_wait - wait for a backing_dev to become uncongested
Jens Axboe8aa7e842009-07-09 14:52:32 +02001034 * @sync: SYNC or ASYNC IO
Andrew Morton3fcfab12006-10-19 23:28:16 -07001035 * @timeout: timeout in jiffies
1036 *
1037 * Waits for up to @timeout jiffies for a backing_dev (any backing_dev) to exit
1038 * write congestion. If no backing_devs are congested then just wait for the
1039 * next write to be completed.
1040 */
Jens Axboe8aa7e842009-07-09 14:52:32 +02001041long congestion_wait(int sync, long timeout)
Andrew Morton3fcfab12006-10-19 23:28:16 -07001042{
1043 long ret;
Mel Gorman52bb9192010-10-26 14:21:41 -07001044 unsigned long start = jiffies;
Andrew Morton3fcfab12006-10-19 23:28:16 -07001045 DEFINE_WAIT(wait);
Jens Axboe8aa7e842009-07-09 14:52:32 +02001046 wait_queue_head_t *wqh = &congestion_wqh[sync];
Andrew Morton3fcfab12006-10-19 23:28:16 -07001047
1048 prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
1049 ret = io_schedule_timeout(timeout);
1050 finish_wait(wqh, &wait);
Mel Gorman52bb9192010-10-26 14:21:41 -07001051
1052 trace_writeback_congestion_wait(jiffies_to_usecs(timeout),
1053 jiffies_to_usecs(jiffies - start));
1054
Andrew Morton3fcfab12006-10-19 23:28:16 -07001055 return ret;
1056}
1057EXPORT_SYMBOL(congestion_wait);