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