include/linux/writeback.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * include/linux/writeback.h
   4  */
   5 #ifndef WRITEBACK_H
   6 #define WRITEBACK_H
   7
   8 #include <linux/sched.h>
   9 #include <linux/workqueue.h>
  10 #include <linux/fs.h>
  11 #include <linux/flex_proportions.h>
  12 #include <linux/backing-dev-defs.h>
  13 #include <linux/blk_types.h>
  14 #include <linux/blk-cgroup.h>
  15
  16 struct bio;
  17
  18 DECLARE_PER_CPU(int, dirty_throttle_leaks);
  19
  20 /*
  21  * The 1/4 region under the global dirty thresh is for smooth dirty throttling:
  22  *
  23  *      (thresh - thresh/DIRTY_FULL_SCOPE, thresh)
  24  *
  25  * Further beyond, all dirtier tasks will enter a loop waiting (possibly long
  26  * time) for the dirty pages to drop, unless written enough pages.
  27  *
  28  * The global dirty threshold is normally equal to the global dirty limit,
  29  * except when the system suddenly allocates a lot of anonymous memory and
  30  * knocks down the global dirty threshold quickly, in which case the global
  31  * dirty limit will follow down slowly to prevent livelocking all dirtier tasks.
  32  */
  33 #define DIRTY_SCOPE             8
  34 #define DIRTY_FULL_SCOPE        (DIRTY_SCOPE / 2)
  35
  36 struct backing_dev_info;
  37
  38 /*
  39  * fs/fs-writeback.c
  40  */
  41 enum writeback_sync_modes {
  42         WB_SYNC_NONE,   /* Don't wait on anything */
  43         WB_SYNC_ALL,    /* Wait on every mapping */
  44 };
  45
  46 /*
  47  * A control structure which tells the writeback code what to do.  These are
  48  * always on the stack, and hence need no locking.  They are always initialised
  49  * in a manner such that unspecified fields are set to zero.
  50  */
  51 struct writeback_control {
  52         long nr_to_write;               /* Write this many pages, and decrement
  53                                            this for each page written */
  54         long pages_skipped;             /* Pages which were not written */
  55
  56         /*
  57          * For a_ops->writepages(): if start or end are non-zero then this is
  58          * a hint that the filesystem need only write out the pages inside that
  59          * byterange.  The byte at `end' is included in the writeout request.
  60          */
  61         loff_t range_start;
  62         loff_t range_end;
  63
  64         enum writeback_sync_modes sync_mode;
  65
  66         unsigned for_kupdate:1;         /* A kupdate writeback */
  67         unsigned for_background:1;      /* A background writeback */
  68         unsigned tagged_writepages:1;   /* tag-and-write to avoid livelock */
  69         unsigned for_reclaim:1;         /* Invoked from the page allocator */
  70         unsigned range_cyclic:1;        /* range_start is cyclic */
  71         unsigned for_sync:1;            /* sync(2) WB_SYNC_ALL writeback */
  72
  73         /*
  74          * When writeback IOs are bounced through async layers, only the
  75          * initial synchronous phase should be accounted towards inode
  76          * cgroup ownership arbitration to avoid confusion.  Later stages
  77          * can set the following flag to disable the accounting.
  78          */
  79         unsigned no_cgroup_owner:1;
  80
  81 #ifdef CONFIG_CGROUP_WRITEBACK
  82         struct bdi_writeback *wb;       /* wb this writeback is issued under */
  83         struct inode *inode;            /* inode being written out */
  84
  85         /* foreign inode detection, see wbc_detach_inode() */
  86         int wb_id;                      /* current wb id */
  87         int wb_lcand_id;                /* last foreign candidate wb id */
  88         int wb_tcand_id;                /* this foreign candidate wb id */
  89         size_t wb_bytes;                /* bytes written by current wb */
  90         size_t wb_lcand_bytes;          /* bytes written by last candidate */
  91         size_t wb_tcand_bytes;          /* bytes written by this candidate */
  92 #endif
  93 };
  94
  95 static inline int wbc_to_write_flags(struct writeback_control *wbc)
  96 {
  97         if (wbc->sync_mode == WB_SYNC_ALL)
  98                 return REQ_SYNC;
  99         else if (wbc->for_kupdate || wbc->for_background)
 100                 return REQ_BACKGROUND;
 101
 102         return 0;
 103 }
 104
 105 static inline struct cgroup_subsys_state *
 106 wbc_blkcg_css(struct writeback_control *wbc)
 107 {
 108 #ifdef CONFIG_CGROUP_WRITEBACK
 109         if (wbc->wb)
 110                 return wbc->wb->blkcg_css;
 111 #endif
 112         return blkcg_root_css;
 113 }
 114
 115 /*
 116  * A wb_domain represents a domain that wb's (bdi_writeback's) belong to
 117  * and are measured against each other in.  There always is one global
 118  * domain, global_wb_domain, that every wb in the system is a member of.
 119  * This allows measuring the relative bandwidth of each wb to distribute
 120  * dirtyable memory accordingly.
 121  */
 122 struct wb_domain {
 123         spinlock_t lock;
 124
 125         /*
 126          * Scale the writeback cache size proportional to the relative
 127          * writeout speed.
 128          *
 129          * We do this by keeping a floating proportion between BDIs, based
 130          * on page writeback completions [end_page_writeback()]. Those
 131          * devices that write out pages fastest will get the larger share,
 132          * while the slower will get a smaller share.
 133          *
 134          * We use page writeout completions because we are interested in
 135          * getting rid of dirty pages. Having them written out is the
 136          * primary goal.
 137          *
 138          * We introduce a concept of time, a period over which we measure
 139          * these events, because demand can/will vary over time. The length
 140          * of this period itself is measured in page writeback completions.
 141          */
 142         struct fprop_global completions;
 143         struct timer_list period_timer; /* timer for aging of completions */
 144         unsigned long period_time;
 145
 146         /*
 147          * The dirtyable memory and dirty threshold could be suddenly
 148          * knocked down by a large amount (eg. on the startup of KVM in a
 149          * swapless system). This may throw the system into deep dirty
 150          * exceeded state and throttle heavy/light dirtiers alike. To
 151          * retain good responsiveness, maintain global_dirty_limit for
 152          * tracking slowly down to the knocked down dirty threshold.
 153          *
 154          * Both fields are protected by ->lock.
 155          */
 156         unsigned long dirty_limit_tstamp;
 157         unsigned long dirty_limit;
 158 };
 159
 160 /**
 161  * wb_domain_size_changed - memory available to a wb_domain has changed
 162  * @dom: wb_domain of interest
 163  *
 164  * This function should be called when the amount of memory available to
 165  * @dom has changed.  It resets @dom's dirty limit parameters to prevent
 166  * the past values which don't match the current configuration from skewing
 167  * dirty throttling.  Without this, when memory size of a wb_domain is
 168  * greatly reduced, the dirty throttling logic may allow too many pages to
 169  * be dirtied leading to consecutive unnecessary OOMs and may get stuck in
 170  * that situation.
 171  */
 172 static inline void wb_domain_size_changed(struct wb_domain *dom)
 173 {
 174         spin_lock(&dom->lock);
 175         dom->dirty_limit_tstamp = jiffies;
 176         dom->dirty_limit = 0;
 177         spin_unlock(&dom->lock);
 178 }
 179
 180 /*
 181  * fs/fs-writeback.c
 182  */
 183 struct bdi_writeback;
 184 void writeback_inodes_sb(struct super_block *, enum wb_reason reason);
 185 void writeback_inodes_sb_nr(struct super_block *, unsigned long nr,
 186                                                         enum wb_reason reason);
 187 void try_to_writeback_inodes_sb(struct super_block *sb, enum wb_reason reason);
 188 void sync_inodes_sb(struct super_block *);
 189 void wakeup_flusher_threads(enum wb_reason reason);
 190 void wakeup_flusher_threads_bdi(struct backing_dev_info *bdi,
 191                                 enum wb_reason reason);
 192 void inode_wait_for_writeback(struct inode *inode);
 193
 194 /* writeback.h requires fs.h; it, too, is not included from here. */
 195 static inline void wait_on_inode(struct inode *inode)
 196 {
 197         might_sleep();
 198         wait_on_bit(&inode->i_state, __I_NEW, TASK_UNINTERRUPTIBLE);
 199 }
 200
 201 #ifdef CONFIG_CGROUP_WRITEBACK
 202
 203 #include <linux/cgroup.h>
 204 #include <linux/bio.h>
 205
 206 void __inode_attach_wb(struct inode *inode, struct page *page);
 207 void wbc_attach_and_unlock_inode(struct writeback_control *wbc,
 208                                  struct inode *inode)
 209         __releases(&inode->i_lock);
 210 void wbc_detach_inode(struct writeback_control *wbc);
 211 void wbc_account_cgroup_owner(struct writeback_control *wbc, struct page *page,
 212                               size_t bytes);
 213 void cgroup_writeback_umount(void);
 214
 215 /**
 216  * inode_attach_wb - associate an inode with its wb
 217  * @inode: inode of interest
 218  * @page: page being dirtied (may be NULL)
 219  *
 220  * If @inode doesn't have its wb, associate it with the wb matching the
 221  * memcg of @page or, if @page is NULL, %current.  May be called w/ or w/o
 222  * @inode->i_lock.
 223  */
 224 static inline void inode_attach_wb(struct inode *inode, struct page *page)
 225 {
 226         if (!inode->i_wb)
 227                 __inode_attach_wb(inode, page);
 228 }
 229
 230 /**
 231  * inode_detach_wb - disassociate an inode from its wb
 232  * @inode: inode of interest
 233  *
 234  * @inode is being freed.  Detach from its wb.
 235  */
 236 static inline void inode_detach_wb(struct inode *inode)
 237 {
 238         if (inode->i_wb) {
 239                 WARN_ON_ONCE(!(inode->i_state & I_CLEAR));
 240                 wb_put(inode->i_wb);
 241                 inode->i_wb = NULL;
 242         }
 243 }
 244
 245 /**
 246  * wbc_attach_fdatawrite_inode - associate wbc and inode for fdatawrite
 247  * @wbc: writeback_control of interest
 248  * @inode: target inode
 249  *
 250  * This function is to be used by __filemap_fdatawrite_range(), which is an
 251  * alternative entry point into writeback code, and first ensures @inode is
 252  * associated with a bdi_writeback and attaches it to @wbc.
 253  */
 254 static inline void wbc_attach_fdatawrite_inode(struct writeback_control *wbc,
 255                                                struct inode *inode)
 256 {
 257         spin_lock(&inode->i_lock);
 258         inode_attach_wb(inode, NULL);
 259         wbc_attach_and_unlock_inode(wbc, inode);
 260 }
 261
 262 /**
 263  * wbc_init_bio - writeback specific initializtion of bio
 264  * @wbc: writeback_control for the writeback in progress
 265  * @bio: bio to be initialized
 266  *
 267  * @bio is a part of the writeback in progress controlled by @wbc.  Perform
 268  * writeback specific initialization.  This is used to apply the cgroup
 269  * writeback context.  Must be called after the bio has been associated with
 270  * a device.
 271  */
 272 static inline void wbc_init_bio(struct writeback_control *wbc, struct bio *bio)
 273 {
 274         /*
 275          * pageout() path doesn't attach @wbc to the inode being written
 276          * out.  This is intentional as we don't want the function to block
 277          * behind a slow cgroup.  Ultimately, we want pageout() to kick off
 278          * regular writeback instead of writing things out itself.
 279          */
 280         if (wbc->wb)
 281                 bio_associate_blkg_from_css(bio, wbc->wb->blkcg_css);
 282 }
 283
 284 #else   /* CONFIG_CGROUP_WRITEBACK */
 285
 286 static inline void inode_attach_wb(struct inode *inode, struct page *page)
 287 {
 288 }
 289
 290 static inline void inode_detach_wb(struct inode *inode)
 291 {
 292 }
 293
 294 static inline void wbc_attach_and_unlock_inode(struct writeback_control *wbc,
 295                                                struct inode *inode)
 296         __releases(&inode->i_lock)
 297 {
 298         spin_unlock(&inode->i_lock);
 299 }
 300
 301 static inline void wbc_attach_fdatawrite_inode(struct writeback_control *wbc,
 302                                                struct inode *inode)
 303 {
 304 }
 305
 306 static inline void wbc_detach_inode(struct writeback_control *wbc)
 307 {
 308 }
 309
 310 static inline void wbc_init_bio(struct writeback_control *wbc, struct bio *bio)
 311 {
 312 }
 313
 314 static inline void wbc_account_cgroup_owner(struct writeback_control *wbc,
 315                                             struct page *page, size_t bytes)
 316 {
 317 }
 318
 319 static inline void cgroup_writeback_umount(void)
 320 {
 321 }
 322
 323 #endif  /* CONFIG_CGROUP_WRITEBACK */
 324
 325 /*
 326  * mm/page-writeback.c
 327  */
 328 #ifdef CONFIG_BLOCK
 329 void laptop_io_completion(struct backing_dev_info *info);
 330 void laptop_sync_completion(void);
 331 void laptop_mode_sync(struct work_struct *work);
 332 void laptop_mode_timer_fn(struct timer_list *t);
 333 #else
 334 static inline void laptop_sync_completion(void) { }
 335 #endif
 336 bool node_dirty_ok(struct pglist_data *pgdat);
 337 int wb_domain_init(struct wb_domain *dom, gfp_t gfp);
 338 #ifdef CONFIG_CGROUP_WRITEBACK
 339 void wb_domain_exit(struct wb_domain *dom);
 340 #endif
 341
 342 extern struct wb_domain global_wb_domain;
 343
 344 /* These are exported to sysctl. */
 345 extern int dirty_background_ratio;
 346 extern unsigned long dirty_background_bytes;
 347 extern int vm_dirty_ratio;
 348 extern unsigned long vm_dirty_bytes;
 349 extern unsigned int dirty_writeback_interval;
 350 extern unsigned int dirty_expire_interval;
 351 extern unsigned int dirtytime_expire_interval;
 352 extern int vm_highmem_is_dirtyable;
 353 extern int block_dump;
 354 extern int laptop_mode;
 355
 356 extern int dirty_background_ratio_handler(struct ctl_table *table, int write,
 357                 void __user *buffer, size_t *lenp,
 358                 loff_t *ppos);
 359 extern int dirty_background_bytes_handler(struct ctl_table *table, int write,
 360                 void __user *buffer, size_t *lenp,
 361                 loff_t *ppos);
 362 extern int dirty_ratio_handler(struct ctl_table *table, int write,
 363                 void __user *buffer, size_t *lenp,
 364                 loff_t *ppos);
 365 extern int dirty_bytes_handler(struct ctl_table *table, int write,
 366                 void __user *buffer, size_t *lenp,
 367                 loff_t *ppos);
 368 int dirtytime_interval_handler(struct ctl_table *table, int write,
 369                                void __user *buffer, size_t *lenp, loff_t *ppos);
 370
 371 struct ctl_table;
 372 int dirty_writeback_centisecs_handler(struct ctl_table *, int,
 373                                       void __user *, size_t *, loff_t *);
 374
 375 void global_dirty_limits(unsigned long *pbackground, unsigned long *pdirty);
 376 unsigned long wb_calc_thresh(struct bdi_writeback *wb, unsigned long thresh);
 377
 378 void wb_update_bandwidth(struct bdi_writeback *wb, unsigned long start_time);
 379 void balance_dirty_pages_ratelimited(struct address_space *mapping);
 380 bool wb_over_bg_thresh(struct bdi_writeback *wb);
 381
 382 typedef int (*writepage_t)(struct page *page, struct writeback_control *wbc,
 383                                 void *data);
 384
 385 int generic_writepages(struct address_space *mapping,
 386                        struct writeback_control *wbc);
 387 void tag_pages_for_writeback(struct address_space *mapping,
 388                              pgoff_t start, pgoff_t end);
 389 int write_cache_pages(struct address_space *mapping,
 390                       struct writeback_control *wbc, writepage_t writepage,
 391                       void *data);
 392 int do_writepages(struct address_space *mapping, struct writeback_control *wbc);
 393 void writeback_set_ratelimit(void);
 394 void tag_pages_for_writeback(struct address_space *mapping,
 395                              pgoff_t start, pgoff_t end);
 396
 397 void account_page_redirty(struct page *page);
 398
 399 void sb_mark_inode_writeback(struct inode *inode);
 400 void sb_clear_inode_writeback(struct inode *inode);
 401
 402 #endif          /* WRITEBACK_H */