1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 1992, 1993, 1994, 1995
7 * Laboratoire MASI - Institut Blaise Pascal
8 * Universite Pierre et Marie Curie (Paris VI)
12 * linux/fs/minix/file.c
14 * Copyright (C) 1991, 1992 Linus Torvalds
16 * ext4 fs regular file handling primitives
18 * 64-bit file support on 64-bit platforms by Jakub Jelinek
22 #include <linux/time.h>
24 #include <linux/iomap.h>
25 #include <linux/mount.h>
26 #include <linux/path.h>
27 #include <linux/dax.h>
28 #include <linux/quotaops.h>
29 #include <linux/pagevec.h>
30 #include <linux/uio.h>
31 #include <linux/mman.h>
32 #include <linux/backing-dev.h>
34 #include "ext4_jbd2.h"
39 static bool ext4_dio_supported(struct inode *inode)
41 if (IS_ENABLED(CONFIG_FS_ENCRYPTION) && IS_ENCRYPTED(inode))
43 if (fsverity_active(inode))
45 if (ext4_should_journal_data(inode))
47 if (ext4_has_inline_data(inode))
52 static ssize_t ext4_dio_read_iter(struct kiocb *iocb, struct iov_iter *to)
55 struct inode *inode = file_inode(iocb->ki_filp);
57 if (iocb->ki_flags & IOCB_NOWAIT) {
58 if (!inode_trylock_shared(inode))
61 inode_lock_shared(inode);
64 if (!ext4_dio_supported(inode)) {
65 inode_unlock_shared(inode);
67 * Fallback to buffered I/O if the operation being performed on
68 * the inode is not supported by direct I/O. The IOCB_DIRECT
69 * flag needs to be cleared here in order to ensure that the
70 * direct I/O path within generic_file_read_iter() is not
73 iocb->ki_flags &= ~IOCB_DIRECT;
74 return generic_file_read_iter(iocb, to);
77 ret = iomap_dio_rw(iocb, to, &ext4_iomap_ops, NULL,
79 inode_unlock_shared(inode);
81 file_accessed(iocb->ki_filp);
86 static ssize_t ext4_dax_read_iter(struct kiocb *iocb, struct iov_iter *to)
88 struct inode *inode = file_inode(iocb->ki_filp);
91 if (iocb->ki_flags & IOCB_NOWAIT) {
92 if (!inode_trylock_shared(inode))
95 inode_lock_shared(inode);
98 * Recheck under inode lock - at this point we are sure it cannot
101 if (!IS_DAX(inode)) {
102 inode_unlock_shared(inode);
103 /* Fallback to buffered IO in case we cannot support DAX */
104 return generic_file_read_iter(iocb, to);
106 ret = dax_iomap_rw(iocb, to, &ext4_iomap_ops);
107 inode_unlock_shared(inode);
109 file_accessed(iocb->ki_filp);
114 static ssize_t ext4_file_read_iter(struct kiocb *iocb, struct iov_iter *to)
116 struct inode *inode = file_inode(iocb->ki_filp);
118 if (unlikely(ext4_forced_shutdown(EXT4_SB(inode->i_sb))))
121 if (!iov_iter_count(to))
122 return 0; /* skip atime */
126 return ext4_dax_read_iter(iocb, to);
128 if (iocb->ki_flags & IOCB_DIRECT)
129 return ext4_dio_read_iter(iocb, to);
131 return generic_file_read_iter(iocb, to);
135 * Called when an inode is released. Note that this is different
136 * from ext4_file_open: open gets called at every open, but release
137 * gets called only when /all/ the files are closed.
139 static int ext4_release_file(struct inode *inode, struct file *filp)
141 if (ext4_test_inode_state(inode, EXT4_STATE_DA_ALLOC_CLOSE)) {
142 ext4_alloc_da_blocks(inode);
143 ext4_clear_inode_state(inode, EXT4_STATE_DA_ALLOC_CLOSE);
145 /* if we are the last writer on the inode, drop the block reservation */
146 if ((filp->f_mode & FMODE_WRITE) &&
147 (atomic_read(&inode->i_writecount) == 1) &&
148 !EXT4_I(inode)->i_reserved_data_blocks) {
149 down_write(&EXT4_I(inode)->i_data_sem);
150 ext4_discard_preallocations(inode, 0);
151 up_write(&EXT4_I(inode)->i_data_sem);
153 if (is_dx(inode) && filp->private_data)
154 ext4_htree_free_dir_info(filp->private_data);
160 * This tests whether the IO in question is block-aligned or not.
161 * Ext4 utilizes unwritten extents when hole-filling during direct IO, and they
162 * are converted to written only after the IO is complete. Until they are
163 * mapped, these blocks appear as holes, so dio_zero_block() will assume that
164 * it needs to zero out portions of the start and/or end block. If 2 AIO
165 * threads are at work on the same unwritten block, they must be synchronized
166 * or one thread will zero the other's data, causing corruption.
169 ext4_unaligned_io(struct inode *inode, struct iov_iter *from, loff_t pos)
171 struct super_block *sb = inode->i_sb;
172 unsigned long blockmask = sb->s_blocksize - 1;
174 if ((pos | iov_iter_alignment(from)) & blockmask)
181 ext4_extending_io(struct inode *inode, loff_t offset, size_t len)
183 if (offset + len > i_size_read(inode) ||
184 offset + len > EXT4_I(inode)->i_disksize)
189 /* Is IO overwriting allocated and initialized blocks? */
190 static bool ext4_overwrite_io(struct inode *inode, loff_t pos, loff_t len)
192 struct ext4_map_blocks map;
193 unsigned int blkbits = inode->i_blkbits;
196 if (pos + len > i_size_read(inode))
199 map.m_lblk = pos >> blkbits;
200 map.m_len = EXT4_MAX_BLOCKS(len, pos, blkbits);
203 err = ext4_map_blocks(NULL, inode, &map, 0);
205 * 'err==len' means that all of the blocks have been preallocated,
206 * regardless of whether they have been initialized or not. To exclude
207 * unwritten extents, we need to check m_flags.
209 return err == blklen && (map.m_flags & EXT4_MAP_MAPPED);
212 static ssize_t ext4_generic_write_checks(struct kiocb *iocb,
213 struct iov_iter *from)
215 struct inode *inode = file_inode(iocb->ki_filp);
218 if (unlikely(IS_IMMUTABLE(inode)))
221 ret = generic_write_checks(iocb, from);
226 * If we have encountered a bitmap-format file, the size limit
227 * is smaller than s_maxbytes, which is for extent-mapped files.
229 if (!(ext4_test_inode_flag(inode, EXT4_INODE_EXTENTS))) {
230 struct ext4_sb_info *sbi = EXT4_SB(inode->i_sb);
232 if (iocb->ki_pos >= sbi->s_bitmap_maxbytes)
234 iov_iter_truncate(from, sbi->s_bitmap_maxbytes - iocb->ki_pos);
237 return iov_iter_count(from);
240 static ssize_t ext4_write_checks(struct kiocb *iocb, struct iov_iter *from)
244 count = ext4_generic_write_checks(iocb, from);
248 ret = file_modified(iocb->ki_filp);
254 static ssize_t ext4_buffered_write_iter(struct kiocb *iocb,
255 struct iov_iter *from)
258 struct inode *inode = file_inode(iocb->ki_filp);
260 if (iocb->ki_flags & IOCB_NOWAIT)
264 ret = ext4_write_checks(iocb, from);
268 current->backing_dev_info = inode_to_bdi(inode);
269 ret = generic_perform_write(iocb->ki_filp, from, iocb->ki_pos);
270 current->backing_dev_info = NULL;
274 if (likely(ret > 0)) {
276 ret = generic_write_sync(iocb, ret);
282 static ssize_t ext4_handle_inode_extension(struct inode *inode, loff_t offset,
283 ssize_t written, size_t count)
286 bool truncate = false;
287 u8 blkbits = inode->i_blkbits;
288 ext4_lblk_t written_blk, end_blk;
292 * Note that EXT4_I(inode)->i_disksize can get extended up to
293 * inode->i_size while the I/O was running due to writeback of delalloc
294 * blocks. But, the code in ext4_iomap_alloc() is careful to use
295 * zeroed/unwritten extents if this is possible; thus we won't leave
296 * uninitialized blocks in a file even if we didn't succeed in writing
297 * as much as we intended.
299 WARN_ON_ONCE(i_size_read(inode) < EXT4_I(inode)->i_disksize);
300 if (offset + count <= EXT4_I(inode)->i_disksize) {
302 * We need to ensure that the inode is removed from the orphan
303 * list if it has been added prematurely, due to writeback of
306 if (!list_empty(&EXT4_I(inode)->i_orphan) && inode->i_nlink) {
307 handle = ext4_journal_start(inode, EXT4_HT_INODE, 2);
309 if (IS_ERR(handle)) {
310 ext4_orphan_del(NULL, inode);
311 return PTR_ERR(handle);
314 ext4_orphan_del(handle, inode);
315 ext4_journal_stop(handle);
324 handle = ext4_journal_start(inode, EXT4_HT_INODE, 2);
325 if (IS_ERR(handle)) {
326 written = PTR_ERR(handle);
330 if (ext4_update_inode_size(inode, offset + written)) {
331 ret = ext4_mark_inode_dirty(handle, inode);
334 ext4_journal_stop(handle);
340 * We may need to truncate allocated but not written blocks beyond EOF.
342 written_blk = ALIGN(offset + written, 1 << blkbits);
343 end_blk = ALIGN(offset + count, 1 << blkbits);
344 if (written_blk < end_blk && ext4_can_truncate(inode))
348 * Remove the inode from the orphan list if it has been extended and
349 * everything went OK.
351 if (!truncate && inode->i_nlink)
352 ext4_orphan_del(handle, inode);
353 ext4_journal_stop(handle);
357 ext4_truncate_failed_write(inode);
359 * If the truncate operation failed early, then the inode may
360 * still be on the orphan list. In that case, we need to try
361 * remove the inode from the in-memory linked list.
364 ext4_orphan_del(NULL, inode);
370 static int ext4_dio_write_end_io(struct kiocb *iocb, ssize_t size,
371 int error, unsigned int flags)
373 loff_t offset = iocb->ki_pos;
374 struct inode *inode = file_inode(iocb->ki_filp);
379 if (size && flags & IOMAP_DIO_UNWRITTEN)
380 return ext4_convert_unwritten_extents(NULL, inode,
386 static const struct iomap_dio_ops ext4_dio_write_ops = {
387 .end_io = ext4_dio_write_end_io,
391 * The intention here is to start with shared lock acquired then see if any
392 * condition requires an exclusive inode lock. If yes, then we restart the
393 * whole operation by releasing the shared lock and acquiring exclusive lock.
395 * - For unaligned_io we never take shared lock as it may cause data corruption
396 * when two unaligned IO tries to modify the same block e.g. while zeroing.
398 * - For extending writes case we don't take the shared lock, since it requires
399 * updating inode i_disksize and/or orphan handling with exclusive lock.
401 * - shared locking will only be true mostly with overwrites. Otherwise we will
402 * switch to exclusive i_rwsem lock.
404 static ssize_t ext4_dio_write_checks(struct kiocb *iocb, struct iov_iter *from,
405 bool *ilock_shared, bool *extend)
407 struct file *file = iocb->ki_filp;
408 struct inode *inode = file_inode(file);
414 ret = ext4_generic_write_checks(iocb, from);
418 offset = iocb->ki_pos;
420 if (ext4_extending_io(inode, offset, count))
423 * Determine whether the IO operation will overwrite allocated
424 * and initialized blocks.
425 * We need exclusive i_rwsem for changing security info
426 * in file_modified().
428 if (*ilock_shared && (!IS_NOSEC(inode) || *extend ||
429 !ext4_overwrite_io(inode, offset, count))) {
430 if (iocb->ki_flags & IOCB_NOWAIT) {
434 inode_unlock_shared(inode);
435 *ilock_shared = false;
440 ret = file_modified(file);
447 inode_unlock_shared(inode);
453 static ssize_t ext4_dio_write_iter(struct kiocb *iocb, struct iov_iter *from)
457 struct inode *inode = file_inode(iocb->ki_filp);
458 loff_t offset = iocb->ki_pos;
459 size_t count = iov_iter_count(from);
460 const struct iomap_ops *iomap_ops = &ext4_iomap_ops;
461 bool extend = false, unaligned_io = false;
462 bool ilock_shared = true;
465 * We initially start with shared inode lock unless it is
466 * unaligned IO which needs exclusive lock anyways.
468 if (ext4_unaligned_io(inode, from, offset)) {
470 ilock_shared = false;
473 * Quick check here without any i_rwsem lock to see if it is extending
474 * IO. A more reliable check is done in ext4_dio_write_checks() with
475 * proper locking in place.
477 if (offset + count > i_size_read(inode))
478 ilock_shared = false;
480 if (iocb->ki_flags & IOCB_NOWAIT) {
482 if (!inode_trylock_shared(inode))
485 if (!inode_trylock(inode))
490 inode_lock_shared(inode);
495 /* Fallback to buffered I/O if the inode does not support direct I/O. */
496 if (!ext4_dio_supported(inode)) {
498 inode_unlock_shared(inode);
501 return ext4_buffered_write_iter(iocb, from);
504 ret = ext4_dio_write_checks(iocb, from, &ilock_shared, &extend);
508 /* if we're going to block and IOCB_NOWAIT is set, return -EAGAIN */
509 if ((iocb->ki_flags & IOCB_NOWAIT) && (unaligned_io || extend)) {
514 offset = iocb->ki_pos;
518 * Unaligned direct IO must be serialized among each other as zeroing
519 * of partial blocks of two competing unaligned IOs can result in data
522 * So we make sure we don't allow any unaligned IO in flight.
523 * For IOs where we need not wait (like unaligned non-AIO DIO),
524 * below inode_dio_wait() may anyway become a no-op, since we start
525 * with exclusive lock.
528 inode_dio_wait(inode);
531 handle = ext4_journal_start(inode, EXT4_HT_INODE, 2);
532 if (IS_ERR(handle)) {
533 ret = PTR_ERR(handle);
537 ret = ext4_orphan_add(handle, inode);
539 ext4_journal_stop(handle);
543 ext4_journal_stop(handle);
547 iomap_ops = &ext4_iomap_overwrite_ops;
548 ret = iomap_dio_rw(iocb, from, iomap_ops, &ext4_dio_write_ops,
549 is_sync_kiocb(iocb) || unaligned_io || extend);
552 ret = ext4_handle_inode_extension(inode, offset, ret, count);
556 inode_unlock_shared(inode);
560 if (ret >= 0 && iov_iter_count(from)) {
564 offset = iocb->ki_pos;
565 err = ext4_buffered_write_iter(iocb, from);
570 * We need to ensure that the pages within the page cache for
571 * the range covered by this I/O are written to disk and
572 * invalidated. This is in attempt to preserve the expected
573 * direct I/O semantics in the case we fallback to buffered I/O
574 * to complete off the I/O request.
577 endbyte = offset + err - 1;
578 err = filemap_write_and_wait_range(iocb->ki_filp->f_mapping,
581 invalidate_mapping_pages(iocb->ki_filp->f_mapping,
582 offset >> PAGE_SHIFT,
583 endbyte >> PAGE_SHIFT);
591 ext4_dax_write_iter(struct kiocb *iocb, struct iov_iter *from)
598 struct inode *inode = file_inode(iocb->ki_filp);
600 if (iocb->ki_flags & IOCB_NOWAIT) {
601 if (!inode_trylock(inode))
607 ret = ext4_write_checks(iocb, from);
611 offset = iocb->ki_pos;
612 count = iov_iter_count(from);
614 if (offset + count > EXT4_I(inode)->i_disksize) {
615 handle = ext4_journal_start(inode, EXT4_HT_INODE, 2);
616 if (IS_ERR(handle)) {
617 ret = PTR_ERR(handle);
621 ret = ext4_orphan_add(handle, inode);
623 ext4_journal_stop(handle);
628 ext4_journal_stop(handle);
631 ret = dax_iomap_rw(iocb, from, &ext4_iomap_ops);
634 ret = ext4_handle_inode_extension(inode, offset, ret, count);
638 ret = generic_write_sync(iocb, ret);
644 ext4_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
646 struct inode *inode = file_inode(iocb->ki_filp);
648 if (unlikely(ext4_forced_shutdown(EXT4_SB(inode->i_sb))))
653 return ext4_dax_write_iter(iocb, from);
655 if (iocb->ki_flags & IOCB_DIRECT)
656 return ext4_dio_write_iter(iocb, from);
658 return ext4_buffered_write_iter(iocb, from);
662 static vm_fault_t ext4_dax_huge_fault(struct vm_fault *vmf,
663 enum page_entry_size pe_size)
668 handle_t *handle = NULL;
669 struct inode *inode = file_inode(vmf->vma->vm_file);
670 struct super_block *sb = inode->i_sb;
673 * We have to distinguish real writes from writes which will result in a
674 * COW page; COW writes should *not* poke the journal (the file will not
675 * be changed). Doing so would cause unintended failures when mounted
678 * We check for VM_SHARED rather than vmf->cow_page since the latter is
679 * unset for pe_size != PE_SIZE_PTE (i.e. only in do_cow_fault); for
680 * other sizes, dax_iomap_fault will handle splitting / fallback so that
681 * we eventually come back with a COW page.
683 bool write = (vmf->flags & FAULT_FLAG_WRITE) &&
684 (vmf->vma->vm_flags & VM_SHARED);
688 sb_start_pagefault(sb);
689 file_update_time(vmf->vma->vm_file);
690 down_read(&EXT4_I(inode)->i_mmap_sem);
692 handle = ext4_journal_start_sb(sb, EXT4_HT_WRITE_PAGE,
693 EXT4_DATA_TRANS_BLOCKS(sb));
694 if (IS_ERR(handle)) {
695 up_read(&EXT4_I(inode)->i_mmap_sem);
696 sb_end_pagefault(sb);
697 return VM_FAULT_SIGBUS;
700 down_read(&EXT4_I(inode)->i_mmap_sem);
702 result = dax_iomap_fault(vmf, pe_size, &pfn, &error, &ext4_iomap_ops);
704 ext4_journal_stop(handle);
706 if ((result & VM_FAULT_ERROR) && error == -ENOSPC &&
707 ext4_should_retry_alloc(sb, &retries))
709 /* Handling synchronous page fault? */
710 if (result & VM_FAULT_NEEDDSYNC)
711 result = dax_finish_sync_fault(vmf, pe_size, pfn);
712 up_read(&EXT4_I(inode)->i_mmap_sem);
713 sb_end_pagefault(sb);
715 up_read(&EXT4_I(inode)->i_mmap_sem);
721 static vm_fault_t ext4_dax_fault(struct vm_fault *vmf)
723 return ext4_dax_huge_fault(vmf, PE_SIZE_PTE);
726 static const struct vm_operations_struct ext4_dax_vm_ops = {
727 .fault = ext4_dax_fault,
728 .huge_fault = ext4_dax_huge_fault,
729 .page_mkwrite = ext4_dax_fault,
730 .pfn_mkwrite = ext4_dax_fault,
733 #define ext4_dax_vm_ops ext4_file_vm_ops
736 static const struct vm_operations_struct ext4_file_vm_ops = {
737 .fault = ext4_filemap_fault,
738 .map_pages = filemap_map_pages,
739 .page_mkwrite = ext4_page_mkwrite,
742 static int ext4_file_mmap(struct file *file, struct vm_area_struct *vma)
744 struct inode *inode = file->f_mapping->host;
745 struct ext4_sb_info *sbi = EXT4_SB(inode->i_sb);
746 struct dax_device *dax_dev = sbi->s_daxdev;
748 if (unlikely(ext4_forced_shutdown(sbi)))
752 * We don't support synchronous mappings for non-DAX files and
753 * for DAX files if underneath dax_device is not synchronous.
755 if (!daxdev_mapping_supported(vma, dax_dev))
759 if (IS_DAX(file_inode(file))) {
760 vma->vm_ops = &ext4_dax_vm_ops;
761 vma->vm_flags |= VM_HUGEPAGE;
763 vma->vm_ops = &ext4_file_vm_ops;
768 static int ext4_sample_last_mounted(struct super_block *sb,
769 struct vfsmount *mnt)
771 struct ext4_sb_info *sbi = EXT4_SB(sb);
777 if (likely(sbi->s_mount_flags & EXT4_MF_MNTDIR_SAMPLED))
780 if (sb_rdonly(sb) || !sb_start_intwrite_trylock(sb))
783 sbi->s_mount_flags |= EXT4_MF_MNTDIR_SAMPLED;
785 * Sample where the filesystem has been mounted and
786 * store it in the superblock for sysadmin convenience
787 * when trying to sort through large numbers of block
788 * devices or filesystem images.
790 memset(buf, 0, sizeof(buf));
792 path.dentry = mnt->mnt_root;
793 cp = d_path(&path, buf, sizeof(buf));
798 handle = ext4_journal_start_sb(sb, EXT4_HT_MISC, 1);
799 err = PTR_ERR(handle);
802 BUFFER_TRACE(sbi->s_sbh, "get_write_access");
803 err = ext4_journal_get_write_access(handle, sbi->s_sbh);
806 strlcpy(sbi->s_es->s_last_mounted, cp,
807 sizeof(sbi->s_es->s_last_mounted));
808 ext4_handle_dirty_super(handle, sb);
810 ext4_journal_stop(handle);
816 static int ext4_file_open(struct inode *inode, struct file *filp)
820 if (unlikely(ext4_forced_shutdown(EXT4_SB(inode->i_sb))))
823 ret = ext4_sample_last_mounted(inode->i_sb, filp->f_path.mnt);
827 ret = fscrypt_file_open(inode, filp);
831 ret = fsverity_file_open(inode, filp);
836 * Set up the jbd2_inode if we are opening the inode for
837 * writing and the journal is present
839 if (filp->f_mode & FMODE_WRITE) {
840 ret = ext4_inode_attach_jinode(inode);
845 filp->f_mode |= FMODE_NOWAIT;
846 return dquot_file_open(inode, filp);
850 * ext4_llseek() handles both block-mapped and extent-mapped maxbytes values
851 * by calling generic_file_llseek_size() with the appropriate maxbytes
854 loff_t ext4_llseek(struct file *file, loff_t offset, int whence)
856 struct inode *inode = file->f_mapping->host;
859 if (!(ext4_test_inode_flag(inode, EXT4_INODE_EXTENTS)))
860 maxbytes = EXT4_SB(inode->i_sb)->s_bitmap_maxbytes;
862 maxbytes = inode->i_sb->s_maxbytes;
866 return generic_file_llseek_size(file, offset, whence,
867 maxbytes, i_size_read(inode));
869 inode_lock_shared(inode);
870 offset = iomap_seek_hole(inode, offset,
871 &ext4_iomap_report_ops);
872 inode_unlock_shared(inode);
875 inode_lock_shared(inode);
876 offset = iomap_seek_data(inode, offset,
877 &ext4_iomap_report_ops);
878 inode_unlock_shared(inode);
884 return vfs_setpos(file, offset, maxbytes);
887 const struct file_operations ext4_file_operations = {
888 .llseek = ext4_llseek,
889 .read_iter = ext4_file_read_iter,
890 .write_iter = ext4_file_write_iter,
891 .iopoll = iomap_dio_iopoll,
892 .unlocked_ioctl = ext4_ioctl,
894 .compat_ioctl = ext4_compat_ioctl,
896 .mmap = ext4_file_mmap,
897 .mmap_supported_flags = MAP_SYNC,
898 .open = ext4_file_open,
899 .release = ext4_release_file,
900 .fsync = ext4_sync_file,
901 .get_unmapped_area = thp_get_unmapped_area,
902 .splice_read = generic_file_splice_read,
903 .splice_write = iter_file_splice_write,
904 .fallocate = ext4_fallocate,
907 const struct inode_operations ext4_file_inode_operations = {
908 .setattr = ext4_setattr,
909 .getattr = ext4_file_getattr,
910 .listxattr = ext4_listxattr,
911 .get_acl = ext4_get_acl,
912 .set_acl = ext4_set_acl,
913 .fiemap = ext4_fiemap,