blob: a69f81fff754aa06ca645f042235b5f5b0188eaf [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * include/linux/backing-dev.h
3 *
4 * low-level device information and state which is propagated up through
5 * to high-level code.
6 */
7
8#ifndef _LINUX_BACKING_DEV_H
9#define _LINUX_BACKING_DEV_H
10
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070011#include <linux/kernel.h>
Miklos Szeredie4ad08fe2008-04-30 00:54:37 -070012#include <linux/fs.h>
Jens Axboe03ba3782009-09-09 09:08:54 +020013#include <linux/sched.h>
14#include <linux/writeback.h>
Tejun Heo9d6e9852015-05-22 17:13:32 -040015#include <linux/backing-dev-defs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
Christoph Hellwigde1414a2015-01-14 10:42:36 +010017struct backing_dev_info *inode_to_bdi(struct inode *inode);
18
Mikulas Patocka8077c0d2013-10-14 12:14:13 -040019int __must_check bdi_init(struct backing_dev_info *bdi);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -070020void bdi_destroy(struct backing_dev_info *bdi);
21
Joe Perchesd2cc4dd2012-11-29 08:37:03 -060022__printf(3, 4)
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070023int bdi_register(struct backing_dev_info *bdi, struct device *parent,
24 const char *fmt, ...);
25int bdi_register_dev(struct backing_dev_info *bdi, dev_t dev);
Christoph Hellwigb4caecd2015-01-14 10:42:32 +010026int __must_check bdi_setup_and_register(struct backing_dev_info *, char *);
Curt Wohlgemuth0e175a12011-10-07 21:54:10 -060027void bdi_start_writeback(struct backing_dev_info *bdi, long nr_pages,
28 enum wb_reason reason);
Christoph Hellwigc5444192010-06-08 18:15:15 +020029void bdi_start_background_writeback(struct backing_dev_info *bdi);
Tejun Heoc9b0f222015-05-22 17:13:30 -040030void wb_workfn(struct work_struct *work);
Jens Axboe03ba3782009-09-09 09:08:54 +020031int bdi_has_dirty_io(struct backing_dev_info *bdi);
Tejun Heoc9b0f222015-05-22 17:13:30 -040032void wb_wakeup_delayed(struct bdi_writeback *wb);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -070033
Jens Axboe03ba3782009-09-09 09:08:54 +020034extern spinlock_t bdi_lock;
Jens Axboe66f3b8e2009-09-02 09:19:46 +020035extern struct list_head bdi_list;
36
Tejun Heo839a8e82013-04-01 19:08:06 -070037extern struct workqueue_struct *bdi_wq;
38
Jens Axboe03ba3782009-09-09 09:08:54 +020039static inline int wb_has_dirty_io(struct bdi_writeback *wb)
40{
41 return !list_empty(&wb->b_dirty) ||
42 !list_empty(&wb->b_io) ||
43 !list_empty(&wb->b_more_io);
44}
45
Tejun Heo9ce34202015-05-22 17:13:27 -040046static inline void __add_wb_stat(struct bdi_writeback *wb,
47 enum wb_stat_item item, s64 amount)
Peter Zijlstrae0bf68d2007-10-16 23:25:46 -070048{
Tejun Heo9ce34202015-05-22 17:13:27 -040049 __percpu_counter_add(&wb->stat[item], amount, WB_STAT_BATCH);
Peter Zijlstrae0bf68d2007-10-16 23:25:46 -070050}
51
Tejun Heo9ce34202015-05-22 17:13:27 -040052static inline void __inc_wb_stat(struct bdi_writeback *wb,
53 enum wb_stat_item item)
Peter Zijlstrae0bf68d2007-10-16 23:25:46 -070054{
Tejun Heo9ce34202015-05-22 17:13:27 -040055 __add_wb_stat(wb, item, 1);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -070056}
57
Tejun Heo9ce34202015-05-22 17:13:27 -040058static inline void inc_wb_stat(struct bdi_writeback *wb, enum wb_stat_item item)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -070059{
60 unsigned long flags;
61
62 local_irq_save(flags);
Tejun Heo9ce34202015-05-22 17:13:27 -040063 __inc_wb_stat(wb, item);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -070064 local_irq_restore(flags);
65}
66
Tejun Heo9ce34202015-05-22 17:13:27 -040067static inline void __dec_wb_stat(struct bdi_writeback *wb,
68 enum wb_stat_item item)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -070069{
Tejun Heo9ce34202015-05-22 17:13:27 -040070 __add_wb_stat(wb, item, -1);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -070071}
72
Tejun Heo9ce34202015-05-22 17:13:27 -040073static inline void dec_wb_stat(struct bdi_writeback *wb, enum wb_stat_item item)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -070074{
75 unsigned long flags;
76
77 local_irq_save(flags);
Tejun Heo9ce34202015-05-22 17:13:27 -040078 __dec_wb_stat(wb, item);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -070079 local_irq_restore(flags);
80}
81
Tejun Heo9ce34202015-05-22 17:13:27 -040082static inline s64 wb_stat(struct bdi_writeback *wb, enum wb_stat_item item)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -070083{
Tejun Heo9ce34202015-05-22 17:13:27 -040084 return percpu_counter_read_positive(&wb->stat[item]);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -070085}
86
Tejun Heo9ce34202015-05-22 17:13:27 -040087static inline s64 __wb_stat_sum(struct bdi_writeback *wb,
88 enum wb_stat_item item)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -070089{
Tejun Heo9ce34202015-05-22 17:13:27 -040090 return percpu_counter_sum_positive(&wb->stat[item]);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -070091}
92
Tejun Heo9ce34202015-05-22 17:13:27 -040093static inline s64 wb_stat_sum(struct bdi_writeback *wb, enum wb_stat_item item)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -070094{
95 s64 sum;
96 unsigned long flags;
97
98 local_irq_save(flags);
Tejun Heo9ce34202015-05-22 17:13:27 -040099 sum = __wb_stat_sum(wb, item);
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700100 local_irq_restore(flags);
101
102 return sum;
103}
104
Tejun Heo9ce34202015-05-22 17:13:27 -0400105extern void wb_writeout_inc(struct bdi_writeback *wb);
Miklos Szeredidd5656e2008-04-30 00:54:37 -0700106
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700107/*
108 * maximal error of a stat counter.
109 */
Tejun Heo9ce34202015-05-22 17:13:27 -0400110static inline unsigned long wb_stat_error(struct bdi_writeback *wb)
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700111{
112#ifdef CONFIG_SMP
Tejun Heo9ce34202015-05-22 17:13:27 -0400113 return nr_cpu_ids * WB_STAT_BATCH;
Peter Zijlstrab2e8fb62007-10-16 23:25:47 -0700114#else
115 return 1;
116#endif
Peter Zijlstrae0bf68d2007-10-16 23:25:46 -0700117}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700119int bdi_set_min_ratio(struct backing_dev_info *bdi, unsigned int min_ratio);
Peter Zijlstraa42dde02008-04-30 00:54:36 -0700120int bdi_set_max_ratio(struct backing_dev_info *bdi, unsigned int max_ratio);
Peter Zijlstra189d3c42008-04-30 00:54:35 -0700121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122/*
123 * Flags in backing_dev_info::capability
Miklos Szeredie4ad08fe2008-04-30 00:54:37 -0700124 *
125 * The first three flags control whether dirty pages will contribute to the
126 * VM's accounting and whether writepages() should be called for dirty pages
127 * (something that would not, for example, be appropriate for ramfs)
128 *
129 * WARNING: these flags are closely related and should not normally be
130 * used separately. The BDI_CAP_NO_ACCT_AND_WRITEBACK combines these
131 * three flags into a single convenience macro.
132 *
133 * BDI_CAP_NO_ACCT_DIRTY: Dirty pages shouldn't contribute to accounting
134 * BDI_CAP_NO_WRITEBACK: Don't write pages back
135 * BDI_CAP_NO_ACCT_WB: Don't automatically account writeback pages
Maxim Patlasov5a537482013-09-11 14:22:46 -0700136 * BDI_CAP_STRICTLIMIT: Keep number of dirty pages below bdi threshold.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 */
Miklos Szeredie4ad08fe2008-04-30 00:54:37 -0700138#define BDI_CAP_NO_ACCT_DIRTY 0x00000001
139#define BDI_CAP_NO_WRITEBACK 0x00000002
Christoph Hellwigb4caecd2015-01-14 10:42:32 +0100140#define BDI_CAP_NO_ACCT_WB 0x00000004
141#define BDI_CAP_STABLE_WRITES 0x00000008
142#define BDI_CAP_STRICTLIMIT 0x00000010
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
Miklos Szeredie4ad08fe2008-04-30 00:54:37 -0700144#define BDI_CAP_NO_ACCT_AND_WRITEBACK \
145 (BDI_CAP_NO_WRITEBACK | BDI_CAP_NO_ACCT_DIRTY | BDI_CAP_NO_ACCT_WB)
146
Jörn Engel5129a462010-04-25 08:54:42 +0200147extern struct backing_dev_info noop_backing_dev_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149int writeback_in_progress(struct backing_dev_info *bdi);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
151static inline int bdi_congested(struct backing_dev_info *bdi, int bdi_bits)
152{
153 if (bdi->congested_fn)
154 return bdi->congested_fn(bdi->congested_data, bdi_bits);
Tejun Heoff3b6c52015-05-22 17:13:26 -0400155 return (bdi->wb.state & bdi_bits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156}
157
158static inline int bdi_read_congested(struct backing_dev_info *bdi)
159{
Tejun Heoff3b6c52015-05-22 17:13:26 -0400160 return bdi_congested(bdi, 1 << WB_sync_congested);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161}
162
163static inline int bdi_write_congested(struct backing_dev_info *bdi)
164{
Tejun Heoff3b6c52015-05-22 17:13:26 -0400165 return bdi_congested(bdi, 1 << WB_async_congested);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166}
167
168static inline int bdi_rw_congested(struct backing_dev_info *bdi)
169{
Tejun Heoff3b6c52015-05-22 17:13:26 -0400170 return bdi_congested(bdi, (1 << WB_sync_congested) |
171 (1 << WB_async_congested));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172}
173
Jens Axboe8aa7e842009-07-09 14:52:32 +0200174long congestion_wait(int sync, long timeout);
Mel Gorman0e093d992010-10-26 14:21:45 -0700175long wait_iff_congested(struct zone *zone, int sync, long timeout);
Wanpeng Li3965c9a2012-07-31 16:41:52 -0700176int pdflush_proc_obsolete(struct ctl_table *table, int write,
177 void __user *buffer, size_t *lenp, loff_t *ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
Darrick J. Wong7d311cd2013-02-21 16:42:48 -0800179static inline bool bdi_cap_stable_pages_required(struct backing_dev_info *bdi)
180{
181 return bdi->capabilities & BDI_CAP_STABLE_WRITES;
182}
183
Miklos Szeredie4ad08fe2008-04-30 00:54:37 -0700184static inline bool bdi_cap_writeback_dirty(struct backing_dev_info *bdi)
185{
186 return !(bdi->capabilities & BDI_CAP_NO_WRITEBACK);
187}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Miklos Szeredie4ad08fe2008-04-30 00:54:37 -0700189static inline bool bdi_cap_account_dirty(struct backing_dev_info *bdi)
190{
191 return !(bdi->capabilities & BDI_CAP_NO_ACCT_DIRTY);
192}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Miklos Szeredie4ad08fe2008-04-30 00:54:37 -0700194static inline bool bdi_cap_account_writeback(struct backing_dev_info *bdi)
195{
196 /* Paranoia: BDI_CAP_NO_WRITEBACK implies BDI_CAP_NO_ACCT_WB */
197 return !(bdi->capabilities & (BDI_CAP_NO_ACCT_WB |
198 BDI_CAP_NO_WRITEBACK));
199}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Miklos Szeredie4ad08fe2008-04-30 00:54:37 -0700201static inline bool mapping_cap_writeback_dirty(struct address_space *mapping)
202{
Christoph Hellwigde1414a2015-01-14 10:42:36 +0100203 return bdi_cap_writeback_dirty(inode_to_bdi(mapping->host));
Miklos Szeredie4ad08fe2008-04-30 00:54:37 -0700204}
205
206static inline bool mapping_cap_account_dirty(struct address_space *mapping)
207{
Christoph Hellwigde1414a2015-01-14 10:42:36 +0100208 return bdi_cap_account_dirty(inode_to_bdi(mapping->host));
Miklos Szeredie4ad08fe2008-04-30 00:54:37 -0700209}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
Jens Axboe03ba3782009-09-09 09:08:54 +0200211static inline int bdi_sched_wait(void *word)
212{
213 schedule();
214 return 0;
215}
216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217#endif /* _LINUX_BACKING_DEV_H */