include/linux/backing-dev-defs.h

   1 #ifndef __LINUX_BACKING_DEV_DEFS_H
   2 #define __LINUX_BACKING_DEV_DEFS_H
   3
   4 #include <linux/list.h>
   5 #include <linux/radix-tree.h>
   6 #include <linux/rbtree.h>
   7 #include <linux/spinlock.h>
   8 #include <linux/percpu_counter.h>
   9 #include <linux/percpu-refcount.h>
  10 #include <linux/flex_proportions.h>
  11 #include <linux/timer.h>
  12 #include <linux/workqueue.h>
  13 #include <linux/kref.h>
  14
  15 struct page;
  16 struct device;
  17 struct dentry;
  18
  19 /*
  20  * Bits in bdi_writeback.state
  21  */
  22 enum wb_state {
  23         WB_registered,          /* bdi_register() was done */
  24         WB_writeback_running,   /* Writeback is in progress */
  25         WB_has_dirty_io,        /* Dirty inodes on ->b_{dirty|io|more_io} */
  26 };
  27
  28 enum wb_congested_state {
  29         WB_async_congested,     /* The async (write) queue is getting full */
  30         WB_sync_congested,      /* The sync queue is getting full */
  31 };
  32
  33 typedef int (congested_fn)(void *, int);
  34
  35 enum wb_stat_item {
  36         WB_RECLAIMABLE,
  37         WB_WRITEBACK,
  38         WB_DIRTIED,
  39         WB_WRITTEN,
  40         NR_WB_STAT_ITEMS
  41 };
  42
  43 #define WB_STAT_BATCH (8*(1+ilog2(nr_cpu_ids)))
  44
  45 /*
  46  * For cgroup writeback, multiple wb's may map to the same blkcg.  Those
  47  * wb's can operate mostly independently but should share the congested
  48  * state.  To facilitate such sharing, the congested state is tracked using
  49  * the following struct which is created on demand, indexed by blkcg ID on
  50  * its bdi, and refcounted.
  51  */
  52 struct bdi_writeback_congested {
  53         unsigned long state;            /* WB_[a]sync_congested flags */
  54         atomic_t refcnt;                /* nr of attached wb's and blkg */
  55
  56 #ifdef CONFIG_CGROUP_WRITEBACK
  57         struct backing_dev_info *bdi;   /* the associated bdi */
  58         int blkcg_id;                   /* ID of the associated blkcg */
  59         struct rb_node rb_node;         /* on bdi->cgwb_congestion_tree */
  60 #endif
  61 };
  62
  63 /*
  64  * Each wb (bdi_writeback) can perform writeback operations, is measured
  65  * and throttled, independently.  Without cgroup writeback, each bdi
  66  * (bdi_writeback) is served by its embedded bdi->wb.
  67  *
  68  * On the default hierarchy, blkcg implicitly enables memcg.  This allows
  69  * using memcg's page ownership for attributing writeback IOs, and every
  70  * memcg - blkcg combination can be served by its own wb by assigning a
  71  * dedicated wb to each memcg, which enables isolation across different
  72  * cgroups and propagation of IO back pressure down from the IO layer upto
  73  * the tasks which are generating the dirty pages to be written back.
  74  *
  75  * A cgroup wb is indexed on its bdi by the ID of the associated memcg,
  76  * refcounted with the number of inodes attached to it, and pins the memcg
  77  * and the corresponding blkcg.  As the corresponding blkcg for a memcg may
  78  * change as blkcg is disabled and enabled higher up in the hierarchy, a wb
  79  * is tested for blkcg after lookup and removed from index on mismatch so
  80  * that a new wb for the combination can be created.
  81  */
  82 struct bdi_writeback {
  83         struct backing_dev_info *bdi;   /* our parent bdi */
  84
  85         unsigned long state;            /* Always use atomic bitops on this */
  86         unsigned long last_old_flush;   /* last old data flush */
  87
  88         struct list_head b_dirty;       /* dirty inodes */
  89         struct list_head b_io;          /* parked for writeback */
  90         struct list_head b_more_io;     /* parked for more writeback */
  91         struct list_head b_dirty_time;  /* time stamps are dirty */
  92         spinlock_t list_lock;           /* protects the b_* lists */
  93
  94         struct percpu_counter stat[NR_WB_STAT_ITEMS];
  95
  96         struct bdi_writeback_congested *congested;
  97
  98         unsigned long bw_time_stamp;    /* last time write bw is updated */
  99         unsigned long dirtied_stamp;
 100         unsigned long written_stamp;    /* pages written at bw_time_stamp */
 101         unsigned long write_bandwidth;  /* the estimated write bandwidth */
 102         unsigned long avg_write_bandwidth; /* further smoothed write bw, > 0 */
 103
 104         /*
 105          * The base dirty throttle rate, re-calculated on every 200ms.
 106          * All the bdi tasks' dirty rate will be curbed under it.
 107          * @dirty_ratelimit tracks the estimated @balanced_dirty_ratelimit
 108          * in small steps and is much more smooth/stable than the latter.
 109          */
 110         unsigned long dirty_ratelimit;
 111         unsigned long balanced_dirty_ratelimit;
 112
 113         struct fprop_local_percpu completions;
 114         int dirty_exceeded;
 115
 116         spinlock_t work_lock;           /* protects work_list & dwork scheduling */
 117         struct list_head work_list;
 118         struct delayed_work dwork;      /* work item used for writeback */
 119
 120         struct list_head bdi_node;      /* anchored at bdi->wb_list */
 121
 122 #ifdef CONFIG_CGROUP_WRITEBACK
 123         struct percpu_ref refcnt;       /* used only for !root wb's */
 124         struct fprop_local_percpu memcg_completions;
 125         struct cgroup_subsys_state *memcg_css; /* the associated memcg */
 126         struct cgroup_subsys_state *blkcg_css; /* and blkcg */
 127         struct list_head memcg_node;    /* anchored at memcg->cgwb_list */
 128         struct list_head blkcg_node;    /* anchored at blkcg->cgwb_list */
 129
 130         union {
 131                 struct work_struct release_work;
 132                 struct rcu_head rcu;
 133         };
 134 #endif
 135 };
 136
 137 struct backing_dev_info {
 138         struct list_head bdi_list;
 139         unsigned long ra_pages; /* max readahead in PAGE_CACHE_SIZE units */
 140         unsigned long io_pages; /* max allowed IO size */
 141         unsigned int capabilities; /* Device capabilities */
 142         congested_fn *congested_fn; /* Function pointer if device is md/dm */
 143         void *congested_data;   /* Pointer to aux data for congested func */
 144
 145         char *name;
 146         struct kref refcnt;     /* Reference counter for the structure */
 147
 148         unsigned int min_ratio;
 149         unsigned int max_ratio, max_prop_frac;
 150
 151         /*
 152          * Sum of avg_write_bw of wbs with dirty inodes.  > 0 if there are
 153          * any dirty wbs, which is depended upon by bdi_has_dirty().
 154          */
 155         atomic_long_t tot_write_bandwidth;
 156
 157         struct bdi_writeback wb;  /* the root writeback info for this bdi */
 158         struct list_head wb_list; /* list of all wbs */
 159 #ifdef CONFIG_CGROUP_WRITEBACK
 160         struct radix_tree_root cgwb_tree; /* radix tree of active cgroup wbs */
 161         struct rb_root cgwb_congested_tree; /* their congested states */
 162         atomic_t usage_cnt; /* counts both cgwbs and cgwb_contested's */
 163         struct rw_semaphore wb_switch_rwsem; /* no cgwb switch while syncing */
 164 #else
 165         struct bdi_writeback_congested *wb_congested;
 166 #endif
 167         wait_queue_head_t wb_waitq;
 168
 169         struct device *dev;
 170         struct device *owner;
 171
 172         struct timer_list laptop_mode_wb_timer;
 173
 174 #ifdef CONFIG_DEBUG_FS
 175         struct dentry *debug_dir;
 176         struct dentry *debug_stats;
 177 #endif
 178 };
 179
 180 enum {
 181         BLK_RW_ASYNC    = 0,
 182         BLK_RW_SYNC     = 1,
 183 };
 184
 185 void clear_wb_congested(struct bdi_writeback_congested *congested, int sync);
 186 void set_wb_congested(struct bdi_writeback_congested *congested, int sync);
 187
 188 static inline void clear_bdi_congested(struct backing_dev_info *bdi, int sync)
 189 {
 190         clear_wb_congested(bdi->wb.congested, sync);
 191 }
 192
 193 static inline void set_bdi_congested(struct backing_dev_info *bdi, int sync)
 194 {
 195         set_wb_congested(bdi->wb.congested, sync);
 196 }
 197
 198 struct wb_lock_cookie {
 199         bool locked;
 200         unsigned long flags;
 201 };
 202
 203 #ifdef CONFIG_CGROUP_WRITEBACK
 204
 205 /**
 206  * wb_tryget - try to increment a wb's refcount
 207  * @wb: bdi_writeback to get
 208  */
 209 static inline bool wb_tryget(struct bdi_writeback *wb)
 210 {
 211         if (wb != &wb->bdi->wb)
 212                 return percpu_ref_tryget(&wb->refcnt);
 213         return true;
 214 }
 215
 216 /**
 217  * wb_get - increment a wb's refcount
 218  * @wb: bdi_writeback to get
 219  */
 220 static inline void wb_get(struct bdi_writeback *wb)
 221 {
 222         if (wb != &wb->bdi->wb)
 223                 percpu_ref_get(&wb->refcnt);
 224 }
 225
 226 /**
 227  * wb_put - decrement a wb's refcount
 228  * @wb: bdi_writeback to put
 229  */
 230 static inline void wb_put(struct bdi_writeback *wb)
 231 {
 232         if (WARN_ON_ONCE(!wb->bdi)) {
 233                 /*
 234                  * A driver bug might cause a file to be removed before bdi was
 235                  * initialized.
 236                  */
 237                 return;
 238         }
 239
 240         if (wb != &wb->bdi->wb)
 241                 percpu_ref_put(&wb->refcnt);
 242 }
 243
 244 /**
 245  * wb_dying - is a wb dying?
 246  * @wb: bdi_writeback of interest
 247  *
 248  * Returns whether @wb is unlinked and being drained.
 249  */
 250 static inline bool wb_dying(struct bdi_writeback *wb)
 251 {
 252         return percpu_ref_is_dying(&wb->refcnt);
 253 }
 254
 255 #else   /* CONFIG_CGROUP_WRITEBACK */
 256
 257 static inline bool wb_tryget(struct bdi_writeback *wb)
 258 {
 259         return true;
 260 }
 261
 262 static inline void wb_get(struct bdi_writeback *wb)
 263 {
 264 }
 265
 266 static inline void wb_put(struct bdi_writeback *wb)
 267 {
 268 }
 269
 270 static inline bool wb_dying(struct bdi_writeback *wb)
 271 {
 272         return false;
 273 }
 274
 275 #endif  /* CONFIG_CGROUP_WRITEBACK */
 276
 277 #endif  /* __LINUX_BACKING_DEV_DEFS_H */