fs/sync.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * High-level sync()-related operations
   4  */
   5
   6 #include <linux/kernel.h>
   7 #include <linux/file.h>
   8 #include <linux/fs.h>
   9 #include <linux/slab.h>
  10 #include <linux/export.h>
  11 #include <linux/namei.h>
  12 #include <linux/sched.h>
  13 #include <linux/writeback.h>
  14 #include <linux/syscalls.h>
  15 #include <linux/linkage.h>
  16 #include <linux/pagemap.h>
  17 #include <linux/quotaops.h>
  18 #include <linux/backing-dev.h>
  19 #include "internal.h"
  20
  21 #define VALID_FLAGS (SYNC_FILE_RANGE_WAIT_BEFORE|SYNC_FILE_RANGE_WRITE| \
  22                         SYNC_FILE_RANGE_WAIT_AFTER)
  23
  24 /*
  25  * Write out and wait upon all dirty data associated with this
  26  * superblock.  Filesystem data as well as the underlying block
  27  * device.  Takes the superblock lock.
  28  */
  29 int sync_filesystem(struct super_block *sb)
  30 {
  31         int ret = 0;
  32
  33         /*
  34          * We need to be protected against the filesystem going from
  35          * r/o to r/w or vice versa.
  36          */
  37         WARN_ON(!rwsem_is_locked(&sb->s_umount));
  38
  39         /*
  40          * No point in syncing out anything if the filesystem is read-only.
  41          */
  42         if (sb_rdonly(sb))
  43                 return 0;
  44
  45         /*
  46          * Do the filesystem syncing work.  For simple filesystems
  47          * writeback_inodes_sb(sb) just dirties buffers with inodes so we have
  48          * to submit I/O for these buffers via __sync_blockdev().  This also
  49          * speeds up the wait == 1 case since in that case write_inode()
  50          * methods call sync_dirty_buffer() and thus effectively write one block
  51          * at a time.
  52          */
  53         writeback_inodes_sb(sb, WB_REASON_SYNC);
  54         if (sb->s_op->sync_fs) {
  55                 ret = sb->s_op->sync_fs(sb, 0);
  56                 if (ret)
  57                         return ret;
  58         }
  59         ret = __sync_blockdev(sb->s_bdev, 0);
  60         if (ret)
  61                 return ret;
  62
  63         sync_inodes_sb(sb);
  64         if (sb->s_op->sync_fs) {
  65                 ret = sb->s_op->sync_fs(sb, 1);
  66                 if (ret)
  67                         return ret;
  68         }
  69         return __sync_blockdev(sb->s_bdev, 1);
  70 }
  71 EXPORT_SYMBOL(sync_filesystem);
  72
  73 static void sync_inodes_one_sb(struct super_block *sb, void *arg)
  74 {
  75         if (!sb_rdonly(sb))
  76                 sync_inodes_sb(sb);
  77 }
  78
  79 static void sync_fs_one_sb(struct super_block *sb, void *arg)
  80 {
  81         if (!sb_rdonly(sb) && !(sb->s_iflags & SB_I_SKIP_SYNC) &&
  82             sb->s_op->sync_fs)
  83                 sb->s_op->sync_fs(sb, *(int *)arg);
  84 }
  85
  86 static void fdatawrite_one_bdev(struct block_device *bdev, void *arg)
  87 {
  88         filemap_fdatawrite(bdev->bd_inode->i_mapping);
  89 }
  90
  91 static void fdatawait_one_bdev(struct block_device *bdev, void *arg)
  92 {
  93         /*
  94          * We keep the error status of individual mapping so that
  95          * applications can catch the writeback error using fsync(2).
  96          * See filemap_fdatawait_keep_errors() for details.
  97          */
  98         filemap_fdatawait_keep_errors(bdev->bd_inode->i_mapping);
  99 }
 100
 101 /*
 102  * Sync everything. We start by waking flusher threads so that most of
 103  * writeback runs on all devices in parallel. Then we sync all inodes reliably
 104  * which effectively also waits for all flusher threads to finish doing
 105  * writeback. At this point all data is on disk so metadata should be stable
 106  * and we tell filesystems to sync their metadata via ->sync_fs() calls.
 107  * Finally, we writeout all block devices because some filesystems (e.g. ext2)
 108  * just write metadata (such as inodes or bitmaps) to block device page cache
 109  * and do not sync it on their own in ->sync_fs().
 110  */
 111 void ksys_sync(void)
 112 {
 113         int nowait = 0, wait = 1;
 114
 115         wakeup_flusher_threads(WB_REASON_SYNC);
 116         iterate_supers(sync_inodes_one_sb, NULL);
 117         iterate_supers(sync_fs_one_sb, &nowait);
 118         iterate_supers(sync_fs_one_sb, &wait);
 119         iterate_bdevs(fdatawrite_one_bdev, NULL);
 120         iterate_bdevs(fdatawait_one_bdev, NULL);
 121         if (unlikely(laptop_mode))
 122                 laptop_sync_completion();
 123 }
 124
 125 SYSCALL_DEFINE0(sync)
 126 {
 127         ksys_sync();
 128         return 0;
 129 }
 130
 131 static void do_sync_work(struct work_struct *work)
 132 {
 133         int nowait = 0;
 134
 135         /*
 136          * Sync twice to reduce the possibility we skipped some inodes / pages
 137          * because they were temporarily locked
 138          */
 139         iterate_supers(sync_inodes_one_sb, &nowait);
 140         iterate_supers(sync_fs_one_sb, &nowait);
 141         iterate_bdevs(fdatawrite_one_bdev, NULL);
 142         iterate_supers(sync_inodes_one_sb, &nowait);
 143         iterate_supers(sync_fs_one_sb, &nowait);
 144         iterate_bdevs(fdatawrite_one_bdev, NULL);
 145         printk("Emergency Sync complete\n");
 146         kfree(work);
 147 }
 148
 149 void emergency_sync(void)
 150 {
 151         struct work_struct *work;
 152
 153         work = kmalloc(sizeof(*work), GFP_ATOMIC);
 154         if (work) {
 155                 INIT_WORK(work, do_sync_work);
 156                 schedule_work(work);
 157         }
 158 }
 159
 160 /*
 161  * sync a single super
 162  */
 163 SYSCALL_DEFINE1(syncfs, int, fd)
 164 {
 165         struct fd f = fdget(fd);
 166         struct super_block *sb;
 167         int ret, ret2;
 168
 169         if (!f.file)
 170                 return -EBADF;
 171         sb = f.file->f_path.dentry->d_sb;
 172
 173         down_read(&sb->s_umount);
 174         ret = sync_filesystem(sb);
 175         up_read(&sb->s_umount);
 176
 177         ret2 = errseq_check_and_advance(&sb->s_wb_err, &f.file->f_sb_err);
 178
 179         fdput(f);
 180         return ret ? ret : ret2;
 181 }
 182
 183 /**
 184  * vfs_fsync_range - helper to sync a range of data & metadata to disk
 185  * @file:               file to sync
 186  * @start:              offset in bytes of the beginning of data range to sync
 187  * @end:                offset in bytes of the end of data range (inclusive)
 188  * @datasync:           perform only datasync
 189  *
 190  * Write back data in range @start..@end and metadata for @file to disk.  If
 191  * @datasync is set only metadata needed to access modified file data is
 192  * written.
 193  */
 194 int vfs_fsync_range(struct file *file, loff_t start, loff_t end, int datasync)
 195 {
 196         struct inode *inode = file->f_mapping->host;
 197
 198         if (!file->f_op->fsync)
 199                 return -EINVAL;
 200         if (!datasync && (inode->i_state & I_DIRTY_TIME))
 201                 mark_inode_dirty_sync(inode);
 202         return file->f_op->fsync(file, start, end, datasync);
 203 }
 204 EXPORT_SYMBOL(vfs_fsync_range);
 205
 206 /**
 207  * vfs_fsync - perform a fsync or fdatasync on a file
 208  * @file:               file to sync
 209  * @datasync:           only perform a fdatasync operation
 210  *
 211  * Write back data and metadata for @file to disk.  If @datasync is
 212  * set only metadata needed to access modified file data is written.
 213  */
 214 int vfs_fsync(struct file *file, int datasync)
 215 {
 216         return vfs_fsync_range(file, 0, LLONG_MAX, datasync);
 217 }
 218 EXPORT_SYMBOL(vfs_fsync);
 219
 220 static int do_fsync(unsigned int fd, int datasync)
 221 {
 222         struct fd f = fdget(fd);
 223         int ret = -EBADF;
 224
 225         if (f.file) {
 226                 ret = vfs_fsync(f.file, datasync);
 227                 fdput(f);
 228         }
 229         return ret;
 230 }
 231
 232 SYSCALL_DEFINE1(fsync, unsigned int, fd)
 233 {
 234         return do_fsync(fd, 0);
 235 }
 236
 237 SYSCALL_DEFINE1(fdatasync, unsigned int, fd)
 238 {
 239         return do_fsync(fd, 1);
 240 }
 241
 242 int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
 243                     unsigned int flags)
 244 {
 245         int ret;
 246         struct address_space *mapping;
 247         loff_t endbyte;                 /* inclusive */
 248         umode_t i_mode;
 249
 250         ret = -EINVAL;
 251         if (flags & ~VALID_FLAGS)
 252                 goto out;
 253
 254         endbyte = offset + nbytes;
 255
 256         if ((s64)offset < 0)
 257                 goto out;
 258         if ((s64)endbyte < 0)
 259                 goto out;
 260         if (endbyte < offset)
 261                 goto out;
 262
 263         if (sizeof(pgoff_t) == 4) {
 264                 if (offset >= (0x100000000ULL << PAGE_SHIFT)) {
 265                         /*
 266                          * The range starts outside a 32 bit machine's
 267                          * pagecache addressing capabilities.  Let it "succeed"
 268                          */
 269                         ret = 0;
 270                         goto out;
 271                 }
 272                 if (endbyte >= (0x100000000ULL << PAGE_SHIFT)) {
 273                         /*
 274                          * Out to EOF
 275                          */
 276                         nbytes = 0;
 277                 }
 278         }
 279
 280         if (nbytes == 0)
 281                 endbyte = LLONG_MAX;
 282         else
 283                 endbyte--;              /* inclusive */
 284
 285         i_mode = file_inode(file)->i_mode;
 286         ret = -ESPIPE;
 287         if (!S_ISREG(i_mode) && !S_ISBLK(i_mode) && !S_ISDIR(i_mode) &&
 288                         !S_ISLNK(i_mode))
 289                 goto out;
 290
 291         mapping = file->f_mapping;
 292         ret = 0;
 293         if (flags & SYNC_FILE_RANGE_WAIT_BEFORE) {
 294                 ret = file_fdatawait_range(file, offset, endbyte);
 295                 if (ret < 0)
 296                         goto out;
 297         }
 298
 299         if (flags & SYNC_FILE_RANGE_WRITE) {
 300                 int sync_mode = WB_SYNC_NONE;
 301
 302                 if ((flags & SYNC_FILE_RANGE_WRITE_AND_WAIT) ==
 303                              SYNC_FILE_RANGE_WRITE_AND_WAIT)
 304                         sync_mode = WB_SYNC_ALL;
 305
 306                 ret = __filemap_fdatawrite_range(mapping, offset, endbyte,
 307                                                  sync_mode);
 308                 if (ret < 0)
 309                         goto out;
 310         }
 311
 312         if (flags & SYNC_FILE_RANGE_WAIT_AFTER)
 313                 ret = file_fdatawait_range(file, offset, endbyte);
 314
 315 out:
 316         return ret;
 317 }
 318
 319 /*
 320  * ksys_sync_file_range() permits finely controlled syncing over a segment of
 321  * a file in the range offset .. (offset+nbytes-1) inclusive.  If nbytes is
 322  * zero then ksys_sync_file_range() will operate from offset out to EOF.
 323  *
 324  * The flag bits are:
 325  *
 326  * SYNC_FILE_RANGE_WAIT_BEFORE: wait upon writeout of all pages in the range
 327  * before performing the write.
 328  *
 329  * SYNC_FILE_RANGE_WRITE: initiate writeout of all those dirty pages in the
 330  * range which are not presently under writeback. Note that this may block for
 331  * significant periods due to exhaustion of disk request structures.
 332  *
 333  * SYNC_FILE_RANGE_WAIT_AFTER: wait upon writeout of all pages in the range
 334  * after performing the write.
 335  *
 336  * Useful combinations of the flag bits are:
 337  *
 338  * SYNC_FILE_RANGE_WAIT_BEFORE|SYNC_FILE_RANGE_WRITE: ensures that all pages
 339  * in the range which were dirty on entry to ksys_sync_file_range() are placed
 340  * under writeout.  This is a start-write-for-data-integrity operation.
 341  *
 342  * SYNC_FILE_RANGE_WRITE: start writeout of all dirty pages in the range which
 343  * are not presently under writeout.  This is an asynchronous flush-to-disk
 344  * operation.  Not suitable for data integrity operations.
 345  *
 346  * SYNC_FILE_RANGE_WAIT_BEFORE (or SYNC_FILE_RANGE_WAIT_AFTER): wait for
 347  * completion of writeout of all pages in the range.  This will be used after an
 348  * earlier SYNC_FILE_RANGE_WAIT_BEFORE|SYNC_FILE_RANGE_WRITE operation to wait
 349  * for that operation to complete and to return the result.
 350  *
 351  * SYNC_FILE_RANGE_WAIT_BEFORE|SYNC_FILE_RANGE_WRITE|SYNC_FILE_RANGE_WAIT_AFTER
 352  * (a.k.a. SYNC_FILE_RANGE_WRITE_AND_WAIT):
 353  * a traditional sync() operation.  This is a write-for-data-integrity operation
 354  * which will ensure that all pages in the range which were dirty on entry to
 355  * ksys_sync_file_range() are written to disk.  It should be noted that disk
 356  * caches are not flushed by this call, so there are no guarantees here that the
 357  * data will be available on disk after a crash.
 358  *
 359  *
 360  * SYNC_FILE_RANGE_WAIT_BEFORE and SYNC_FILE_RANGE_WAIT_AFTER will detect any
 361  * I/O errors or ENOSPC conditions and will return those to the caller, after
 362  * clearing the EIO and ENOSPC flags in the address_space.
 363  *
 364  * It should be noted that none of these operations write out the file's
 365  * metadata.  So unless the application is strictly performing overwrites of
 366  * already-instantiated disk blocks, there are no guarantees here that the data
 367  * will be available after a crash.
 368  */
 369 int ksys_sync_file_range(int fd, loff_t offset, loff_t nbytes,
 370                          unsigned int flags)
 371 {
 372         int ret;
 373         struct fd f;
 374
 375         ret = -EBADF;
 376         f = fdget(fd);
 377         if (f.file)
 378                 ret = sync_file_range(f.file, offset, nbytes, flags);
 379
 380         fdput(f);
 381         return ret;
 382 }
 383
 384 SYSCALL_DEFINE4(sync_file_range, int, fd, loff_t, offset, loff_t, nbytes,
 385                                 unsigned int, flags)
 386 {
 387         return ksys_sync_file_range(fd, offset, nbytes, flags);
 388 }
 389
 390 /* It would be nice if people remember that not all the world's an i386
 391    when they introduce new system calls */
 392 SYSCALL_DEFINE4(sync_file_range2, int, fd, unsigned int, flags,
 393                                  loff_t, offset, loff_t, nbytes)
 394 {
 395         return ksys_sync_file_range(fd, offset, nbytes, flags);
 396 }