include/linux/backing-dev.h

   1 /*
   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
  11 #include <linux/percpu_counter.h>
  12 #include <linux/log2.h>
  13 #include <linux/proportions.h>
  14 #include <linux/kernel.h>
  15 #include <linux/fs.h>
  16 #include <linux/sched.h>
  17 #include <linux/writeback.h>
  18 #include <asm/atomic.h>
  19
  20 struct page;
  21 struct device;
  22 struct dentry;
  23
  24 /*
  25  * Bits in backing_dev_info.state
  26  */
  27 enum bdi_state {
  28         BDI_pending,            /* On its way to being activated */
  29         BDI_wb_alloc,           /* Default embedded wb allocated */
  30         BDI_async_congested,    /* The async (write) queue is getting full */
  31         BDI_sync_congested,     /* The sync queue is getting full */
  32         BDI_registered,         /* bdi_register() was done */
  33         BDI_unused,             /* Available bits start here */
  34 };
  35
  36 typedef int (congested_fn)(void *, int);
  37
  38 enum bdi_stat_item {
  39         BDI_RECLAIMABLE,
  40         BDI_WRITEBACK,
  41         NR_BDI_STAT_ITEMS
  42 };
  43
  44 #define BDI_STAT_BATCH (8*(1+ilog2(nr_cpu_ids)))
  45
  46 struct bdi_writeback {
  47         struct list_head list;                  /* hangs off the bdi */
  48
  49         struct backing_dev_info *bdi;           /* our parent bdi */
  50         unsigned int nr;
  51
  52         unsigned long last_old_flush;           /* last old data flush */
  53
  54         struct task_struct      *task;          /* writeback task */
  55
  56         struct rb_root          flush_tree;
  57 };
  58
  59 struct backing_dev_info {
  60         struct list_head bdi_list;
  61         struct rcu_head rcu_head;
  62         unsigned long ra_pages; /* max readahead in PAGE_CACHE_SIZE units */
  63         unsigned long state;    /* Always use atomic bitops on this */
  64         unsigned int capabilities; /* Device capabilities */
  65         congested_fn *congested_fn; /* Function pointer if device is md/dm */
  66         void *congested_data;   /* Pointer to aux data for congested func */
  67         void (*unplug_io_fn)(struct backing_dev_info *, struct page *);
  68         void *unplug_io_data;
  69
  70         char *name;
  71
  72         struct percpu_counter bdi_stat[NR_BDI_STAT_ITEMS];
  73
  74         struct prop_local_percpu completions;
  75         int dirty_exceeded;
  76
  77         unsigned int min_ratio;
  78         unsigned int max_ratio, max_prop_frac;
  79
  80         struct bdi_writeback wb;  /* default writeback info for this bdi */
  81         spinlock_t wb_lock;       /* protects update side of wb_list */
  82         struct list_head wb_list; /* the flusher threads hanging off this bdi */
  83         unsigned long wb_mask;    /* bitmask of registered tasks */
  84         unsigned int wb_cnt;      /* number of registered tasks */
  85
  86         struct list_head work_list;
  87
  88         struct device *dev;
  89
  90 #ifdef CONFIG_DEBUG_FS
  91         struct dentry *debug_dir;
  92         struct dentry *debug_stats;
  93 #endif
  94 };
  95
  96 int bdi_init(struct backing_dev_info *bdi);
  97 void bdi_destroy(struct backing_dev_info *bdi);
  98
  99 int bdi_register(struct backing_dev_info *bdi, struct device *parent,
 100                 const char *fmt, ...);
 101 int bdi_register_dev(struct backing_dev_info *bdi, dev_t dev);
 102 void bdi_unregister(struct backing_dev_info *bdi);
 103 void bdi_start_writeback(struct backing_dev_info *bdi, struct super_block *sb,
 104                                 long nr_pages);
 105 int bdi_writeback_task(struct bdi_writeback *wb);
 106 bool bdi_has_dirty_io(struct backing_dev_info *bdi);
 107
 108 extern spinlock_t bdi_lock;
 109 extern struct list_head bdi_list;
 110
 111 static inline bool wb_has_dirty_io(struct bdi_writeback *wb)
 112 {
 113         return !RB_EMPTY_ROOT(&wb->flush_tree);
 114 }
 115
 116 static inline void __add_bdi_stat(struct backing_dev_info *bdi,
 117                 enum bdi_stat_item item, s64 amount)
 118 {
 119         __percpu_counter_add(&bdi->bdi_stat[item], amount, BDI_STAT_BATCH);
 120 }
 121
 122 static inline void __inc_bdi_stat(struct backing_dev_info *bdi,
 123                 enum bdi_stat_item item)
 124 {
 125         __add_bdi_stat(bdi, item, 1);
 126 }
 127
 128 static inline void inc_bdi_stat(struct backing_dev_info *bdi,
 129                 enum bdi_stat_item item)
 130 {
 131         unsigned long flags;
 132
 133         local_irq_save(flags);
 134         __inc_bdi_stat(bdi, item);
 135         local_irq_restore(flags);
 136 }
 137
 138 static inline void __dec_bdi_stat(struct backing_dev_info *bdi,
 139                 enum bdi_stat_item item)
 140 {
 141         __add_bdi_stat(bdi, item, -1);
 142 }
 143
 144 static inline void dec_bdi_stat(struct backing_dev_info *bdi,
 145                 enum bdi_stat_item item)
 146 {
 147         unsigned long flags;
 148
 149         local_irq_save(flags);
 150         __dec_bdi_stat(bdi, item);
 151         local_irq_restore(flags);
 152 }
 153
 154 static inline s64 bdi_stat(struct backing_dev_info *bdi,
 155                 enum bdi_stat_item item)
 156 {
 157         return percpu_counter_read_positive(&bdi->bdi_stat[item]);
 158 }
 159
 160 static inline s64 __bdi_stat_sum(struct backing_dev_info *bdi,
 161                 enum bdi_stat_item item)
 162 {
 163         return percpu_counter_sum_positive(&bdi->bdi_stat[item]);
 164 }
 165
 166 static inline s64 bdi_stat_sum(struct backing_dev_info *bdi,
 167                 enum bdi_stat_item item)
 168 {
 169         s64 sum;
 170         unsigned long flags;
 171
 172         local_irq_save(flags);
 173         sum = __bdi_stat_sum(bdi, item);
 174         local_irq_restore(flags);
 175
 176         return sum;
 177 }
 178
 179 extern void bdi_writeout_inc(struct backing_dev_info *bdi);
 180
 181 /*
 182  * maximal error of a stat counter.
 183  */
 184 static inline unsigned long bdi_stat_error(struct backing_dev_info *bdi)
 185 {
 186 #ifdef CONFIG_SMP
 187         return nr_cpu_ids * BDI_STAT_BATCH;
 188 #else
 189         return 1;
 190 #endif
 191 }
 192
 193 int bdi_set_min_ratio(struct backing_dev_info *bdi, unsigned int min_ratio);
 194 int bdi_set_max_ratio(struct backing_dev_info *bdi, unsigned int max_ratio);
 195
 196 /*
 197  * Flags in backing_dev_info::capability
 198  *
 199  * The first three flags control whether dirty pages will contribute to the
 200  * VM's accounting and whether writepages() should be called for dirty pages
 201  * (something that would not, for example, be appropriate for ramfs)
 202  *
 203  * WARNING: these flags are closely related and should not normally be
 204  * used separately.  The BDI_CAP_NO_ACCT_AND_WRITEBACK combines these
 205  * three flags into a single convenience macro.
 206  *
 207  * BDI_CAP_NO_ACCT_DIRTY:  Dirty pages shouldn't contribute to accounting
 208  * BDI_CAP_NO_WRITEBACK:   Don't write pages back
 209  * BDI_CAP_NO_ACCT_WB:     Don't automatically account writeback pages
 210  *
 211  * These flags let !MMU mmap() govern direct device mapping vs immediate
 212  * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
 213  *
 214  * BDI_CAP_MAP_COPY:       Copy can be mapped (MAP_PRIVATE)
 215  * BDI_CAP_MAP_DIRECT:     Can be mapped directly (MAP_SHARED)
 216  * BDI_CAP_READ_MAP:       Can be mapped for reading
 217  * BDI_CAP_WRITE_MAP:      Can be mapped for writing
 218  * BDI_CAP_EXEC_MAP:       Can be mapped for execution
 219  *
 220  * BDI_CAP_SWAP_BACKED:    Count shmem/tmpfs objects as swap-backed.
 221  */
 222 #define BDI_CAP_NO_ACCT_DIRTY   0x00000001
 223 #define BDI_CAP_NO_WRITEBACK    0x00000002
 224 #define BDI_CAP_MAP_COPY        0x00000004
 225 #define BDI_CAP_MAP_DIRECT      0x00000008
 226 #define BDI_CAP_READ_MAP        0x00000010
 227 #define BDI_CAP_WRITE_MAP       0x00000020
 228 #define BDI_CAP_EXEC_MAP        0x00000040
 229 #define BDI_CAP_NO_ACCT_WB      0x00000080
 230 #define BDI_CAP_SWAP_BACKED     0x00000100
 231
 232 #define BDI_CAP_VMFLAGS \
 233         (BDI_CAP_READ_MAP | BDI_CAP_WRITE_MAP | BDI_CAP_EXEC_MAP)
 234
 235 #define BDI_CAP_NO_ACCT_AND_WRITEBACK \
 236         (BDI_CAP_NO_WRITEBACK | BDI_CAP_NO_ACCT_DIRTY | BDI_CAP_NO_ACCT_WB)
 237
 238 #if defined(VM_MAYREAD) && \
 239         (BDI_CAP_READ_MAP != VM_MAYREAD || \
 240          BDI_CAP_WRITE_MAP != VM_MAYWRITE || \
 241          BDI_CAP_EXEC_MAP != VM_MAYEXEC)
 242 #error please change backing_dev_info::capabilities flags
 243 #endif
 244
 245 extern struct backing_dev_info default_backing_dev_info;
 246 void default_unplug_io_fn(struct backing_dev_info *bdi, struct page *page);
 247
 248 int writeback_in_progress(struct backing_dev_info *bdi);
 249
 250 static inline int bdi_congested(struct backing_dev_info *bdi, int bdi_bits)
 251 {
 252         if (bdi->congested_fn)
 253                 return bdi->congested_fn(bdi->congested_data, bdi_bits);
 254         return (bdi->state & bdi_bits);
 255 }
 256
 257 static inline int bdi_read_congested(struct backing_dev_info *bdi)
 258 {
 259         return bdi_congested(bdi, 1 << BDI_sync_congested);
 260 }
 261
 262 static inline int bdi_write_congested(struct backing_dev_info *bdi)
 263 {
 264         return bdi_congested(bdi, 1 << BDI_async_congested);
 265 }
 266
 267 static inline int bdi_rw_congested(struct backing_dev_info *bdi)
 268 {
 269         return bdi_congested(bdi, (1 << BDI_sync_congested) |
 270                                   (1 << BDI_async_congested));
 271 }
 272
 273 enum {
 274         BLK_RW_ASYNC    = 0,
 275         BLK_RW_SYNC     = 1,
 276 };
 277
 278 void clear_bdi_congested(struct backing_dev_info *bdi, int sync);
 279 void set_bdi_congested(struct backing_dev_info *bdi, int sync);
 280 long congestion_wait(int sync, long timeout);
 281
 282
 283 static inline bool bdi_cap_writeback_dirty(struct backing_dev_info *bdi)
 284 {
 285         return !(bdi->capabilities & BDI_CAP_NO_WRITEBACK);
 286 }
 287
 288 static inline bool bdi_cap_account_dirty(struct backing_dev_info *bdi)
 289 {
 290         return !(bdi->capabilities & BDI_CAP_NO_ACCT_DIRTY);
 291 }
 292
 293 static inline bool bdi_cap_account_writeback(struct backing_dev_info *bdi)
 294 {
 295         /* Paranoia: BDI_CAP_NO_WRITEBACK implies BDI_CAP_NO_ACCT_WB */
 296         return !(bdi->capabilities & (BDI_CAP_NO_ACCT_WB |
 297                                       BDI_CAP_NO_WRITEBACK));
 298 }
 299
 300 static inline bool bdi_cap_swap_backed(struct backing_dev_info *bdi)
 301 {
 302         return bdi->capabilities & BDI_CAP_SWAP_BACKED;
 303 }
 304
 305 static inline bool bdi_cap_flush_forker(struct backing_dev_info *bdi)
 306 {
 307         return bdi == &default_backing_dev_info;
 308 }
 309
 310 static inline bool mapping_cap_writeback_dirty(struct address_space *mapping)
 311 {
 312         return bdi_cap_writeback_dirty(mapping->backing_dev_info);
 313 }
 314
 315 static inline bool mapping_cap_account_dirty(struct address_space *mapping)
 316 {
 317         return bdi_cap_account_dirty(mapping->backing_dev_info);
 318 }
 319
 320 static inline bool mapping_cap_swap_backed(struct address_space *mapping)
 321 {
 322         return bdi_cap_swap_backed(mapping->backing_dev_info);
 323 }
 324
 325 static inline int bdi_sched_wait(void *word)
 326 {
 327         schedule();
 328         return 0;
 329 }
 330
 331 static inline void blk_run_backing_dev(struct backing_dev_info *bdi,
 332                                        struct page *page)
 333 {
 334         if (bdi && bdi->unplug_io_fn)
 335                 bdi->unplug_io_fn(bdi, page);
 336 }
 337
 338 static inline void blk_run_address_space(struct address_space *mapping)
 339 {
 340         if (mapping)
 341                 blk_run_backing_dev(mapping->backing_dev_info, NULL);
 342 }
 343
 344 #endif          /* _LINUX_BACKING_DEV_H */