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 written_stamp;    /* pages written at bw_time_stamp */
  79         unsigned long write_bandwidth;  /* the estimated write bandwidth */
  80         unsigned long avg_write_bandwidth; /* further smoothed write bw */
  81
  82         struct prop_local_percpu completions;
  83         int dirty_exceeded;
  84
  85         unsigned int min_ratio;
  86         unsigned int max_ratio, max_prop_frac;
  87
  88         struct bdi_writeback wb;  /* default writeback info for this bdi */
  89         spinlock_t wb_lock;       /* protects work_list */
  90
  91         struct list_head work_list;
  92
  93         struct device *dev;
  94
  95         struct timer_list laptop_mode_wb_timer;
  96
  97 #ifdef CONFIG_DEBUG_FS
  98         struct dentry *debug_dir;
  99         struct dentry *debug_stats;
 100 #endif
 101 };
 102
 103 int bdi_init(struct backing_dev_info *bdi);
 104 void bdi_destroy(struct backing_dev_info *bdi);
 105
 106 int bdi_register(struct backing_dev_info *bdi, struct device *parent,
 107                 const char *fmt, ...);
 108 int bdi_register_dev(struct backing_dev_info *bdi, dev_t dev);
 109 void bdi_unregister(struct backing_dev_info *bdi);
 110 int bdi_setup_and_register(struct backing_dev_info *, char *, unsigned int);
 111 void bdi_start_writeback(struct backing_dev_info *bdi, long nr_pages);
 112 void bdi_start_background_writeback(struct backing_dev_info *bdi);
 113 int bdi_writeback_thread(void *data);
 114 int bdi_has_dirty_io(struct backing_dev_info *bdi);
 115 void bdi_arm_supers_timer(void);
 116 void bdi_wakeup_thread_delayed(struct backing_dev_info *bdi);
 117 void bdi_lock_two(struct bdi_writeback *wb1, struct bdi_writeback *wb2);
 118
 119 extern spinlock_t bdi_lock;
 120 extern struct list_head bdi_list;
 121 extern struct list_head bdi_pending_list;
 122
 123 static inline int wb_has_dirty_io(struct bdi_writeback *wb)
 124 {
 125         return !list_empty(&wb->b_dirty) ||
 126                !list_empty(&wb->b_io) ||
 127                !list_empty(&wb->b_more_io);
 128 }
 129
 130 static inline void __add_bdi_stat(struct backing_dev_info *bdi,
 131                 enum bdi_stat_item item, s64 amount)
 132 {
 133         __percpu_counter_add(&bdi->bdi_stat[item], amount, BDI_STAT_BATCH);
 134 }
 135
 136 static inline void __inc_bdi_stat(struct backing_dev_info *bdi,
 137                 enum bdi_stat_item item)
 138 {
 139         __add_bdi_stat(bdi, item, 1);
 140 }
 141
 142 static inline void inc_bdi_stat(struct backing_dev_info *bdi,
 143                 enum bdi_stat_item item)
 144 {
 145         unsigned long flags;
 146
 147         local_irq_save(flags);
 148         __inc_bdi_stat(bdi, item);
 149         local_irq_restore(flags);
 150 }
 151
 152 static inline void __dec_bdi_stat(struct backing_dev_info *bdi,
 153                 enum bdi_stat_item item)
 154 {
 155         __add_bdi_stat(bdi, item, -1);
 156 }
 157
 158 static inline void dec_bdi_stat(struct backing_dev_info *bdi,
 159                 enum bdi_stat_item item)
 160 {
 161         unsigned long flags;
 162
 163         local_irq_save(flags);
 164         __dec_bdi_stat(bdi, item);
 165         local_irq_restore(flags);
 166 }
 167
 168 static inline s64 bdi_stat(struct backing_dev_info *bdi,
 169                 enum bdi_stat_item item)
 170 {
 171         return percpu_counter_read_positive(&bdi->bdi_stat[item]);
 172 }
 173
 174 static inline s64 __bdi_stat_sum(struct backing_dev_info *bdi,
 175                 enum bdi_stat_item item)
 176 {
 177         return percpu_counter_sum_positive(&bdi->bdi_stat[item]);
 178 }
 179
 180 static inline s64 bdi_stat_sum(struct backing_dev_info *bdi,
 181                 enum bdi_stat_item item)
 182 {
 183         s64 sum;
 184         unsigned long flags;
 185
 186         local_irq_save(flags);
 187         sum = __bdi_stat_sum(bdi, item);
 188         local_irq_restore(flags);
 189
 190         return sum;
 191 }
 192
 193 extern void bdi_writeout_inc(struct backing_dev_info *bdi);
 194
 195 /*
 196  * maximal error of a stat counter.
 197  */
 198 static inline unsigned long bdi_stat_error(struct backing_dev_info *bdi)
 199 {
 200 #ifdef CONFIG_SMP
 201         return nr_cpu_ids * BDI_STAT_BATCH;
 202 #else
 203         return 1;
 204 #endif
 205 }
 206
 207 int bdi_set_min_ratio(struct backing_dev_info *bdi, unsigned int min_ratio);
 208 int bdi_set_max_ratio(struct backing_dev_info *bdi, unsigned int max_ratio);
 209
 210 /*
 211  * Flags in backing_dev_info::capability
 212  *
 213  * The first three flags control whether dirty pages will contribute to the
 214  * VM's accounting and whether writepages() should be called for dirty pages
 215  * (something that would not, for example, be appropriate for ramfs)
 216  *
 217  * WARNING: these flags are closely related and should not normally be
 218  * used separately.  The BDI_CAP_NO_ACCT_AND_WRITEBACK combines these
 219  * three flags into a single convenience macro.
 220  *
 221  * BDI_CAP_NO_ACCT_DIRTY:  Dirty pages shouldn't contribute to accounting
 222  * BDI_CAP_NO_WRITEBACK:   Don't write pages back
 223  * BDI_CAP_NO_ACCT_WB:     Don't automatically account writeback pages
 224  *
 225  * These flags let !MMU mmap() govern direct device mapping vs immediate
 226  * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
 227  *
 228  * BDI_CAP_MAP_COPY:       Copy can be mapped (MAP_PRIVATE)
 229  * BDI_CAP_MAP_DIRECT:     Can be mapped directly (MAP_SHARED)
 230  * BDI_CAP_READ_MAP:       Can be mapped for reading
 231  * BDI_CAP_WRITE_MAP:      Can be mapped for writing
 232  * BDI_CAP_EXEC_MAP:       Can be mapped for execution
 233  *
 234  * BDI_CAP_SWAP_BACKED:    Count shmem/tmpfs objects as swap-backed.
 235  */
 236 #define BDI_CAP_NO_ACCT_DIRTY   0x00000001
 237 #define BDI_CAP_NO_WRITEBACK    0x00000002
 238 #define BDI_CAP_MAP_COPY        0x00000004
 239 #define BDI_CAP_MAP_DIRECT      0x00000008
 240 #define BDI_CAP_READ_MAP        0x00000010
 241 #define BDI_CAP_WRITE_MAP       0x00000020
 242 #define BDI_CAP_EXEC_MAP        0x00000040
 243 #define BDI_CAP_NO_ACCT_WB      0x00000080
 244 #define BDI_CAP_SWAP_BACKED     0x00000100
 245
 246 #define BDI_CAP_VMFLAGS \
 247         (BDI_CAP_READ_MAP | BDI_CAP_WRITE_MAP | BDI_CAP_EXEC_MAP)
 248
 249 #define BDI_CAP_NO_ACCT_AND_WRITEBACK \
 250         (BDI_CAP_NO_WRITEBACK | BDI_CAP_NO_ACCT_DIRTY | BDI_CAP_NO_ACCT_WB)
 251
 252 #if defined(VM_MAYREAD) && \
 253         (BDI_CAP_READ_MAP != VM_MAYREAD || \
 254          BDI_CAP_WRITE_MAP != VM_MAYWRITE || \
 255          BDI_CAP_EXEC_MAP != VM_MAYEXEC)
 256 #error please change backing_dev_info::capabilities flags
 257 #endif
 258
 259 extern struct backing_dev_info default_backing_dev_info;
 260 extern struct backing_dev_info noop_backing_dev_info;
 261
 262 int writeback_in_progress(struct backing_dev_info *bdi);
 263
 264 static inline int bdi_congested(struct backing_dev_info *bdi, int bdi_bits)
 265 {
 266         if (bdi->congested_fn)
 267                 return bdi->congested_fn(bdi->congested_data, bdi_bits);
 268         return (bdi->state & bdi_bits);
 269 }
 270
 271 static inline int bdi_read_congested(struct backing_dev_info *bdi)
 272 {
 273         return bdi_congested(bdi, 1 << BDI_sync_congested);
 274 }
 275
 276 static inline int bdi_write_congested(struct backing_dev_info *bdi)
 277 {
 278         return bdi_congested(bdi, 1 << BDI_async_congested);
 279 }
 280
 281 static inline int bdi_rw_congested(struct backing_dev_info *bdi)
 282 {
 283         return bdi_congested(bdi, (1 << BDI_sync_congested) |
 284                                   (1 << BDI_async_congested));
 285 }
 286
 287 enum {
 288         BLK_RW_ASYNC    = 0,
 289         BLK_RW_SYNC     = 1,
 290 };
 291
 292 void clear_bdi_congested(struct backing_dev_info *bdi, int sync);
 293 void set_bdi_congested(struct backing_dev_info *bdi, int sync);
 294 long congestion_wait(int sync, long timeout);
 295 long wait_iff_congested(struct zone *zone, int sync, long timeout);
 296
 297 static inline bool bdi_cap_writeback_dirty(struct backing_dev_info *bdi)
 298 {
 299         return !(bdi->capabilities & BDI_CAP_NO_WRITEBACK);
 300 }
 301
 302 static inline bool bdi_cap_account_dirty(struct backing_dev_info *bdi)
 303 {
 304         return !(bdi->capabilities & BDI_CAP_NO_ACCT_DIRTY);
 305 }
 306
 307 static inline bool bdi_cap_account_writeback(struct backing_dev_info *bdi)
 308 {
 309         /* Paranoia: BDI_CAP_NO_WRITEBACK implies BDI_CAP_NO_ACCT_WB */
 310         return !(bdi->capabilities & (BDI_CAP_NO_ACCT_WB |
 311                                       BDI_CAP_NO_WRITEBACK));
 312 }
 313
 314 static inline bool bdi_cap_swap_backed(struct backing_dev_info *bdi)
 315 {
 316         return bdi->capabilities & BDI_CAP_SWAP_BACKED;
 317 }
 318
 319 static inline bool bdi_cap_flush_forker(struct backing_dev_info *bdi)
 320 {
 321         return bdi == &default_backing_dev_info;
 322 }
 323
 324 static inline bool mapping_cap_writeback_dirty(struct address_space *mapping)
 325 {
 326         return bdi_cap_writeback_dirty(mapping->backing_dev_info);
 327 }
 328
 329 static inline bool mapping_cap_account_dirty(struct address_space *mapping)
 330 {
 331         return bdi_cap_account_dirty(mapping->backing_dev_info);
 332 }
 333
 334 static inline bool mapping_cap_swap_backed(struct address_space *mapping)
 335 {
 336         return bdi_cap_swap_backed(mapping->backing_dev_info);
 337 }
 338
 339 static inline int bdi_sched_wait(void *word)
 340 {
 341         schedule();
 342         return 0;
 343 }
 344
 345 #endif          /* _LINUX_BACKING_DEV_H */