blob: efc5b83acd2df59499f80c450e2db3b6f2c176a5 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Andrew Morton3fcfab12006-10-19 23:28:16 -07002
3#include <linux/wait.h>
Tejun Heo34f8fe52019-08-26 09:06:53 -07004#include <linux/rbtree.h>
Andrew Morton3fcfab12006-10-19 23:28:16 -07005#include <linux/backing-dev.h>
Jens Axboe03ba3782009-09-09 09:08:54 +02006#include <linux/kthread.h>
7#include <linux/freezer.h>
Andrew Morton3fcfab12006-10-19 23:28:16 -07008#include <linux/fs.h>
Jens Axboe26160152009-03-17 09:35:06 +01009#include <linux/pagemap.h>
Jens Axboe03ba3782009-09-09 09:08:54 +020010#include <linux/mm.h>
Andrew Morton3fcfab12006-10-19 23:28:16 -070011#include <linux/sched.h>
12#include <linux/module.h>
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070013#include <linux/writeback.h>
14#include <linux/device.h>
Dave Chinner455b2862010-07-07 13:24:06 +100015#include <trace/events/writeback.h>
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070016
Jörn Engel5129a462010-04-25 08:54:42 +020017struct backing_dev_info noop_backing_dev_info = {
18 .name = "noop",
Jan Kara976e48f2010-09-21 11:48:55 +020019 .capabilities = BDI_CAP_NO_ACCT_AND_WRITEBACK,
Jörn Engel5129a462010-04-25 08:54:42 +020020};
Tejun Heoa212b102015-05-22 17:13:33 -040021EXPORT_SYMBOL_GPL(noop_backing_dev_info);
Jörn Engel5129a462010-04-25 08:54:42 +020022
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070023static struct class *bdi_class;
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +020024static const char *bdi_unknown_name = "(unknown)";
Jens Axboecfc4ba52009-09-14 13:12:40 +020025
26/*
Tejun Heo34f8fe52019-08-26 09:06:53 -070027 * bdi_lock protects bdi_tree and updates to bdi_list. bdi_list has RCU
28 * reader side locking.
Jens Axboecfc4ba52009-09-14 13:12:40 +020029 */
Jens Axboe03ba3782009-09-09 09:08:54 +020030DEFINE_SPINLOCK(bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -070031static u64 bdi_id_cursor;
32static struct rb_root bdi_tree = RB_ROOT;
Jens Axboe66f3b8e2009-09-02 09:19:46 +020033LIST_HEAD(bdi_list);
Jens Axboe03ba3782009-09-09 09:08:54 +020034
Tejun Heo839a8e82013-04-01 19:08:06 -070035/* bdi_wq serves all asynchronous writeback tasks */
36struct workqueue_struct *bdi_wq;
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
75#define K(x) ((x) << (PAGE_SHIFT - 10))
76 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#undef K
105
106 return 0;
107}
Andy Shevchenko5ad35092018-04-05 16:23:16 -0700108DEFINE_SHOW_ATTRIBUTE(bdi_debug_stats);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700109
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100110static void bdi_debug_register(struct backing_dev_info *bdi, const char *name)
Miklos Szeredi76f14182008-04-30 00:54:36 -0700111{
112 bdi->debug_dir = debugfs_create_dir(name, bdi_debug_root);
weiping zhang97f07692017-10-31 18:37:54 +0800113
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100114 debugfs_create_file("stats", 0444, bdi->debug_dir, bdi,
115 &bdi_debug_stats_fops);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700116}
117
118static void bdi_debug_unregister(struct backing_dev_info *bdi)
119{
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100120 debugfs_remove_recursive(bdi->debug_dir);
Miklos Szeredi76f14182008-04-30 00:54:36 -0700121}
122#else
123static inline void bdi_debug_init(void)
124{
125}
Greg Kroah-Hartman2d146b92019-01-22 16:21:07 +0100126static inline void bdi_debug_register(struct backing_dev_info *bdi,
Miklos Szeredi76f14182008-04-30 00:54:36 -0700127 const char *name)
128{
129}
130static inline void bdi_debug_unregister(struct backing_dev_info *bdi)
131{
132}
133#endif
134
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700135static ssize_t read_ahead_kb_store(struct device *dev,
136 struct device_attribute *attr,
137 const char *buf, size_t count)
138{
139 struct backing_dev_info *bdi = dev_get_drvdata(dev);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700140 unsigned long read_ahead_kb;
Namjae Jeon7034ed12012-08-25 16:57:27 +0800141 ssize_t ret;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700142
Namjae Jeon7034ed12012-08-25 16:57:27 +0800143 ret = kstrtoul(buf, 10, &read_ahead_kb);
144 if (ret < 0)
145 return ret;
146
147 bdi->ra_pages = read_ahead_kb >> (PAGE_SHIFT - 10);
148
149 return count;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700150}
151
152#define K(pages) ((pages) << (PAGE_SHIFT - 10))
153
154#define BDI_SHOW(name, expr) \
155static ssize_t name##_show(struct device *dev, \
156 struct device_attribute *attr, char *page) \
157{ \
158 struct backing_dev_info *bdi = dev_get_drvdata(dev); \
159 \
160 return snprintf(page, PAGE_SIZE-1, "%lld\n", (long long)expr); \
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700161} \
162static DEVICE_ATTR_RW(name);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700163
164BDI_SHOW(read_ahead_kb, K(bdi->ra_pages))
165
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700166static ssize_t min_ratio_store(struct device *dev,
167 struct device_attribute *attr, const char *buf, size_t count)
168{
169 struct backing_dev_info *bdi = dev_get_drvdata(dev);
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700170 unsigned int ratio;
Namjae Jeon7034ed12012-08-25 16:57:27 +0800171 ssize_t ret;
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700172
Namjae Jeon7034ed12012-08-25 16:57:27 +0800173 ret = kstrtouint(buf, 10, &ratio);
174 if (ret < 0)
175 return ret;
176
177 ret = bdi_set_min_ratio(bdi, ratio);
178 if (!ret)
179 ret = count;
180
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700181 return ret;
182}
183BDI_SHOW(min_ratio, bdi->min_ratio)
184
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700185static ssize_t max_ratio_store(struct device *dev,
186 struct device_attribute *attr, const char *buf, size_t count)
187{
188 struct backing_dev_info *bdi = dev_get_drvdata(dev);
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700189 unsigned int ratio;
Namjae Jeon7034ed12012-08-25 16:57:27 +0800190 ssize_t ret;
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700191
Namjae Jeon7034ed12012-08-25 16:57:27 +0800192 ret = kstrtouint(buf, 10, &ratio);
193 if (ret < 0)
194 return ret;
195
196 ret = bdi_set_max_ratio(bdi, ratio);
197 if (!ret)
198 ret = count;
199
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700200 return ret;
201}
202BDI_SHOW(max_ratio, bdi->max_ratio)
203
Darrick J. Wong7d311cd2013-02-21 16:42:48 -0800204static ssize_t stable_pages_required_show(struct device *dev,
205 struct device_attribute *attr,
206 char *page)
207{
208 struct backing_dev_info *bdi = dev_get_drvdata(dev);
209
210 return snprintf(page, PAGE_SIZE-1, "%d\n",
211 bdi_cap_stable_pages_required(bdi) ? 1 : 0);
212}
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700213static DEVICE_ATTR_RO(stable_pages_required);
Darrick J. Wong7d311cd2013-02-21 16:42:48 -0800214
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700215static struct attribute *bdi_dev_attrs[] = {
216 &dev_attr_read_ahead_kb.attr,
217 &dev_attr_min_ratio.attr,
218 &dev_attr_max_ratio.attr,
219 &dev_attr_stable_pages_required.attr,
220 NULL,
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700221};
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700222ATTRIBUTE_GROUPS(bdi_dev);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700223
224static __init int bdi_class_init(void)
225{
226 bdi_class = class_create(THIS_MODULE, "bdi");
Anton Blanchard14421452010-04-02 09:46:55 +0200227 if (IS_ERR(bdi_class))
228 return PTR_ERR(bdi_class);
229
Greg Kroah-Hartmand9e12412013-07-24 15:05:26 -0700230 bdi_class->dev_groups = bdi_dev_groups;
Miklos Szeredi76f14182008-04-30 00:54:36 -0700231 bdi_debug_init();
Jan Karad03f6cd2017-02-02 15:56:51 +0100232
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700233 return 0;
234}
Miklos Szeredi76f14182008-04-30 00:54:36 -0700235postcore_initcall(bdi_class_init);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700236
Jan Kara2e82b842017-04-12 12:24:48 +0200237static int bdi_init(struct backing_dev_info *bdi);
238
Jens Axboe26160152009-03-17 09:35:06 +0100239static int __init default_bdi_init(void)
240{
241 int err;
242
Mika Westerberga2b90f12019-10-04 13:00:24 +0300243 bdi_wq = alloc_workqueue("writeback", WQ_MEM_RECLAIM | WQ_UNBOUND |
244 WQ_SYSFS, 0);
Tejun Heo839a8e82013-04-01 19:08:06 -0700245 if (!bdi_wq)
246 return -ENOMEM;
247
Jan Kara976e48f2010-09-21 11:48:55 +0200248 err = bdi_init(&noop_backing_dev_info);
Jens Axboe26160152009-03-17 09:35:06 +0100249
250 return err;
251}
252subsys_initcall(default_bdi_init);
253
Artem Bityutskiy64677162010-07-25 14:29:22 +0300254/*
Tejun Heof0054bb2015-05-22 17:13:30 -0400255 * This function is used when the first inode for this wb is marked dirty. It
Artem Bityutskiy64677162010-07-25 14:29:22 +0300256 * wakes-up the corresponding bdi thread which should then take care of the
257 * periodic background write-out of dirty inodes. Since the write-out would
258 * starts only 'dirty_writeback_interval' centisecs from now anyway, we just
259 * set up a timer which wakes the bdi thread up later.
260 *
261 * Note, we wouldn't bother setting up the timer, but this function is on the
262 * fast-path (used by '__mark_inode_dirty()'), so we save few context switches
263 * by delaying the wake-up.
Derek Basehore6ca738d2014-04-03 14:46:22 -0700264 *
265 * We have to be careful not to postpone flush work if it is scheduled for
266 * earlier. Thus we use queue_delayed_work().
Artem Bityutskiy64677162010-07-25 14:29:22 +0300267 */
Tejun Heof0054bb2015-05-22 17:13:30 -0400268void wb_wakeup_delayed(struct bdi_writeback *wb)
Artem Bityutskiy64677162010-07-25 14:29:22 +0300269{
270 unsigned long timeout;
271
272 timeout = msecs_to_jiffies(dirty_writeback_interval * 10);
Tejun Heof0054bb2015-05-22 17:13:30 -0400273 spin_lock_bh(&wb->work_lock);
274 if (test_bit(WB_registered, &wb->state))
275 queue_delayed_work(bdi_wq, &wb->dwork, timeout);
276 spin_unlock_bh(&wb->work_lock);
Jens Axboe03ba3782009-09-09 09:08:54 +0200277}
278
Jens Axboecfc4ba52009-09-14 13:12:40 +0200279/*
Tejun Heoa88a3412015-05-22 17:13:28 -0400280 * Initial write bandwidth: 100 MB/s
Jens Axboecfc4ba52009-09-14 13:12:40 +0200281 */
Tejun Heoa88a3412015-05-22 17:13:28 -0400282#define INIT_BW (100 << (20 - PAGE_SHIFT))
Jens Axboecfc4ba52009-09-14 13:12:40 +0200283
Tejun Heo8395cd92015-05-22 17:13:34 -0400284static int wb_init(struct bdi_writeback *wb, struct backing_dev_info *bdi,
Tejun Heoa13f35e2015-07-02 08:44:34 -0600285 int blkcg_id, gfp_t gfp)
Artem Bityutskiy64677162010-07-25 14:29:22 +0300286{
Tejun Heo93f78d82015-05-22 17:13:27 -0400287 int i, err;
288
Artem Bityutskiy64677162010-07-25 14:29:22 +0300289 memset(wb, 0, sizeof(*wb));
290
Jan Kara810df542017-03-23 01:36:55 +0100291 if (wb != &bdi->wb)
292 bdi_get(bdi);
Artem Bityutskiy64677162010-07-25 14:29:22 +0300293 wb->bdi = bdi;
294 wb->last_old_flush = jiffies;
295 INIT_LIST_HEAD(&wb->b_dirty);
296 INIT_LIST_HEAD(&wb->b_io);
297 INIT_LIST_HEAD(&wb->b_more_io);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500298 INIT_LIST_HEAD(&wb->b_dirty_time);
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600299 spin_lock_init(&wb->list_lock);
Tejun Heo93f78d82015-05-22 17:13:27 -0400300
Tejun Heoa88a3412015-05-22 17:13:28 -0400301 wb->bw_time_stamp = jiffies;
302 wb->balanced_dirty_ratelimit = INIT_BW;
303 wb->dirty_ratelimit = INIT_BW;
304 wb->write_bandwidth = INIT_BW;
305 wb->avg_write_bandwidth = INIT_BW;
306
Tejun Heof0054bb2015-05-22 17:13:30 -0400307 spin_lock_init(&wb->work_lock);
308 INIT_LIST_HEAD(&wb->work_list);
309 INIT_DELAYED_WORK(&wb->dwork, wb_workfn);
Jens Axboeb57d74a2016-09-01 10:20:33 -0600310 wb->dirty_sleep = jiffies;
Tejun Heof0054bb2015-05-22 17:13:30 -0400311
Tejun Heoa13f35e2015-07-02 08:44:34 -0600312 wb->congested = wb_congested_get_create(bdi, blkcg_id, gfp);
Jan Kara810df542017-03-23 01:36:55 +0100313 if (!wb->congested) {
314 err = -ENOMEM;
315 goto out_put_bdi;
316 }
Tejun Heoa13f35e2015-07-02 08:44:34 -0600317
Tejun Heo8395cd92015-05-22 17:13:34 -0400318 err = fprop_local_init_percpu(&wb->completions, gfp);
Tejun Heoa88a3412015-05-22 17:13:28 -0400319 if (err)
Tejun Heoa13f35e2015-07-02 08:44:34 -0600320 goto out_put_cong;
Tejun Heoa88a3412015-05-22 17:13:28 -0400321
Tejun Heo93f78d82015-05-22 17:13:27 -0400322 for (i = 0; i < NR_WB_STAT_ITEMS; i++) {
Tejun Heo8395cd92015-05-22 17:13:34 -0400323 err = percpu_counter_init(&wb->stat[i], 0, gfp);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600324 if (err)
325 goto out_destroy_stat;
Tejun Heo93f78d82015-05-22 17:13:27 -0400326 }
327
328 return 0;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600329
330out_destroy_stat:
Rasmus Villemoes078c6c32016-02-11 16:13:06 -0800331 while (i--)
Tejun Heoa13f35e2015-07-02 08:44:34 -0600332 percpu_counter_destroy(&wb->stat[i]);
333 fprop_local_destroy_percpu(&wb->completions);
334out_put_cong:
335 wb_congested_put(wb->congested);
Jan Kara810df542017-03-23 01:36:55 +0100336out_put_bdi:
337 if (wb != &bdi->wb)
338 bdi_put(bdi);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600339 return err;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700340}
Jens Axboe03ba3782009-09-09 09:08:54 +0200341
Jan Karae8cb72b2017-03-23 01:36:56 +0100342static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb);
343
Tejun Heo46100072015-05-22 17:13:31 -0400344/*
345 * Remove bdi from the global list and shutdown any threads we have running
346 */
347static void wb_shutdown(struct bdi_writeback *wb)
348{
349 /* Make sure nobody queues further work */
350 spin_lock_bh(&wb->work_lock);
351 if (!test_and_clear_bit(WB_registered, &wb->state)) {
352 spin_unlock_bh(&wb->work_lock);
353 return;
354 }
355 spin_unlock_bh(&wb->work_lock);
356
Jan Karae8cb72b2017-03-23 01:36:56 +0100357 cgwb_remove_from_bdi_list(wb);
Tejun Heo46100072015-05-22 17:13:31 -0400358 /*
359 * Drain work list and shutdown the delayed_work. !WB_registered
360 * tells wb_workfn() that @wb is dying and its work_list needs to
361 * be drained no matter what.
362 */
363 mod_delayed_work(bdi_wq, &wb->dwork, 0);
364 flush_delayed_work(&wb->dwork);
365 WARN_ON(!list_empty(&wb->work_list));
366}
367
Tejun Heof0054bb2015-05-22 17:13:30 -0400368static void wb_exit(struct bdi_writeback *wb)
Tejun Heo93f78d82015-05-22 17:13:27 -0400369{
370 int i;
371
372 WARN_ON(delayed_work_pending(&wb->dwork));
373
374 for (i = 0; i < NR_WB_STAT_ITEMS; i++)
375 percpu_counter_destroy(&wb->stat[i]);
Artem Bityutskiy64677162010-07-25 14:29:22 +0300376
Tejun Heoa88a3412015-05-22 17:13:28 -0400377 fprop_local_destroy_percpu(&wb->completions);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600378 wb_congested_put(wb->congested);
Jan Kara810df542017-03-23 01:36:55 +0100379 if (wb != &wb->bdi->wb)
380 bdi_put(wb->bdi);
Tejun Heoa88a3412015-05-22 17:13:28 -0400381}
Wu Fengguange98be2d2010-08-29 11:22:30 -0600382
Tejun Heo52ebea72015-05-22 17:13:37 -0400383#ifdef CONFIG_CGROUP_WRITEBACK
384
385#include <linux/memcontrol.h>
386
387/*
388 * cgwb_lock protects bdi->cgwb_tree, bdi->cgwb_congested_tree,
389 * blkcg->cgwb_list, and memcg->cgwb_list. bdi->cgwb_tree is also RCU
Jan Kara45144512017-03-23 01:36:58 +0100390 * protected.
Tejun Heo52ebea72015-05-22 17:13:37 -0400391 */
392static DEFINE_SPINLOCK(cgwb_lock);
Tejun Heof1834642018-05-23 10:56:32 -0700393static struct workqueue_struct *cgwb_release_wq;
Tejun Heo52ebea72015-05-22 17:13:37 -0400394
395/**
396 * wb_congested_get_create - get or create a wb_congested
397 * @bdi: associated bdi
398 * @blkcg_id: ID of the associated blkcg
399 * @gfp: allocation mask
400 *
401 * Look up the wb_congested for @blkcg_id on @bdi. If missing, create one.
402 * The returned wb_congested has its reference count incremented. Returns
403 * NULL on failure.
404 */
405struct bdi_writeback_congested *
406wb_congested_get_create(struct backing_dev_info *bdi, int blkcg_id, gfp_t gfp)
407{
408 struct bdi_writeback_congested *new_congested = NULL, *congested;
409 struct rb_node **node, *parent;
410 unsigned long flags;
Tejun Heo52ebea72015-05-22 17:13:37 -0400411retry:
412 spin_lock_irqsave(&cgwb_lock, flags);
413
414 node = &bdi->cgwb_congested_tree.rb_node;
415 parent = NULL;
416
417 while (*node != NULL) {
418 parent = *node;
Geliang Tangbc712262017-02-22 15:45:52 -0800419 congested = rb_entry(parent, struct bdi_writeback_congested,
420 rb_node);
Tejun Heo52ebea72015-05-22 17:13:37 -0400421 if (congested->blkcg_id < blkcg_id)
422 node = &parent->rb_left;
423 else if (congested->blkcg_id > blkcg_id)
424 node = &parent->rb_right;
425 else
426 goto found;
427 }
428
429 if (new_congested) {
430 /* !found and storage for new one already allocated, insert */
431 congested = new_congested;
Tejun Heo52ebea72015-05-22 17:13:37 -0400432 rb_link_node(&congested->rb_node, parent, node);
433 rb_insert_color(&congested->rb_node, &bdi->cgwb_congested_tree);
Sebastian Andrzej Siewiore58dd0d2018-08-21 21:55:31 -0700434 spin_unlock_irqrestore(&cgwb_lock, flags);
435 return congested;
Tejun Heo52ebea72015-05-22 17:13:37 -0400436 }
437
438 spin_unlock_irqrestore(&cgwb_lock, flags);
439
440 /* allocate storage for new one and retry */
441 new_congested = kzalloc(sizeof(*new_congested), gfp);
442 if (!new_congested)
443 return NULL;
444
Sebastian Andrzej Siewiore58dd0d2018-08-21 21:55:31 -0700445 refcount_set(&new_congested->refcnt, 1);
Jan Karab7d680d2017-03-23 01:36:54 +0100446 new_congested->__bdi = bdi;
Tejun Heo52ebea72015-05-22 17:13:37 -0400447 new_congested->blkcg_id = blkcg_id;
448 goto retry;
449
450found:
Sebastian Andrzej Siewiore58dd0d2018-08-21 21:55:31 -0700451 refcount_inc(&congested->refcnt);
Tejun Heo52ebea72015-05-22 17:13:37 -0400452 spin_unlock_irqrestore(&cgwb_lock, flags);
453 kfree(new_congested);
454 return congested;
455}
456
457/**
458 * wb_congested_put - put a wb_congested
459 * @congested: wb_congested to put
460 *
461 * Put @congested and destroy it if the refcnt reaches zero.
462 */
463void wb_congested_put(struct bdi_writeback_congested *congested)
464{
Tejun Heo52ebea72015-05-22 17:13:37 -0400465 unsigned long flags;
466
Anna-Maria Gleixner060288a72018-08-21 21:55:35 -0700467 if (!refcount_dec_and_lock_irqsave(&congested->refcnt, &cgwb_lock, &flags))
Tejun Heo52ebea72015-05-22 17:13:37 -0400468 return;
Tejun Heo52ebea72015-05-22 17:13:37 -0400469
Tejun Heoa20135ff2015-07-01 20:53:37 -0400470 /* bdi might already have been destroyed leaving @congested unlinked */
Jan Karab7d680d2017-03-23 01:36:54 +0100471 if (congested->__bdi) {
Tejun Heoa20135ff2015-07-01 20:53:37 -0400472 rb_erase(&congested->rb_node,
Jan Karab7d680d2017-03-23 01:36:54 +0100473 &congested->__bdi->cgwb_congested_tree);
474 congested->__bdi = NULL;
Tejun Heoa20135ff2015-07-01 20:53:37 -0400475 }
476
Tejun Heo52ebea72015-05-22 17:13:37 -0400477 spin_unlock_irqrestore(&cgwb_lock, flags);
478 kfree(congested);
Tejun Heo52ebea72015-05-22 17:13:37 -0400479}
480
481static void cgwb_release_workfn(struct work_struct *work)
482{
483 struct bdi_writeback *wb = container_of(work, struct bdi_writeback,
484 release_work);
Dennis Zhou (Facebook)59b57712018-08-31 16:22:43 -0400485 struct blkcg *blkcg = css_to_blkcg(wb->blkcg_css);
Tejun Heo52ebea72015-05-22 17:13:37 -0400486
Jan Kara3ee7e862018-06-18 15:46:58 +0200487 mutex_lock(&wb->bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400488 wb_shutdown(wb);
489
490 css_put(wb->memcg_css);
491 css_put(wb->blkcg_css);
Jan Kara3ee7e862018-06-18 15:46:58 +0200492 mutex_unlock(&wb->bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400493
Tejun Heod866dbf2019-07-24 10:37:22 -0700494 /* triggers blkg destruction if no online users left */
495 blkcg_unpin_online(blkcg);
Dennis Zhou (Facebook)59b57712018-08-31 16:22:43 -0400496
Tejun Heo841710a2015-05-22 18:23:33 -0400497 fprop_local_destroy_percpu(&wb->memcg_completions);
Tejun Heo52ebea72015-05-22 17:13:37 -0400498 percpu_ref_exit(&wb->refcnt);
499 wb_exit(wb);
500 kfree_rcu(wb, rcu);
Tejun Heo52ebea72015-05-22 17:13:37 -0400501}
502
503static void cgwb_release(struct percpu_ref *refcnt)
504{
505 struct bdi_writeback *wb = container_of(refcnt, struct bdi_writeback,
506 refcnt);
Tejun Heof1834642018-05-23 10:56:32 -0700507 queue_work(cgwb_release_wq, &wb->release_work);
Tejun Heo52ebea72015-05-22 17:13:37 -0400508}
509
510static void cgwb_kill(struct bdi_writeback *wb)
511{
512 lockdep_assert_held(&cgwb_lock);
513
514 WARN_ON(!radix_tree_delete(&wb->bdi->cgwb_tree, wb->memcg_css->id));
515 list_del(&wb->memcg_node);
516 list_del(&wb->blkcg_node);
517 percpu_ref_kill(&wb->refcnt);
518}
519
Jan Karae8cb72b2017-03-23 01:36:56 +0100520static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
521{
522 spin_lock_irq(&cgwb_lock);
523 list_del_rcu(&wb->bdi_node);
524 spin_unlock_irq(&cgwb_lock);
525}
526
Tejun Heo52ebea72015-05-22 17:13:37 -0400527static int cgwb_create(struct backing_dev_info *bdi,
528 struct cgroup_subsys_state *memcg_css, gfp_t gfp)
529{
530 struct mem_cgroup *memcg;
531 struct cgroup_subsys_state *blkcg_css;
532 struct blkcg *blkcg;
533 struct list_head *memcg_cgwb_list, *blkcg_cgwb_list;
534 struct bdi_writeback *wb;
535 unsigned long flags;
536 int ret = 0;
537
538 memcg = mem_cgroup_from_css(memcg_css);
Tejun Heoc165b3e2015-08-18 14:55:29 -0700539 blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
Tejun Heo52ebea72015-05-22 17:13:37 -0400540 blkcg = css_to_blkcg(blkcg_css);
Wang Long9ccc3612018-06-07 17:07:19 -0700541 memcg_cgwb_list = &memcg->cgwb_list;
Tejun Heo52ebea72015-05-22 17:13:37 -0400542 blkcg_cgwb_list = &blkcg->cgwb_list;
543
544 /* look up again under lock and discard on blkcg mismatch */
545 spin_lock_irqsave(&cgwb_lock, flags);
546 wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
547 if (wb && wb->blkcg_css != blkcg_css) {
548 cgwb_kill(wb);
549 wb = NULL;
550 }
551 spin_unlock_irqrestore(&cgwb_lock, flags);
552 if (wb)
553 goto out_put;
554
555 /* need to create a new one */
556 wb = kmalloc(sizeof(*wb), gfp);
Christophe JAILLET0b045bd2017-09-11 21:43:23 +0200557 if (!wb) {
558 ret = -ENOMEM;
559 goto out_put;
560 }
Tejun Heo52ebea72015-05-22 17:13:37 -0400561
Tejun Heoa13f35e2015-07-02 08:44:34 -0600562 ret = wb_init(wb, bdi, blkcg_css->id, gfp);
Tejun Heo52ebea72015-05-22 17:13:37 -0400563 if (ret)
564 goto err_free;
565
566 ret = percpu_ref_init(&wb->refcnt, cgwb_release, 0, gfp);
567 if (ret)
568 goto err_wb_exit;
569
Tejun Heo841710a2015-05-22 18:23:33 -0400570 ret = fprop_local_init_percpu(&wb->memcg_completions, gfp);
571 if (ret)
572 goto err_ref_exit;
573
Tejun Heo52ebea72015-05-22 17:13:37 -0400574 wb->memcg_css = memcg_css;
575 wb->blkcg_css = blkcg_css;
576 INIT_WORK(&wb->release_work, cgwb_release_workfn);
577 set_bit(WB_registered, &wb->state);
578
579 /*
580 * The root wb determines the registered state of the whole bdi and
581 * memcg_cgwb_list and blkcg_cgwb_list's next pointers indicate
582 * whether they're still online. Don't link @wb if any is dead.
583 * See wb_memcg_offline() and wb_blkcg_offline().
584 */
585 ret = -ENODEV;
586 spin_lock_irqsave(&cgwb_lock, flags);
587 if (test_bit(WB_registered, &bdi->wb.state) &&
588 blkcg_cgwb_list->next && memcg_cgwb_list->next) {
589 /* we might have raced another instance of this function */
590 ret = radix_tree_insert(&bdi->cgwb_tree, memcg_css->id, wb);
591 if (!ret) {
Tejun Heob8175252015-10-02 14:47:05 -0400592 list_add_tail_rcu(&wb->bdi_node, &bdi->wb_list);
Tejun Heo52ebea72015-05-22 17:13:37 -0400593 list_add(&wb->memcg_node, memcg_cgwb_list);
594 list_add(&wb->blkcg_node, blkcg_cgwb_list);
Tejun Heod866dbf2019-07-24 10:37:22 -0700595 blkcg_pin_online(blkcg);
Tejun Heo52ebea72015-05-22 17:13:37 -0400596 css_get(memcg_css);
597 css_get(blkcg_css);
598 }
599 }
600 spin_unlock_irqrestore(&cgwb_lock, flags);
601 if (ret) {
602 if (ret == -EEXIST)
603 ret = 0;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600604 goto err_fprop_exit;
Tejun Heo52ebea72015-05-22 17:13:37 -0400605 }
606 goto out_put;
607
Tejun Heo841710a2015-05-22 18:23:33 -0400608err_fprop_exit:
609 fprop_local_destroy_percpu(&wb->memcg_completions);
Tejun Heo52ebea72015-05-22 17:13:37 -0400610err_ref_exit:
611 percpu_ref_exit(&wb->refcnt);
612err_wb_exit:
613 wb_exit(wb);
614err_free:
615 kfree(wb);
616out_put:
617 css_put(blkcg_css);
618 return ret;
619}
620
621/**
Tejun Heoed288dc2019-08-26 09:06:54 -0700622 * wb_get_lookup - get wb for a given memcg
Tejun Heo52ebea72015-05-22 17:13:37 -0400623 * @bdi: target bdi
624 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
Tejun Heo52ebea72015-05-22 17:13:37 -0400625 *
Tejun Heoed288dc2019-08-26 09:06:54 -0700626 * Try to get the wb for @memcg_css on @bdi. The returned wb has its
627 * refcount incremented.
Tejun Heo52ebea72015-05-22 17:13:37 -0400628 *
629 * This function uses css_get() on @memcg_css and thus expects its refcnt
630 * to be positive on invocation. IOW, rcu_read_lock() protection on
631 * @memcg_css isn't enough. try_get it before calling this function.
632 *
633 * A wb is keyed by its associated memcg. As blkcg implicitly enables
634 * memcg on the default hierarchy, memcg association is guaranteed to be
635 * more specific (equal or descendant to the associated blkcg) and thus can
636 * identify both the memcg and blkcg associations.
637 *
638 * Because the blkcg associated with a memcg may change as blkcg is enabled
639 * and disabled closer to root in the hierarchy, each wb keeps track of
640 * both the memcg and blkcg associated with it and verifies the blkcg on
641 * each lookup. On mismatch, the existing wb is discarded and a new one is
642 * created.
643 */
Tejun Heoed288dc2019-08-26 09:06:54 -0700644struct bdi_writeback *wb_get_lookup(struct backing_dev_info *bdi,
645 struct cgroup_subsys_state *memcg_css)
646{
647 struct bdi_writeback *wb;
648
649 if (!memcg_css->parent)
650 return &bdi->wb;
651
652 rcu_read_lock();
653 wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
654 if (wb) {
655 struct cgroup_subsys_state *blkcg_css;
656
657 /* see whether the blkcg association has changed */
658 blkcg_css = cgroup_get_e_css(memcg_css->cgroup, &io_cgrp_subsys);
659 if (unlikely(wb->blkcg_css != blkcg_css || !wb_tryget(wb)))
660 wb = NULL;
661 css_put(blkcg_css);
662 }
663 rcu_read_unlock();
664
665 return wb;
666}
667
668/**
669 * wb_get_create - get wb for a given memcg, create if necessary
670 * @bdi: target bdi
671 * @memcg_css: cgroup_subsys_state of the target memcg (must have positive ref)
672 * @gfp: allocation mask to use
673 *
674 * Try to get the wb for @memcg_css on @bdi. If it doesn't exist, try to
675 * create one. See wb_get_lookup() for more details.
676 */
Tejun Heo52ebea72015-05-22 17:13:37 -0400677struct bdi_writeback *wb_get_create(struct backing_dev_info *bdi,
678 struct cgroup_subsys_state *memcg_css,
679 gfp_t gfp)
680{
681 struct bdi_writeback *wb;
682
Mel Gormand0164ad2015-11-06 16:28:21 -0800683 might_sleep_if(gfpflags_allow_blocking(gfp));
Tejun Heo52ebea72015-05-22 17:13:37 -0400684
685 if (!memcg_css->parent)
686 return &bdi->wb;
687
688 do {
Tejun Heoed288dc2019-08-26 09:06:54 -0700689 wb = wb_get_lookup(bdi, memcg_css);
Tejun Heo52ebea72015-05-22 17:13:37 -0400690 } while (!wb && !cgwb_create(bdi, memcg_css, gfp));
691
692 return wb;
693}
694
Tejun Heoa13f35e2015-07-02 08:44:34 -0600695static int cgwb_bdi_init(struct backing_dev_info *bdi)
Tejun Heo52ebea72015-05-22 17:13:37 -0400696{
Tejun Heoa13f35e2015-07-02 08:44:34 -0600697 int ret;
698
Tejun Heo52ebea72015-05-22 17:13:37 -0400699 INIT_RADIX_TREE(&bdi->cgwb_tree, GFP_ATOMIC);
700 bdi->cgwb_congested_tree = RB_ROOT;
Jan Kara3ee7e862018-06-18 15:46:58 +0200701 mutex_init(&bdi->cgwb_release_mutex);
Tejun Heo7fc58542017-12-12 08:38:30 -0800702 init_rwsem(&bdi->wb_switch_rwsem);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600703
704 ret = wb_init(&bdi->wb, bdi, 1, GFP_KERNEL);
705 if (!ret) {
Johannes Weiner7d828602016-01-14 15:20:56 -0800706 bdi->wb.memcg_css = &root_mem_cgroup->css;
Tejun Heoa13f35e2015-07-02 08:44:34 -0600707 bdi->wb.blkcg_css = blkcg_root_css;
708 }
709 return ret;
Tejun Heo52ebea72015-05-22 17:13:37 -0400710}
711
Jan Karab1c51af2017-03-23 01:36:59 +0100712static void cgwb_bdi_unregister(struct backing_dev_info *bdi)
Tejun Heo52ebea72015-05-22 17:13:37 -0400713{
714 struct radix_tree_iter iter;
715 void **slot;
Jan Kara5318ce72017-03-23 01:36:57 +0100716 struct bdi_writeback *wb;
Tejun Heo52ebea72015-05-22 17:13:37 -0400717
718 WARN_ON(test_bit(WB_registered, &bdi->wb.state));
719
720 spin_lock_irq(&cgwb_lock);
721 radix_tree_for_each_slot(slot, &bdi->cgwb_tree, &iter, 0)
722 cgwb_kill(*slot);
Jan Kara3ee7e862018-06-18 15:46:58 +0200723 spin_unlock_irq(&cgwb_lock);
Jan Kara5318ce72017-03-23 01:36:57 +0100724
Jan Kara3ee7e862018-06-18 15:46:58 +0200725 mutex_lock(&bdi->cgwb_release_mutex);
726 spin_lock_irq(&cgwb_lock);
Jan Kara5318ce72017-03-23 01:36:57 +0100727 while (!list_empty(&bdi->wb_list)) {
728 wb = list_first_entry(&bdi->wb_list, struct bdi_writeback,
729 bdi_node);
730 spin_unlock_irq(&cgwb_lock);
731 wb_shutdown(wb);
732 spin_lock_irq(&cgwb_lock);
733 }
Tejun Heo52ebea72015-05-22 17:13:37 -0400734 spin_unlock_irq(&cgwb_lock);
Jan Kara3ee7e862018-06-18 15:46:58 +0200735 mutex_unlock(&bdi->cgwb_release_mutex);
Tejun Heo52ebea72015-05-22 17:13:37 -0400736}
737
738/**
739 * wb_memcg_offline - kill all wb's associated with a memcg being offlined
740 * @memcg: memcg being offlined
741 *
742 * Also prevents creation of any new wb's associated with @memcg.
743 */
744void wb_memcg_offline(struct mem_cgroup *memcg)
745{
Wang Long9ccc3612018-06-07 17:07:19 -0700746 struct list_head *memcg_cgwb_list = &memcg->cgwb_list;
Tejun Heo52ebea72015-05-22 17:13:37 -0400747 struct bdi_writeback *wb, *next;
748
749 spin_lock_irq(&cgwb_lock);
750 list_for_each_entry_safe(wb, next, memcg_cgwb_list, memcg_node)
751 cgwb_kill(wb);
752 memcg_cgwb_list->next = NULL; /* prevent new wb's */
753 spin_unlock_irq(&cgwb_lock);
754}
755
756/**
757 * wb_blkcg_offline - kill all wb's associated with a blkcg being offlined
758 * @blkcg: blkcg being offlined
759 *
760 * Also prevents creation of any new wb's associated with @blkcg.
761 */
762void wb_blkcg_offline(struct blkcg *blkcg)
763{
Tejun Heo52ebea72015-05-22 17:13:37 -0400764 struct bdi_writeback *wb, *next;
765
766 spin_lock_irq(&cgwb_lock);
767 list_for_each_entry_safe(wb, next, &blkcg->cgwb_list, blkcg_node)
768 cgwb_kill(wb);
769 blkcg->cgwb_list.next = NULL; /* prevent new wb's */
770 spin_unlock_irq(&cgwb_lock);
771}
772
Jan Karadf23de52017-03-08 17:48:32 +0100773static void cgwb_bdi_exit(struct backing_dev_info *bdi)
774{
775 struct rb_node *rbn;
776
777 spin_lock_irq(&cgwb_lock);
778 while ((rbn = rb_first(&bdi->cgwb_congested_tree))) {
779 struct bdi_writeback_congested *congested =
780 rb_entry(rbn, struct bdi_writeback_congested, rb_node);
781
782 rb_erase(rbn, &bdi->cgwb_congested_tree);
Jan Karab7d680d2017-03-23 01:36:54 +0100783 congested->__bdi = NULL; /* mark @congested unlinked */
Jan Karadf23de52017-03-08 17:48:32 +0100784 }
785 spin_unlock_irq(&cgwb_lock);
786}
787
Jan Karae8cb72b2017-03-23 01:36:56 +0100788static void cgwb_bdi_register(struct backing_dev_info *bdi)
789{
790 spin_lock_irq(&cgwb_lock);
791 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
792 spin_unlock_irq(&cgwb_lock);
793}
794
Tejun Heof1834642018-05-23 10:56:32 -0700795static int __init cgwb_init(void)
796{
797 /*
798 * There can be many concurrent release work items overwhelming
799 * system_wq. Put them in a separate wq and limit concurrency.
800 * There's no point in executing many of these in parallel.
801 */
802 cgwb_release_wq = alloc_workqueue("cgwb_release", 0, 1);
803 if (!cgwb_release_wq)
804 return -ENOMEM;
805
806 return 0;
807}
808subsys_initcall(cgwb_init);
809
Tejun Heo52ebea72015-05-22 17:13:37 -0400810#else /* CONFIG_CGROUP_WRITEBACK */
811
Tejun Heoa13f35e2015-07-02 08:44:34 -0600812static int cgwb_bdi_init(struct backing_dev_info *bdi)
813{
814 int err;
815
816 bdi->wb_congested = kzalloc(sizeof(*bdi->wb_congested), GFP_KERNEL);
817 if (!bdi->wb_congested)
818 return -ENOMEM;
819
Sebastian Andrzej Siewiore58dd0d2018-08-21 21:55:31 -0700820 refcount_set(&bdi->wb_congested->refcnt, 1);
Tejun Heo5f478e42017-02-08 15:19:07 -0500821
Tejun Heoa13f35e2015-07-02 08:44:34 -0600822 err = wb_init(&bdi->wb, bdi, 1, GFP_KERNEL);
823 if (err) {
Tejun Heo5f478e42017-02-08 15:19:07 -0500824 wb_congested_put(bdi->wb_congested);
Tejun Heoa13f35e2015-07-02 08:44:34 -0600825 return err;
826 }
827 return 0;
828}
829
Jan Karab1c51af2017-03-23 01:36:59 +0100830static void cgwb_bdi_unregister(struct backing_dev_info *bdi) { }
Jan Karadf23de52017-03-08 17:48:32 +0100831
832static void cgwb_bdi_exit(struct backing_dev_info *bdi)
Tejun Heo5f478e42017-02-08 15:19:07 -0500833{
834 wb_congested_put(bdi->wb_congested);
835}
Tejun Heo52ebea72015-05-22 17:13:37 -0400836
Jan Karae8cb72b2017-03-23 01:36:56 +0100837static void cgwb_bdi_register(struct backing_dev_info *bdi)
838{
839 list_add_tail_rcu(&bdi->wb.bdi_node, &bdi->wb_list);
840}
841
842static void cgwb_remove_from_bdi_list(struct bdi_writeback *wb)
843{
844 list_del_rcu(&wb->bdi_node);
845}
846
Tejun Heo52ebea72015-05-22 17:13:37 -0400847#endif /* CONFIG_CGROUP_WRITEBACK */
848
Jan Kara2e82b842017-04-12 12:24:48 +0200849static int bdi_init(struct backing_dev_info *bdi)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700850{
Tejun Heob8175252015-10-02 14:47:05 -0400851 int ret;
852
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700853 bdi->dev = NULL;
854
Jan Karad03f6cd2017-02-02 15:56:51 +0100855 kref_init(&bdi->refcnt);
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700856 bdi->min_ratio = 0;
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700857 bdi->max_ratio = 100;
Jan Karaeb608e32012-05-24 18:59:11 +0200858 bdi->max_prop_frac = FPROP_FRAC_BASE;
Jens Axboe66f3b8e2009-09-02 09:19:46 +0200859 INIT_LIST_HEAD(&bdi->bdi_list);
Tejun Heob8175252015-10-02 14:47:05 -0400860 INIT_LIST_HEAD(&bdi->wb_list);
Tejun Heocc395d72015-05-22 17:13:58 -0400861 init_waitqueue_head(&bdi->wb_waitq);
Jens Axboe03ba3782009-09-09 09:08:54 +0200862
Tejun Heob8175252015-10-02 14:47:05 -0400863 ret = cgwb_bdi_init(bdi);
864
Tejun Heob8175252015-10-02 14:47:05 -0400865 return ret;
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700866}
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700867
Jan Karad03f6cd2017-02-02 15:56:51 +0100868struct backing_dev_info *bdi_alloc_node(gfp_t gfp_mask, int node_id)
869{
870 struct backing_dev_info *bdi;
871
872 bdi = kmalloc_node(sizeof(struct backing_dev_info),
873 gfp_mask | __GFP_ZERO, node_id);
874 if (!bdi)
875 return NULL;
876
877 if (bdi_init(bdi)) {
878 kfree(bdi);
879 return NULL;
880 }
881 return bdi;
882}
Jan Kara62bf42a2017-04-12 12:24:27 +0200883EXPORT_SYMBOL(bdi_alloc_node);
Jan Karad03f6cd2017-02-02 15:56:51 +0100884
Tejun Heo34f8fe52019-08-26 09:06:53 -0700885static struct rb_node **bdi_lookup_rb_node(u64 id, struct rb_node **parentp)
886{
887 struct rb_node **p = &bdi_tree.rb_node;
888 struct rb_node *parent = NULL;
889 struct backing_dev_info *bdi;
890
891 lockdep_assert_held(&bdi_lock);
892
893 while (*p) {
894 parent = *p;
895 bdi = rb_entry(parent, struct backing_dev_info, rb_node);
896
897 if (bdi->id > id)
898 p = &(*p)->rb_left;
899 else if (bdi->id < id)
900 p = &(*p)->rb_right;
901 else
902 break;
903 }
904
905 if (parentp)
906 *parentp = parent;
907 return p;
908}
909
910/**
911 * bdi_get_by_id - lookup and get bdi from its id
912 * @id: bdi id to lookup
913 *
914 * Find bdi matching @id and get it. Returns NULL if the matching bdi
915 * doesn't exist or is already unregistered.
916 */
917struct backing_dev_info *bdi_get_by_id(u64 id)
918{
919 struct backing_dev_info *bdi = NULL;
920 struct rb_node **p;
921
922 spin_lock_bh(&bdi_lock);
923 p = bdi_lookup_rb_node(id, NULL);
924 if (*p) {
925 bdi = rb_entry(*p, struct backing_dev_info, rb_node);
926 bdi_get(bdi);
927 }
928 spin_unlock_bh(&bdi_lock);
929
930 return bdi;
931}
932
Jan Kara7c4cc302017-04-12 12:24:49 +0200933int bdi_register_va(struct backing_dev_info *bdi, const char *fmt, va_list args)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700934{
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700935 struct device *dev;
Tejun Heo34f8fe52019-08-26 09:06:53 -0700936 struct rb_node *parent, **p;
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700937
938 if (bdi->dev) /* The driver needs to use separate queues per device */
939 return 0;
940
Christoph Hellwig6bd87ee2020-05-04 14:47:56 +0200941 vsnprintf(bdi->dev_name, sizeof(bdi->dev_name), fmt, args);
942 dev = device_create(bdi_class, NULL, MKDEV(0, 0), bdi, bdi->dev_name);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700943 if (IS_ERR(dev))
944 return PTR_ERR(dev);
945
Jan Karae8cb72b2017-03-23 01:36:56 +0100946 cgwb_bdi_register(bdi);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700947 bdi->dev = dev;
948
Jens Axboe6d0e4822017-12-21 10:01:30 -0700949 bdi_debug_register(bdi, dev_name(dev));
Tejun Heo46100072015-05-22 17:13:31 -0400950 set_bit(WB_registered, &bdi->wb.state);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700951
952 spin_lock_bh(&bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700953
954 bdi->id = ++bdi_id_cursor;
955
956 p = bdi_lookup_rb_node(bdi->id, &parent);
957 rb_link_node(&bdi->rb_node, parent, p);
958 rb_insert_color(&bdi->rb_node, &bdi_tree);
959
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700960 list_add_tail_rcu(&bdi->bdi_list, &bdi_list);
Tejun Heo34f8fe52019-08-26 09:06:53 -0700961
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700962 spin_unlock_bh(&bdi_lock);
963
964 trace_writeback_bdi_register(bdi);
965 return 0;
966}
Jan Karabaf7a612017-04-12 12:24:25 +0200967EXPORT_SYMBOL(bdi_register_va);
968
Jan Kara7c4cc302017-04-12 12:24:49 +0200969int bdi_register(struct backing_dev_info *bdi, const char *fmt, ...)
Jan Karabaf7a612017-04-12 12:24:25 +0200970{
971 va_list args;
972 int ret;
973
974 va_start(args, fmt);
Jan Kara7c4cc302017-04-12 12:24:49 +0200975 ret = bdi_register_va(bdi, fmt, args);
Jan Karabaf7a612017-04-12 12:24:25 +0200976 va_end(args);
977 return ret;
978}
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700979EXPORT_SYMBOL(bdi_register);
980
Dan Williamsdf08c322016-07-31 11:15:13 -0700981int bdi_register_owner(struct backing_dev_info *bdi, struct device *owner)
982{
983 int rc;
984
Jan Kara7c4cc302017-04-12 12:24:49 +0200985 rc = bdi_register(bdi, "%u:%u", MAJOR(owner->devt), MINOR(owner->devt));
Dan Williamsdf08c322016-07-31 11:15:13 -0700986 if (rc)
987 return rc;
Jan Karab6f8fec2017-03-08 17:48:31 +0100988 /* Leaking owner reference... */
989 WARN_ON(bdi->owner);
Dan Williamsdf08c322016-07-31 11:15:13 -0700990 bdi->owner = owner;
991 get_device(owner);
992 return 0;
993}
994EXPORT_SYMBOL(bdi_register_owner);
995
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700996/*
Tejun Heo46100072015-05-22 17:13:31 -0400997 * Remove bdi from bdi_list, and ensure that it is no longer visible
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700998 */
Tejun Heo46100072015-05-22 17:13:31 -0400999static void bdi_remove_from_list(struct backing_dev_info *bdi)
Peter Zijlstra04fbfdc2007-10-16 23:25:50 -07001000{
Tejun Heo46100072015-05-22 17:13:31 -04001001 spin_lock_bh(&bdi_lock);
Tejun Heo34f8fe52019-08-26 09:06:53 -07001002 rb_erase(&bdi->rb_node, &bdi_tree);
Tejun Heo46100072015-05-22 17:13:31 -04001003 list_del_rcu(&bdi->bdi_list);
1004 spin_unlock_bh(&bdi_lock);
Andrew Morton3fcfab12006-10-19 23:28:16 -07001005
Tejun Heo46100072015-05-22 17:13:31 -04001006 synchronize_rcu_expedited();
Andrew Morton3fcfab12006-10-19 23:28:16 -07001007}
1008
Tejun Heob02176f2015-09-08 12:20:22 -04001009void bdi_unregister(struct backing_dev_info *bdi)
Andrew Morton3fcfab12006-10-19 23:28:16 -07001010{
Tejun Heof0054bb2015-05-22 17:13:30 -04001011 /* make sure nobody finds us on the bdi_list anymore */
1012 bdi_remove_from_list(bdi);
1013 wb_shutdown(&bdi->wb);
Jan Karab1c51af2017-03-23 01:36:59 +01001014 cgwb_bdi_unregister(bdi);
Rabin Vincent7a401a92011-11-11 13:29:04 +01001015
Christoph Hellwigc4db59d2015-01-20 14:05:00 -07001016 if (bdi->dev) {
1017 bdi_debug_unregister(bdi);
1018 device_unregister(bdi->dev);
1019 bdi->dev = NULL;
1020 }
Dan Williamsdf08c322016-07-31 11:15:13 -07001021
1022 if (bdi->owner) {
1023 put_device(bdi->owner);
1024 bdi->owner = NULL;
1025 }
Tejun Heob02176f2015-09-08 12:20:22 -04001026}
Christoph Hellwigc4db59d2015-01-20 14:05:00 -07001027
Jan Karad03f6cd2017-02-02 15:56:51 +01001028static void release_bdi(struct kref *ref)
1029{
1030 struct backing_dev_info *bdi =
1031 container_of(ref, struct backing_dev_info, refcnt);
1032
Jan Kara5af110b2017-04-12 12:24:26 +02001033 if (test_bit(WB_registered, &bdi->wb.state))
1034 bdi_unregister(bdi);
Jan Kara2e82b842017-04-12 12:24:48 +02001035 WARN_ON_ONCE(bdi->dev);
1036 wb_exit(&bdi->wb);
1037 cgwb_bdi_exit(bdi);
Jan Karad03f6cd2017-02-02 15:56:51 +01001038 kfree(bdi);
1039}
1040
1041void bdi_put(struct backing_dev_info *bdi)
1042{
1043 kref_put(&bdi->refcnt, release_bdi);
1044}
Jan Kara62bf42a2017-04-12 12:24:27 +02001045EXPORT_SYMBOL(bdi_put);
Jan Karad03f6cd2017-02-02 15:56:51 +01001046
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +02001047const char *bdi_dev_name(struct backing_dev_info *bdi)
1048{
1049 if (!bdi || !bdi->dev)
1050 return bdi_unknown_name;
Christoph Hellwig6bd87ee2020-05-04 14:47:56 +02001051 return bdi->dev_name;
Christoph Hellwigeb7ae5e2020-05-04 14:47:54 +02001052}
1053EXPORT_SYMBOL_GPL(bdi_dev_name);
1054
Andrew Morton3fcfab12006-10-19 23:28:16 -07001055static wait_queue_head_t congestion_wqh[2] = {
1056 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[0]),
1057 __WAIT_QUEUE_HEAD_INITIALIZER(congestion_wqh[1])
1058 };
Tejun Heoec8a6f22015-05-22 17:13:41 -04001059static atomic_t nr_wb_congested[2];
Andrew Morton3fcfab12006-10-19 23:28:16 -07001060
Tejun Heoec8a6f22015-05-22 17:13:41 -04001061void clear_wb_congested(struct bdi_writeback_congested *congested, int sync)
Andrew Morton3fcfab12006-10-19 23:28:16 -07001062{
Jens Axboe1faa16d2009-04-06 14:48:01 +02001063 wait_queue_head_t *wqh = &congestion_wqh[sync];
Kaixu Xiac877ef82016-03-31 13:19:41 +00001064 enum wb_congested_state bit;
Andrew Morton3fcfab12006-10-19 23:28:16 -07001065
Tejun Heo44522262015-05-22 17:13:26 -04001066 bit = sync ? WB_sync_congested : WB_async_congested;
Tejun Heoec8a6f22015-05-22 17:13:41 -04001067 if (test_and_clear_bit(bit, &congested->state))
1068 atomic_dec(&nr_wb_congested[sync]);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001069 smp_mb__after_atomic();
Andrew Morton3fcfab12006-10-19 23:28:16 -07001070 if (waitqueue_active(wqh))
1071 wake_up(wqh);
1072}
Tejun Heoec8a6f22015-05-22 17:13:41 -04001073EXPORT_SYMBOL(clear_wb_congested);
Andrew Morton3fcfab12006-10-19 23:28:16 -07001074
Tejun Heoec8a6f22015-05-22 17:13:41 -04001075void set_wb_congested(struct bdi_writeback_congested *congested, int sync)
Andrew Morton3fcfab12006-10-19 23:28:16 -07001076{
Kaixu Xiac877ef82016-03-31 13:19:41 +00001077 enum wb_congested_state bit;
Andrew Morton3fcfab12006-10-19 23:28:16 -07001078
Tejun Heo44522262015-05-22 17:13:26 -04001079 bit = sync ? WB_sync_congested : WB_async_congested;
Tejun Heoec8a6f22015-05-22 17:13:41 -04001080 if (!test_and_set_bit(bit, &congested->state))
1081 atomic_inc(&nr_wb_congested[sync]);
Andrew Morton3fcfab12006-10-19 23:28:16 -07001082}
Tejun Heoec8a6f22015-05-22 17:13:41 -04001083EXPORT_SYMBOL(set_wb_congested);
Andrew Morton3fcfab12006-10-19 23:28:16 -07001084
1085/**
1086 * congestion_wait - wait for a backing_dev to become uncongested
Jens Axboe8aa7e842009-07-09 14:52:32 +02001087 * @sync: SYNC or ASYNC IO
Andrew Morton3fcfab12006-10-19 23:28:16 -07001088 * @timeout: timeout in jiffies
1089 *
1090 * Waits for up to @timeout jiffies for a backing_dev (any backing_dev) to exit
1091 * write congestion. If no backing_devs are congested then just wait for the
1092 * next write to be completed.
1093 */
Jens Axboe8aa7e842009-07-09 14:52:32 +02001094long congestion_wait(int sync, long timeout)
Andrew Morton3fcfab12006-10-19 23:28:16 -07001095{
1096 long ret;
Mel Gorman52bb9192010-10-26 14:21:41 -07001097 unsigned long start = jiffies;
Andrew Morton3fcfab12006-10-19 23:28:16 -07001098 DEFINE_WAIT(wait);
Jens Axboe8aa7e842009-07-09 14:52:32 +02001099 wait_queue_head_t *wqh = &congestion_wqh[sync];
Andrew Morton3fcfab12006-10-19 23:28:16 -07001100
1101 prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
1102 ret = io_schedule_timeout(timeout);
1103 finish_wait(wqh, &wait);
Mel Gorman52bb9192010-10-26 14:21:41 -07001104
1105 trace_writeback_congestion_wait(jiffies_to_usecs(timeout),
1106 jiffies_to_usecs(jiffies - start));
1107
Andrew Morton3fcfab12006-10-19 23:28:16 -07001108 return ret;
1109}
1110EXPORT_SYMBOL(congestion_wait);
1111
Mel Gorman0e093d992010-10-26 14:21:45 -07001112/**
Mel Gorman599d0c92016-07-28 15:45:31 -07001113 * 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 -07001114 * @sync: SYNC or ASYNC IO
1115 * @timeout: timeout in jiffies
1116 *
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -07001117 * In the event of a congested backing_dev (any backing_dev) this waits
1118 * for up to @timeout jiffies for either a BDI to exit congestion of the
1119 * given @sync queue or a write to complete.
Mel Gorman0e093d992010-10-26 14:21:45 -07001120 *
1121 * The return value is 0 if the sleep is for the full timeout. Otherwise,
1122 * it is the number of jiffies that were still remaining when the function
1123 * returned. return_value == timeout implies the function did not sleep.
1124 */
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -07001125long wait_iff_congested(int sync, long timeout)
Mel Gorman0e093d992010-10-26 14:21:45 -07001126{
1127 long ret;
1128 unsigned long start = jiffies;
1129 DEFINE_WAIT(wait);
1130 wait_queue_head_t *wqh = &congestion_wqh[sync];
1131
1132 /*
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -07001133 * If there is no congestion, yield if necessary instead
Mel Gorman0e093d992010-10-26 14:21:45 -07001134 * of sleeping on the congestion queue
1135 */
Andrey Ryabinine3c1ac52018-04-10 16:28:03 -07001136 if (atomic_read(&nr_wb_congested[sync]) == 0) {
Michal Hockoede37712016-05-20 16:57:03 -07001137 cond_resched();
Mel Gorman599d0c92016-07-28 15:45:31 -07001138
Mel Gorman0e093d992010-10-26 14:21:45 -07001139 /* In case we scheduled, work out time remaining */
1140 ret = timeout - (jiffies - start);
1141 if (ret < 0)
1142 ret = 0;
1143
1144 goto out;
1145 }
1146
1147 /* Sleep until uncongested or a write happens */
1148 prepare_to_wait(wqh, &wait, TASK_UNINTERRUPTIBLE);
1149 ret = io_schedule_timeout(timeout);
1150 finish_wait(wqh, &wait);
1151
1152out:
1153 trace_writeback_wait_iff_congested(jiffies_to_usecs(timeout),
1154 jiffies_to_usecs(jiffies - start));
1155
1156 return ret;
1157}
1158EXPORT_SYMBOL(wait_iff_congested);