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