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/kernel.h>
  12 #include <linux/fs.h>
  13 #include <linux/sched.h>
  14 #include <linux/blkdev.h>
  15 #include <linux/writeback.h>
  16 #include <linux/blk-cgroup.h>
  17 #include <linux/backing-dev-defs.h>
  18 #include <linux/slab.h>
  19
  20 static inline struct backing_dev_info *bdi_get(struct backing_dev_info *bdi)
  21 {
  22         kref_get(&bdi->refcnt);
  23         return bdi;
  24 }
  25
  26 void bdi_put(struct backing_dev_info *bdi);
  27
  28 __printf(2, 3)
  29 int bdi_register(struct backing_dev_info *bdi, const char *fmt, ...);
  30 int bdi_register_va(struct backing_dev_info *bdi, const char *fmt,
  31                     va_list args);
  32 int bdi_register_owner(struct backing_dev_info *bdi, struct device *owner);
  33 void bdi_unregister(struct backing_dev_info *bdi);
  34
  35 struct backing_dev_info *bdi_alloc_node(gfp_t gfp_mask, int node_id);
  36 static inline struct backing_dev_info *bdi_alloc(gfp_t gfp_mask)
  37 {
  38         return bdi_alloc_node(gfp_mask, NUMA_NO_NODE);
  39 }
  40
  41 void wb_start_background_writeback(struct bdi_writeback *wb);
  42 void wb_workfn(struct work_struct *work);
  43 void wb_wakeup_delayed(struct bdi_writeback *wb);
  44
  45 extern spinlock_t bdi_lock;
  46 extern struct list_head bdi_list;
  47
  48 extern struct workqueue_struct *bdi_wq;
  49
  50 static inline bool wb_has_dirty_io(struct bdi_writeback *wb)
  51 {
  52         return test_bit(WB_has_dirty_io, &wb->state);
  53 }
  54
  55 static inline bool bdi_has_dirty_io(struct backing_dev_info *bdi)
  56 {
  57         /*
  58          * @bdi->tot_write_bandwidth is guaranteed to be > 0 if there are
  59          * any dirty wbs.  See wb_update_write_bandwidth().
  60          */
  61         return atomic_long_read(&bdi->tot_write_bandwidth);
  62 }
  63
  64 static inline void __add_wb_stat(struct bdi_writeback *wb,
  65                                  enum wb_stat_item item, s64 amount)
  66 {
  67         percpu_counter_add_batch(&wb->stat[item], amount, WB_STAT_BATCH);
  68 }
  69
  70 static inline void inc_wb_stat(struct bdi_writeback *wb, enum wb_stat_item item)
  71 {
  72         __add_wb_stat(wb, item, 1);
  73 }
  74
  75 static inline void dec_wb_stat(struct bdi_writeback *wb, enum wb_stat_item item)
  76 {
  77         __add_wb_stat(wb, item, -1);
  78 }
  79
  80 static inline s64 wb_stat(struct bdi_writeback *wb, enum wb_stat_item item)
  81 {
  82         return percpu_counter_read_positive(&wb->stat[item]);
  83 }
  84
  85 static inline s64 wb_stat_sum(struct bdi_writeback *wb, enum wb_stat_item item)
  86 {
  87         return percpu_counter_sum_positive(&wb->stat[item]);
  88 }
  89
  90 extern void wb_writeout_inc(struct bdi_writeback *wb);
  91
  92 /*
  93  * maximal error of a stat counter.
  94  */
  95 static inline unsigned long wb_stat_error(struct bdi_writeback *wb)
  96 {
  97 #ifdef CONFIG_SMP
  98         return nr_cpu_ids * WB_STAT_BATCH;
  99 #else
 100         return 1;
 101 #endif
 102 }
 103
 104 int bdi_set_min_ratio(struct backing_dev_info *bdi, unsigned int min_ratio);
 105 int bdi_set_max_ratio(struct backing_dev_info *bdi, unsigned int max_ratio);
 106
 107 /*
 108  * Flags in backing_dev_info::capability
 109  *
 110  * The first three flags control whether dirty pages will contribute to the
 111  * VM's accounting and whether writepages() should be called for dirty pages
 112  * (something that would not, for example, be appropriate for ramfs)
 113  *
 114  * WARNING: these flags are closely related and should not normally be
 115  * used separately.  The BDI_CAP_NO_ACCT_AND_WRITEBACK combines these
 116  * three flags into a single convenience macro.
 117  *
 118  * BDI_CAP_NO_ACCT_DIRTY:  Dirty pages shouldn't contribute to accounting
 119  * BDI_CAP_NO_WRITEBACK:   Don't write pages back
 120  * BDI_CAP_NO_ACCT_WB:     Don't automatically account writeback pages
 121  * BDI_CAP_STRICTLIMIT:    Keep number of dirty pages below bdi threshold.
 122  *
 123  * BDI_CAP_CGROUP_WRITEBACK: Supports cgroup-aware writeback.
 124  */
 125 #define BDI_CAP_NO_ACCT_DIRTY   0x00000001
 126 #define BDI_CAP_NO_WRITEBACK    0x00000002
 127 #define BDI_CAP_NO_ACCT_WB      0x00000004
 128 #define BDI_CAP_STABLE_WRITES   0x00000008
 129 #define BDI_CAP_STRICTLIMIT     0x00000010
 130 #define BDI_CAP_CGROUP_WRITEBACK 0x00000020
 131
 132 #define BDI_CAP_NO_ACCT_AND_WRITEBACK \
 133         (BDI_CAP_NO_WRITEBACK | BDI_CAP_NO_ACCT_DIRTY | BDI_CAP_NO_ACCT_WB)
 134
 135 extern struct backing_dev_info noop_backing_dev_info;
 136
 137 /**
 138  * writeback_in_progress - determine whether there is writeback in progress
 139  * @wb: bdi_writeback of interest
 140  *
 141  * Determine whether there is writeback waiting to be handled against a
 142  * bdi_writeback.
 143  */
 144 static inline bool writeback_in_progress(struct bdi_writeback *wb)
 145 {
 146         return test_bit(WB_writeback_running, &wb->state);
 147 }
 148
 149 static inline struct backing_dev_info *inode_to_bdi(struct inode *inode)
 150 {
 151         struct super_block *sb;
 152
 153         if (!inode)
 154                 return &noop_backing_dev_info;
 155
 156         sb = inode->i_sb;
 157 #ifdef CONFIG_BLOCK
 158         if (sb_is_blkdev_sb(sb))
 159                 return I_BDEV(inode)->bd_bdi;
 160 #endif
 161         return sb->s_bdi;
 162 }
 163
 164 static inline int wb_congested(struct bdi_writeback *wb, int cong_bits)
 165 {
 166         struct backing_dev_info *bdi = wb->bdi;
 167
 168         if (bdi->congested_fn)
 169                 return bdi->congested_fn(bdi->congested_data, cong_bits);
 170         return wb->congested->state & cong_bits;
 171 }
 172
 173 long congestion_wait(int sync, long timeout);
 174 long wait_iff_congested(struct pglist_data *pgdat, int sync, long timeout);
 175
 176 static inline bool bdi_cap_stable_pages_required(struct backing_dev_info *bdi)
 177 {
 178         return bdi->capabilities & BDI_CAP_STABLE_WRITES;
 179 }
 180
 181 static inline bool bdi_cap_writeback_dirty(struct backing_dev_info *bdi)
 182 {
 183         return !(bdi->capabilities & BDI_CAP_NO_WRITEBACK);
 184 }
 185
 186 static inline bool bdi_cap_account_dirty(struct backing_dev_info *bdi)
 187 {
 188         return !(bdi->capabilities & BDI_CAP_NO_ACCT_DIRTY);
 189 }
 190
 191 static inline bool bdi_cap_account_writeback(struct backing_dev_info *bdi)
 192 {
 193         /* Paranoia: BDI_CAP_NO_WRITEBACK implies BDI_CAP_NO_ACCT_WB */
 194         return !(bdi->capabilities & (BDI_CAP_NO_ACCT_WB |
 195                                       BDI_CAP_NO_WRITEBACK));
 196 }
 197
 198 static inline bool mapping_cap_writeback_dirty(struct address_space *mapping)
 199 {
 200         return bdi_cap_writeback_dirty(inode_to_bdi(mapping->host));
 201 }
 202
 203 static inline bool mapping_cap_account_dirty(struct address_space *mapping)
 204 {
 205         return bdi_cap_account_dirty(inode_to_bdi(mapping->host));
 206 }
 207
 208 static inline int bdi_sched_wait(void *word)
 209 {
 210         schedule();
 211         return 0;
 212 }
 213
 214 #ifdef CONFIG_CGROUP_WRITEBACK
 215
 216 struct bdi_writeback_congested *
 217 wb_congested_get_create(struct backing_dev_info *bdi, int blkcg_id, gfp_t gfp);
 218 void wb_congested_put(struct bdi_writeback_congested *congested);
 219 struct bdi_writeback *wb_get_create(struct backing_dev_info *bdi,
 220                                     struct cgroup_subsys_state *memcg_css,
 221                                     gfp_t gfp);
 222 void wb_memcg_offline(struct mem_cgroup *memcg);
 223 void wb_blkcg_offline(struct blkcg *blkcg);
 224 int inode_congested(struct inode *inode, int cong_bits);
 225
 226 /**
 227  * inode_cgwb_enabled - test whether cgroup writeback is enabled on an inode
 228  * @inode: inode of interest
 229  *
 230  * cgroup writeback requires support from both the bdi and filesystem.
 231  * Also, both memcg and iocg have to be on the default hierarchy.  Test
 232  * whether all conditions are met.
 233  *
 234  * Note that the test result may change dynamically on the same inode
 235  * depending on how memcg and iocg are configured.
 236  */
 237 static inline bool inode_cgwb_enabled(struct inode *inode)
 238 {
 239         struct backing_dev_info *bdi = inode_to_bdi(inode);
 240
 241         return cgroup_subsys_on_dfl(memory_cgrp_subsys) &&
 242                 cgroup_subsys_on_dfl(io_cgrp_subsys) &&
 243                 bdi_cap_account_dirty(bdi) &&
 244                 (bdi->capabilities & BDI_CAP_CGROUP_WRITEBACK) &&
 245                 (inode->i_sb->s_iflags & SB_I_CGROUPWB);
 246 }
 247
 248 /**
 249  * wb_find_current - find wb for %current on a bdi
 250  * @bdi: bdi of interest
 251  *
 252  * Find the wb of @bdi which matches both the memcg and blkcg of %current.
 253  * Must be called under rcu_read_lock() which protects the returend wb.
 254  * NULL if not found.
 255  */
 256 static inline struct bdi_writeback *wb_find_current(struct backing_dev_info *bdi)
 257 {
 258         struct cgroup_subsys_state *memcg_css;
 259         struct bdi_writeback *wb;
 260
 261         memcg_css = task_css(current, memory_cgrp_id);
 262         if (!memcg_css->parent)
 263                 return &bdi->wb;
 264
 265         wb = radix_tree_lookup(&bdi->cgwb_tree, memcg_css->id);
 266
 267         /*
 268          * %current's blkcg equals the effective blkcg of its memcg.  No
 269          * need to use the relatively expensive cgroup_get_e_css().
 270          */
 271         if (likely(wb && wb->blkcg_css == task_css(current, io_cgrp_id)))
 272                 return wb;
 273         return NULL;
 274 }
 275
 276 /**
 277  * wb_get_create_current - get or create wb for %current on a bdi
 278  * @bdi: bdi of interest
 279  * @gfp: allocation mask
 280  *
 281  * Equivalent to wb_get_create() on %current's memcg.  This function is
 282  * called from a relatively hot path and optimizes the common cases using
 283  * wb_find_current().
 284  */
 285 static inline struct bdi_writeback *
 286 wb_get_create_current(struct backing_dev_info *bdi, gfp_t gfp)
 287 {
 288         struct bdi_writeback *wb;
 289
 290         rcu_read_lock();
 291         wb = wb_find_current(bdi);
 292         if (wb && unlikely(!wb_tryget(wb)))
 293                 wb = NULL;
 294         rcu_read_unlock();
 295
 296         if (unlikely(!wb)) {
 297                 struct cgroup_subsys_state *memcg_css;
 298
 299                 memcg_css = task_get_css(current, memory_cgrp_id);
 300                 wb = wb_get_create(bdi, memcg_css, gfp);
 301                 css_put(memcg_css);
 302         }
 303         return wb;
 304 }
 305
 306 /**
 307  * inode_to_wb_is_valid - test whether an inode has a wb associated
 308  * @inode: inode of interest
 309  *
 310  * Returns %true if @inode has a wb associated.  May be called without any
 311  * locking.
 312  */
 313 static inline bool inode_to_wb_is_valid(struct inode *inode)
 314 {
 315         return inode->i_wb;
 316 }
 317
 318 /**
 319  * inode_to_wb - determine the wb of an inode
 320  * @inode: inode of interest
 321  *
 322  * Returns the wb @inode is currently associated with.  The caller must be
 323  * holding either @inode->i_lock, @inode->i_mapping->tree_lock, or the
 324  * associated wb's list_lock.
 325  */
 326 static inline struct bdi_writeback *inode_to_wb(struct inode *inode)
 327 {
 328 #ifdef CONFIG_LOCKDEP
 329         WARN_ON_ONCE(debug_locks &&
 330                      (!lockdep_is_held(&inode->i_lock) &&
 331                       !lockdep_is_held(&inode->i_mapping->tree_lock) &&
 332                       !lockdep_is_held(&inode->i_wb->list_lock)));
 333 #endif
 334         return inode->i_wb;
 335 }
 336
 337 /**
 338  * unlocked_inode_to_wb_begin - begin unlocked inode wb access transaction
 339  * @inode: target inode
 340  * @lockedp: temp bool output param, to be passed to the end function
 341  *
 342  * The caller wants to access the wb associated with @inode but isn't
 343  * holding inode->i_lock, mapping->tree_lock or wb->list_lock.  This
 344  * function determines the wb associated with @inode and ensures that the
 345  * association doesn't change until the transaction is finished with
 346  * unlocked_inode_to_wb_end().
 347  *
 348  * The caller must call unlocked_inode_to_wb_end() with *@lockdep
 349  * afterwards and can't sleep during transaction.  IRQ may or may not be
 350  * disabled on return.
 351  */
 352 static inline struct bdi_writeback *
 353 unlocked_inode_to_wb_begin(struct inode *inode, bool *lockedp)
 354 {
 355         rcu_read_lock();
 356
 357         /*
 358          * Paired with store_release in inode_switch_wb_work_fn() and
 359          * ensures that we see the new wb if we see cleared I_WB_SWITCH.
 360          */
 361         *lockedp = smp_load_acquire(&inode->i_state) & I_WB_SWITCH;
 362
 363         if (unlikely(*lockedp))
 364                 spin_lock_irq(&inode->i_mapping->tree_lock);
 365
 366         /*
 367          * Protected by either !I_WB_SWITCH + rcu_read_lock() or tree_lock.
 368          * inode_to_wb() will bark.  Deref directly.
 369          */
 370         return inode->i_wb;
 371 }
 372
 373 /**
 374  * unlocked_inode_to_wb_end - end inode wb access transaction
 375  * @inode: target inode
 376  * @locked: *@lockedp from unlocked_inode_to_wb_begin()
 377  */
 378 static inline void unlocked_inode_to_wb_end(struct inode *inode, bool locked)
 379 {
 380         if (unlikely(locked))
 381                 spin_unlock_irq(&inode->i_mapping->tree_lock);
 382
 383         rcu_read_unlock();
 384 }
 385
 386 #else   /* CONFIG_CGROUP_WRITEBACK */
 387
 388 static inline bool inode_cgwb_enabled(struct inode *inode)
 389 {
 390         return false;
 391 }
 392
 393 static inline struct bdi_writeback_congested *
 394 wb_congested_get_create(struct backing_dev_info *bdi, int blkcg_id, gfp_t gfp)
 395 {
 396         atomic_inc(&bdi->wb_congested->refcnt);
 397         return bdi->wb_congested;
 398 }
 399
 400 static inline void wb_congested_put(struct bdi_writeback_congested *congested)
 401 {
 402         if (atomic_dec_and_test(&congested->refcnt))
 403                 kfree(congested);
 404 }
 405
 406 static inline struct bdi_writeback *wb_find_current(struct backing_dev_info *bdi)
 407 {
 408         return &bdi->wb;
 409 }
 410
 411 static inline struct bdi_writeback *
 412 wb_get_create_current(struct backing_dev_info *bdi, gfp_t gfp)
 413 {
 414         return &bdi->wb;
 415 }
 416
 417 static inline bool inode_to_wb_is_valid(struct inode *inode)
 418 {
 419         return true;
 420 }
 421
 422 static inline struct bdi_writeback *inode_to_wb(struct inode *inode)
 423 {
 424         return &inode_to_bdi(inode)->wb;
 425 }
 426
 427 static inline struct bdi_writeback *
 428 unlocked_inode_to_wb_begin(struct inode *inode, bool *lockedp)
 429 {
 430         return inode_to_wb(inode);
 431 }
 432
 433 static inline void unlocked_inode_to_wb_end(struct inode *inode, bool locked)
 434 {
 435 }
 436
 437 static inline void wb_memcg_offline(struct mem_cgroup *memcg)
 438 {
 439 }
 440
 441 static inline void wb_blkcg_offline(struct blkcg *blkcg)
 442 {
 443 }
 444
 445 static inline int inode_congested(struct inode *inode, int cong_bits)
 446 {
 447         return wb_congested(&inode_to_bdi(inode)->wb, cong_bits);
 448 }
 449
 450 #endif  /* CONFIG_CGROUP_WRITEBACK */
 451
 452 static inline int inode_read_congested(struct inode *inode)
 453 {
 454         return inode_congested(inode, 1 << WB_sync_congested);
 455 }
 456
 457 static inline int inode_write_congested(struct inode *inode)
 458 {
 459         return inode_congested(inode, 1 << WB_async_congested);
 460 }
 461
 462 static inline int inode_rw_congested(struct inode *inode)
 463 {
 464         return inode_congested(inode, (1 << WB_sync_congested) |
 465                                       (1 << WB_async_congested));
 466 }
 467
 468 static inline int bdi_congested(struct backing_dev_info *bdi, int cong_bits)
 469 {
 470         return wb_congested(&bdi->wb, cong_bits);
 471 }
 472
 473 static inline int bdi_read_congested(struct backing_dev_info *bdi)
 474 {
 475         return bdi_congested(bdi, 1 << WB_sync_congested);
 476 }
 477
 478 static inline int bdi_write_congested(struct backing_dev_info *bdi)
 479 {
 480         return bdi_congested(bdi, 1 << WB_async_congested);
 481 }
 482
 483 static inline int bdi_rw_congested(struct backing_dev_info *bdi)
 484 {
 485         return bdi_congested(bdi, (1 << WB_sync_congested) |
 486                                   (1 << WB_async_congested));
 487 }
 488
 489 #endif  /* _LINUX_BACKING_DEV_H */