include/linux/backing-dev.h

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